The_Great_Archive/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-09-12 19:50:57 +05:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
dev
ArchiveBox/docs/apidocs/archivebox/archivebox.config.configset.md
Nick Sweeting f4932430db
Some checks are pending
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Waiting to run
Details
Build Debian package / build (amd64) (push) Waiting to run
Details
Build Debian package / build (arm64) (push) Waiting to run
Details
Build Debian package / test (amd64, ubuntu-24.04) (push) Blocked by required conditions
Details
Build Debian package / test (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
Details
Build Debian package / release (push) Blocked by required conditions
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-amd64, docker-amd64, linux/amd64, ubuntu-24.04) (push) Waiting to run
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-arm64, docker-arm64, linux/arm64, ubuntu-24.04-arm) (push) Waiting to run
Details
Build Docker image / publish multiarch tags (push) Blocked by required conditions
Details
Run linters / lint (push) Waiting to run
Details
Build Pip package / build (push) Waiting to run
Details
Release State / release-state (push) Waiting to run
Details
Parallel Tests / Discover test files (push) Waiting to run
Details
Parallel Tests / ${{ matrix.test.name }} (push) Blocked by required conditions
Details
Parallel Tests / ${{ matrix.plugin.name }} (push) Blocked by required conditions
Details
Run tests / python_tests (ubuntu-22.04, 3.13) (push) Waiting to run
Details
Run tests / docker_tests (push) Waiting to run
Details
docs: regenerate sphinx apidocs to reflect current source tree 
Clean rebuild of docs/apidocs/archivebox/ via autodoc2:
- Removes 19 stale module pages whose source files no longer exist
  (cli_utils, host_utils, schedule_utils — renamed to *_util; actors,
  ideas, debugging, folders, legacy, progress_layout, tests_piping,
  config_tags, personas.runtime/views, orchestrator*, worker, tasks).
- Adds 29 new module pages for code that was added since the previous
  generation but not yet documented.
- Updates 100 existing pages to reflect API surface changes (e.g.
  ENABLED_PLUGINS Field removed, SNAPSHOTS_PER_PAGE clamp removed,
  default bumped to 50, etc.).

156 source modules <-> 156 apidoc files (zero drift). Build clean
under sphinx-build -W --keep-going.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-31 03:40:25 -07:00

8.6 KiB
Raw Permalink Blame History

{py:mod}archivebox.config.configset

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`CaseConfigParser <archivebox.config.configset.CaseConfigParser>`
  -
* - {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}`_read_ini_config_cached <archivebox.config.configset._read_ini_config_cached>`
  - ```{autodoc2-docstring} archivebox.config.configset._read_ini_config_cached
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

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

API

:canonical: archivebox.config.configset.COMPUTED_CONFIG_KEYS
:value: >
   ('TERM_WIDTH', 'COMMIT_HASH', 'BUILD_TIME', 'USES_SUBDOMAIN_ROUTING', 'ENABLES_FULL_JS_REPLAY', 'CON...

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


:canonical: archivebox.config.configset.CaseConfigParser

Bases: {py:obj}`configparser.ConfigParser`

````{py:method} optionxform(optionstr: str) -> str
:canonical: archivebox.config.configset.CaseConfigParser.optionxform

```{autodoc2-docstring} archivebox.config.configset.CaseConfigParser.optionxform
```

````


:canonical: archivebox.config.configset._INI_CACHE
:type: dict[tuple[str, float], dict[str, typing.Any]]
:value: >
   None

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


:canonical: archivebox.config.configset._read_ini_config_cached

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

: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) -> tuple[typing.Any, str, bool]
:canonical: archivebox.config.configset.IniConfigSettingsSource.get_field_value

````

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

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

````

````{py:method} _load_config_file() -> 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: >
   'SettingsConfigDict(...)'

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

````

````{py:attribute} computed_config_keys
:canonical: archivebox.config.configset.BaseConfigSet.computed_config_keys
:type: typing.ClassVar[tuple[str, ...]]
:value: >
   ()

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

````

````{py:method} settings_customise_sources(settings_cls: 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) -> 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) -> dict[str, str]
:canonical: archivebox.config.configset.BaseConfigSet.load_from_file
:classmethod:

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

````

````{py:method} __getitem__(key: str) -> typing.Any
:canonical: archivebox.config.configset.BaseConfigSet.__getitem__

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

````

````{py:method} __setitem__(key: str, value: typing.Any) -> None
:canonical: archivebox.config.configset.BaseConfigSet.__setitem__

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

````

````{py:method} update(*args, **kwargs) -> None
:canonical: archivebox.config.configset.BaseConfigSet.update

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

````

````{py:method} __contains__(key: str) -> bool
:canonical: archivebox.config.configset.BaseConfigSet.__contains__

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

````

````{py:method} get(key: str, default: typing.Any = None) -> typing.Any
:canonical: archivebox.config.configset.BaseConfigSet.get

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

````

````{py:method} as_dict() -> dict[str, typing.Any]
:canonical: archivebox.config.configset.BaseConfigSet.as_dict

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

````

````{py:method} items()
:canonical: archivebox.config.configset.BaseConfigSet.items

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

````

````{py:method} keys()
:canonical: archivebox.config.configset.BaseConfigSet.keys

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

````

````{py:method} values()
:canonical: archivebox.config.configset.BaseConfigSet.values

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

````