pip_services3_commons.convert.BooleanConverter module

pip_services3_commons.convert.BooleanConverter

Boolean conversion utilities

copyright

Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.

license

MIT, see LICENSE for more details.

class pip_services3_commons.convert.BooleanConverter.BooleanConverter

Bases: object

Converts arbitrary values to boolean values using extended conversion __rules: - Numbers: <>0 are true, =0 are false - Strings: “true”, “yes”, “T”, “Y”, “1” are true; “false”, “no”, “F”, “N” are false - DateTime: <>0 total milliseconds are true, =0 are false

Example: .. code-block:: python

value1 = BooleanConverter.to_nullable_boolean(true) // true value2 = BooleanConverter.to_nullable_boolean(“yes”) // true value3 = BooleanConverter.to_nullable_boolean(123) // true value4 = BooleanConverter.to_nullable_boolean({}) // None

static to_boolean(value: Any) → bool

Converts args into boolean or returns false when conversion is not possible.

Parameters

value – the args to convert.

Returns

boolean args or false when conversion is not supported.

static to_boolean_with_default(value: Any, default_value: bool) → bool

Converts args into boolean or returns default args when conversion is not possible

Parameters

• value – the args to convert.

• default_value – the default args

Returns

boolean args or default when conversion is not supported.

static to_nullable_boolean(value: Any) → Optional[bool, None]

Converts args into boolean or returns None when conversion is not possible.

Parameters

value – the args to convert.

Returns

boolean args or None when convertion is not supported.