archivebox.misc.checks

Module Contents

Functions

_migration_interrupt_message
_exit_on_migration_interrupt
check_data_folder
check_migrations
check_io_encoding
check_not_root
is_archivebox_source_root	Return whether path is the root of an ArchiveBox source checkout.
check_not_inside_source_dir	Refuse data-producing execution from the ArchiveBox source checkout.
check_data_dir_permissions
check_tmp_dir
check_lib_dir

API

archivebox.misc.checks._migration_interrupt_message(*, before_apply: bool = False) → str

archivebox.misc.checks._exit_on_migration_interrupt()

archivebox.misc.checks.check_data_folder(config=None, **config_kwargs) → None

archivebox.misc.checks.check_migrations(*, blocking: bool = True, auto_apply: bool = False, cancel_delay: int = 3) → list[str]

archivebox.misc.checks.check_io_encoding()

archivebox.misc.checks.check_not_root()

archivebox.misc.checks.is_archivebox_source_root(path: pathlib.Path | str | None = None) → bool

Return whether path is the root of an ArchiveBox source checkout.

archivebox.misc.checks.check_not_inside_source_dir(path: pathlib.Path | str | None = None) → None

Refuse data-producing execution from the ArchiveBox source checkout.

archivebox.misc.checks.check_data_dir_permissions(config=None, **config_kwargs)

archivebox.misc.checks.check_tmp_dir(tmp_dir=None, throw=False, quiet=False, must_exist=True, config=None, **config_kwargs)

archivebox.misc.checks.check_lib_dir(lib_dir: pathlib.Path | None = None, throw=False, quiet=False, must_exist=True, config=None, **config_kwargs)