pydantic_settings.restorer

Module Contents

class pydantic_settings.restorer.FlatMapValues(restored_env_values: Dict[JsonLocation, str], restored_text_values: Dict[str, Union[TextValues, Dict]], **values: Json)

get_location(self, val_loc: JsonLocation) → FlatMapLocation

Maps model location to flat-mapping location, preserving original case

Parameters

val_loc – model location

Raises

KeyError – in case if such value hasn’t been restored

Returns

flat-mapping location

exception pydantic_settings.restorer.InvalidAssignError(loc: Optional[Sequence[str]], key: str)

Value applying error.

exception pydantic_settings.restorer.CannotParseValueError(loc: Optional[Sequence[str]], key: str)

Cannot parse value.

exception pydantic_settings.restorer.AssignBeyondSimpleValueError(loc: Optional[Sequence[str]], key: str)

Assigning value deeper then previous simple value is forbidden.

class pydantic_settings.restorer.ModelShapeRestorer(model: AnyModelType, prefix: str, case_sensitive: bool, dead_end_value_resolver: Callable[[str], TextValues])

Restores flat-mapping into JSON document of known shape.

Currently, setting nested a value inside of any sequence isn’t supported.

property prefix(self) → str

restore(self, flat_map: Mapping[str, str]) → Tuple['FlatMapValues', Optional[Sequence[InvalidAssignError]]]