Skip to content

DOC update DataFrame.to_csv write modes (#51839) #51881

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
merged 8 commits into from
Mar 17, 2023
Merged

DOC update DataFrame.to_csv write modes (#51839) #51881

Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6b4d5f7
DOC update DataFrame.to_csv write modes (#51839)
HamidrezaSK Mar 10, 2023
2262c56
DOC: style fix (#51839)
HamidrezaSK Mar 10, 2023
94ac0b7
DOC update DataFrame.to_csv write modes (#51839)
HamidrezaSK Mar 10, 2023
2cf3308
Merge branch 'main' into DataFrame_to_csv_Doc_Fix
HamidrezaSK Mar 12, 2023
0e26363
DOC: update DataFrame.to_csv write modes (#51839)
HamidrezaSK Mar 13, 2023
bff7ccd
Merge branch 'DataFrame_to_csv_Doc_Fix' of https://github.com/Hamidre…
HamidrezaSK Mar 13, 2023
c609257
DOC: update DataFrame.to_csv write modes (#51839)
HamidrezaSK Mar 15, 2023
51a5bbf
DOC: update DataFrame.to_csv write modes (#51839)
HamidrezaSK Mar 17, 2023
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
14 changes: 11 additions & 3 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3635,9 +3635,17 @@ def to_csv(
sequence should be given if the object uses MultiIndex. If
False do not print fields for index names. Use index_label=False
for easier importing in R.
mode : str, default 'w'
Python write mode. The available write modes are the same as
:py:func:`open`.
mode : {{'w', 'x', 'a'}}, default 'w'
Forwarded to either `open(mode=)` or `fsspec.open(mode=)` to control
the file opening. Typical values include:

- 'w', open for writing, truncating the file first.
- 'x', open for exclusive creation, failing if the file already exists.
- 'a', open for writing, appending to the end of file if it exists.

Including 'b' or 't' in the mode parameter will inform Pandas whether
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We usually use pandas lowercase.

`path_or_buf` requires string or binary data. However, in most cases,
this should not be necessary.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good point, but I don't think it makes sense to have binary csv files. I think this was a comment in the issue, about using b, which in general makes sense, but I don't see how for to_csv it could make sense to save data in a binary file. Unless I'm missing something (correct me if I'm wong), better to simply delete this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your input.

I also think the same, but we had a discussion with @twoertwein earlier here #51881 (comment).

Could you please share your thoughts on this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If that part is more confusing than helpful, feel free to remove it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for clarifying. I agree with these comments in general, bit I don't think in this particular case it's possible to binary data. Csv relies on the delimiter, the quote character and the line break to understand the structure. Binary data could have any of those and break a csv. Unless I'm missing something, it's not that in most cases "b" shouldn't be used, it can never be used. To me it makes more sense to remove that comment, since I think it's giving the impression that users can actually use binary csv's in some cases, and some may start researching about it. So, probably a bit confusing and distracting.

Feel free to disagree, but that's how I feel about that comment.

encoding : str, optional
A string representing the encoding to use in the output file,
defaults to 'utf-8'. `encoding` is not supported if `path_or_buf`
Expand Down