ENH: Added ability to freeze panes from DataFrame.to_excel() (#15160) #15291

jeffcarey · 2017-02-02T05:28:00Z

closes to_excel should (optionally) freeze panes #15160
tests passed- Existing tests passed. New test added and passed.
passes git diff upstream/master | flake8 --diff
whatsnew entry- Added to 0.20.

The ability to freeze panes has been added to the to_excel() method on data frames. The parameter is a tuple of 2 integers, representing the bottom-most row and right-most column to freeze, respectively. (This is the same format xlsxwriter uses). The default value is None, resulting in no freezing.

Example usage:
df.to_excel(writer, sheet_name='Sheet1', freeze_panes=(1,1))

The following engines are supported:
xlsxwriter
xlwt
openpyxl22

The parameter exists for openpyxl20 and openpyxl1 but it has no effect, in anticipation of support for these versions being dropped (#15184).

Can one of the maintainers confirm this approach for engine support is adequate, or suggest an alternative? Once that is settled I can write a test to create a workbook using each engine and then try reading it back in using openpyxl.

codecov-io · 2017-02-02T08:28:39Z

Codecov Report

Merging #15291 into master will increase coverage by <.01%.
The diff coverage is 95%.

@@            Coverage Diff             @@
##           master   #15291      +/-   ##
==========================================
+ Coverage   90.36%   90.37%   +<.01%     
==========================================
  Files         135      135              
  Lines       49438    49452      +14     
==========================================
+ Hits        44675    44690      +15     
+ Misses       4763     4762       -1

Impacted Files	Coverage Δ
pandas/core/generic.py	`96.33% <ø> (ø)`	✅
pandas/io/excel.py	`79.64% <100%> (+0.24%)`	✅
pandas/core/frame.py	`97.82% <83.33%> (-0.05%)`	❌
pandas/util/testing.py	`81.97% <ø> (+0.18%)`	✅

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d6f8b46...cef8fce. Read the comment docs.

jreback · 2017-02-02T13:43:06Z

seems reasonable to me. yeah I wouldn't worry about supporting older version of openpyxl.

not sure how to test this (except for a smoke test I think).

jreback · 2017-02-02T13:41:33Z

pandas/io/excel.py

@@ -1322,6 +1327,10 @@ def write_cells(self, cells, sheet_name=None, startrow=0, startcol=0):
            wks.title = sheet_name
            self.sheets[sheet_name] = wks

+        if freeze_panes is not None:
+            wks.freeze_panes = wks.cell(row=freeze_panes[0] + 1,


vaidate that its a len 2 tuples

jreback · 2017-02-02T13:41:49Z

pandas/io/excel.py

@@ -1404,6 +1414,11 @@ def write_cells(self, cells, sheet_name=None, startrow=0, startcol=0):
            wks = self.book.add_sheet(sheet_name)
            self.sheets[sheet_name] = wks

+        if freeze_panes is not None:
+            wks.set_panes_frozen(True)


jreback · 2017-02-02T13:42:11Z

pandas/io/excel.py

@@ -1529,6 +1545,9 @@ def write_cells(self, cells, sheet_name=None, startrow=0, startcol=0):

        style_dict = {}

+        if freeze_panes is not None:
+            wks.freeze_panes(*(freeze_panes))


same (you may want to make a general validation for this somewhere)

jreback · 2017-02-02T13:44:26Z

pls add a whatsnew note, update docs in io.rst (maybe put a small section on 'Style'), IOW things that you can do. (we don't really support much readl styling yet (other issues about that), though things like float_format could be included).

chris-b1 · 2017-02-03T15:35:35Z

pandas/core/frame.py

@@ -1390,7 +1390,8 @@ def to_csv(self, path_or_buf=None, sep=",", na_rep='', float_format=None,
    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):
+                 merge_cells=True, encoding=None, inf_rep='inf', verbose=True,
+                 freeze_panes=None):


Add freeze_panes to the docstring here, which this function uses

pandas/pandas/core/generic.py

Line 1021 in 9ddba8d

_shared_docs['to_excel'] = """

jeffcarey · 2017-02-04T22:52:10Z

@jreback @chris-b1 Requested changes made, please review.

Also, I can look at supporting autofilter as well, as was mentioned in the original issue. Shall I open a separate issue for that? Sounds cleaner to me.

jreback · 2017-02-04T23:13:56Z

@jeffcarey that's fine to open a new issue.

One thing to thing about is do we just keep adding kwargs to .to_excel? or a better API?

@chris-b1

jreback · 2017-02-04T23:35:05Z

pandas/core/generic.py

@@ -1058,6 +1058,9 @@ def __setstate__(self, state):
    inf_rep : string, default 'inf'
        Representation for infinity (there is no native representation for
        infinity in Excel)
+    freeze_panes : tuple of integer (length 2), default None
+        Specifies the bottommost row and rightmost column that
+        is to be frozen


add a versionadded tag here

jreback · 2017-02-04T23:36:22Z

pandas/io/excel.py

@@ -1322,6 +1328,14 @@ def write_cells(self, cells, sheet_name=None, startrow=0, startcol=0):
            wks.title = sheet_name
            self.sheets[sheet_name] = wks

+        if (
+            freeze_panes is not None and


maybe make this a validation function

freeze_panes = _validate_freeze_panes(freeze_panes) if freeze_panes: ....

jreback · 2017-02-04T23:37:05Z

can you add a smoke test to write & then read back a simple frame.

chris-b1 · 2017-02-04T23:47:29Z

@jreback - not sure on the API, for now probably easiest as a kwarg.

I guess could see having some kind of template / styler like api?

df.to_excel('tmp.xlsx') # default, template=ExcelTemplate

my_template =  pd.ExcelTemplate.freeze_panes().autofilter()

df.to_excel('tmp2.xlsx', template=my_template)

jreback · 2017-02-04T23:52:11Z

@chris-b1 yeah, I guess if only a couple of other options then kwargs is the way to go.

jreback · 2017-02-07T16:31:50Z

doc/source/io.rst

@@ -2823,6 +2824,16 @@ argument to ``to_excel`` and to ``ExcelWriter``. The built-in engines are:

   df.to_excel('path_to_file.xlsx', sheet_name='Sheet1')

+Style and Formatting


you can add a ref-tag here: io.excel.style

jreback · 2017-02-07T16:32:39Z

pandas/core/frame.py

+                all(isinstance(item, int) for item in freeze_panes)
+            ):
+                return freeze_panes
+            else:


don't need the else

jreback · 2017-02-07T16:33:01Z

pandas/io/tests/test_excel.py

@@ -1837,6 +1837,15 @@ def test_true_and_false_value_options(self):
            tm.assert_frame_equal(read_frame, expected)


+    # GH15160


put the comment inside the function

jreback · 2017-02-07T16:34:23Z

minor comments, some flake issues (use git diff master | flake8 --diff to see).

lgtm. ping on green.

jeffcarey · 2017-02-08T17:03:29Z

@jreback Checks are green. Do you want me to fix the conflict that came up in the whatsnew or is that something you can do?

jreback · 2017-02-08T17:17:48Z

@jorisvandenbossche comments?

@jeffcarey can fix it on merge.

jreback · 2017-02-14T23:08:28Z

can you rebase

jreback · 2017-02-15T16:29:07Z

@jeffcarey can you rebase and push one more time. sorry had asome issues with the ci.

Cleaning up tests and whatsnew Added additional validation, whats new entry, documentation entry Clean up conflicts Added 1) test 2) validate function for freeze_panes 3) versionadded tag Clean up commits Fixed flake differences, Added tag in docs

jreback · 2017-02-16T17:47:49Z

thanks!

keem em coming!

jorisvandenbossche

@jeffcarey a bit late feedback for the PR, but if you would like to do a small follow-up PR for this, always welcome!

jorisvandenbossche · 2017-02-16T22:50:21Z

doc/source/io.rst

+
+- ``float_format`` : Format string for floating point numbers (default None)
+- ``freeze_panes`` : A tuple of two integers representing the bottommost row and rightmost column to freeze. Each of these parameters is one-based, so (1, 1) will
+freeze the first row and first column (default None)


this line will not be formatted nicely in the html docs (it needs two spaces at the start to have it indented in the list)

jorisvandenbossche · 2017-02-16T22:51:07Z

pandas/core/generic.py

@@ -1072,6 +1072,11 @@ def __setstate__(self, state):
    inf_rep : string, default 'inf'
        Representation for infinity (there is no native representation for
        infinity in Excel)
+    freeze_panes : tuple of integer (length 2), default None
+        Specifies the bottommost row and rightmost column that
+        is to be frozen


Does this start at zero or one?

jreback · 2017-03-04T23:50:18Z

@jeffcarey I just realized that https://github.com/pandas-dev/pandas/blame/master/pandas/core/frame.py#L1441 was defined in core/frame.py. This should only be in io/excel.py. We want to make code core/frame.py as simple as possible, and this is completely extraneous.

Can you do a PR to remove (and simply put it in .write_cells, where I think it is already validated anyhow).

…dev#15160) closes pandas-dev#15160 Author: Jeff Carey <[email protected]> Closes pandas-dev#15291 from jeffcarey/enh-15160 and squashes the following commits: cef8fce [Jeff Carey] ENH: Added ability to freeze panes from DataFrame.to_excel()

jreback added Enhancement IO Excel read_excel, to_excel labels Feb 2, 2017

jreback requested changes Feb 2, 2017

View reviewed changes

chris-b1 reviewed Feb 3, 2017

View reviewed changes

jreback reviewed Feb 4, 2017

View reviewed changes

jreback reviewed Feb 7, 2017

View reviewed changes

jreback added this to the 0.20.0 milestone Feb 7, 2017

jeffcarey force-pushed the enh-15160 branch from 99ec0f4 to f61a9e0 Compare February 15, 2017 00:35

jeffcarey force-pushed the enh-15160 branch from f61a9e0 to cef8fce Compare February 16, 2017 01:47

jreback closed this in 9b5d848 Feb 16, 2017

jorisvandenbossche reviewed Feb 16, 2017

View reviewed changes

jeffcarey mentioned this pull request Feb 17, 2017

Documents touch-up for DataFrame.to_excel() freeze_panes option #15436

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENH: Added ability to freeze panes from DataFrame.to_excel() (#15160) #15291

ENH: Added ability to freeze panes from DataFrame.to_excel() (#15160) #15291

jeffcarey commented Feb 2, 2017 •

edited

Loading

codecov-io commented Feb 2, 2017 •

edited

Loading

jreback commented Feb 2, 2017

jreback Feb 2, 2017

jreback Feb 2, 2017

jreback Feb 2, 2017

jreback commented Feb 2, 2017

chris-b1 Feb 3, 2017

jeffcarey commented Feb 4, 2017

jreback commented Feb 4, 2017

jreback Feb 4, 2017

jreback Feb 4, 2017 •

edited

Loading

jreback commented Feb 4, 2017

chris-b1 commented Feb 4, 2017

jreback commented Feb 4, 2017

jreback Feb 7, 2017

jreback Feb 7, 2017

jreback Feb 7, 2017

jreback commented Feb 7, 2017

jeffcarey commented Feb 8, 2017

jreback commented Feb 8, 2017

jreback commented Feb 14, 2017

jreback commented Feb 15, 2017

jreback commented Feb 16, 2017

jorisvandenbossche left a comment

jorisvandenbossche Feb 16, 2017

jorisvandenbossche Feb 16, 2017

jreback commented Mar 4, 2017

		@@ -2823,6 +2824,16 @@ argument to ``to_excel`` and to ``ExcelWriter``. The built-in engines are:

		df.to_excel('path_to_file.xlsx', sheet_name='Sheet1')

		Style and Formatting

		@@ -1837,6 +1837,15 @@ def test_true_and_false_value_options(self):
		tm.assert_frame_equal(read_frame, expected)


		# GH15160

ENH: Added ability to freeze panes from DataFrame.to_excel() (#15160) #15291

ENH: Added ability to freeze panes from DataFrame.to_excel() (#15160) #15291

Conversation

jeffcarey commented Feb 2, 2017 • edited Loading

codecov-io commented Feb 2, 2017 • edited Loading

Codecov Report

jreback commented Feb 2, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Feb 2, 2017

Choose a reason for hiding this comment

jeffcarey commented Feb 4, 2017

jreback commented Feb 4, 2017

Choose a reason for hiding this comment

jreback Feb 4, 2017 • edited Loading

Choose a reason for hiding this comment

jreback commented Feb 4, 2017

chris-b1 commented Feb 4, 2017

jreback commented Feb 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Feb 7, 2017

jeffcarey commented Feb 8, 2017

jreback commented Feb 8, 2017

jreback commented Feb 14, 2017

jreback commented Feb 15, 2017

jreback commented Feb 16, 2017

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

jreback commented Mar 4, 2017

jeffcarey commented Feb 2, 2017 •

edited

Loading

codecov-io commented Feb 2, 2017 •

edited

Loading

jreback Feb 4, 2017 •

edited

Loading