Skip to content

Loader

Env-spec loader.

======================================================================================================================== Name: core/env/loader.py Description: Parses env_data_model.yaml into typed Python dataclasses that represent every environment variable defined for the project.

Classes:

Name Description
DBField

Configuration for para entrada.

DBSpec

Configuration for Peewee/DB.

EnvSection

A named group of environment variables.

EnvSpec

Full specification parsed from the YAML file.

EnvVarSpec

Env vars spec.

SectionType

Section type.

ValidationSpec

Validation spec.

Functions:

Name Description
load_env_spec

Load env spec.

DBField

Bases: BaseModel

Configuration for para entrada.

DBSpec

Bases: BaseModel

Configuration for Peewee/DB.

EnvSection

Bases: BaseModel

A named group of environment variables.

Methods:

Name Description
propagate_section_context

Name and prefix injection.

propagate_section_context

propagate_section_context() -> EnvSection

Name and prefix injection.

EnvSpec

Bases: BaseModel

Full specification parsed from the YAML file.

Methods:

Name Description
validate_no_duplicates

Validation.

Attributes:

Name Type Description
all_vars list[EnvVarSpec]

Flat list of all variable specifications.

all_vars property

all_vars: list[EnvVarSpec]

Flat list of all variable specifications.

validate_no_duplicates

validate_no_duplicates() -> EnvSpec

Validation.

EnvVarSpec

Bases: BaseModel

Env vars spec.

Methods:

Name Description
display_value

Return a masked or real default value for documentation purposes.

pre_process_names

Preprocess names.

display_value

display_value() -> str

Return a masked or real default value for documentation purposes.

pre_process_names classmethod

pre_process_names(data: dict) -> dict

Preprocess names.

SectionType

Bases: StrEnum

Section type.

ValidationSpec

Bases: BaseModel

Validation spec.

load_env_spec

load_env_spec(path: str | Path | None = None) -> EnvSpec

Load env spec.