recursivenamespace Module

Main Class

class recursivenamespace.main.recursivenamespace(data: Dict[str, Any] | None = None, accepted_iter_types: List[type] | None = None, use_raw_key: bool = False, **kwargs: Any)

Bases: SimpleNamespace

__init__(data: Dict[str, Any] | None = None, accepted_iter_types: List[type] | None = None, use_raw_key: bool = False, **kwargs: Any) → None

__eq__(other: object) → bool

Return self==value.

__repr__() → str

Return repr(self).

__len__() → int

__setitem__(key: str, value: Any) → None

__getitem__(key: str) → Any

__delitem__(key: str) → None

__contains__(key: str) → bool

classmethod from_json(json_str: str, accepted_iter_types: List[type] | None = None, use_raw_key: bool = False) → recursivenamespace

classmethod load_json(filepath: str | Path, accepted_iter_types: List[type] | None = None, use_raw_key: bool = False) → recursivenamespace

classmethod from_toml(toml_str: str, accepted_iter_types: List[type] | None = None, use_raw_key: bool = False) → recursivenamespace

classmethod load_toml(filepath: str | Path, accepted_iter_types: List[type] | None = None, use_raw_key: bool = False) → recursivenamespace

set_key(key: str) → None

get_key() → str

update(data: Dict[str, Any] | recursivenamespace) → None

copy() → recursivenamespace

deepcopy() → recursivenamespace

pop(key: str, default: T | None = None) → Any | T

items() → List[tuple[str, Any]]

keys() → List[str]

values() → List[Any]

to_dict(flatten_sep: str | bool = False) → Dict[str, Any]

val_set(key: str, value: Any) → None

val_get(key: str) → Any

get_or_else(key: str, or_else: T | None = None, show_log: bool = False) → Any | T

as_schema(schema_cls: type[T], /, **kwargs: Any) → T

temporary() → AbstractContextManager[recursivenamespace]

overlay(overrides: Dict[str, Any]) → AbstractContextManager[recursivenamespace]

to_json(indent: int | None = 2, sort_keys: bool = False, ensure_ascii: bool = True, **kwargs: Any) → str

save_json(filepath: str | Path, indent: int | None = 2, **kwargs: Any) → None

to_toml() → str

save_toml(filepath: str | Path) → None

Decorator

recursivenamespace.main.rns(accepted_iter_types: List[type] | None = None, use_raw_key: bool = False, use_chain_key: bool = False, props: str = 'props') → Callable[[Callable[[...], Any]], Callable[[...], recursivenamespace]]

Create RNS object

Exceptions

class recursivenamespace.main.SetChainKeyError(obj: Any, key: str, sub_key: str)

Bases: KeyError

__init__(obj: Any, key: str, sub_key: str) → None

class recursivenamespace.main.GetChainKeyError(obj: Any, key: str, sub_key: str)

Bases: KeyError

__init__(obj: Any, key: str, sub_key: str) → None

class recursivenamespace.main.SerializationError

Bases: Exception

Raised when serialization or deserialization fails.