Utils Module

Key Manipulation

recursivenamespace.utils.escape_key(key: str, sep: str | None = None) → str[source]

recursivenamespace.utils.unescape_key(key: str, sep: str | None = None) → str[source]

recursivenamespace.utils.split_key(key: str, sep: str | None = None) → list[str][source]

recursivenamespace.utils.join_key(parts: List[str], sep: str | None = None) → str[source]

Flattening Functions

recursivenamespace.utils.flatten_as_dict(data: Dict[str, Any] | None, sep: str = '.', flat_list: bool = False, use_ordered_dict: bool = True) → Dict[str, Any][source]

recursivenamespace.utils.flatten_as_list(data: Dict[str, Any] | None, sep: str = '.', flat_list_type: FlatListType = FlatListType.SKIP) → List[KV_Pair][source]

Types

class recursivenamespace.utils.KV_Pair(key, value)[source]

key: str: Alias for field number 0

value: Any: Alias for field number 1

class recursivenamespace.utils.FlatListType(*values)[source]

SKIP = 0

WITH_INDEX = 1

WITHOUT_INDEX = 2

WITH_SMART_INDEX = 3