ENH: Change DataFrame.to_excel to output unformatted excel file #54302

rmhowe425 · 2023-07-29T03:47:29Z

closes REF: Proposal: change DataFrame.to_excel to output unformatted excel file #54154
Tests added and passed if fixing a bug or adding a new feature
All code checks passed.
Added type annotations to new arguments/methods/functions.
Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

rmhowe425 · 2023-07-31T11:53:05Z

@rhshadrach pinging on green

mroeschke · 2023-07-31T17:56:12Z

doc/source/whatsnew/v2.1.0.rst

@@ -176,6 +176,7 @@ Other enhancements
 - Performance improvement in :func:`concat` with homogeneous ``np.float64`` or ``np.float32`` dtypes (:issue:`52685`)
 - Performance improvement in :meth:`DataFrame.filter` when ``items`` is given (:issue:`52941`)
 - Reductions :meth:`Series.argmax`, :meth:`Series.argmin`, :meth:`Series.idxmax`, :meth:`Series.idxmin`, :meth:`Index.argmax`, :meth:`Index.argmin`, :meth:`DataFrame.idxmax`, :meth:`DataFrame.idxmin` are now supported for object-dtype objects (:issue:`4279`, :issue:`18021`, :issue:`40685`, :issue:`43697`)
+- Updated :meth:`DataFrame.to_excel` so that the output spreadsheet has no styling. (:issue:`54154`)


From the issue, this change will need to happen in 3.0 not 2.1

@mroeschke Looks like there is no whatsnew file yet for 3.0.

I can just create one by creating a template based on 2.1?

We'll create one once we release 2.2 (in December), so let's hold on with this PR for now

rhshadrach · 2023-07-31T20:30:29Z

doc/source/user_guide/io.rst

+
+    As of Pandas 3.0, by default spreadsheets created with the ``to_excel`` method
+    will not contain any styling. Users wishing to bold text, add bordered styles,
+    etc in a worksheet output by ``to_excel`` can do so by using ``Styler.to_excel``


Can you use :meth:`Styler.to_excel` and also add a reference to the section in the User Guide: https://pandas.pydata.org/docs/user_guide/style.html#Export-to-Excel

rhshadrach · 2023-07-31T20:31:39Z

doc/source/user_guide/io.rst

+    css = "border: 1pt solid #111222"
+    styler = df.style.map(lambda x: css)


I don't think this is equivalent to how Excel files are currently styled, is that right? Would it make sense to do that instead?

I agree, think we need to provide the exact replication. Typing on phone now but I suggest the its probably going to be something like;

css = "border: 1px solid black; font-weight: bold;" # instead of df.to_excel("myfile.xlsx") df.style.map_index(lambda x: css).map_index(lambda x: css, axis=1).to_excel("myfile.xlsx")

It might need text-align as well - I cant remember off hand.

@attack68 Yeah doing a quick comparison of the above with a basic call to DataFrame.to_excel() shows that the above styling is the same as the current default styling.

github-actions · 2023-09-08T00:04:57Z

This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this.

rmhowe425 · 2023-09-09T01:08:58Z

This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this.

Still interested in working on this PR. Waiting for whatsnew v3.0 to come out

mroeschke · 2024-01-31T18:52:37Z

@rmhowe425 the 3.0.0.rst whatsnew is out now. Are you still interested in continuing this?

rmhowe425 · 2024-02-01T02:48:46Z

@rmhowe425 the 3.0.0.rst whatsnew is out now. Are you still interested in continuing this?

Yes I am still interested! Thank you for pinging me and letting me know!

weikhor · 2024-02-06T14:35:58Z

pandas/tests/io/excel/test_style.py

