airflow.providers.standard.sensors.time_delta

Module Contents

Classes

TimeDeltaSensor

Waits for a timedelta after the run's data interval.

TimeDeltaSensorAsync

A deferrable drop-in replacement for TimeDeltaSensor.

WaitSensor

A sensor that waits a specified period of time before completing.
class airflow.providers.standard.sensors.time_delta.TimeDeltaSensor(*, delta, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Waits for a timedelta after the run’s data interval.

Parameters

delta – time length to wait after the data interval before succeeding.

See also

For more information on how to use this sensor, take a look at the guide: TimeDeltaSensor

poke(context)[source]

Override when deriving this class.

class airflow.providers.standard.sensors.time_delta.TimeDeltaSensorAsync(*, end_from_trigger=False, delta, **kwargs)[source]

Bases: TimeDeltaSensor

A deferrable drop-in replacement for TimeDeltaSensor.

Will defers itself to avoid taking up a worker slot while it is waiting.

Parameters

  • delta – time length to wait after the data interval before succeeding.

  • end_from_trigger (bool) – End the task directly from the triggerer without going into the worker.

See also

For more information on how to use this sensor, take a look at the guide: TimeDeltaSensorAsync

execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

execute_complete(context, event=None)[source]

Handle the event when the trigger fires and return immediately.

class airflow.providers.standard.sensors.time_delta.WaitSensor(time_to_wait, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

A sensor that waits a specified period of time before completing.

This differs from TimeDeltaSensor because the time to wait is measured from the start of the task, not the data_interval_end of the DAG run.

Parameters

  • time_to_wait (datetime.timedelta | int) – time length to wait after the task starts before succeeding.

  • deferrable (bool) – Run sensor in deferrable mode

execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?