turbaszek edited a comment on pull request #9697:
URL: https://github.com/apache/airflow/pull/9697#issuecomment-662919204
@zikun before we merge, I think it would be helpful to add some info from PR
description to docstring:
```
A major advantage of this sensor is idempotence for the ``target_time``.
It handles some cases for which ``TimeSensor`` and ``TimeDeltaSensor``
are not suited.
**Example**: 1 ::
If a task needs to wait for 11am on each ``execution_date``. Using
``TimeSensor`` or ``TimeDeltaSensor``, all backfill tasks started at
1am have to wait for 10 hours.
This is unnecessary, e.g. a backfill task with ``{{ ds }} =
'1970-01-01'`` does not need to wait
because ``1970-01-01T11:00:00`` has already passed.
**Example**: 2 ::
If a DAG is scheduled to run at 23:00 daily, but one of the tasks is
required
to run at 01:00 next day, using ``TimeSensor`` will return ``True``
immediately because 23:00 > 01:00.
Instead, we can use ``DateTimeSensor``:
.. code-block:: python
DateTimeSensor(
task_id='wait_for_0100',
target_time='{{
next_execution_date.tomorrow().replace(hour=1) }}',
dag=dag
)
```
Hope this is ok formatted rst but I'm not sure
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
