phanikumv commented on code in PR #32515:
URL: https://github.com/apache/airflow/pull/32515#discussion_r1259593743
##########
airflow/sensors/base.py:
##########
@@ -87,9 +87,18 @@ class BaseSensorOperator(BaseOperator, SkipMixin):
a criteria is met and fail if and when they time out.
:param soft_fail: Set to true to mark the task as SKIPPED on failure
- :param poke_interval: Time in seconds that the job should wait in
- between each try
- :param timeout: Time, in seconds before the task times out and fails.
+ :param poke_interval: Time that the job should wait in between each try.
+ Can be ``timedelta`` or ``float`` seconds.
+ :param timeout: Time before the task times out and fails.
+ Can be ``timedelta`` or ``float`` seconds.
+ This should not be confused with ``execution_timeout`` of the
+ ``BaseOperator`` class. ``timeout`` measure the time between the
+ first poke and the current time (taking into account any
+ reschedule delay between each poke), while ``execution_timeout``
+ check the **running** time of the task (leaving out any reschedule
Review Comment:
```suggestion
checks the **running** time of the task (leaving out any reschedule
```
##########
airflow/sensors/base.py:
##########
@@ -87,9 +87,18 @@ class BaseSensorOperator(BaseOperator, SkipMixin):
a criteria is met and fail if and when they time out.
:param soft_fail: Set to true to mark the task as SKIPPED on failure
- :param poke_interval: Time in seconds that the job should wait in
- between each try
- :param timeout: Time, in seconds before the task times out and fails.
+ :param poke_interval: Time that the job should wait in between each try.
+ Can be ``timedelta`` or ``float`` seconds.
+ :param timeout: Time before the task times out and fails.
+ Can be ``timedelta`` or ``float`` seconds.
+ This should not be confused with ``execution_timeout`` of the
+ ``BaseOperator`` class. ``timeout`` measure the time between the
Review Comment:
```suggestion
``BaseOperator`` class. ``timeout`` measures the time elapsed
between the
```
##########
airflow/sensors/base.py:
##########
@@ -87,9 +87,18 @@ class BaseSensorOperator(BaseOperator, SkipMixin):
a criteria is met and fail if and when they time out.
:param soft_fail: Set to true to mark the task as SKIPPED on failure
- :param poke_interval: Time in seconds that the job should wait in
- between each try
- :param timeout: Time, in seconds before the task times out and fails.
+ :param poke_interval: Time that the job should wait in between each try.
+ Can be ``timedelta`` or ``float`` seconds.
+ :param timeout: Time before the task times out and fails.
Review Comment:
```suggestion
:param timeout: Time elapsed before the task times out and fails.
```
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
