• Home
• Public Interface of Airflow
• airflow.utils.state

airflow.utils.state

Module Contents

Classes

JobState	All possible states that a Job can be in.
TerminalTIState	States that a Task Instance can be in that indicate it has reached a terminal state.
IntermediateTIState	States that a Task Instance can be in that indicate it is not yet in a terminal or running state.
TaskInstanceState	All possible states that a Task Instance can be in.
DagRunState	All possible states that a DagRun can be in.
State	Static class with task instance state constants and color methods to avoid hard-coding.

class airflow.utils.state.JobState

Bases: str, enum.Enum

All possible states that a Job can be in.

RUNNING = 'running'

SUCCESS = 'success'

RESTARTING = 'restarting'

FAILED = 'failed'

__str__()

Return str(self).

class airflow.utils.state.TerminalTIState

Bases: str, enum.Enum

States that a Task Instance can be in that indicate it has reached a terminal state.

SUCCESS = 'success'

FAILED = 'failed'

SKIPPED = 'skipped'

REMOVED = 'removed'

__str__()

Return str(self).

class airflow.utils.state.IntermediateTIState

Bases: str, enum.Enum

States that a Task Instance can be in that indicate it is not yet in a terminal or running state.

SCHEDULED = 'scheduled'

QUEUED = 'queued'

RESTARTING = 'restarting'

UP_FOR_RETRY = 'up_for_retry'

UP_FOR_RESCHEDULE = 'up_for_reschedule'

UPSTREAM_FAILED = 'upstream_failed'

DEFERRED = 'deferred'

__str__()

Return str(self).

class airflow.utils.state.TaskInstanceState

Bases: str, enum.Enum

All possible states that a Task Instance can be in.

Note that None is also allowed, so always use this in a type hint with Optional.

REMOVED

SCHEDULED

QUEUED

RUNNING = 'running'

SUCCESS

RESTARTING

FAILED

UP_FOR_RETRY

UP_FOR_RESCHEDULE

UPSTREAM_FAILED

SKIPPED

DEFERRED

__str__()

Return str(self).

class airflow.utils.state.DagRunState

Bases: str, enum.Enum

All possible states that a DagRun can be in.

These are “shared” with TaskInstanceState in some parts of the code, so please ensure that their values always match the ones with the same name in TaskInstanceState.

QUEUED = 'queued'

RUNNING = 'running'

SUCCESS = 'success'

FAILED = 'failed'

__str__()

Return str(self).

class airflow.utils.state.State

Static class with task instance state constants and color methods to avoid hard-coding.

SUCCESS

RUNNING

FAILED

NONE

REMOVED

SCHEDULED

QUEUED

RESTARTING

UP_FOR_RETRY

UP_FOR_RESCHEDULE

UPSTREAM_FAILED

SKIPPED

DEFERRED

finished_dr_states: frozenset[DagRunState]

unfinished_dr_states: frozenset[DagRunState]

task_states: tuple[TaskInstanceState | None, Ellipsis] = (None,)

dag_states: tuple[DagRunState, Ellipsis] = ()

state_color: dict[TaskInstanceState | None, str]

finished: frozenset[TaskInstanceState]

A list of states indicating a task has reached a terminal state (i.e. it has “finished”) and needs no further action.

Note that the attempt could have resulted in failure or have been interrupted; or perhaps never run at all (skip, or upstream_failed) in any case, it is no longer running.

unfinished: frozenset[TaskInstanceState | None]

A list of states indicating that a task either has not completed a run or has not even started.

failed_states: frozenset[TaskInstanceState]

A list of states indicating that a task or dag is a failed state.

success_states: frozenset[TaskInstanceState]

A list of states indicating that a task or dag is a success state.

adoptable_states

A list of states indicating that a task can be adopted or reset by a scheduler job if it was queued by another scheduler job that is not running anymore.

classmethod color(state)

Return color for a state.

classmethod color_fg(state)

Black&white colors for a state.

Previous Next

Was this entry helpful?