states

Built-in task states.

States

See task-states.

Sets

READY_STATES

Set of states meaning the task result is ready (has been executed).

UNREADY_STATES

Set of states meaning the task result is not ready (hasn’t been executed).

EXCEPTION_STATES

Set of states meaning the task returned an exception.

PROPAGATE_STATES

Set of exception states that should propagate exceptions to the user.

ALL_STATES

Set of all possible states.

Misc

Module Contents

Classes

state() Task state.

Functions

precedence(state) Get the precedence index for state.
precedence(state)

Get the precedence index for state.

Lower index means higher precedence.

class state

Task state.

State is a subclass of str, implementing comparison methods adhering to state precedence rules:

>>> from celery.states import state, PENDING, SUCCESS

>>> state(PENDING) < state(SUCCESS)
True

Any custom state is considered to be lower than :state:`FAILURE` and :state:`SUCCESS`, but higher than any of the other built-in states:

>>> state('PROGRESS') > state(STARTED)
True

>>> state('PROGRESS') > state('SUCCESS')
False
__gt__(other)
__ge__(other)
__lt__(other)
__le__(other)