DayOfWeekSensor

Apache Airflow Certified

Waits until the first specified day of the week.

View on GitHub

Last Updated: Nov. 17, 2022

Access Instructions

Install the Apache Airflow provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

Documentation

Parameters

week_dayRequiredDay 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} To use WeekDay enum, import it from airflow.utils.weekday

use_task_logical_dateIf True, uses task’s logical date 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.

use_task_execution_daydeprecated parameter, same effect as use_task_logical_date

Documentation

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_logical_date=True,
    dag=dag)

Example (with multiple day using set):

weekend_check = DayOfWeekSensor(
    task_id='weekend_check',
    week_day={'Saturday', 'Sunday'},
    use_task_logical_date=True,
    dag=dag)

Example (with WeekDay enum):

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

weekend_check = DayOfWeekSensor(
    task_id='weekend_check',
    week_day={WeekDay.SATURDAY, WeekDay.SUNDAY},
    use_task_logical_date=True,
    dag=dag)