Skip to content

Export StoreScope from airflow.sdk as public interface #73600

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

Merged
amoghrajesh merged 2 commits into from
Sep 24, 2026
Merged

Export StoreScope from airflow.sdk as public interface #73600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5d2931
Export StoreScope from airflow.sdk as public interface
amoghrajesh Sep 23, 2026
f5293b5
fixing compat tests
amoghrajesh Sep 24, 2026
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/administration-and-deployment/task-and-asset-state-store.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Custom backends

A custom backend must subclass :class:`~airflow.sdk.state.BaseStoreBackend` and implement its abstract methods: ``get``, ``set``, ``delete``, and ``clear`` for synchronous callers and the ``aget``, ``aset``, ``adelete``, and ``aclear`` async equivalents. Refer to :class:`~airflow.sdk.state.BaseStoreBackend` for the full API.

Each method receives a ``scope`` argument that is either a :class:`~airflow.sdk.state.TaskScope` or an :class:`~airflow.sdk.state.AssetScope`. Use ``isinstance`` to dispatch:
Each method receives a ``scope`` argument that is either a :class:`~airflow.sdk.state.TaskScope` or an :class:`~airflow.sdk.state.AssetScope`. The union of the two is exported as ``airflow.sdk.state.StoreScope`` for type annotations. Use ``isinstance`` to dispatch:

.. code-block:: python

Expand Down
4 changes: 3 additions & 1 deletion providers/common/io/src/airflow/providers/common/io/state_store/backend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy.orm import Session

from airflow.sdk.state import StoreScope


from airflow.sdk import ObjectStoragePath
from airflow.sdk._shared.state import AssetScope, BaseStoreBackend, StoreScope, TaskScope
from airflow.sdk.state import AssetScope, BaseStoreBackend, TaskScope

SECTION = "common.io"

Expand Down
1 change: 1 addition & 0 deletions task-sdk/src/airflow/sdk/state.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,6 @@
from airflow.sdk._shared.state import (
AssetScope as AssetScope,
BaseStoreBackend as BaseStoreBackend,
StoreScope as StoreScope,
TaskScope as TaskScope,
)
Loading