-
Notifications
You must be signed in to change notification settings - Fork 17.5k
Support pandas 3 for DataFrame XComs #70558
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.
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
potiuk
wants to merge
3
commits into
main
Choose a base branch
from
pandas-3-support
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| pandas 3 changes how DataFrame XComs are stored and read back | ||
|
|
||
| pandas 3 exposes its public classes from the ``pandas`` namespace, so a DataFrame is qualified as | ||
| ``pandas.DataFrame`` instead of ``pandas.core.frame.DataFrame``. XComs record that name alongside the | ||
| serialized value, so the name written into the metadata database depends on the pandas version of the | ||
| component that pushed the value. Airflow registers both names, and a DataFrame written by either | ||
| pandas version can be read by either — no configuration change is needed, and existing XComs stay | ||
| readable. | ||
|
|
||
| What you should do: | ||
|
|
||
| * **Roll this Airflow version out to every component before pandas 3 reaches any of them** — workers | ||
| in particular. A component that predates this change cannot read a DataFrame XCom written under | ||
| pandas 3, and fails the pull with: | ||
|
|
||
| .. code-block:: text | ||
|
|
||
| ImportError: pandas.DataFrame was not found in allow list for deserialization imports. | ||
| To allow it, add it to allowed_deserialization_classes in the configuration | ||
|
|
||
| The message points at configuration, but the allow list is not the cause and changing it does not | ||
| help. The rows are not corrupt: they become readable again as soon as the reader is upgraded. | ||
|
|
||
| * **Treat a downgrade as a one-way door for those XComs.** Rolling back to an Airflow version without | ||
| this change strands any DataFrame XCom written while on pandas 3, with the same error, until you | ||
| roll forward again. | ||
|
|
||
| * **Review Dags that inspect the dtypes of a pulled DataFrame.** The pandas version of the *reader* | ||
| determines what a pulled DataFrame looks like, not the version that wrote it. Under pandas 3, a | ||
| column of strings comes back with the ``str`` dtype rather than ``object``, and its missing values | ||
| come back as ``nan`` rather than ``None``. Values are unchanged, but downstream code that branches | ||
| on ``dtype == "object"``, checks cells with ``is None``, or compares against a reference frame with | ||
| ``DataFrame.equals()`` can behave differently after the upgrade. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The round-trip test and the error message tests only exercise whichever pandas major is installed.
Maybe we should add a test that manufactures an encoded payload with the older version too.(eg:
pandas.core.frame.DataFrameas CLASSNAME and assert deserialize() succeeds while running under pandas 3, and the reverse).