Source code for airflow.example_dags.plugins.workday

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
"""Plugin to demonstrate timetable registration and accommodate example DAGs."""

from __future__ import annotations

import logging
from datetime import timedelta
from typing import TYPE_CHECKING

# [START howto_timetable]
from pendulum import UTC, Date, DateTime, Time

from airflow.plugins_manager import AirflowPlugin
from airflow.timetables.base import DagRunInfo, DataInterval, Timetable

    from airflow.timetables.base import TimeRestriction

[docs]log = logging.getLogger(__name__)
try: from import USFederalHolidayCalendar
[docs] holiday_calendar = USFederalHolidayCalendar()
except ImportError: log.warning("Could not import pandas. Holidays will not be considered.") holiday_calendar = None # type: ignore[assignment]
[docs]class AfterWorkdayTimetable(Timetable):
[docs] def get_next_workday(self, d: DateTime, incr=1) -> DateTime: next_start = d while True: if next_start.weekday() not in (5, 6): # not on weekend if holiday_calendar is None: holidays = set() else: holidays = holiday_calendar.holidays(start=next_start, end=next_start).to_pydatetime() if next_start not in holidays: break next_start = next_start.add(days=incr) return next_start
# [START howto_timetable_infer_manual_data_interval]
[docs] def infer_manual_data_interval(self, run_after: DateTime) -> DataInterval: start = DateTime.combine((run_after - timedelta(days=1)).date(), Time.min).replace(tzinfo=UTC) # Skip backwards over weekends and holidays to find last run start = self.get_next_workday(start, incr=-1) return DataInterval(start=start, end=(start + timedelta(days=1)))
# [END howto_timetable_infer_manual_data_interval] # [START howto_timetable_next_dagrun_info]
[docs] def next_dagrun_info( self, *, last_automated_data_interval: DataInterval | None, restriction: TimeRestriction, ) -> DagRunInfo | None: if last_automated_data_interval is not None: # There was a previous run on the regular schedule. last_start = last_automated_data_interval.start next_start = DateTime.combine((last_start + timedelta(days=1)).date(), Time.min) # Otherwise this is the first ever run on the regular schedule... elif (earliest := restriction.earliest) is None: return None # No start_date. Don't schedule. elif not restriction.catchup: # If the DAG has catchup=False, today is the earliest to consider. next_start = max(earliest, DateTime.combine(, Time.min)) elif earliest.time() != Time.min: # If earliest does not fall on midnight, skip to the next day. next_start = DateTime.combine( + timedelta(days=1), Time.min) else: next_start = earliest # Skip weekends and holidays next_start = self.get_next_workday(next_start.replace(tzinfo=UTC)) if restriction.latest is not None and next_start > restriction.latest: return None # Over the DAG's scheduled end; don't schedule. return DagRunInfo.interval(start=next_start, end=(next_start + timedelta(days=1)))
# [END howto_timetable_next_dagrun_info]
[docs]class WorkdayTimetablePlugin(AirflowPlugin):
[docs] name = "workday_timetable_plugin"
[docs] timetables = [AfterWorkdayTimetable]
# [END howto_timetable]

Was this entry helpful?