airflow.sensors.weekday

模組內容

類別

DayOfWeekSensor

等待直到一週中的第一個指定日。
class airflow.sensors.weekday.DayOfWeekSensor(*, week_day, use_task_logical_date=False, use_task_execution_day=False, **kwargs)[原始碼]

基底類別: 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.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 | Iterable[str] | airflow.utils.weekday.WeekDay | Iterable[airflow.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，使用系統的星期幾。當您不想在系統的平日執行任何操作時很有用。

  • use_task_execution_day (bool) – 已棄用的參數，與 use_task_logical_date 效果相同

參見

有關如何使用此感測器的更多資訊，請參閱指南： DayOfWeekSensor

poke(context)[原始碼]

衍生此類別時覆寫。

此條目是否有幫助？