mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 02:41:25 -07:00
487cf0ee8d
The error message as it was confused me when the value was 'enabled' and
there was also a module parameter named 'enabled'.
enabled is not a valid boolean. Valid booleans include: yes, on, 1, true, ...
So by clearly describing it as a value, the confusion would have been
avoided.
The value 'enabled' is not a valid boolean. Valid booleans include: yes, on, 1, true, ...
26 lines
1,008 B
Python
26 lines
1,008 B
Python
# Copyright: 2017, Ansible Project
|
|
# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause )
|
|
|
|
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().strip()
|
|
|
|
if normalized_value in BOOLEANS_TRUE:
|
|
return True
|
|
elif normalized_value in BOOLEANS_FALSE or not strict:
|
|
return False
|
|
|
|
raise TypeError("The value '%s' is not a valid boolean. Valid booleans include: %s" % (to_text(value), ', '.join(repr(i) for i in BOOLEANS)))
|