+@pytest.mark.parametrize(
+    "css",
+    ["background-color: #111222"],
+)
+def test_styler_custom_style(css):
+    # GH 54154
+    openpyxl = pytest.importorskip("openpyxl")
+    df = DataFrame([{"A": 1, "B": 2}, {"A": 1, "B": 2}])
+
+    with tm.ensure_clean(".xlsx") as path:
+        with ExcelWriter(path, engine="openpyxl") as writer:
+            styler = df.style.map(lambda x: css)
+            styler.to_excel(writer, sheet_name="custom", index=False)
+
+        with contextlib.closing(openpyxl.load_workbook(path)) as wb:
+            # Check font, spacing, indentation
+            assert wb["custom"].cell(1, 1).font.bold is False
+            assert wb["custom"].cell(1, 1).alignment.horizontal is None
+            assert wb["custom"].cell(1, 1).alignment.vertical is None
+
+            # Check border
+            assert wb["custom"].cell(1, 1).border.bottom.color is None
+            assert wb["custom"].cell(1, 1).border.top.color is None
+            assert wb["custom"].cell(1, 1).border.left.color is None
+            assert wb["custom"].cell(1, 1).border.right.color is None
+
+            # Check background color
+            assert wb["custom"].cell(2, 1).fill.fgColor.index == "00111222"
+            assert wb["custom"].cell(3, 1).fill.fgColor.index == "00111222"
+            assert wb["custom"].cell(2, 2).fill.fgColor.index == "00111222"
+            assert wb["custom"].cell(3, 2).fill.fgColor.index == "00111222"
+
+


I think we can simplify code test by combining both functions test_styler_default_values and test_styler_custom_style to one function.

@pytest.mark.parametrize( "css, color", [("", "00000000"), ("background-color: #111222", "00111222")], ) def test_default_and_custom_style(css, color): # GH 54154 openpyxl = pytest.importorskip("openpyxl") df = DataFrame([{"A": 1, "B": 2}, {"A": 1, "B": 2}]) with tm.ensure_clean(".xlsx") as path: with ExcelWriter(path, engine="openpyxl") as writer: styler = df.style.map(lambda x: css) styler.to_excel(writer, sheet_name="custom", index=False) with contextlib.closing(openpyxl.load_workbook(path)) as wb: # Check font, spacing, indentation assert wb["custom"].cell(1, 1).font.bold is False assert wb["custom"].cell(1, 1).alignment.horizontal is None assert wb["custom"].cell(1, 1).alignment.vertical is None # Check border assert wb["custom"].cell(1, 1).border.bottom.color is None assert wb["custom"].cell(1, 1).border.top.color is None assert wb["custom"].cell(1, 1).border.left.color is None assert wb["custom"].cell(1, 1).border.right.color is None # Check background color assert wb["custom"].cell(2, 1).fill.fgColor.index == color assert wb["custom"].cell(3, 1).fill.fgColor.index == color assert wb["custom"].cell(2, 2).fill.fgColor.index == color assert wb["custom"].cell(3, 2).fill.fgColor.index == color

rmhowe425 · 2024-02-15T05:26:37Z

@rhshadrach @mroeschke Pinging on green.

Did you guys want me to combine my unit tests into one test as recommended here?

IMHO I think it makes more sense to keep them separated, but happy to combine them if you guys want me to.

attack68

I think separate tests is fine. LGTM and passes tests.

mroeschke · 2024-02-15T17:26:38Z

pandas/tests/io/excel/test_style.py

@@ -123,6 +145,39 @@ def test_styler_to_excel_unstyled(engine):
 ]


