EHN: add ability to format index and col names to Styler #57880

quangngd · 2024-03-18T05:58:17Z

closes ENH: Styler apply_index and format_index applicable to index names #48936 and closes BUG: index naming escaping not performed by Styler.format_index #47489
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.

Stage one. Part of an multi-stages effort: #57880 (comment)

Adding a method to Styler and ensuring it works for the default HTML cases with tests in the appropriate pages.

attack68 · 2024-03-18T11:14:46Z

Hi thanks for this PR.

A Styler.format_names or Styler.format_index_names method has been on the requested agenda for a while now.
This PR mixes three concepts, however.

One is adding a method to Styler and ensuring it works for the default HTML cases with tests in the appropriate pages.
Two is extending it to the Styler.to_latex implementation and adding specific to_latex tests.
Three is ensuring that the legacy DataFrame.to_latex implementation is capable of using it (in its limited form).
(Four would be about checking if Styler.to_string and Styler.to_excel will function accordingly)
(Five is ensuring documentation and examples exist in Styler.format_names )

Since a method addition is quite a significant undertaking. I would ask that you split this PR into multiple stages.
The first stage I would look to review is part One. Adding the method just to Styler and adding tests in generic places, including testing the default implementation for HTML output.

From what I can see you have followed the template of previous code and that is a great start.

quangngd · 2024-03-19T04:29:27Z

Hi @attack68,

I've updated my code. It's now my attempt at the first point in your list.
Please help me take a look.

attack68 · 2024-03-19T08:39:04Z

I think we should probably call this method format_index_names. Even though its longer I think it is more obvious what it does.

I think we also need greater test coverage to cover lines.
Take a look at https://github.com./pandas-dev/pandas/blob/main/pandas/tests/io/formats/style/test_format.py

You should probably look to replicate the tests for the specific case :

test_format_index_level
test_format_clear
test_format_callable
test_format_dict
test_display_format_index

attack68 · 2024-03-19T08:42:11Z

Since your code also involves cases where things are hidden you should also include a test to show that, say if a multi-index has a level hidden, the format function still works correctly on the levels that are still shown.

pandas/io/formats/style_render.py

Co-authored-by: JHM Darbyshire <[email protected]>

… styler_format_names

quangngd · 2024-03-19T16:42:43Z

@attack68 added a bunch of new tests.

don't immediately see the point of test_display_format_index for this case so i didnt adapt it.

attack68 · 2024-03-19T16:55:04Z

Are you familiar with coverage ? The idea was that that collection of tests should pretty much cover all your code branches. Some of the re-used material like _maybe_wrap_formatter is already well covered.

attack68 · 2024-03-19T17:03:06Z

pandas/io/formats/style_render.py

+
+        Notes
+        -----
+    This method has a similar signature to :meth:`Styler.format_index`. Since `names` are generally label 


pls fix this indentation. my fault from previous i expect

quangngd · 2024-03-19T17:23:19Z

Are you familiar with coverage ? The idea was that that collection of tests should pretty much cover all your code branches. Some of the re-used material like _maybe_wrap_formatter is already well covered.

Yeah. I ran coverage and see my new method is well covered. Mostly because i reuse a lot of things, as you have pointed out.

So i don't really understand what your suggestion is. Can you elaborate? Or maybe most of the material is reuse so you suggest we could achieve the same coverage without so much test? I hope not.

attack68 · 2024-03-19T17:28:08Z

My point is you need to cover your code with your tests. Aim for 100%. It seems you have achieved that. Do you agree?

quangngd · 2024-03-19T17:39:15Z

Thought so too.

If there is nothing major, I think i would fix up whats left and wrap this up. Then ill start to work on the next point in a new PR.

In case if things go stale, this PR can still be merged as an enhancement on its own. (ofc versionadded and whatsnew have to be filled before merge).

Does that sound good to you?

attack68 · 2024-03-19T19:23:26Z

Indeed, is what I would suggest. Thanks for the good work here and following the structure. Hopefully the other reviewers will recognise this as quite a tidy addition and be fairly quick approve also. I'll look to add my approval when all the bits in and tests pass.

There is one additional file you have to add to: doc/source/reference/style.rst

pandas/io/formats/style_render.py

attack68 · 2024-03-21T07:51:23Z

pandas/tests/io/formats/style/test_html.py

