Skip to content

Style concats #49212

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.

Sign up for GitHub

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

Merged
merged 21 commits into from
Dec 12, 2022
Merged

Style concats #49212

Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
b3bc28b
allow chaining of style.concat
Oct 20, 2022
4d77906
updated what's new
Oct 20, 2022
aa1484f
tests: different styles used, to verify that they are all apllied cor…
Nov 8, 2022
6de1944
updated docs
Nov 8, 2022
8d41210
fix: adding the concatenated to self.ctx correctly
Nov 8, 2022
dd4d29d
added type hint
Nov 9, 2022
0d5a258
Update doc/source/whatsnew/v1.5.2.rst
tsvikas Nov 15, 2022
8cfc69c
minor: change case in docstring
Nov 9, 2022
28d937e
removed unneeded uuid_len in tests
Nov 15, 2022
6c85396
different css classes for different concatenated stylers
Nov 15, 2022
5703836
fixed bug with duplicated css styles, added a relevant test
Nov 15, 2022
4532396
refactor: ctx_len is calculated from the concatenated length
Nov 16, 2022
fe4be54
updated documentation
tsvikas Nov 17, 2022
e2c42cc
Merge branch 'main' into style-concats
Nov 22, 2022
20ce639
moved change to 1.5.3
Nov 22, 2022
4bc20d1
fix mypy complaint
Nov 22, 2022
2698deb
Update pandas/io/formats/style.py
attack68 Nov 25, 2022
eff3d92
Merge branch 'main' into style-concats
tsvikas Nov 28, 2022
c1cee9d
Merge branch 'main' into style-concats
tsvikas Nov 29, 2022
9cfb970
Update pandas/io/formats/style_render.py
mroeschke Dec 8, 2022
e416060
style: remove space in EOL
Dec 10, 2022
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updated documentation 
to explain the css of chained concats
  • Loading branch information
@tsvikas
tsvikas authored Nov 17, 2022
commit fe4be54911f279a1333c4ab9236097223a91ebb3
6 changes: 4 additions & 2 deletions pandas/io/formats/style.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,8 +318,10 @@ def concat(self, other: Styler) -> Styler:
original Styler
- ``css`` will be inherited from the original Styler, and the value of
keys ``data``, ``row_heading`` and ``row`` will be prepended with
``foot_``. If several stylers are chained, they will all have only one
``foot_`` prepended.
``foot0_``. If more concats are chained, their styles will be prepended
Copy link
Member

@mroeschke mroeschke Nov 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So if there is only 1 Styler, before foot_ would be prepended and now foot0_will be prepended?
Copy link
Member

@mroeschke mroeschke Dec 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't appear to have been addressed (please don't resolve unresolved conversations)
Copy link
Contributor

@attack68 attack68 Dec 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When chaining multiple Stylers the CSS needs a unique identifier. Previously it was only possible to compound multiple styler concatenations:

styler1.concat(styler2.concat(styler3))

which resulted in CSS classes None, foot_ and foot_foot_.

When allowing chained stylers you need an integer id, so

styler1.concat(styler2).concat(styler3.concat(styler4)).concat(styler5)

results in None, foot0_, foot1_ and foot1_foot0_, foot2_.

The CSS classes were not documented in 1.5.0 previously and not exposed to the user.
Here they are now amended and documented.
Copy link
Member

@mroeschke mroeschke Dec 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So just to confirm, a result with foot_ wasn't visible to the user previously and wouldn't see that foot0_ would now be returned?
Copy link
Contributor

@attack68 attack68 Dec 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

foot_ is returned as part of the HTML string in 1.5.0. All of the automatically generated styling CSS ids reference foot_ so that the rendered HTML table, including styles works correctly.

Now the HTML string returned will contain foot0_ and all the auto generated CSS ids will reference that instead.

Unless the user is specifically adding a CSS rule for foot either with an external stylesheet or using set_table_styles there will be no visible difference in the rendered HTML display, either in a JupyterLab or browser.

i.e.

styler2.applymap(lambda v: "color: red;") styler1.concat(styler2)

will display the same in both versions even though the CSS class names have been changed.
Copy link
Member

@mroeschke mroeschke Dec 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay thanks for the explanation!
with ``foot1_``, ''foot_2'', etc., and if a concatenated style have
another concatanated style, the second style will be prepended with
``foot{parent}_foot{child}_``.

A common use case is to concatenate user defined functions with
``DataFrame.agg`` or with described statistics via ``DataFrame.describe``.
Expand Down