Added robot.utils.is_noney.

pekkaklarck · pekkaklarck · commit 33857d67a472 · 2017-07-30T01:21:46.000+03:00
Also added docs and tests for is_truthy and is_falsy. Fixes robotframework#2646.
diff --git a/src/robot/utils/__init__.py b/src/robot/utils/__init__.py
@@ -65,8 +65,8 @@
                         secs_to_timestr, timestamp_to_secs, timestr_to_secs,
                         parse_time)
 from .robottypes import (is_bytes, is_dict_like, is_falsy, is_integer,
-                         is_list_like, is_number, is_string, is_truthy,
-                         is_unicode, type_name)
+                         is_list_like, is_noney, is_number, is_string,
+                         is_truthy, is_unicode, type_name)
 from .setter import setter, SetterAwareType
 from .sortable import Sortable
 from .text import (cut_long_message, format_assign_message,
diff --git a/src/robot/utils/robottypes.py b/src/robot/utils/robottypes.py
@@ -26,10 +26,39 @@
 
 
 def is_truthy(item):
+    """Returns `True` or `False` depending is the item considered true or not.
+
+    Validation rules:
+
+    - If the value is a string, it is considered `True` if it is not `FALSE`,
+      `NO` or and empty string, case-insensitively.
+    - Other values are handled by using the standard `bool()` function.
+
+    Designed to be used also by external test libraries that want to handle
+    Boolean values similarly as Robot Framework itself. See also
+    :func:`is_falsy` and :func:`is_noney`.
+    """
     if is_string(item):
         return item.upper() not in ('FALSE', 'NO', '')
     return bool(item)
 
 
 def is_falsy(item):
+    """Opposite of :func:`is_truthy`."""
     return not is_truthy(item)
+
+
+def is_noney(item):
+    """Returns `True` or `False` depending is the item considered `None` or not.
+
+    Validation rules:
+
+    - If the value is a string, it is considered `None` if it is equal to
+      `NONE`, case-insensitively.
+    - Otherwise the value is considerd `None` only if it is the actual `None`.
+
+    Designed to be used also by external test libraries that want to handle
+    `NONE` similarly as Robot Framework itself. New in Robot Framework 3.0.3.
+    See also :func:`is_truthy` and :func:`is_falsy`.
+    """
+    return item is None or is_string(item) and item.upper() == 'NONE'
diff --git a/utest/utils/test_robottypes.py b/utest/utils/test_robottypes.py
@@ -16,9 +16,9 @@
 except ImportError:
     pass
 
-from robot.utils import (is_bytes, is_dict_like, is_list_like, is_string,
-                         type_name, JYTHON, PY3)
-from robot.utils.asserts import assert_equal
+from robot.utils import (is_bytes, is_falsy, is_dict_like, is_list_like,
+                         is_noney, is_string, is_truthy, type_name, JYTHON, PY3)
+from robot.utils.asserts import assert_equal, assert_true
 
 
 if PY3:
@@ -156,5 +156,22 @@ def test_java_object(self):
                 assert_equal(type_name(item), exp)
 
 
+class TestIsY(unittest.TestCase):
+
+    def test_is_truthy_and_is_falsy(self):
+        for item in [True, 1, [False], unittest.TestCase, 'foo', 'True']:
+            assert_true(is_truthy(item) is True)
+            assert_true(is_falsy(item) is False)
+        for item in [False, 0, [], None, 'False', 'FALSE', 'No', 'nO', '']:
+            assert_true(is_truthy(item) is False)
+            assert_true(is_falsy(item) is True)
+
+    def test_noney(self):
+        for item in [None, 'None', 'NONE', 'none']:
+            assert_true(is_noney(item) is True)
+        for item in [True, False, 1, '', 'xxx']:
+            assert_true(is_noney(item) is False)
+
+
 if __name__ == '__main__':
     unittest.main()
