dev.docs.config#

Configuration.

Module Contents#

Classes#

PluginModelConfig

Pydantic plugin model configuration.

Settings

Package settings.

Data#

API#

dev.docs.config.settings_paths#

‘get_settings_paths(…)’

class dev.docs.config.PluginModelConfig(
_case_sensitive: bool | None = None,
_nested_model_default_partial_update: bool | None = None,
_env_prefix: str | None = None,
_env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL,
_env_file_encoding: str | None = None,
_env_ignore_empty: bool | None = None,
_env_nested_delimiter: str | None = None,
_env_parse_none_str: str | None = None,
_env_parse_enums: bool | None = None,
_cli_prog_name: str | None = None,
_cli_parse_args: bool | list[str] | tuple[str, ...] | None = None,
_cli_settings_source: pydantic_settings.sources.CliSettingsSource[Any] | None = None,
_cli_parse_none_str: str | None = None,
_cli_hide_none_type: bool | None = None,
_cli_avoid_json: bool | None = None,
_cli_enforce_required: bool | None = None,
_cli_use_class_docs_for_groups: bool | None = None,
_cli_exit_on_error: bool | None = None,
_cli_prefix: str | None = None,
_cli_implicit_flags: bool | None = None,
_secrets_dir: pydantic_settings.sources.PathType | None = None,
**values: Any,
)#

Bases: pydantic_settings.BaseSettings

Pydantic plugin model configuration.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

classmethod settings_customise_sources(
settings_cls: type[pydantic_settings.BaseSettings],
init_settings: pydantic_settings.PydanticBaseSettingsSource,
*_args: pydantic_settings.PydanticBaseSettingsSource,
**_kwds: pydantic_settings.PydanticBaseSettingsSource,
) tuple[pydantic_settings.PydanticBaseSettingsSource, ...]#

Source settings from init and TOML.

class dev.docs.config.Settings(
_case_sensitive: bool | None = None,
_nested_model_default_partial_update: bool | None = None,
_env_prefix: str | None = None,
_env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL,
_env_file_encoding: str | None = None,
_env_ignore_empty: bool | None = None,
_env_nested_delimiter: str | None = None,
_env_parse_none_str: str | None = None,
_env_parse_enums: bool | None = None,
_cli_prog_name: str | None = None,
_cli_parse_args: bool | list[str] | tuple[str, ...] | None = None,
_cli_settings_source: pydantic_settings.sources.CliSettingsSource[Any] | None = None,
_cli_parse_none_str: str | None = None,
_cli_hide_none_type: bool | None = None,
_cli_avoid_json: bool | None = None,
_cli_enforce_required: bool | None = None,
_cli_use_class_docs_for_groups: bool | None = None,
_cli_exit_on_error: bool | None = None,
_cli_prefix: str | None = None,
_cli_implicit_flags: bool | None = None,
_secrets_dir: pydantic_settings.sources.PathType | None = None,
**values: Any,
)#

Bases: pydantic_settings.BaseSettings

Package settings.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

build: dev.docs.models.Build#

‘Field(…)’

classmethod settings_customise_sources(
settings_cls: type[pydantic_settings.BaseSettings],
init_settings: pydantic_settings.PydanticBaseSettingsSource,
*_args: pydantic_settings.PydanticBaseSettingsSource,
**_kwds: pydantic_settings.PydanticBaseSettingsSource,
) tuple[pydantic_settings.PydanticBaseSettingsSource, ...]#

Source settings from init and TOML.

dev.docs.config.default#

‘Settings(…)’