Utils

NumberType

Bases: Enum

Enumeration FLOAT or DECIMAL to specify number type.

Source code in configcalc/utils.py

class NumberType(Enum):
    """Enumeration FLOAT or DECIMAL to specify number type."""

    FLOAT = auto()
    DECIMAL = auto()

get_deep(nested_list, indices)

Gets element in nested list

Parameters:

Name	Type	Description	Default
nested_list	list[Any]	list with possible sublists	required
indices	list[int]	list of indices on each list to locate the element, from top to bottom	required

Returns:

Name	Type	Description
Any	Any	element value

Source code in configcalc/utils.py

def get_deep(nested_list: list[Any], indices: list[int]) -> Any:
    """Gets element in nested list

    Args:
        nested_list (list[Any]): list with possible sublists
        indices (list[int]): list of indices on each list to locate the element, from top to bottom

    Returns:
        Any: element value
    """
    # see https://stackoverflow.com/a/44579249/10926757
    if (len(indices) > 1) and (isinstance(nested_list[indices[0]], (list, dict))):
        return get_deep(nested_list[indices[0]], indices[1:])
    else:
        return nested_list[indices[0]]

set_deep(nested_list, indices, value)

Sets an element value deep in a nested list

Parameters:

Name	Type	Description	Default
nested_list	list[Any]	nested list	required
indices	list[int]	list of indices to the element	required
value	Any	new value of element	required

Returns:

Type	Description
list[Any]	list[Any]: nested list with updated value of element

Source code in configcalc/utils.py

def set_deep(nested_list: list[Any], indices: list[int], value: Any) -> list[Any]:
    """Sets an element value deep in a nested list

    Args:
        nested_list (list[Any]): nested list
        indices (list[int]): list of indices to the element
        value (Any): new value of element

    Returns:
        list[Any]: nested list with updated value of element
    """
    if (len(indices) > 1) and isinstance(nested_list[indices[0]], (list, dict)):
        set_deep(nested_list[indices[0]], indices[1:], value)
    else:
        nested_list[indices[0]] = value
    return nested_list