prefect.settings.sources

Classes

EnvFilterSettingsSource ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L41" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Custom pydantic settings source to filter out specific environment variables.

All validation aliases are loaded from environment variables by default. We use AliasPath to maintain the ability set fields via model initialization, but those shouldn't be loaded from environment variables. This loader allows use to say which environment variables should be ignored.

FilteredDotEnvSettingsSource ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L84" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

ProfileSettingsTomlLoader ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L122" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Custom pydantic settings source to load profile settings from a toml file.

See https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources

Methods:

get_field_value ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L173" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

get_field_value(self, field: FieldInfo, field_name: str) -> Tuple[Any, str, bool]

Concrete implementation to get the field value from the profile settings

TomlConfigSettingsSourceBase ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L226" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

get_field_value ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L243" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

get_field_value(self, field: FieldInfo, field_name: str) -> tuple[Any, str, bool]

Concrete implementation to get the field value from toml data

prepare_field_value ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L270" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

prepare_field_value(self, field_name: str, field: FieldInfo, value: Any, value_is_complex: bool) -> Any

Override to skip JSON decoding for dict values already parsed from TOML.

PrefectTomlConfigSettingsSource ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L295" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Custom pydantic settings source to load settings from a prefect.toml file

Methods:

get_field_value ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L243" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

get_field_value(self, field: FieldInfo, field_name: str) -> tuple[Any, str, bool]

Concrete implementation to get the field value from toml data

prepare_field_value ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L270" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

prepare_field_value(self, field_name: str, field: FieldInfo, value: Any, value_is_complex: bool) -> Any

Override to skip JSON decoding for dict values already parsed from TOML.

PyprojectTomlConfigSettingsSource ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L314" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Custom pydantic settings source to load settings from a pyproject.toml file

Methods:

get_field_value ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L243" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

get_field_value(self, field: FieldInfo, field_name: str) -> tuple[Any, str, bool]

Concrete implementation to get the field value from toml data

prepare_field_value ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/sources.py#L270" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

prepare_field_value(self, field_name: str, field: FieldInfo, value: Any, value_is_complex: bool) -> Any

Override to skip JSON decoding for dict values already parsed from TOML.