airflow.timetables.simple

Module Contents

Classes

NullTimetable

Timetable that never schedules anything.

OnceTimetable

Timetable that schedules the execution once as soon as possible.

class airflow.timetables.simple.NullTimetable[source]

Bases: _TrivialTimetable

Timetable that never schedules anything.

This corresponds to schedule_interval=None.

property summary(self) str[source]

A short summary for the timetable.

This is used to display the timetable in the web UI. A cron expression timetable, for example, can use this to display the expression. The default implementation returns the timetable’s type name.

next_dagrun_info(self, *, last_automated_data_interval: Optional[airflow.timetables.base.DataInterval], restriction: airflow.timetables.base.TimeRestriction) Optional[airflow.timetables.base.DagRunInfo][source]

Provide information to schedule the next DagRun.

The default implementation raises NotImplementedError.

Parameters
  • last_automated_data_interval – The data interval of the associated DAG’s last scheduled or backfilled run (manual runs not considered).

  • restriction – Restriction to apply when scheduling the DAG run. See documentation of TimeRestriction for details.

Returns

Information on when the next DagRun can be scheduled. None means a DagRun will not happen. This does not mean no more runs will be scheduled even again for this DAG; the timetable can return a DagRunInfo object when asked at another time.

class airflow.timetables.simple.OnceTimetable[source]

Bases: _TrivialTimetable

Timetable that schedules the execution once as soon as possible.

This corresponds to schedule_interval="@once".

property summary(self) str[source]

A short summary for the timetable.

This is used to display the timetable in the web UI. A cron expression timetable, for example, can use this to display the expression. The default implementation returns the timetable’s type name.

next_dagrun_info(self, *, last_automated_data_interval: Optional[airflow.timetables.base.DataInterval], restriction: airflow.timetables.base.TimeRestriction) Optional[airflow.timetables.base.DagRunInfo][source]

Provide information to schedule the next DagRun.

The default implementation raises NotImplementedError.

Parameters
  • last_automated_data_interval – The data interval of the associated DAG’s last scheduled or backfilled run (manual runs not considered).

  • restriction – Restriction to apply when scheduling the DAG run. See documentation of TimeRestriction for details.

Returns

Information on when the next DagRun can be scheduled. None means a DagRun will not happen. This does not mean no more runs will be scheduled even again for this DAG; the timetable can return a DagRunInfo object when asked at another time.

Was this entry helpful?