JobMetadata#

class safir.arq.JobMetadata(id, name, args, kwargs, enqueue_time, status, queue_name)#

Bases: object

Information about a queued job.

id#

The arq.jobs.Job identifier

Type:

str

name#

The task name.

Type:

str

args#

The positional arguments to the task function.

Type:

Any

kwargs#

The keyword arguments to the task function.

Type:

Any

enqueue_time#

Time when the job was added to the queue.

Type:

datetime.datetime

status#

Status of the job.

States are defined by the arq.jobs.JobStatus enumeration:

  • deferred (in queue, but waiting a predetermined time to become ready to run)

  • queued (queued to run)

  • in_progress (actively being run by a worker)

  • complete (result is available)

  • not_found (the job cannot be found)

Type:

str

queue_name#

Name of the queue this job belongs to.

Type:

str

Parameters:

Methods Summary

from_job(job)

Initialize JobMetadata from an arq Job.

Methods Documentation

async classmethod from_job(job)#

Initialize JobMetadata from an arq Job.

Raises:

JobNotFound – Raised if the job is not found

Parameters:

job (Job) –

Return type:

JobMetadata