+  <thead>
+    <tr>
+      <th class="blank" >&nbsp;</th>
+      <th class="index_name level0" >{expected_columns[0]}</th>
+      <th id="T_test_level0_col0" class="col_heading level0 col0" colspan="2">A</th>
+      <th id="T_test_level0_col2" class="col_heading level0 col2" colspan="2">B</th>
+    </tr>
+    <tr>
+      <th class="blank" >&nbsp;</th>
+      <th class="index_name level1" >{expected_columns[1]}</th>
+      <th id="T_test_level1_col0" class="col_heading level1 col0" >a</th>
+      <th id="T_test_level1_col1" class="col_heading level1 col1" >b</th>
+      <th id="T_test_level1_col2" class="col_heading level1 col2" >a</th>
+      <th id="T_test_level1_col3" class="col_heading level1 col3" >b</th>
+    </tr>
+    <tr>
+      <th class="index_name level0" >{expected_index[0]}</th>
+      <th class="index_name level1" >{expected_index[1]}</th>


Its probably sufficient to assert expected in result rather than equate the large bulk of text. This also future proofs the test so that if other changes are implemented which dont affect the specific format_index_names function this test wont need updating.

attack68

Needs a whatsnew entry.
Otherwise LGTM.

quangngd · 2024-03-24T13:21:54Z

Do you know the target version? Or should we wait for an active member?

pandas/io/formats/style_render.py

mroeschke · 2024-03-25T16:59:21Z

pandas/io/formats/style_render.py

+        When using a ``formatter`` string the dtypes must be compatible, otherwise a
+        `ValueError` will be raised.


Can you put this in its own

Raises ------

section?

mroeschke

Could you add a whatsnew note in v3.0.0.rst under Other Enhancements?

Co-authored-by: Matthew Roeschke <[email protected]>

… styler_format_names

quangngd · 2024-03-26T04:56:18Z

Could you add a whatsnew note in v3.0.0.rst under Other Enhancements?

Added

mroeschke · 2024-03-26T17:26:15Z

Thanks @quangngd

attack68 · 2024-04-11T17:14:28Z

@quangngd are you interested to work on stage 2 of this. I think it would be good to get in so that there is no disconnect for users between these functions and the LaTeX output.

To my knowledge there are currently no undocumented issues between the styler and the LaTeX output so good for me to keep an eye on.

quangngd · 2024-04-12T00:11:46Z

@attack68
Sure! Been a bit busy at work lately but I'll find some time to do it in the upcoming weekends.

…57880) * add new method to styler * add html test * fix type * rename to format_index_names * Update pandas/io/formats/style_render.py Co-authored-by: JHM Darbyshire <[email protected]> * Update pandas/io/formats/style_render.py Co-authored-by: JHM Darbyshire <[email protected]> * add tests * add test * more doc * doc * update code_checks * add example * update test * Update pandas/io/formats/style_render.py Co-authored-by: Matthew Roeschke <[email protected]> * Update pandas/io/formats/style_render.py Co-authored-by: Matthew Roeschke <[email protected]> * update doc --------- Co-authored-by: JHM Darbyshire <[email protected]> Co-authored-by: Matthew Roeschke <[email protected]>

quangngd requested a review from attack68 as a code owner March 18, 2024 05:58

attack68 added Styler conditional formatting using DataFrame.style Enhancement labels Mar 18, 2024

quangngd added 2 commits March 18, 2024 19:51

add new method to styler

777ce63

add html test

3cbe658

quangngd force-pushed the styler_format_names branch from 9062cff to 3cbe658 Compare March 19, 2024 03:29

fix type

d214e02

rename to format_index_names

1e3661f

attack68 reviewed Mar 19, 2024

View reviewed changes

pandas/io/formats/style_render.py Outdated Show resolved Hide resolved

attack68 reviewed Mar 19, 2024

View reviewed changes

pandas/io/formats/style_render.py Outdated Show resolved Hide resolved

quangngd and others added 5 commits March 19, 2024 22:22

Update pandas/io/formats/style_render.py

9241a1b

Co-authored-by: JHM Darbyshire <[email protected]>

Update pandas/io/formats/style_render.py

d96eac4

Co-authored-by: JHM Darbyshire <[email protected]>

add tests

ec2d2b3

Merge branch 'styler_format_names' of github.com.:quangngd/pandas into…

0636690

… styler_format_names

add test

87ffa4d

attack68 reviewed Mar 19, 2024

View reviewed changes

quangngd added 2 commits March 20, 2024 09:55

more doc

783269e

doc

a644ac1

