This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new f76060c45a Update admonitions in Python operator doc to reflect
sentiment (#36340)
f76060c45a is described below
commit f76060c45a67771442162c65cf5cc7f7882b6f28
Author: Josh Fell <[email protected]>
AuthorDate: Thu Dec 21 04:07:31 2023 -0500
Update admonitions in Python operator doc to reflect sentiment (#36340)
Within the Python operator how-to guide, there are doc admonitions that
don't necessarily reflect the sentiment of the call-out. For example, there are
several places where there is a recommendation to use the TaskFlow version of
an operator but the admonition is a warning; this is more of a tip when
authoring DAGs.
This PR hopes to match the sentiment of the call-out with an "appropriate"
admonition in the doc for better context and visbility when reading the doc.
---
docs/apache-airflow/howto/operator/python.rst | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/docs/apache-airflow/howto/operator/python.rst
b/docs/apache-airflow/howto/operator/python.rst
index d785b3cdb2..eab22073de 100644
--- a/docs/apache-airflow/howto/operator/python.rst
+++ b/docs/apache-airflow/howto/operator/python.rst
@@ -24,7 +24,7 @@ PythonOperator
Use the :class:`~airflow.operators.python.PythonOperator` to execute Python
callables.
-.. warning::
+.. tip::
The ``@task`` decorator is recommended over the classic ``PythonOperator``
to execute Python callables.
.. tab-set::
@@ -111,7 +111,7 @@ Use the
:class:`~airflow.operators.python.PythonVirtualenvOperator` decorator to
inside a new Python virtual environment. The ``virtualenv`` package needs to
be installed in the environment
that runs Airflow (as optional dependency ``pip install
apache-airflow[virtualenv] --constraint ...``).
-.. warning::
+.. tip::
The ``@task.virtualenv`` decorator is recommended over the classic
``PythonVirtualenvOperator``
to execute Python callables inside new Python virtual environments.
@@ -146,7 +146,7 @@ Otherwise you won't have access to the most context
variables of Airflow in ``op
If you want the context related to datetime objects like
``data_interval_start`` you can add ``pendulum`` and
``lazy_object_proxy``.
-.. warning::
+.. important::
The Python function body defined to be executed is cut out of the DAG into
a temporary file w/o surrounding code.
As in the examples you need to add all imports again and you can not rely
on variables from the global Python context.
@@ -219,7 +219,7 @@ pre-defined environment. The virtualenv package should be
preinstalled in the en
In case ``dill`` is used, it has to be preinstalled in the environment (the
same version that is installed
in main Airflow environment).
-.. warning::
+.. tip::
The ``@task.external_python`` decorator is recommended over the classic
``ExternalPythonOperator``
to execute Python code in pre-defined Python environments.
@@ -255,7 +255,7 @@ Otherwise you won't have access to the most context
variables of Airflow in ``op
If you want the context related to datetime objects like
``data_interval_start`` you can add ``pendulum`` and
``lazy_object_proxy`` to your virtual environment.
-.. warning::
+.. important::
The Python function body defined to be executed is cut out of the DAG into
a temporary file w/o surrounding code.
As in the examples you need to add all imports again and you can not rely
on variables from the global Python context.
@@ -270,7 +270,7 @@ PythonBranchOperator
Use the :class:`~airflow.operators.python.PythonBranchOperator` to execute
Python :ref:`branching <concepts:branching>`
tasks.
-.. warning::
+.. tip::
The ``@task.branch`` decorator is recommended over the classic
``PythonBranchOperator``
to execute Python code.
@@ -304,7 +304,7 @@ BranchPythonVirtualenvOperator
Use the :class:`~airflow.operators.python.BranchPythonVirtualenvOperator`
decorator to execute Python :ref:`branching <concepts:branching>`
tasks and is a hybrid of the
:class:`~airflow.operators.python.PythonBranchOperator` with execution in a
virtual environment.
-.. warning::
+.. tip::
The ``@task.branch_virtualenv`` decorator is recommended over the classic
``BranchPythonVirtualenvOperator`` to execute Python code.
@@ -339,7 +339,7 @@ Use the
:class:`~airflow.operators.python.BranchExternalPythonOperator` to execu
tasks and is a hybrid of the
:class:`~airflow.operators.python.PythonBranchOperator` with execution in an
external Python environment.
-.. warning::
+.. tip::
The ``@task.branch_external_python`` decorator is recommended over the
classic
``BranchExternalPythonOperator`` to execute Python code.
@@ -380,7 +380,7 @@ based on the configured short-circuiting (more on this
later). In the example be
"condition_is_true" task will execute while the tasks downstream of the
"condition_is_false" task will be
skipped.
-.. warning::
+.. tip::
The ``@task.short_circuit`` decorator is recommended over the classic
``ShortCircuitOperator``
to short-circuit pipelines via Python callables.
@@ -458,7 +458,7 @@ PythonSensor
The :class:`~airflow.sensors.python.PythonSensor` executes an arbitrary
callable and waits for its return
value to be True.
-.. warning::
+.. tip::
The ``@task.sensor`` decorator is recommended over the classic
``PythonSensor``
to execute Python callables to check for True condition.
