Skip to content

settings

ApplicationSettings

Bases: BaseSettings

Configuration for python-package-template.

Values are read from environment variables and optionally overridden by a .env file.

Source code in src/python_package_template/settings.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class ApplicationSettings(BaseSettings):
    """Configuration for python-package-template.

    Values are read from environment variables and optionally
    overridden by a ``.env`` file.
    """

    # if .env is present, it will override the environment variables
    model_config = SettingsConfigDict(env_file=".env", extra="ignore")

    # use .get_secret_value() to get the value
    EXAMPLE_API_KEY: Optional[SecretStr] = Field(default=None, description="the api key")
    EXAMPLE_ENDPOINT: Optional[str] = Field(default=None, description="the endpoint")

    logging_level: str = Field(
        default="DEBUG",
        validation_alias=AliasChoices("LOGGING_LEVEL", "logging_level"),
        description="Log level (TRACE, DEBUG, INFO, WARNING, ERROR, CRITICAL)",
    )

    def model_post_init(self, __context):
        """Called after model initialization."""
        pass

model_post_init(__context)

Called after model initialization.

Source code in src/python_package_template/settings.py 
32
33
34
def model_post_init(self, __context):
    """Called after model initialization."""
    pass