YamlBaseSettings

pydantic settings safir.pydantic.YamlBaseSettings

Base class for Pydantic settings from a YAML file.

This class is intended to serve as the base class for application settings when the settings are primarily parsed from a YAML configuration file with optional overrides and secrets from environment variables. It enables camel case for validation, allowing all parameters to be specified in the camel-case format that is standard for Helm charts. It also forbids extra settings and disables settings sources other than the constructor (used when reading YAML files) and environment variables.

It is normally used in conjunction with ConfigDependency.

Parameters:

• _case_sensitive (Optional[bool], default: None)

• _nested_model_default_partial_update (Optional[bool], default: None)

• _env_prefix (Optional[str], default: None)

• _env_prefix_target (Optional[Literal['variable', 'alias', 'all']], default: None)

• _env_file (Union[Path, str, Sequence[Union[Path, str]], None], default: PosixPath('.'))

• _env_file_encoding (Optional[str], default: None)

• _env_file_depth (Optional[int], default: None)

• _env_ignore_empty (Optional[bool], default: None)

• _env_nested_delimiter (Optional[str], default: None)

• _env_nested_max_split (Optional[int], default: None)

• _env_parse_none_str (Optional[str], default: None)

• _env_parse_enums (Optional[bool], default: None)

• _cli_prog_name (Optional[str], default: None)

• _cli_parse_args (Union[bool, list[str], tuple[str, ...], None], default: None)

• _cli_settings_source (Optional[CliSettingsSource[Any]], default: None)

• _cli_parse_none_str (Optional[str], default: None)

• _cli_hide_none_type (Optional[bool], default: None)

• _cli_avoid_json (Optional[bool], default: None)

• _cli_enforce_required (Optional[bool], default: None)

• _cli_use_class_docs_for_groups (Optional[bool], default: None)

• _cli_show_env_vars (Optional[bool], default: None)

• _cli_exit_on_error (Optional[bool], default: None)

• _cli_prefix (Optional[str], default: None)

• _cli_flag_prefix_char (Optional[str], default: None)

• _cli_implicit_flags (Union[bool, Literal['dual', 'toggle'], None], default: None)

• _cli_ignore_unknown_args (Optional[bool], default: None)

• _cli_kebab_case (Union[bool, Literal['all', 'no_enums'], None], default: None)

• _cli_shortcuts (Optional[Mapping[str, Union[str, list[str]]]], default: None)

• _secrets_dir (Union[Path, str, Sequence[Union[Path, str]], None], default: None)

• _build_sources (Optional[tuple[tuple[PydanticBaseSettingsSource, ...], dict[str, Any]]], default: None)

• values (Any)

Show JSON schema

{
   "title": "YamlBaseSettings",
   "description": "Base class for Pydantic settings from a YAML file.\n\nThis class is intended to serve as the base class for application settings\nwhen the settings are primarily parsed from a YAML configuration file with\noptional overrides and secrets from environment variables. It enables\ncamel case for validation, allowing all parameters to be specified in the\ncamel-case format that is standard for Helm charts. It also forbids extra\nsettings and disables settings sources other than the constructor (used\nwhen reading YAML files) and environment variables.\n\nIt is normally used in conjunction with\n`~safir.dependencies.config.ConfigDependency`.",
   "type": "object",
   "properties": {},
   "additionalProperties": false
}

Config:

• alias_generator: AliasGenerator = AliasGenerator(alias=None, validation_alias=<function YamlBaseSettings.<lambda> at 0x73f1017a4eb0>, serialization_alias=None)

• validate_by_name: bool = True

classmethod from_file(path)

Construct a settings object from a configuration file.

Parameters:

path (Path) – Path to the configuration file in YAML.

Returns:

The corresponding settings object.

Return type:

YamlBaseSettings