DOC: mention .attrs are preserved in Parquet IO for pyarrow engine #61912
Conversation
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
arthurlw
suggested changes
Jul 21, 2025
| @@ -2958,7 +2958,8 @@ def to_parquet( | |||
| is expected and consistent with pandas' handling of categorical data. | |||
| To manage file size and ensure a more predictable roundtrip process, | |||
| consider using :meth:`Categorical.remove_unused_categories` on the | |||
| DataFrame before saving. | |||
| DataFrame before saving | |||
| * When using the "pyarrow" engine, `DataFrame.attrs` are stored as part of the file's metadata and restored on reading. | |||
There was a problem hiding this comment.
CI is failing because this line exceeds the maximum allowed length. Try splitting it into two lines to satisfy the linter.
|
Thanks for the PR, but I don't think we need to necessarily document this so closing. Happy to have your contributions on other issues labeled |
Given that this is a behaviour that is rather unique to the parquet format (most other IO methods in pandas don't preserve attrs, I think?), and also something that differs between both engines, this seems worth mentioning in the docs? |
jorisvandenbossche
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds documentation to
DataFrame.to_parquetandpandas.read_parquethighlighting thatDataFrame.attrsare preserved when using the "pyarrow" engine.This behavior is already implemented in
pandas/io/parquet/pyarrow.py, but was undocumented. This PR improves discoverability for users.Notessection in both docstringsFirst-time contributor 😊