JobStatus

class JobStatus(value)

Enumeration of possible lifecycle states for a Job.

Attributes:

INITIALIZING

The job object has been created but execution has not yet been handed off to the backend. This is a transient state: a correctly implemented backend must ensure that every job exits INITIALIZING before run_async() returns.

QUEUED

The job has been submitted and is waiting for execution resources.

RUNNING

The job is currently being executed.

DONE

The job completed successfully. Results are available.

CANCELLED

The job was cancelled before or during execution.

ERROR

The job failed due to an error during execution.

Members

JobStatus.INITIALIZING = 'initializing'

JobStatus.QUEUED = 'queued'

JobStatus.RUNNING = 'running'

JobStatus.DONE = 'done'

JobStatus.CANCELLED = 'cancelled'

JobStatus.ERROR = 'error'

Methods

classmethod JobStatus.final_states() → tuple[JobStatus, ...]

Terminal states: once a Job reaches one of these, its state won’t change anymore.