pydantic_configmanager

Top-level package for Pydantic Configuration Manager.

Classes

class pydantic_configmanager.EnvironmentBaseModel(_env_file='<object object>', _env_file_encoding=None, _secrets_dir=None, **values)[source]

Pydantic BaseSettings class with extended environment variable generation and template output.

This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku, Kubernetes, Openshift and any 12 factor app design.

Inheritance

Inheritance diagram of EnvironmentBaseModel
Parameters
  • _env_file (Optional[Union[pathlib.Path, str]]) –

  • _env_file_encoding (Optional[str]) –

  • _secrets_dir (Optional[Union[pathlib.Path, str]]) –

  • values (Any) –

Return type

None

class Config[source]

Configuratio for the Config class via a… Config class.

classmethod env_config(by_alias=True, include_export=False)[source]

Return settings template as they would go into environment.

Parameters
  • by_alias (bool) –

  • include_export (bool) –

Return type

str

classmethod from_env(**data)[source]

Initialize object from environmnent variables.

Parameters

data (Any) –

Return type

pydantic_configmanager.main.T

class pydantic_configmanager.SettingsConfig[source]

Inheritance

Inheritance diagram of SettingsConfig
classmethod env_alias_generator(fieldname)[source]

Create environment names with a name prefix, env prefix and a postfix.

Parameters

fieldname (str) –

Return type

str

classmethod prepare_field(field)[source]

Optional hook to check or modify fields during model creation.

Parameters

field (pydantic.fields.ModelField) –

Return type

None