pip_services3_commons.convert.ArrayConverter module

pip_services3_commons.convert.ArrayConverter

Array 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.ArrayConverter.ArrayConverter

Bases: object

Converts arbitrary values into array objects. Example:

value1 = ArrayConverter.to_array([1, 2])       # Result: [1, 2]
value2 = ArrayConverter.to_array(1)            # Result: [1]
value2 = ArrayConverter.list_to_array("1,2,3") # Result: ["1", "2", "3"]

static list_to_array(value: Any) → List[Any]

Converts args into array object with empty array as default. Strings with comma-delimited values are split into array of strings.

Parameters: value – the list to convert.
Returns: array object or empty array when args is None

static to_array(value: Any) → Any

Converts args into array object with empty array as default. Single values are converted into arrays with single element.

Parameters: value – the args to convert.
Returns: array object or empty array when args is None.

static to_array_with_default(value: Any, default_value: List[Any]) → List[Any]

Converts args into array object with specified default. Single values are converted into arrays with single element.

Parameters

value – the args to convert.
default_value – default array object.

Returns

array object or default array when args is None.

static to_nullable_array(value: Any) → Optional[List[Any], None]

Converts args into array object. Single values are converted into arrays with a single element.

Parameters: value – the args to convert.
Returns: array object or None when args is None.