archivebox.workers.models

Module Contents

Classes

DefaultStatusChoices
ModelWithQueue	Durable queue fields and atomic lease operations shared by work rows.

Data

default_status_field
default_retry_at_field
RETRY_AT_MAX
ACTIVE_STATE_LEASE_SECONDS
logger
MODULE_PATH
REPO_ROOT
PACKAGE_ROOT

API

class archivebox.workers.models.DefaultStatusChoices

Bases: django.db.models.TextChoices

QUEUED

(‘queued’, ‘Queued’)

STARTED

(‘started’, ‘Started’)

PAUSED

(‘paused’, ‘Paused’)

SEALED

(‘sealed’, ‘Sealed’)

archivebox.workers.models.default_status_field: django.db.models.CharField

‘CharField(…)’

archivebox.workers.models.default_retry_at_field: django.db.models.DateTimeField

‘DateTimeField(…)’

archivebox.workers.models.RETRY_AT_MAX

‘datetime(…)’

archivebox.workers.models.ACTIVE_STATE_LEASE_SECONDS

60

archivebox.workers.models.logger

‘getLogger(…)’

archivebox.workers.models.MODULE_PATH

‘resolve(…)’

archivebox.workers.models.REPO_ROOT

None

archivebox.workers.models.PACKAGE_ROOT

None

class archivebox.workers.models.ModelWithQueue

Bases: django.db.models.Model

Durable queue fields and atomic lease operations shared by work rows.

Concrete models own lifecycle transitions. This mixin only owns the common database queue protocol: status, retry_at, pause/resume, and claims.

StatusChoices: ClassVar[type[django.db.models.TextChoices]]

None

INITIAL_STATE: ClassVar[str]

None

ACTIVE_STATE: ClassVar[str]

None

FINAL_STATES: ClassVar[tuple[str, ...]]

()

warn_on_save_outside_runner: ClassVar[bool]

True

status: django.db.models.CharField

‘CharField(…)’

retry_at: django.db.models.DateTimeField

‘DateTimeField(…)’

class Meta

Bases: django_stubs_ext.db.models.TypedModelMeta

app_label

‘workers’

abstract

True

FINAL_OR_ACTIVE_STATES: ClassVar[tuple[str, ...]]

()

classmethod status_counts(queryset: django.db.models.QuerySet | None = None, statuses: collections.abc.Iterable[str] | None = None) → dict[str, int]

property RETRY_AT: datetime.datetime | None

property STATE: str

bump_retry_at(seconds: int = 10) → None

property is_paused: bool

safe_update(update_fields: dict[str, Any], *, refresh: bool = True, extra_filter: dict[str, Any] | None = None) → bool

save(*args: Any, **kwargs: Any) → None

pause(*, save: bool = True) → bool

resume(*, when: datetime.datetime | None = None, save: bool = True) → bool

update_and_requeue(*, refresh: bool = True, **kwargs: Any) → bool

classmethod get_queue()

classmethod claim_for_worker(obj: archivebox.workers.models.ModelWithQueue, lock_seconds: int = 60) → bool

claim_processing_lock(lock_seconds: int = 60) → bool

classmethod extend_choices(base_choices: type[django.db.models.TextChoices])

classmethod StatusField(**kwargs: Any) → django.db.models.CharField

classmethod RetryAtField(**kwargs: Any) → django.db.models.DateTimeField