Stable (2.10.5)2.10.52.10.42.10.32.10.22.10.12.10.02.9.32.9.22.9.12.9.02.8.42.8.32.8.22.8.12.8.02.7.32.7.22.7.12.7.02.6.32.6.22.6.12.6.02.5.32.5.22.5.12.5.02.4.32.4.22.4.12.4.02.3.42.3.32.3.22.3.12.3.02.2.52.2.42.2.32.2.22.2.12.2.02.1.42.1.32.1.22.1.12.1.02.0.32.0.22.0.12.0.01.10.151.10.141.10.131.10.121.10.111.10.101.10.91.10.81.10.71.10.61.10.51.10.41.10.31.10.21.10.1
Stable (2.10.5)2.10.52.10.42.10.32.10.22.10.12.10.02.9.32.9.22.9.12.9.02.8.42.8.32.8.22.8.12.8.02.7.32.7.22.7.12.7.02.6.32.6.22.6.12.6.02.5.32.5.22.5.12.5.02.4.32.4.22.4.12.4.02.3.42.3.32.3.22.3.12.3.02.2.52.2.42.2.32.2.22.2.12.2.02.1.42.1.32.1.22.1.12.1.02.0.32.0.22.0.12.0.01.10.151.10.141.10.131.10.121.10.111.10.101.10.91.10.81.10.71.10.61.10.51.10.41.10.31.10.21.10.1

airflow.contrib.sensors.weekday_sensor

Module Contents

class airflow.contrib.sensors.weekday_sensor.DayOfWeekSensor(week_day, use_task_execution_day=False, *args, **kwargs)[source]

Bases: airflow.sensors.base_sensor_operator.BaseSensorOperator

Waits until the first specified day of the week. For example, if the execution day of the task is ‘2018-12-22’ (Saturday) and you pass ‘FRIDAY’, the task will wait until next Friday.

Example (with single day):

weekend_check = DayOfWeekSensor(
    task_id='weekend_check',
    week_day='Saturday',
    use_task_execution_day=True,
    dag=dag)
Copy to clipboard

Example (with multiple day using set):

weekend_check = DayOfWeekSensor(
    task_id='weekend_check',
    week_day={'Saturday', 'Sunday'},
    use_task_execution_day=True,
    dag=dag)
Copy to clipboard

Example (with WeekDay enum):

# import WeekDay Enum
from airflow.contrib.utils.weekday import WeekDay

weekend_check = DayOfWeekSensor(
    task_id='weekend_check',
    week_day={WeekDay.SATURDAY, WeekDay.SUNDAY},
    use_task_execution_day=True,
    dag=dag)
Copy to clipboard
Parameters

  • week_day (set or str or airflow.contrib.utils.weekday.WeekDay) –

    Day of the week to check (full name). Optionally, a set of days can also be provided using a set. Example values:

    • "MONDAY",

    • {"Saturday", "Sunday"}

    • {WeekDay.TUESDAY}

    • {WeekDay.SATURDAY, WeekDay.SUNDAY}

  • use_task_execution_day (bool) – If True, uses task’s execution day to compare with week_day. Execution Date is Useful for backfilling. If False, uses system’s day of the week. Useful when you don’t want to run anything on weekdays on the system.

poke(self, context)[source]

Was this entry helpful?