Adding a configuration

This site explains how to create a new configuration, both for the generic part and for the application.

The following illustration shows the structure of the project:

Application
 ├── src
 │   ├── __init__.py
 │   ├── db.py
 │   ├── configuration.py
 │   └── tetue_generic
 │       ├── __init__.py
 │       └── watcher.py
 ├── default.env
 └── main.py

Generic

The watcher module with new functions should be added to the generic folder. If a configuration is required for the new generic parts, the following must be created.

1. Create a configuration class in watcher.py

from pydantic import BaseModel, FilePath

class WatcherConfiguration(BaseModel):
    log_level: str = ""
    log_file_path: FilePath = None

2. Declaring a local configuration and the initialization function in watcher.py

watcher_settings = WatcherConfiguration()

def init_generic_watcher(log_file_path: FilePath) -> None:
    watcher_settings.log_file_path = log_file_path

3. Add new configuration variables to default.env with nested delimiter

TT_WATCHER__LOG_FILE_PATH=files/app.log
TT_WATCHER__log_level=INFO

4. Add new init function in watcher.py to set_configurations() in configuration.py in src

def set_configurations(configuration: Configuration) -> None:
    init_generic_watcher(configuration.watcher.log_file_path)

Application

The db module with new functions should be added to the app folder. If a configuration is required for the new db parts, the following must be created.

1. Create a configuration class in db.py

from pydantic import BaseModel, IPvAnyAddress

class DbConfiguration(BaseModel):
    """
    Configuration settings for database handler
    """
    ip: IPvAnyAddress
    user: str
    active: bool = True

3. Add new configuration variables to .env with nested delimiter

TT_DB__IP=192.168.0.1
TT_DB__USER=TeTue

Here it’s different to the generic parts, as these are application-specific. Therefore, the variables that are optional (e.g. active) should be assigned a default value in DbConfiguration. All required (e.g. ip and user) variables from user must be specified in the .env.

Primary

If you need settings that are once again superordinate in the project, i.e. are not directly assigned to a module (user and name), these are specified and verified directly in the configuration class.

class Configuration(BaseSettings):
    model_config = SettingsConfigDict(env_prefix='TT_', env_nested_delimiter='__')

    user: str
    name: str = "TeTue"
    gen_req: GenReqConfiguration
    watcher: WatcherConfiguration
    db: DbConfiguration