airflow.providers.standard.sensors.weekday¶

类¶

DayOfWeekSensor

等待直到到达指定的第一个星期几。

模块内容¶

class airflow.providers.standard.sensors.weekday.DayOfWeekSensor(*, week_day, use_task_logical_date=False, **kwargs)[source]¶

基类: airflow.sensors.base.BaseSensorOperator

等待直到到达指定的第一个星期几。

例如，如果任务的执行日期是 '2018-12-22' (星期六)，并且您传入 'FRIDAY'，任务将等待直到下一个星期五。

示例 (单天)

weekend_check = DayOfWeekSensor(
    task_id="weekend_check", week_day="Saturday", use_task_logical_date=True, dag=dag
)

示例 (使用集合包含多天)

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

示例 (使用 WeekDay 枚举)

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

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

参数:

week_day (str | collections.abc.Iterable[str] | airflow.providers.standard.utils.weekday.WeekDay | collections.abc.Iterable[airflow.providers.standard.utils.weekday.WeekDay]) –
要检查的星期几（全称）。或者，也可以使用集合提供一组天。示例值：
- "MONDAY",
- {"Saturday", "Sunday"}
- {WeekDay.TUESDAY}
- {WeekDay.SATURDAY, WeekDay.SUNDAY}
要使用 WeekDay 枚举，请从 airflow.utils.weekday 导入它
use_task_logical_date (bool) – 如果 True，则使用任务的逻辑日期与 `week_day` 进行比较。执行日期对于回填非常有用。如果 False，则使用系统的星期几。当您不希望在系统的星期几上运行任何内容时很有用。

另请参阅

有关如何使用此传感器的更多信息，请查看指南： DayOfWeekSensor

week_day[source]¶

use_task_logical_date = False[source]¶

poke(context)[source]¶

在派生此类时覆盖此方法。