## 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## http://www.apache.org/licenses/LICENSE-2.0## Unless required by applicable law or agreed to in writing,# software distributed under the License is distributed on an# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY# KIND, either express or implied. See the License for the# specific language governing permissions and limitations# under the License.from__future__importannotationsimportwarningsfromtypingimportIterablefromairflow.exceptionsimportRemovedInAirflow3Warningfromairflow.sensors.baseimportBaseSensorOperatorfromairflow.utilsimporttimezonefromairflow.utils.contextimportContextfromairflow.utils.weekdayimportWeekDay
[docs]classDayOfWeekSensor(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_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 :class:`~airflow.utils.weekday.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) :param week_day: 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}`` To use ``WeekDay`` enum, import it from ``airflow.utils.weekday`` :param use_task_logical_date: If ``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. :param use_task_execution_day: deprecated parameter, same effect as `use_task_logical_date` .. seealso:: For more information on how to use this sensor, take a look at the guide: :ref:`howto/operator:DayOfWeekSensor` """def__init__(self,*,week_day:str|Iterable[str]|WeekDay|Iterable[WeekDay],use_task_logical_date:bool=False,use_task_execution_day:bool=False,**kwargs,)->None:super().__init__(**kwargs)self.week_day=week_dayself.use_task_logical_date=use_task_logical_dateifuse_task_execution_day:self.use_task_logical_date=use_task_execution_daywarnings.warn("Parameter ``use_task_execution_day`` is deprecated. Use ``use_task_logical_date``.",RemovedInAirflow3Warning,stacklevel=2,)self._week_day_num=WeekDay.validate_week_day(week_day)
[docs]defpoke(self,context:Context)->bool:self.log.info("Poking until weekday is in %s, Today is %s",self.week_day,WeekDay(timezone.utcnow().isoweekday()).name,)ifself.use_task_logical_date:returncontext["logical_date"].isoweekday()inself._week_day_numelse:returntimezone.utcnow().isoweekday()inself._week_day_num