Taragolis commented on code in PR #36767: URL: https://github.com/apache/airflow/pull/36767#discussion_r1451703827
########## docs/apache-airflow/public-airflow-interface.rst: ########## @@ -95,57 +95,14 @@ Properties of a :class:`~airflow.models.dagrun.DagRun` can also be referenced in _api/airflow/models/dagrun/index +.. _pythonapi:operators: Operators --------- -Operators allow for generation of certain types of tasks that become nodes in -the DAG when instantiated. - -There are 3 main types of operators: - -- Operators that performs an **action**, or tell another system to - perform an action -- **Transfer** operators move data from one system to another -- **Sensors** are a certain type of operator that will keep running until a - certain criterion is met. Examples include a specific file landing in HDFS or - S3, a partition appearing in Hive, or a specific time of the day. Sensors - are derived from :class:`~airflow.sensors.base.BaseSensorOperator` and run a poke - method at a specified :attr:`~airflow.sensors.base.BaseSensorOperator.poke_interval` until it - returns ``True``. - -All operators are derived from :class:`~airflow.models.baseoperator.BaseOperator` and acquire much -functionality through inheritance. Since this is the core of the engine, -it's worth taking the time to understand the parameters of :class:`~airflow.models.baseoperator.BaseOperator` -to understand the primitive features that can be leveraged in your DAGs. - -Airflow has a set of Operators that are considered public. You are also free to extend their functionality -by extending them: - -.. toctree:: - :includehidden: - :glob: - :maxdepth: 1 - - _api/airflow/operators/index - - _api/airflow/sensors/index - - -You can read more about the operators in :doc:`core-concepts/operators`, :doc:`core-concepts/sensors`. -Also you can learn how to write a custom operator in :doc:`howto/custom-operator`. - -.. _pythonapi:hooks: - -References for the modules used in for operators are here: - -.. toctree:: - :includehidden: - :glob: - :maxdepth: 1 - - _api/airflow/models/baseoperator/index +The base classes :class:`~airflow.models.baseoperator.BaseOperator` and :class:`~airflow.sensors.base.BaseSensorOperator` are public and may be extended to make new operators. +Subclasses of BaseOperator which are published in Apache Airflow are public in behavior but not in structure. That is to say, the Operator's parameters and behavior is governed by semver but the methods are subject to change at any time. So if you extend subclasses of BaseOperator y Review Comment: It feels like the last sentence was cut off in the middle. -- 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]
