ArchiveBox/docs/apidocs/archivebox/archivebox.misc.jsonl.md
Nick Sweeting f4932430db
Some checks are pending
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Waiting to run
Build Debian package / build (amd64) (push) Waiting to run
Build Debian package / build (arm64) (push) Waiting to run
Build Debian package / test (amd64, ubuntu-24.04) (push) Blocked by required conditions
Build Debian package / test (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
Build Debian package / release (push) Blocked by required conditions
Build Docker image / build ${{ matrix.platform }} (digest-linux-amd64, docker-amd64, linux/amd64, ubuntu-24.04) (push) Waiting to run
Build Docker image / build ${{ matrix.platform }} (digest-linux-arm64, docker-arm64, linux/arm64, ubuntu-24.04-arm) (push) Waiting to run
Build Docker image / publish multiarch tags (push) Blocked by required conditions
Run linters / lint (push) Waiting to run
Build Pip package / build (push) Waiting to run
Release State / release-state (push) Waiting to run
Parallel Tests / Discover test files (push) Waiting to run
Parallel Tests / ${{ matrix.test.name }} (push) Blocked by required conditions
Parallel Tests / ${{ matrix.plugin.name }} (push) Blocked by required conditions
Run tests / python_tests (ubuntu-22.04, 3.13) (push) Waiting to run
Run tests / docker_tests (push) Waiting to run
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

5.0 KiB

{py:mod}archivebox.misc.jsonl

:allowtitles:

Module Contents

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`parse_line <archivebox.misc.jsonl.parse_line>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.parse_line
    :summary:
    ```
* - {py:obj}`read_stdin <archivebox.misc.jsonl.read_stdin>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.read_stdin
    :summary:
    ```
* - {py:obj}`read_file <archivebox.misc.jsonl.read_file>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.read_file
    :summary:
    ```
* - {py:obj}`read_args_or_stdin <archivebox.misc.jsonl.read_args_or_stdin>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.read_args_or_stdin
    :summary:
    ```
* - {py:obj}`write_record <archivebox.misc.jsonl.write_record>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.write_record
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`TYPE_SNAPSHOT <archivebox.misc.jsonl.TYPE_SNAPSHOT>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_SNAPSHOT
    :summary:
    ```
* - {py:obj}`TYPE_ARCHIVERESULT <archivebox.misc.jsonl.TYPE_ARCHIVERESULT>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_ARCHIVERESULT
    :summary:
    ```
* - {py:obj}`TYPE_TAG <archivebox.misc.jsonl.TYPE_TAG>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_TAG
    :summary:
    ```
* - {py:obj}`TYPE_CRAWL <archivebox.misc.jsonl.TYPE_CRAWL>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_CRAWL
    :summary:
    ```
* - {py:obj}`TYPE_BINARYREQUEST <archivebox.misc.jsonl.TYPE_BINARYREQUEST>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_BINARYREQUEST
    :summary:
    ```
* - {py:obj}`TYPE_BINARY <archivebox.misc.jsonl.TYPE_BINARY>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_BINARY
    :summary:
    ```
* - {py:obj}`TYPE_PROCESS <archivebox.misc.jsonl.TYPE_PROCESS>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_PROCESS
    :summary:
    ```
* - {py:obj}`TYPE_MACHINE <archivebox.misc.jsonl.TYPE_MACHINE>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_MACHINE
    :summary:
    ```
* - {py:obj}`VALID_TYPES <archivebox.misc.jsonl.VALID_TYPES>`
  - ```{autodoc2-docstring} archivebox.misc.jsonl.VALID_TYPES
    :summary:
    ```

API

:canonical: archivebox.misc.jsonl.TYPE_SNAPSHOT
:value: >
   'Snapshot'

```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_SNAPSHOT
```

:canonical: archivebox.misc.jsonl.TYPE_ARCHIVERESULT
:value: >
   'ArchiveResult'

```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_ARCHIVERESULT
```

:canonical: archivebox.misc.jsonl.TYPE_TAG
:value: >
   'Tag'

```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_TAG
```

:canonical: archivebox.misc.jsonl.TYPE_CRAWL
:value: >
   'Crawl'

```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_CRAWL
```

:canonical: archivebox.misc.jsonl.TYPE_BINARYREQUEST
:value: >
   'BinaryRequest'

```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_BINARYREQUEST
```

:canonical: archivebox.misc.jsonl.TYPE_BINARY
:value: >
   'Binary'

```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_BINARY
```

:canonical: archivebox.misc.jsonl.TYPE_PROCESS
:value: >
   'Process'

```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_PROCESS
```

:canonical: archivebox.misc.jsonl.TYPE_MACHINE
:value: >
   'Machine'

```{autodoc2-docstring} archivebox.misc.jsonl.TYPE_MACHINE
```

:canonical: archivebox.misc.jsonl.VALID_TYPES
:value: >
   None

```{autodoc2-docstring} archivebox.misc.jsonl.VALID_TYPES
```

:canonical: archivebox.misc.jsonl.parse_line

```{autodoc2-docstring} archivebox.misc.jsonl.parse_line
```
:canonical: archivebox.misc.jsonl.read_stdin

```{autodoc2-docstring} archivebox.misc.jsonl.read_stdin
```
:canonical: archivebox.misc.jsonl.read_file

```{autodoc2-docstring} archivebox.misc.jsonl.read_file
```
:canonical: archivebox.misc.jsonl.read_args_or_stdin

```{autodoc2-docstring} archivebox.misc.jsonl.read_args_or_stdin
```
:canonical: archivebox.misc.jsonl.write_record

```{autodoc2-docstring} archivebox.misc.jsonl.write_record
```