Documentation Index Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
Use this file to discover all available pages before exploring further.
prefect.settings.sources
Classes
EnvFilterSettingsSource
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
ProfileSettingsTomlLoader
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
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
Methods:
get_field_value
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
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
Custom pydantic settings source to load settings from a prefect.toml file
Methods:
get_field_value
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
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
Custom pydantic settings source to load settings from a pyproject.toml file
Methods:
get_field_value
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
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.