archivebox.cli.archivebox_extract

Run abx-dl snapshot hooks for existing ArchiveBox snapshots.

Module Contents

Functions

_resolve_requests

Resolve CLI records to snapshot-level execution requests.

_run_snapshot_requests

run_plugins

Execute selected plugins through the snapshot-level runner.

process_archiveresult_by_id

Re-run the parent Snapshot plugin referenced by an ArchiveResult.

main

Run plugins on Snapshots; ArchiveResult IDs select their parent plugin.

Data

__command__

API

archivebox.cli.archivebox_extract.__command__[source]

‘archivebox extract’

archivebox.cli.archivebox_extract._resolve_requests(records: list[dict], plugins: str) tuple[dict[str, set[str]], set[str]][source]

Resolve CLI records to snapshot-level execution requests.

ArchiveResult input is accepted as a convenient reference to its parent Snapshot and plugin. It is never reset or converted into queued work.

archivebox.cli.archivebox_extract._run_snapshot_requests(requested: dict[str, set[str]], *, wait: bool, show_progress: bool) int[source]
archivebox.cli.archivebox_extract.run_plugins(args: tuple, records: list[dict] | None = None, plugins: str = '', wait: bool = True, emit_results: bool = True, show_progress: bool = True) int[source]

Execute selected plugins through the snapshot-level runner.

archivebox.cli.archivebox_extract.process_archiveresult_by_id(archiveresult_id: str) int[source]

Re-run the parent Snapshot plugin referenced by an ArchiveResult.

archivebox.cli.archivebox_extract.main(plugins: str, wait: bool, args: tuple)[source]

Run plugins on Snapshots; ArchiveResult IDs select their parent plugin.