quangngd requested a review from mroeschke as a code owner March 20, 2024 04:01

Merge branch 'main' into styler_format_names

d33f58c

update code_checks

7d396cc

attack68 reviewed Mar 20, 2024

View reviewed changes

pandas/io/formats/style_render.py Show resolved Hide resolved

add example

bcfb5f4

attack68 reviewed Mar 21, 2024

View reviewed changes

update test

1396cfd

attack68 approved these changes Mar 24, 2024

View reviewed changes

mroeschke reviewed Mar 25, 2024

View reviewed changes

pandas/io/formats/style_render.py Outdated Show resolved Hide resolved

mroeschke reviewed Mar 25, 2024

View reviewed changes

pandas/io/formats/style_render.py Outdated Show resolved Hide resolved

mroeschke reviewed Mar 25, 2024

View reviewed changes

quangngd and others added 5 commits March 26, 2024 09:58

Update pandas/io/formats/style_render.py

f4806f7

Co-authored-by: Matthew Roeschke <[email protected]>

Update pandas/io/formats/style_render.py

f7d3461

Co-authored-by: Matthew Roeschke <[email protected]>

update doc

60e6ef2

Merge branch 'styler_format_names' of github.com.:quangngd/pandas into…

1864c59

… styler_format_names

Merge branch 'main' into styler_format_names

f44c8ce

mroeschke approved these changes Mar 26, 2024

View reviewed changes

mroeschke added this to the 3.0 milestone Mar 26, 2024

mroeschke merged commit 010328f into pandas-dev:main Mar 26, 2024
46 checks passed

attack68 mentioned this pull request Jul 26, 2024

ENH: extend Styler to_latex for index name styling #59324

Open

3 tasks

quangngd mentioned this pull request Apr 19, 2025

EHN: df.to_latex(escape=True) also escape index names #61307

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EHN: add ability to format index and col names to Styler #57880

EHN: add ability to format index and col names to Styler #57880

quangngd commented Mar 18, 2024 •

edited

Loading

attack68 commented Mar 18, 2024

quangngd commented Mar 19, 2024

attack68 commented Mar 19, 2024

attack68 commented Mar 19, 2024

quangngd commented Mar 19, 2024

attack68 commented Mar 19, 2024

attack68 Mar 19, 2024

quangngd Mar 20, 2024

quangngd commented Mar 19, 2024 •

edited

Loading

attack68 commented Mar 19, 2024

quangngd commented Mar 19, 2024

attack68 commented Mar 19, 2024

attack68 Mar 21, 2024

quangngd Mar 21, 2024

attack68 left a comment

quangngd commented Mar 24, 2024

mroeschke Mar 25, 2024

quangngd Mar 26, 2024

mroeschke left a comment

quangngd commented Mar 26, 2024

mroeschke commented Mar 26, 2024

attack68 commented Apr 11, 2024

quangngd commented Apr 12, 2024

		When using a ``formatter`` string the dtypes must be compatible, otherwise a
		`ValueError` will be raised.

EHN: add ability to format index and col names to Styler #57880

EHN: add ability to format index and col names to Styler #57880

Conversation

quangngd commented Mar 18, 2024 • edited Loading

attack68 commented Mar 18, 2024

quangngd commented Mar 19, 2024

attack68 commented Mar 19, 2024

attack68 commented Mar 19, 2024

quangngd commented Mar 19, 2024

attack68 commented Mar 19, 2024

attack68 Mar 19, 2024

Choose a reason for hiding this comment

quangngd Mar 20, 2024

Choose a reason for hiding this comment

quangngd commented Mar 19, 2024 • edited Loading

attack68 commented Mar 19, 2024

quangngd commented Mar 19, 2024

attack68 commented Mar 19, 2024

attack68 Mar 21, 2024

Choose a reason for hiding this comment

quangngd Mar 21, 2024

Choose a reason for hiding this comment

attack68 left a comment

Choose a reason for hiding this comment

quangngd commented Mar 24, 2024

mroeschke Mar 25, 2024

Choose a reason for hiding this comment

quangngd Mar 26, 2024

Choose a reason for hiding this comment

mroeschke left a comment

Choose a reason for hiding this comment

quangngd commented Mar 26, 2024

mroeschke commented Mar 26, 2024

attack68 commented Apr 11, 2024

quangngd commented Apr 12, 2024

quangngd commented Mar 18, 2024 •

edited

Loading

quangngd commented Mar 19, 2024 •

edited

Loading