uranusjr commented on a change in pull request #20530: URL: https://github.com/apache/airflow/pull/20530#discussion_r780864287
########## File path: tests/decorators/test_sensor.py ########## @@ -0,0 +1,131 @@ +# +# 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. + +import pytest + +from airflow.decorators import task +from airflow.exceptions import AirflowException, AirflowSensorTimeout +from airflow.utils.state import State + + +class TestSensorDecorator: + def test_sensor_fails_on_none_python_callable(self, dag_maker): + not_callable = {} + with pytest.raises(AirflowException): + task.sensor(not_callable) + + def test_basic_sensor_success(self, dag_maker): + @task.sensor() Review comment: ```suggestion @task.sensor ``` Assuming the parathenses-less form works (I think it should since `task_decorator_factory` provides that?) this should be used for consistency. (Although I personally dislike it.) ########## File path: docs/apache-airflow/tutorial_taskflow_api.rst ########## @@ -208,6 +208,51 @@ Python version to run your function. These two options should allow for far greater flexibility for users who wish to keep their workflows more simple and Pythonic. +Using the TaskFlow API for Sensor operators +------------------------------------------- +You can apply the @task.sensor decorator to convert a regular Python function to an instance of the BaseSensorOperator +class. The Python function implements the poke logic and returns a Boolean value just as the poke() method in the +BaseSensorOperator does. Review comment: ```suggestion You can apply the ``@task.sensor`` decorator to convert a regular Python function to an instance of the BaseSensorOperator class. The Python function implements the poke logic and returns a Boolean value just as the ``poke()`` method in the BaseSensorOperator does. ``` -- 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]
