Skip to content

Base

sereto.models.base

SeretoBaseModel

Bases: BaseModel

Pydantic BaseModel with custom configuration.

This class is a subclass of pydantic's BaseModel. It is used to define custom configuration for pydantic models.

Source code in sereto/models/base.py 
 9
10
11
12
13
14
15
class SeretoBaseModel(BaseModel):
    """Pydantic BaseModel with custom configuration.

    This class is a subclass of pydantic's BaseModel. It is used to define custom configuration for pydantic models.
    """

    model_config = ConfigDict(extra="forbid", strict=True, validate_assignment=True)

SeretoBaseSettings

Bases: BaseSettings

Pydantic's BaseSettings with custom configuration.

Source code in sereto/models/base.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
class SeretoBaseSettings(BaseSettings):
    """Pydantic's BaseSettings with custom configuration."""

    model_config = SettingsConfigDict(
        env_prefix="SERETO_",
        extra="forbid",
        # strict=True,
        validate_assignment=True,
    )

    @classmethod
    def settings_customise_sources(
        cls,
        settings_cls: type[BaseSettings],
        init_settings: PydanticBaseSettingsSource,
        env_settings: PydanticBaseSettingsSource,
        dotenv_settings: PydanticBaseSettingsSource,
        file_secret_settings: PydanticBaseSettingsSource,
    ) -> tuple[PydanticBaseSettingsSource, ...]:
        """Define the sources and their order for loading the settings values.

        Args:
            settings_cls: The Settings class.
            init_settings: The `InitSettingsSource` instance.
            env_settings: The `EnvSettingsSource` instance.
            dotenv_settings: The `DotEnvSettingsSource` instance.
            file_secret_settings: The `SecretsSettingsSource` instance.

        Returns:
            A tuple containing the sources and their order for loading the settings values.
        """
        return env_settings, init_settings, dotenv_settings, file_secret_settings

settings_customise_sources(settings_cls, init_settings, env_settings, dotenv_settings, file_secret_settings) classmethod

Define the sources and their order for loading the settings values.

Parameters:

Name Type Description Default
settings_cls type[BaseSettings]

The Settings class.

 required
init_settings PydanticBaseSettingsSource

The InitSettingsSource instance.

 required
env_settings PydanticBaseSettingsSource

The EnvSettingsSource instance.

 required
dotenv_settings PydanticBaseSettingsSource

The DotEnvSettingsSource instance.

 required
file_secret_settings PydanticBaseSettingsSource

The SecretsSettingsSource instance.

 required

Returns:

Type Description
tuple[PydanticBaseSettingsSource, ...]

A tuple containing the sources and their order for loading the settings values.
Source code in sereto/models/base.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
@classmethod
def settings_customise_sources(
    cls,
    settings_cls: type[BaseSettings],
    init_settings: PydanticBaseSettingsSource,
    env_settings: PydanticBaseSettingsSource,
    dotenv_settings: PydanticBaseSettingsSource,
    file_secret_settings: PydanticBaseSettingsSource,
) -> tuple[PydanticBaseSettingsSource, ...]:
    """Define the sources and their order for loading the settings values.

    Args:
        settings_cls: The Settings class.
        init_settings: The `InitSettingsSource` instance.
        env_settings: The `EnvSettingsSource` instance.
        dotenv_settings: The `DotEnvSettingsSource` instance.
        file_secret_settings: The `SecretsSettingsSource` instance.

    Returns:
        A tuple containing the sources and their order for loading the settings values.
    """
    return env_settings, init_settings, dotenv_settings, file_secret_settings