ENH: Pandas Series provide to_excel method #14780

s-celles · 2016-12-01T07:51:08Z

closes Pandas Series should provide to_excel method #8825
tests added / passed
passes git diff upstream/master | flake8 --diff
whatsnew entry

sinhrks · 2016-12-01T09:45:42Z

pandas/core/series.py

+        strings before writing.
+        """
+        from pandas.core.frame import DataFrame
+        df = DataFrame(self)


use .to_frame.

sinhrks · 2016-12-01T11:11:58Z

pandas/core/series.py

+        """
+        from pandas.core.frame import DataFrame
+        df = DataFrame(self)
+        df.to_excel(excel_writer, sheet_name, na_rep,


pls use keyword args as locations may be changed.

jreback · 2016-12-01T11:55:40Z

pandas/core/series.py

+                    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,


use shared docs here to avoid repeating everything

Could you show me an example?

look for shared_doc

Should this shared docstring be in pandas/io/excel.py or somewhere else?

jreback · 2016-12-01T15:12:45Z

pandas/core/series.py

@@ -2619,6 +2619,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='',


add to the doc-string a versionadded tag (0.20.)

jreback · 2016-12-01T15:13:27Z

this prob needs to be added to api.rst as well

s-celles · 2016-12-02T16:33:25Z

Could you retrigger this job ? Thanks

sinhrks · 2016-12-02T20:04:25Z

@scls19fr The job fails because of a lint error. pls fix.

codecov-io · 2016-12-02T20:40:22Z

Current coverage is 85.27% (diff: 100%)

Merging #14780 into master will increase coverage by <.01%

@@             master     #14780   diff @@
==========================================
  Files           144        144          
  Lines         50946      50953     +7   
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
+ Hits          43445      43452     +7   
  Misses         7501       7501          
  Partials          0          0

Powered by Codecov. Last update c0e13d1...0ab4876

s-celles · 2016-12-02T20:43:37Z

Thanks @sinhrks I didn't noticed because that's only for 1 job.

jorisvandenbossche · 2016-12-02T22:27:04Z

pandas/core/generic.py

+    _shared_docs['to_excel'] = """
+    Write %(klass)s to a excel sheet
+
+    .. versionadded:: 0.20.0


This is not the case for DataFrame. You can add it separately for series with _shared_doc_kwargs

@jorisvandenbossche how will you name this key in _shared_doc_kwargs?
What value will you put? .. versionadded:: 0.20.0 or 0.20.0?

The first one, as for DataFrame.excel there should be no versionadded

jreback · 2016-12-04T17:26:51Z

doc/source/whatsnew/v0.20.0.txt

@@ -49,7 +49,7 @@ Other enhancements
 ^^^^^^^^^^^^^^^^^^

 - ``pd.read_excel`` now preserves sheet order when using ``sheetname=None`` (:issue:`9930`)
-
+- ``Series`` provides a ``to_excel`` method to output Excel files (:issue:`8825`)


Series has gained a .to_excel method, to output Excel files, similar to DataFrame.to_excel

jreback · 2016-12-04T17:28:01Z

pandas/core/frame.py

@@ -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.""",


@jorisvandenbossche any better way to do this?

I think this is fine (given our current way of doing this with _shared_doc_kwargs. This could maybe get an overhaul, but that is another issue :-))

jreback · 2016-12-04T17:28:32Z

pls rebase and push again

Closes pandas-dev#8825

jorisvandenbossche

Looks good, small comment regarding newlines in the resulting docstring

jorisvandenbossche · 2016-12-04T21:15:36Z

pandas/core/generic.py

+    Write %(klass)s to a excel sheet
+
+    %(versionadded_to_excel)s
+


Can you remove the blank lines before and after the versionadded here? And include the newlines in the versionadded_to_excel arg for Series. Because otherwise for DataFrame.to_excel, you would get three blank lines instead of one here.

jorisvandenbossche · 2016-12-04T21:20:23Z

pandas/core/frame.py

@@ -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.""",


I think this is fine (given our current way of doing this with _shared_doc_kwargs. This could maybe get an overhaul, but that is another issue :-))

jorisvandenbossche · 2016-12-05T14:39:25Z

@scls19fr Thanks a lot!

sinhrks suggested changes Dec 1, 2016

View reviewed changes

sinhrks added API Design IO Excel read_excel, to_excel labels Dec 1, 2016

jreback requested changes Dec 1, 2016

View reviewed changes

sinhrks approved these changes Dec 1, 2016

View reviewed changes

jreback reviewed Dec 1, 2016

View reviewed changes

s-celles force-pushed the series_to_excel branch from fcaa86b to df02b00 Compare December 2, 2016 20:42

jorisvandenbossche reviewed Dec 2, 2016

View reviewed changes

jreback reviewed Dec 4, 2016

View reviewed changes

jreback approved these changes Dec 4, 2016

View reviewed changes

s-celles force-pushed the series_to_excel branch from 8f5e162 to 4353531 Compare December 4, 2016 18:09

s-celles added 2 commits December 4, 2016 19:14

Update whatsnew

68d7609

ENH: Pandas Series provide to_excel method

0ab4876

Closes pandas-dev#8825

s-celles force-pushed the series_to_excel branch from dc2c5ca to 0ab4876 Compare December 4, 2016 18:43

jorisvandenbossche reviewed Dec 4, 2016

View reviewed changes

Remove blank lines

605b9ce

jorisvandenbossche added this to the 0.20.0 milestone Dec 5, 2016

jorisvandenbossche merged commit b3dd9ba into pandas-dev:master Dec 5, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENH: Pandas Series provide to_excel method #14780

ENH: Pandas Series provide to_excel method #14780

s-celles commented Dec 1, 2016 •

edited

Loading

sinhrks Dec 1, 2016

sinhrks Dec 1, 2016 •

edited

Loading

jreback Dec 1, 2016

s-celles Dec 1, 2016

jreback Dec 1, 2016

s-celles Dec 1, 2016 •

edited

Loading

jreback Dec 1, 2016

jreback commented Dec 1, 2016

s-celles commented Dec 2, 2016

sinhrks commented Dec 2, 2016

codecov-io commented Dec 2, 2016 •

edited

Loading

s-celles commented Dec 2, 2016

jorisvandenbossche Dec 2, 2016

s-celles Dec 3, 2016

jorisvandenbossche Dec 3, 2016

jreback Dec 4, 2016

jreback Dec 4, 2016

jorisvandenbossche Dec 4, 2016

jreback commented Dec 4, 2016

jorisvandenbossche left a comment

jorisvandenbossche Dec 4, 2016

jorisvandenbossche Dec 4, 2016

jorisvandenbossche commented Dec 5, 2016

ENH: Pandas Series provide to_excel method #14780

ENH: Pandas Series provide to_excel method #14780

Conversation

s-celles commented Dec 1, 2016 • edited Loading

Choose a reason for hiding this comment

sinhrks Dec 1, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s-celles Dec 1, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Dec 1, 2016

s-celles commented Dec 2, 2016

sinhrks commented Dec 2, 2016

codecov-io commented Dec 2, 2016 • edited Loading

Current coverage is 85.27% (diff: 100%)

s-celles commented Dec 2, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Dec 4, 2016

jorisvandenbossche left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorisvandenbossche commented Dec 5, 2016

s-celles commented Dec 1, 2016 •

edited

Loading

sinhrks Dec 1, 2016 •

edited

Loading

s-celles Dec 1, 2016 •

edited

Loading

codecov-io commented Dec 2, 2016 •

edited

Loading