-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
ENH: Pandas Series provide to_excel method #14780
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 all commits
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 |
---|---|---|
|
@@ -105,7 +105,8 @@ | |
axes_single_arg="{0 or 'index', 1 or 'columns'}", | ||
optional_by=""" | ||
by : str or list of str | ||
Name or list of names which refer to the axis items.""") | ||
Name or list of names which refer to the axis items.""", | ||
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. @jorisvandenbossche any better way to do this? 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 is fine (given our current way of doing this with |
||
versionadded_to_excel='') | ||
|
||
_numeric_only_doc = """numeric_only : boolean, default None | ||
Include only float, int, boolean data. If None, will attempt to use | ||
|
@@ -1385,65 +1386,11 @@ def to_csv(self, path_or_buf=None, sep=",", na_rep='', float_format=None, | |
if path_or_buf is None: | ||
return formatter.path_or_buf.getvalue() | ||
|
||
@Appender(_shared_docs['to_excel'] % _shared_doc_kwargs) | ||
def to_excel(self, excel_writer, sheet_name='Sheet1', na_rep='', | ||
float_format=None, columns=None, header=True, index=True, | ||
index_label=None, startrow=0, startcol=0, engine=None, | ||
merge_cells=True, encoding=None, inf_rep='inf', verbose=True): | ||
""" | ||
Write DataFrame to a excel sheet | ||
|
||
Parameters | ||
---------- | ||
excel_writer : string or ExcelWriter object | ||
File path or existing ExcelWriter | ||
sheet_name : string, default 'Sheet1' | ||
Name of sheet which will contain DataFrame | ||
na_rep : string, default '' | ||
Missing data representation | ||
float_format : string, default None | ||
Format string for floating point numbers | ||
columns : sequence, optional | ||
Columns to write | ||
header : boolean or list of string, default True | ||
Write out column names. If a list of string is given it is | ||
assumed to be aliases for the column names | ||
index : boolean, default True | ||
Write row names (index) | ||
index_label : string or sequence, default None | ||
Column label for index column(s) if desired. If None is given, and | ||
`header` and `index` are True, then the index names are used. A | ||
sequence should be given if the DataFrame uses MultiIndex. | ||
startrow : | ||
upper left cell row to dump data frame | ||
startcol : | ||
upper left cell column to dump data frame | ||
engine : string, default None | ||
write engine to use - you can also set this via the options | ||
``io.excel.xlsx.writer``, ``io.excel.xls.writer``, and | ||
``io.excel.xlsm.writer``. | ||
merge_cells : boolean, default True | ||
Write MultiIndex and Hierarchical Rows as merged cells. | ||
encoding: string, default None | ||
encoding of the resulting excel file. Only necessary for xlwt, | ||
other writers support unicode natively. | ||
inf_rep : string, default 'inf' | ||
Representation for infinity (there is no native representation for | ||
infinity in Excel) | ||
|
||
Notes | ||
----- | ||
If passing an existing ExcelWriter object, then the sheet will be added | ||
to the existing workbook. This can be used to save different | ||
DataFrames to one workbook: | ||
|
||
>>> writer = ExcelWriter('output.xlsx') | ||
>>> df1.to_excel(writer,'Sheet1') | ||
>>> df2.to_excel(writer,'Sheet2') | ||
>>> writer.save() | ||
|
||
For compatibility with to_csv, to_excel serializes lists and dicts to | ||
strings before writing. | ||
""" | ||
from pandas.io.excel import ExcelWriter | ||
need_save = False | ||
if encoding is None: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -80,7 +80,8 @@ | |
inplace="""inplace : boolean, default False | ||
If True, performs operation inplace and returns None.""", | ||
unique='np.ndarray', duplicated='Series', | ||
optional_by='') | ||
optional_by='', | ||
versionadded_to_excel='\n.. versionadded:: 0.20.0\n') | ||
|
||
|
||
def _coerce_method(converter): | ||
|
@@ -2619,6 +2620,19 @@ def to_csv(self, path=None, index=True, sep=",", na_rep='', | |
if path is None: | ||
return result | ||
|
||
@Appender(generic._shared_docs['to_excel'] % _shared_doc_kwargs) | ||
def to_excel(self, excel_writer, sheet_name='Sheet1', na_rep='', | ||
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. add to the doc-string a versionadded tag (0.20.) |
||
float_format=None, columns=None, header=True, index=True, | ||
index_label=None, startrow=0, startcol=0, engine=None, | ||
merge_cells=True, encoding=None, inf_rep='inf', verbose=True): | ||
df = self.to_frame() | ||
df.to_excel(excel_writer=excel_writer, sheet_name=sheet_name, | ||
na_rep=na_rep, float_format=float_format, columns=columns, | ||
header=header, index=index, index_label=index_label, | ||
startrow=startrow, startcol=startcol, engine=engine, | ||
merge_cells=merge_cells, encoding=encoding, | ||
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. use shared docs here to avoid repeating everything 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. Could you show me an example? 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. look for shared_doc 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. Should this shared docstring be in |
||
inf_rep=inf_rep, verbose=verbose) | ||
|
||
def dropna(self, axis=0, inplace=False, **kwargs): | ||
""" | ||
Return Series without null values | ||
|
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.
Series has gained a
.to_excel
method, to output Excel files, similar toDataFrame.to_excel