+@pytest.mark.parametrize(
+    "css",
+    ["background-color: #111222"],


Can you inline this in the test since it's only 1 parameter

mroeschke · 2024-02-15T17:27:30Z

doc/source/whatsnew/v3.0.0.rst

@@ -32,7 +32,7 @@ Other enhancements
 - :func:`read_stata` now returns ``datetime64`` resolutions better matching those natively stored in the stata format (:issue:`55642`)
 - Allow dictionaries to be passed to :meth:`pandas.Series.str.replace` via ``pat`` parameter (:issue:`51748`)
 - Support passing a :class:`Series` input to :func:`json_normalize` that retains the :class:`Series` :class:`Index` (:issue:`51452`)
-
+- Updated :meth:`DataFrame.to_excel` so that the output spreadsheet has no styling. (:issue:`54154`)


Can you put this under Other API Changes and also mention that styling can still be done with Styler.to_excel?

rmhowe425 · 2024-02-15T21:01:25Z

@mroeschke Pinging on green

rhshadrach

Nice tests, lgtm.

mroeschke · 2024-02-15T21:19:54Z

Thanks @rmhowe425

…as-dev#54302) * Updated default styling logic for to_excel and added unit tests. * Adding documentation to the Pandas User Guide. * Updating whatsnew * Fixing merge conflict. * Updating user guide documentation. * Fixing syntax error. * Updating implementation based on reviewer feedback. * Updating documentation.

rmhowe425 added 2 commits July 28, 2023 23:44

Updated default styling logic for to_excel and added unit tests.

620dc40

Adding documentation to the Pandas User Guide.

a44242a

mroeschke requested changes Jul 31, 2023

View reviewed changes

mroeschke added the Styler conditional formatting using DataFrame.style label Jul 31, 2023

rhshadrach requested changes Jul 31, 2023

View reviewed changes

mroeschke added this to the 3.0 milestone Aug 8, 2023

github-actions bot added the Stale label Sep 8, 2023

weikhor reviewed Feb 6, 2024

View reviewed changes

mroeschke removed the Stale label Feb 6, 2024

rmhowe425 and others added 5 commits February 14, 2024 22:12

Merge branch 'main' into dev/to_excel/format

4c04104

Updating whatsnew

ac25ee3

Fixing merge conflict.

505b4a8

Updating user guide documentation.

86662c4

Fixing syntax error.

024a162

rmhowe425 requested review from mroeschke and rhshadrach February 15, 2024 05:25

attack68 approved these changes Feb 15, 2024

View reviewed changes

mroeschke reviewed Feb 15, 2024

View reviewed changes

rmhowe425 added 2 commits February 15, 2024 15:05

Updating implementation based on reviewer feedback.

c1731fd

Updating documentation.

ebdef70

rmhowe425 requested a review from mroeschke February 15, 2024 21:00

rhshadrach approved these changes Feb 15, 2024

View reviewed changes

mroeschke approved these changes Feb 15, 2024

View reviewed changes

mroeschke merged commit db54438 into pandas-dev:main Feb 15, 2024

rmhowe425 deleted the dev/to_excel/format branch February 17, 2024 17:19

rmhowe425 mentioned this pull request Jul 7, 2024

Excel styles should default to using number format from display.precision option #16161

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENH: Change DataFrame.to_excel to output unformatted excel file #54302

ENH: Change DataFrame.to_excel to output unformatted excel file #54302

rmhowe425 commented Jul 29, 2023 •

edited

Loading

rmhowe425 commented Jul 31, 2023

mroeschke Jul 31, 2023

rmhowe425 Jul 31, 2023

mroeschke Jul 31, 2023

rhshadrach Jul 31, 2023

rhshadrach Jul 31, 2023

attack68 Aug 3, 2023 •

edited

Loading

rmhowe425 Feb 15, 2024

github-actions bot commented Sep 8, 2023

rmhowe425 commented Sep 9, 2023

mroeschke commented Jan 31, 2024

rmhowe425 commented Feb 1, 2024

weikhor Feb 6, 2024 •

edited

Loading

rmhowe425 commented Feb 15, 2024

attack68 left a comment

mroeschke Feb 15, 2024

mroeschke Feb 15, 2024

rmhowe425 commented Feb 15, 2024

rhshadrach left a comment

mroeschke commented Feb 15, 2024

		css = "border: 1pt solid #111222"
		styler = df.style.map(lambda x: css)

ENH: Change DataFrame.to_excel to output unformatted excel file #54302

ENH: Change DataFrame.to_excel to output unformatted excel file #54302

Conversation

rmhowe425 commented Jul 29, 2023 • edited Loading

rmhowe425 commented Jul 31, 2023

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

attack68 Aug 3, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 8, 2023

rmhowe425 commented Sep 9, 2023

mroeschke commented Jan 31, 2024

rmhowe425 commented Feb 1, 2024

weikhor Feb 6, 2024 • edited Loading

Choose a reason for hiding this comment

rmhowe425 commented Feb 15, 2024

attack68 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rmhowe425 commented Feb 15, 2024

rhshadrach left a comment

Choose a reason for hiding this comment

mroeschke commented Feb 15, 2024

rmhowe425 commented Jul 29, 2023 •

edited

Loading

attack68 Aug 3, 2023 •

edited

Loading

weikhor Feb 6, 2024 •

edited

Loading