Source code for airflow.sensors.time_delta

#
# 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__ import annotations

from typing import TYPE_CHECKING, Any, NoReturn

from airflow.exceptions import AirflowSkipException
from airflow.sensors.base import BaseSensorOperator
from airflow.triggers.temporal import DateTimeTrigger
from airflow.utils import timezone

if TYPE_CHECKING:
    from airflow.utils.context import Context


[docs]class TimeDeltaSensor(BaseSensorOperator): """ Waits for a timedelta after the run's data interval. :param delta: time length to wait after the data interval before succeeding. .. seealso:: For more information on how to use this sensor, take a look at the guide: :ref:`howto/operator:TimeDeltaSensor` """ def __init__(self, *, delta, **kwargs): super().__init__(**kwargs) self.delta = delta
[docs] def poke(self, context: Context): target_dttm = context["data_interval_end"] target_dttm += self.delta self.log.info("Checking if the time (%s) has come", target_dttm) return timezone.utcnow() > target_dttm
[docs]class TimeDeltaSensorAsync(TimeDeltaSensor): """ A deferrable drop-in replacement for TimeDeltaSensor. Will defers itself to avoid taking up a worker slot while it is waiting. :param delta: time length to wait after the data interval before succeeding. :param end_from_trigger: End the task directly from the triggerer without going into the worker. .. seealso:: For more information on how to use this sensor, take a look at the guide: :ref:`howto/operator:TimeDeltaSensorAsync` """ def __init__(self, *, end_from_trigger: bool = False, delta, **kwargs) -> None: super().__init__(delta=delta, **kwargs) self.end_from_trigger = end_from_trigger
[docs] def execute(self, context: Context) -> bool | NoReturn: target_dttm = context["data_interval_end"] target_dttm += self.delta if timezone.utcnow() > target_dttm: # If the target datetime is in the past, return immediately return True try: trigger = DateTimeTrigger(moment=target_dttm, end_from_trigger=self.end_from_trigger) except (TypeError, ValueError) as e: if self.soft_fail: raise AirflowSkipException("Skipping due to soft_fail is set to True.") from e raise self.defer(trigger=trigger, method_name="execute_complete")
[docs] def execute_complete(self, context: Context, event: Any = None) -> None: """Handle the event when the trigger fires and return immediately.""" return None

Was this entry helpful?