ENH: Include df.attrs metadata in to_csv output
#53816
Closed
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
canthonyscott
changed the title
df.attrs metadata in to_csv output
phofl
reviewed
Jul 2, 2023
| @@ -3636,6 +3636,7 @@ def to_csv( | |||
| decimal: str = ..., | |||
| errors: OpenFileErrors = ..., | |||
| storage_options: StorageOptions = ..., | |||
| comment: str | None = ..., | |||
There was a problem hiding this comment.
It was intended to mirror the read_csv parameter for consistency between the two. Setting it will write the comments with that prefix.
|
This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this. |
|
Thanks for the pull request, but it appears to have gone stale. If interested in continuing, please merge in the main branch, address any review comments and/or failing tests, and we can reopen. |
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.
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.This new functionality writes DataFrame metadata stored in df.attrs as header/comment lines at the top of a CSV file.
The
to_csv()method had acommentparam added to its call, matching theread_csv()method signatureIf this param is set all key/values will be written to the beginning of the CSV file in the following format
[comment][key]:[value]There was previous PR for this (#53740) that I closed. I accidentally butchered that previous branch, this is the new PR with a clean, fresh branch