summaryrefslogtreecommitdiff
path: root/lib/ansible/module_utils/parsing
diff options
context:
space:
mode:
authorToshio Kuratomi <a.badger@gmail.com>2017-07-14 16:44:58 -0700
committerToshio Kuratomi <a.badger@gmail.com>2017-07-17 11:48:05 -0700
commitff22528b076fa7ab17e096c73f5d30d370bd0448 (patch)
tree3a2b1e658ab2a7a661036e3e5fc53d77e0db9849 /lib/ansible/module_utils/parsing
parentf9c60e1a827909236c9b131f534c75f665dedee3 (diff)
downloadansible-ff22528b076fa7ab17e096c73f5d30d370bd0448.tar.gz
Consolidate boolean/mk_boolean conversion functions into a single location
Consolidate the module_utils, constants, and config functions that convert values into booleans into a single function in module_utils. Port code to use the module_utils.validate.convert_bool.boolean function isntead of mk_boolean.
Diffstat (limited to 'lib/ansible/module_utils/parsing')
-rw-r--r--lib/ansible/module_utils/parsing/__init__.py0
-rw-r--r--lib/ansible/module_utils/parsing/convert_bool.py26
2 files changed, 26 insertions, 0 deletions
diff --git a/lib/ansible/module_utils/parsing/__init__.py b/lib/ansible/module_utils/parsing/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/lib/ansible/module_utils/parsing/__init__.py
diff --git a/lib/ansible/module_utils/parsing/convert_bool.py b/lib/ansible/module_utils/parsing/convert_bool.py
new file mode 100644
index 0000000000..415bfe1cae
--- /dev/null
+++ b/lib/ansible/module_utils/parsing/convert_bool.py
@@ -0,0 +1,26 @@
+# Copyright: 2017, Ansible Project
+# License: GNU General Public License v3 or later (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt )
+
+from ansible.module_utils.six import binary_type, text_type
+from ansible.module_utils._text import to_text
+
+
+BOOLEANS_TRUE = frozenset(('y', 'yes', 'on', '1', 'true', 't', 1, 1.0, True))
+BOOLEANS_FALSE = frozenset(('n', 'no', 'off', '0', 'false', 'f', 0, 0.0, False))
+BOOLEANS = BOOLEANS_TRUE.union(BOOLEANS_FALSE)
+
+
+def boolean(value, strict=True):
+ if isinstance(value, bool):
+ return value
+
+ normalized_value = value
+ if isinstance(value, (text_type, binary_type)):
+ normalized_value = to_text(value, errors='surrogate_or_strict').lower()
+
+ if normalized_value in BOOLEANS_TRUE:
+ return True
+ elif normalized_value in BOOLEANS_FALSE or not strict:
+ return False
+
+ raise TypeError('%s is not a valid boolean. Valid booleans include: %s' % (to_text(value), ', '.join(repr(i) for i in BOOLEANS)))