saq.types

Types

Module Contents

class saq.types.Context

Bases: typing_extensions.TypedDict

Task context.

Extra context fields are allowed.

worker: typing_extensions.Required[saq.worker.Worker]

Worker currently executing the task

job: saq.job.Job

Job() instance of the task

queue: saq.queue.Queue

Queue the task is running on

exception: Exception | None

Exception raised by the task if any

class saq.types.JobTaskContext

Bases: typing_extensions.TypedDict

Jobs Task Context

task: asyncio.Task[Any]

asyncio Task of the Job

aborted: str | None

If this task has been aborted, this is the reason

class saq.types.WorkerInfo

Bases: typing_extensions.TypedDict

Worker Info

class saq.types.QueueInfo

Bases: typing_extensions.TypedDict

Queue Info

workers: dict[str, WorkerInfo]

Worker information

name: str

Queue name

queued: int

Number of jobs currently in the queue

active: int

Number of jobs currently active

jobs: list[dict[str, Any]]

A truncated list containing the jobs that are scheduled to execute soonest

class saq.types.WorkerStats

Bases: typing_extensions.TypedDict

Worker Stats

complete: int

Number of complete tasks

failed: int

Number of failed tasks

retried: int

Number of retries

aborted: int

Number of aborted tasks

uptime: int

Queue uptime in milliseconds

class saq.types.TimersDict

Bases: typing_extensions.TypedDict

Timers Dictionary

schedule: int

How often we poll to schedule jobs in seconds (default 1)

worker_info: int

How often to update worker info, stats and metadata in seconds (default 10)

sweep: int

How often to clean up stuck jobs in seconds (default 60)

abort: int

How often to check if a job is aborted in seconds (default 1)

class saq.types.PartialTimersDict

Bases: TimersDict

For argument to Worker, all keys are not required

class saq.types.SettingsDict

Bases: typing_extensions.TypedDict

Settings