JobResult

class safir.arq.JobResult(id, name, args, kwargs, enqueue_time, status, queue_name, start_time, finish_time, success, result)

Bases: JobMetadata

The full result of a job, as well as its metadata.

Parameters:

• id (str)

• name (str)

• args (tuple[Any, ...])

• kwargs (dict[str, Any])

• enqueue_time (datetime)

• status (JobStatus)

• queue_name (str)

• start_time (datetime)

• finish_time (datetime)

• success (bool)

• result (Any)

Attributes Summary

args	The positional arguments to the task function.
enqueue_time	Time when the job was added to the queue.
finish_time	Time when the job finished.
id	The Job identifier.
kwargs	The keyword arguments to the task function.
name	The task name.
queue_name	Name of the queue this job belongs to.
result	The job's result.
start_time	Time when the job started.
status	Status of the job.
success	True if the job returned without an exception, False if an exception was raised.

Methods Summary

from_job(job)

Initialize the JobResult from an arq Job.

Attributes Documentation

args: tuple[Any, ...] = <dataclasses._MISSING_TYPE object>

The positional arguments to the task function.

enqueue_time: datetime = <dataclasses._MISSING_TYPE object>

Time when the job was added to the queue.

finish_time: datetime = <dataclasses._MISSING_TYPE object>

Time when the job finished.

id: str = <dataclasses._MISSING_TYPE object>

The Job identifier.

kwargs: dict[str, Any] = <dataclasses._MISSING_TYPE object>

The keyword arguments to the task function.

name: str = <dataclasses._MISSING_TYPE object>

The task name.

queue_name: str = <dataclasses._MISSING_TYPE object>

Name of the queue this job belongs to.

result: Any = <dataclasses._MISSING_TYPE object>

The job’s result.

start_time: datetime = <dataclasses._MISSING_TYPE object>

Time when the job started.

status: JobStatus = <dataclasses._MISSING_TYPE object>

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)

success: bool = <dataclasses._MISSING_TYPE object>

True if the job returned without an exception, False if an exception was raised.

Methods Documentation

async classmethod from_job(job)

Initialize the JobResult from an arq Job.

Raises:

• JobNotFound – Raised if the job is not found

• JobResultUnavailable – Raised if the job result is not available.

Parameters:

job (Job)

Return type:

Self