Skip to content

Remove airflow.utils.xcom module and add backcompat shim #53187

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 3 commits into from
Jul 14, 2025
Merged

Remove airflow.utils.xcom module and add backcompat shim #53187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e6ad767
Remove airflow.utils.xcom module and add backcompat shim
amoghrajesh Jul 11, 2025
2961b49
Merge branch 'main' into nuke-xcom-utils
amoghrajesh Jul 14, 2025
2323cb9
ffixing mypy issueS
amoghrajesh Jul 14, 2025
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
3 changes: 3 additions & 0 deletions airflow-core/src/airflow/utils/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,8 @@ def __getattr__(name: str):
"BaseSetupTeardownContext": "airflow.sdk.definitions._internal.setup_teardown.BaseSetupTeardownContext",
"SetupTeardownContext": "airflow.sdk.definitions._internal.setup_teardown.SetupTeardownContext",
},
"xcom": {
"XCOM_RETURN_KEY": "airflow.models.xcom.XCOM_RETURN_KEY",
},
}
add_deprecated_classes(__deprecated_classes, __name__)
24 changes: 0 additions & 24 deletions airflow-core/src/airflow/utils/xcom.py
View file
Open in desktop

This file was deleted.

6 changes: 6 additions & 0 deletions devel-common/src/tests_common/test_utils/compat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@
from airflow.sensors.date_time import DateTimeSensor # type: ignore[no-redef]
from airflow.utils.python_virtualenv import write_python_script # type: ignore[no-redef]

try:
from airflow.models.xcom import XCOM_RETURN_KEY
except ImportError:
# Compatibility for Airflow < 3.1
from airflow.utils.xcom import XCOM_RETURN_KEY # type: ignore[no-redef,attr-defined]


if TYPE_CHECKING:
from airflow.models import Connection
Expand Down
3 changes: 2 additions & 1 deletion devel-common/src/tests_common/test_utils/mock_context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ def mock_context(task) -> Context:
from airflow.models import TaskInstance
from airflow.utils.session import NEW_SESSION
from airflow.utils.state import TaskInstanceState
from airflow.utils.xcom import XCOM_RETURN_KEY

from tests_common.test_utils.compat import XCOM_RETURN_KEY

values: dict[str, Any] = {}

Expand Down
2 changes: 1 addition & 1 deletion devel-common/src/tests_common/test_utils/version_compat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def get_base_airflow_version_tuple() -> tuple[int, int, int]:

XCOM_RETURN_KEY = BaseXCom.XCOM_RETURN_KEY
else:
from airflow.utils.xcom import XCOM_RETURN_KEY
from airflow.utils.xcom import XCOM_RETURN_KEY # type: ignore[no-redef]


def get_sqlalchemy_version_tuple() -> tuple[int, int, int]:
Expand Down
2 changes: 1 addition & 1 deletion providers/cncf/kubernetes/src/airflow/providers/cncf/kubernetes/version_compat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def get_base_airflow_version_tuple() -> tuple[int, int, int]:
else:
from airflow.hooks.base import BaseHook # type: ignore[attr-defined,no-redef]
from airflow.models import BaseOperator
from airflow.utils.xcom import XCOM_RETURN_KEY
from airflow.utils.xcom import XCOM_RETURN_KEY # type: ignore[no-redef]

if AIRFLOW_V_3_0_PLUS:
from airflow.sdk import BaseSensorOperator
Expand Down
2 changes: 1 addition & 1 deletion providers/microsoft/azure/src/airflow/providers/microsoft/azure/version_compat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ def get_base_airflow_version_tuple() -> tuple[int, int, int]:
from airflow.sdk import BaseHook
else:
from airflow.hooks.base import BaseHook # type: ignore[attr-defined,no-redef]
from airflow.utils.xcom import XCOM_RETURN_KEY
from airflow.utils.xcom import XCOM_RETURN_KEY # type: ignore[no-redef]

__all__ = [
"AIRFLOW_V_3_0_PLUS",
Expand Down