Skip to content

documentation - taskflow is not better than OOP #71315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
raphaelauv wants to merge 1 commit into
base: main
Choose a base branch
from
Open

documentation - taskflow is not better than OOP #71315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion airflow-core/docs/core-concepts/operators.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Airflow has a very extensive set of operators available, with some built-in to t
- Use the ``@task`` decorator to execute an arbitrary Python function. It doesn't support rendering jinja templates passed as arguments.

.. note::
The ``@task`` decorator is recommended over the classic :class:`~airflow.providers.standard.operators.python.PythonOperator`
The ``@task`` decorator is the Taskflow equivalent of :class:`~airflow.providers.standard.operators.python.PythonOperator`
to execute Python callables with no template rendering in its arguments.

For a list of all core operators, see: :doc:`Core Operators and Hooks Reference </operators-and-hooks-ref>`.
Expand Down
2 changes: 1 addition & 1 deletion providers/standard/docs/operators/bash.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ determined by:

.. tip::

The ``@task.bash`` decorator is recommended over the classic ``BashOperator`` to execute Bash commands.
The ``@task.bash`` decorator is the Taskflow equivalent of ``BashOperator`` to execute Bash commands.


.. tab-set::
Expand Down
14 changes: 7 additions & 7 deletions providers/standard/docs/operators/python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ PythonOperator
Use the :class:`~airflow.providers.standard.operators.python.PythonOperator` to execute Python callables.

.. tip::
The ``@task`` decorator is recommended over the classic ``PythonOperator`` to execute Python callables.
The ``@task`` decorator is the Taskflow equivalent of ``PythonOperator`` to execute Python callables.

.. tab-set::

Expand Down Expand Up @@ -160,7 +160,7 @@ Cloudpickle offers a strong advantage for its focus on standard pickling protoco
smoother data exchange, while still effectively handling common Python objects and global variables within functions.

.. tip::
The ``@task.virtualenv`` decorator is recommended over the classic ``PythonVirtualenvOperator``
The ``@task.virtualenv`` decorator is the Taskflow equivalent of ``PythonVirtualenvOperator``
to execute Python callables inside new Python virtual environments.

.. tab-set::
Expand Down Expand Up @@ -284,7 +284,7 @@ In case ``dill`` is used, it has to be preinstalled in the environment (the same
in main Airflow environment).

.. tip::
The ``@task.external_python`` decorator is recommended over the classic ``ExternalPythonOperator``
The ``@task.external_python`` decorator is the Taskflow equivalent of ``ExternalPythonOperator``
to execute Python code in pre-defined Python environments.

.. tab-set::
Expand Down Expand Up @@ -341,7 +341,7 @@ Use the :class:`~airflow.providers.standard.operators.python.BranchPythonOperato
tasks.

.. tip::
The ``@task.branch`` decorator is recommended over the classic ``BranchPythonOperator``
The ``@task.branch`` decorator is the Taskflow equivalent of ``BranchPythonOperator``
to execute Python code.

.. tab-set::
Expand Down Expand Up @@ -378,7 +378,7 @@ Use the :class:`~airflow.providers.standard.operators.python.BranchPythonVirtual
tasks and is a hybrid of the :class:`~airflow.providers.standard.operators.python.BranchPythonOperator` with execution in a virtual environment.

.. tip::
The ``@task.branch_virtualenv`` decorator is recommended over the classic
The ``@task.branch_virtualenv`` decorator is the Taskflow equivalent of
``BranchPythonVirtualenvOperator`` to execute Python code.

.. tab-set::
Expand Down Expand Up @@ -416,7 +416,7 @@ tasks and is a hybrid of the :class:`~airflow.providers.standard.operators.pytho
external Python environment.

.. tip::
The ``@task.branch_external_python`` decorator is recommended over the classic
The ``@task.branch_external_python`` decorator is the Taskflow equivalent of
``BranchExternalPythonOperator`` to execute Python code.

.. tab-set::
Expand Down Expand Up @@ -461,7 +461,7 @@ based on the configured short-circuiting (more on this later). In the example be
skipped.

.. tip::
The ``@task.short_circuit`` decorator is recommended over the classic ``ShortCircuitOperator``
The ``@task.short_circuit`` decorator is the Taskflow equivalent of ``ShortCircuitOperator``
to short-circuit pipelines via Python callables.

.. tab-set::
Expand Down
2 changes: 1 addition & 1 deletion providers/standard/docs/sensors/python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The :class:`~airflow.providers.standard.sensors.python.PythonSensor` executes an
value to be True.

.. tip::
The ``@task.sensor`` decorator is recommended over the classic ``PythonSensor``
The ``@task.sensor`` decorator is the Taskflow equivalent of ``PythonSensor``
to execute Python callables to check for True condition.

.. tab-set::
Expand Down