Skip to content

Docs: clarify public Task Instance API #60494

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
Arunodoy18 wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −0
Open

Docs: clarify public Task Instance API #60494

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
7 changes: 7 additions & 0 deletions airflow-core/docs/public-airflow-interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,13 @@ Task Instances

Task instances are the individual runs of a single task in a Dag (in a Dag Run). Task instances are accessed through
the Task Context via :func:`~airflow.sdk.get_current_context`. Direct database access is not possible.
The supported public interface for task instance data is provided by the Task SDK.
Specifically, the Task Context implements
:class:`airflow.sdk.types.RuntimeTaskInstanceProtocol`, which defines the stable,
supported API for accessing runtime task instance metadata and helpers.

Direct use of :class:`airflow.models.taskinstance.TaskInstance` is not part of the
public API and is not guaranteed to remain stable.

.. note::
Task Context is part of the airflow.sdk namespace.
Expand Down