-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Expose ExcelWriter as part of the Generated API #22359
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
Changes from 6 commits
e040ab0
76edcde
a416f92
172257a
e218103
b2f1880
04b59a5
546ce0a
ec2fe16
b74364e
40fd6fe
1d0e833
e69316f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1924,11 +1924,25 @@ def _repr_latex_(self): | |
If you wish to write to more than one sheet in the workbook, it is | ||
necessary to specify an ExcelWriter object: | ||
|
||
>>> writer = pd.ExcelWriter('output2.xlsx', engine='xlsxwriter') | ||
>>> df1.to_excel(writer, sheet_name='Sheet1') | ||
>>> df2 = df1.copy() | ||
>>> df2.to_excel(writer, sheet_name='Sheet2') | ||
>>> writer.save() | ||
>>> with ExcelWriter('output.xlsx') as writer: | ||
... df1.to_excel(writer, sheet_name='Sheet_name_1') | ||
... df2.to_excel(writer, sheet_name='Sheet_name_2') | ||
|
||
If you want to set engine that can manipulate Excel, | ||
pass keyword argument named engine. Actually | ||
engine is automatically chosen by file extension: | ||
|
||
>>> df1.to_excel('output1.xlsx', engine='xlsxwriter') | ||
>>> with ExcelWriter('output2.xlsx', engine='openpyxl') as writer: | ||
... df2.to_excel(writer) | ||
|
||
You can set date format or datetime format: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Delete this example (keywords here are only applicable to |
||
|
||
>>> with ExcelWriter('path_to_file.xlsx', | ||
date_format='YYYY-MM-DD', | ||
datetime_format='YYYY-MM-DD HH:MM:SS') as writer: | ||
... df.to_excel(writer) | ||
|
||
""" | ||
|
||
def to_json(self, path_or_buf=None, orient=None, date_format=None, | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -824,8 +824,45 @@ class ExcelWriter(object): | |
|
||
Notes | ||
----- | ||
None of the methods and properties are considered public. | ||
|
||
For compatibility with CSV writers, ExcelWriter serializes lists | ||
and dicts to strings before writing. | ||
|
||
Examples | ||
-------- | ||
Default usage: | ||
|
||
>>> with ExcelWriter('path_to_file.xlsx') as writer: | ||
... df.to_excel(writer) | ||
|
||
To write to separate sheets in a single file: | ||
|
||
>>> with ExcelWriter('path_to_file.xlsx') as writer: | ||
... df1.to_excel(writer, sheet_name='Sheet1') | ||
... df2.to_excel(writer, sheet_name='Sheet2') | ||
|
||
You can set date format or datetime format: | ||
|
||
>>> with ExcelWriter('path_to_file.xlsx', | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I am actually surprised that we allow date / date time formatting with ExcelWriter but don't have the same usage in |
||
date_format='YYYY-MM-DD', | ||
datetime_format='YYYY-MM-DD HH:MM:SS') as writer: | ||
... df.to_excel(writer) | ||
|
||
You can also append to an existing Excel file: | ||
|
||
>>> with ExcelWriter('path_to_file.xlsx', mode='a') as writer: | ||
... df.to_excel(writer) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would add here a sheet name? (I think you typically want to add a new sheet to an existing file?) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It seems more natural to do that:) |
||
|
||
.. versionadded:: 0.24.0 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this one can be removed |
||
|
||
Attributes | ||
---------- | ||
None | ||
|
||
Methods | ||
------- | ||
None | ||
""" | ||
# Defining an ExcelWriter implementation (see abstract methods for more...) | ||
|
||
|
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.
Don't use
ExcelWriter
here - just useto_excel
. Also move this example up above the one preceding it