Config

pydantic settings nublado.purger.config.Config

Configuration for the purger.

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_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_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)

Fields:

• add_timestamp (bool)

• alert_hook (pydantic.types.SecretStr | None)

• debug (bool)

• dry_run (bool)

• future_duration (HumanTimedelta | None)

• log_level (safir.logging._models.LogLevel)

• log_profile (safir.logging._models.Profile)

• policy_file (pathlib.Path)

field add_timestamp: Annotated[bool] = False

field alert_hook: Annotated[Optional[SecretStr]] = None

An https URL, which should be considered secret. If not set or set to None, this feature will be disabled.

field debug: Annotated[bool] = False

If True, then log level will be set to debug and will non-structured, human-readable output.

field dry_run: Annotated[bool] = False

field future_duration: Annotated[Optional[TypeAliasType]] = None

field log_level: Annotated[LogLevel] = LogLevel.INFO

field log_profile: Annotated[Profile] = Profile.production

field policy_file: Annotated[Path] = PosixPath('/etc/purger/policy.yaml')

configure_logging()

Configure logging based on the purger configuration.

Return type:

None

classmethod from_file(path)

Construct the configuration from a YAML file.

Parameters:

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

Returns:

The corresponding configuration.

Return type:

nublado.purger.config.Config