archivebox.config.configset

{py:mod}archivebox.config.configset

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`IniConfigSettingsSource <archivebox.config.configset.IniConfigSettingsSource>`
  - ```{autodoc2-docstring} archivebox.config.configset.IniConfigSettingsSource
    :summary:
    ```
* - {py:obj}`BaseConfigSet <archivebox.config.configset.BaseConfigSet>`
  - ```{autodoc2-docstring} archivebox.config.configset.BaseConfigSet
    :summary:
    ```

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`get_config <archivebox.config.configset.get_config>`
  - ```{autodoc2-docstring} archivebox.config.configset.get_config
    :summary:
    ```
* - {py:obj}`get_flat_config <archivebox.config.configset.get_flat_config>`
  - ```{autodoc2-docstring} archivebox.config.configset.get_flat_config
    :summary:
    ```
* - {py:obj}`get_all_configs <archivebox.config.configset.get_all_configs>`
  - ```{autodoc2-docstring} archivebox.config.configset.get_all_configs
    :summary:
    ```
* - {py:obj}`_parse_env_value <archivebox.config.configset._parse_env_value>`
  - ```{autodoc2-docstring} archivebox.config.configset._parse_env_value
    :summary:
    ```
* - {py:obj}`get_worker_concurrency <archivebox.config.configset.get_worker_concurrency>`
  - ```{autodoc2-docstring} archivebox.config.configset.get_worker_concurrency
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`DEFAULT_WORKER_CONCURRENCY <archivebox.config.configset.DEFAULT_WORKER_CONCURRENCY>`
  - ```{autodoc2-docstring} archivebox.config.configset.DEFAULT_WORKER_CONCURRENCY
    :summary:
    ```

API

:canonical: archivebox.config.configset.IniConfigSettingsSource

Bases: {py:obj}`pydantic_settings.PydanticBaseSettingsSource`

```{autodoc2-docstring} archivebox.config.configset.IniConfigSettingsSource
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.config.configset.IniConfigSettingsSource.__init__
```

````{py:method} get_field_value(field: typing.Any, field_name: str) -> typing.Tuple[typing.Any, str, bool]
:canonical: archivebox.config.configset.IniConfigSettingsSource.get_field_value

````

````{py:method} __call__() -> typing.Dict[str, typing.Any]
:canonical: archivebox.config.configset.IniConfigSettingsSource.__call__

```{autodoc2-docstring} archivebox.config.configset.IniConfigSettingsSource.__call__
```

````

````{py:method} _load_config_file() -> typing.Dict[str, typing.Any]
:canonical: archivebox.config.configset.IniConfigSettingsSource._load_config_file

```{autodoc2-docstring} archivebox.config.configset.IniConfigSettingsSource._load_config_file
```

````

:canonical: archivebox.config.configset.BaseConfigSet

Bases: {py:obj}`pydantic_settings.BaseSettings`

```{autodoc2-docstring} archivebox.config.configset.BaseConfigSet
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.config.configset.BaseConfigSet.__init__
```

````{py:attribute} model_config
:canonical: archivebox.config.configset.BaseConfigSet.model_config
:value: >
   'ConfigDict(...)'

```{autodoc2-docstring} archivebox.config.configset.BaseConfigSet.model_config
```

````

````{py:method} settings_customise_sources(settings_cls: typing.Type[pydantic_settings.BaseSettings], init_settings: pydantic_settings.PydanticBaseSettingsSource, env_settings: pydantic_settings.PydanticBaseSettingsSource, dotenv_settings: pydantic_settings.PydanticBaseSettingsSource, file_secret_settings: pydantic_settings.PydanticBaseSettingsSource) -> typing.Tuple[pydantic_settings.PydanticBaseSettingsSource, ...]
:canonical: archivebox.config.configset.BaseConfigSet.settings_customise_sources
:classmethod:

```{autodoc2-docstring} archivebox.config.configset.BaseConfigSet.settings_customise_sources
```

````

````{py:method} load_from_file(config_path: pathlib.Path) -> typing.Dict[str, str]
:canonical: archivebox.config.configset.BaseConfigSet.load_from_file
:classmethod:

```{autodoc2-docstring} archivebox.config.configset.BaseConfigSet.load_from_file
```

````

````{py:method} update_in_place(warn: bool = True, persist: bool = False, **kwargs) -> None
:canonical: archivebox.config.configset.BaseConfigSet.update_in_place

```{autodoc2-docstring} archivebox.config.configset.BaseConfigSet.update_in_place
```

````

:canonical: archivebox.config.configset.get_config

```{autodoc2-docstring} archivebox.config.configset.get_config
```

:canonical: archivebox.config.configset.get_flat_config

```{autodoc2-docstring} archivebox.config.configset.get_flat_config
```

:canonical: archivebox.config.configset.get_all_configs

```{autodoc2-docstring} archivebox.config.configset.get_all_configs
```

:canonical: archivebox.config.configset._parse_env_value

```{autodoc2-docstring} archivebox.config.configset._parse_env_value
```

:canonical: archivebox.config.configset.DEFAULT_WORKER_CONCURRENCY
:value: >
   None

```{autodoc2-docstring} archivebox.config.configset.DEFAULT_WORKER_CONCURRENCY
```

:canonical: archivebox.config.configset.get_worker_concurrency

```{autodoc2-docstring} archivebox.config.configset.get_worker_concurrency
```