ENH: Styler tooltips feature #35643

attack68 · 2020-08-09T12:41:11Z

closes [Enhancement Request] Styler support for tooltips. #21266
tests added / passed
passes black pandas
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

This is a draft PR to address 21266: Tooltips for DataFrames in Styler.

This PR has the following objectives:

Add functionality whilst being completely (almost) decoupled from the rest of the HTML rendering process
Be fully backwards compatible and have no impact at all on previous Styler's that have never used tooltips.
Use pseudo CSS class rendering via table_styles to control the visualisation of the tooltips.

To address 1) the architecture was simple:

If tooltips are detected then an additional HTML element is added to every data cell: <span class="pd-t"></span>. If tooltips are not detected (by default) nothing is done.
Add generic table level CSS for the tooltip class, hiding tooltips by default but positioning, sizing, and coloring them.
Loop through a tooltips DataFrame and based on the row and col index add additional content to the element using the ::after pseudo-element targeting the exact cell id. This is table level also. Rendering is performed as the last step.

To address 2) default values ensure the functions make no changes unless set_tooltips has been called.

Extensions

The very simple architecture requires a DataFrame of tooltips to be supplied. This requires the user to have constructed it privately (possibly using the regular DataFrame.apply and DataFrame.applymap) methods. These could be incorporated.

It would also be better to only add extra HTML elements to data cells that have tooltips. This requires conditional looping of the render dict, which I haven't included here to save on initial complexity. For small dataframes it is also irrelevant.

However, given my time constraints I would rather leave this to a more available and more competent developer!!

Comments welcome..

pep8speaks · 2020-08-09T12:41:16Z

Hello @attack68! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-01-16 10:41:11 UTC

pandas/tests/io/formats/test_style.py

attack68 · 2020-08-20T16:13:18Z

@reviewers: this is ready to be reviewed. All green, except for known unrelated issues

attack68 · 2020-08-28T19:10:00Z

@TomAugspurger @WillAyd you both commented on the underlying issue. Would you care to review this pull request for suitability?

TomAugspurger · 2020-08-31T11:50:23Z

It'll be a while before I can look. No need to hold it up for me.

…

On Fri, Aug 28, 2020 at 2:10 PM attack68 ***@***.***> wrote: @TomAugspurger <https://github.com/TomAugspurger> @WillAyd <https://github.com/WillAyd> you both commented on the underlying issue. Would you care to review this pull request for suitability? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#35643 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKAOIXGGVOYJUO2GU73BJ3SC76JNANCNFSM4PZFPFBQ> .

jreback

looks reasonable, some comments

jreback · 2020-09-05T18:04:22Z

doc/source/user_guide/style.ipynb

@@ -1241,4 +1241,4 @@
 },
 "nbformat": 4,
 "nbformat_minor": 1
-}
+}


can you revert this

i've no real experience with selected git revert, doesn't it just get squashed?

git checkout upstream/master doc/source/user_guide/style.ipynb and commit the result

pandas/io/formats/style.py

attack68 · 2020-11-06T23:13:35Z

@jreback @WillAyd this is still live, but it needs agreement on whether you want list comprehensions (previous change request) or not (new request), style wise.

to be honest I think the latest version (jreback's request) is cleanest.

hamishdarbyshire · 2020-11-15T15:02:10Z

would be good to to have the 1.2 milestone on this and then I can work on improving the documentation for all the Styler enhancements I have contributed in subsequent minor versions..

@jreback

attack68 · 2020-11-15T15:04:04Z

apologies for posting with wrong account above: work not personal.

attack68 · 2020-12-18T07:11:40Z

@WillAyd @jreback can this get a 1.2 milestone tag - all my other Styler PRs made it in and it would be great if this last one could be added.

I can then update the documentation notebook with examples of all new features.

jreback

i know you really want this for 1.2, but it needs some work, if you can turn it around shortly then we can do

pandas/io/formats/style.py

jreback · 2020-12-22T00:32:45Z

pandas/io/formats/style.py

@@ -540,6 +627,7 @@ def render(self, **kwargs) -> str:
        self._compute()
        # TODO: namespace all the pandas keys
        d = self._translate()
+        d = self.tooltips._translate_tooltips(self.data, self.uuid, d)


this is very confusing here, why is this not part of _translate itself?

pandas/io/formats/style.py

jreback · 2020-12-22T00:35:58Z

pandas/io/formats/style.py

+            for style in sublist
+        ]
+
+        if self.table_styles:


i am puzzled by this here why this is involved at all

the above table_styles will be an empty list if there are no tooltips to add, i.e if the mask was empty. In that case this if check provides some efficiency by avoiding adding a <span> html selector to every table cell.

ok can you add that as a comment

can you update this

i added a comment line 1938?

jreback

looks good, some small comments. ping on green.

assume that you will do a followon to add docs to the style notebook? (can also be in this PR)

pandas/io/formats/style.py

jreback · 2021-01-08T14:46:59Z

pandas/io/formats/style.py

+            for style in sublist
+        ]
+
+        if self.table_styles:


ok can you add that as a comment

jreback

looks good a question and comment.

pandas/io/formats/style.py

jreback · 2021-01-14T14:29:10Z

pandas/io/formats/style.py

+            for style in sublist
+        ]
+
+        if self.table_styles:


can you update this

jreback · 2021-01-14T18:50:33Z

ok @attack68 can you resolve this precommit issue:
pandas/io/formats/style.py:809: error: Attribute 'tooltips' already defined on line 185 [no-redef]

merge master and ping on green-ish

…eature # Conflicts: # doc/source/whatsnew/v1.3.0.rst

attack68 · 2021-01-17T08:52:08Z

@jreback fixed, green-ish... ping.

jreback

thanks @attack68

would not object to a PR to split up pandas/io/formats/style.py to submodules in the future as this file is getting kind of long / including multiple functionaility.

simonjayhawkins · 2021-01-17T16:11:23Z

@jreback this broke pre-commit on master. will fix up shortly so feel free to carry on merging PRs to master

jreback · 2021-01-17T22:20:36Z

thanks @simonjayhawkins

attack68 changed the title ~~Styler tooltips feature~~ ENH: Styler tooltips feature Aug 9, 2020

attack68 marked this pull request as draft August 9, 2020 12:53

attack68 marked this pull request as ready for review August 9, 2020 13:35

attack68 commented Aug 10, 2020

View reviewed changes

pandas/tests/io/formats/test_style.py Show resolved Hide resolved

attack68 commented Aug 10, 2020

View reviewed changes

pandas/tests/io/formats/test_style.py Outdated Show resolved Hide resolved

jreback added Styler conditional formatting using DataFrame.style Enhancement labels Aug 13, 2020

attack68 force-pushed the styler_tooltips_feature branch from cdaf9d9 to 1598830 Compare August 18, 2020 09:52

attack68 force-pushed the styler_tooltips_feature branch from 6a69f83 to c18103b Compare August 26, 2020 06:04

attack68 added 14 commits August 28, 2020 18:00

ENH: Styler can add tooltips directly from a DataFrame of strings

3e83fc6

ENH: black fix

f8ffbbe

ENH: test to ensure tooltip class ignored if set_tooltips not called.

b92d255

ENH: pep8 line length

cd6c5f2

ENH: pep8 line length

1f61e87

ENH: test fixes: Linting and Typing

af83833

ENH: add in calling the render step!

078c0bb

ENH: mypy Type specification changes

eeddd19

improve tests, integrate into styler.clear()

6389811

add GH

e7557f5

black fix

64f789a

update docs

0b1e930

update docs

5ca86a5

improve test

f798852

attack68 force-pushed the styler_tooltips_feature branch from c18103b to f798852 Compare August 28, 2020 16:00

attack68 mentioned this pull request Sep 2, 2020

QST: What is the use of cell_context in the Styler? #35998

Closed

2 tasks

jreback requested changes Sep 5, 2020

View reviewed changes

github-actions bot added the Stale label Oct 30, 2020

jreback requested changes Dec 22, 2020

View reviewed changes

attack68 added 5 commits January 5, 2021 11:20

merged into upstream/master

c0b004e

requested changes jreback

e4a5e20

requested changes jreback

849b1f4

requested changes jreback

950b3b1

pre commit fails fix

efc7fca

attack68 requested review from jreback and WillAyd January 8, 2021 07:22

jreback requested changes Jan 8, 2021

View reviewed changes

minor requests

eb7fe68

jreback requested changes Jan 14, 2021

View reviewed changes

attack68 requested a review from jreback January 14, 2021 18:45

attack68 added 2 commits January 16, 2021 11:37

resolve duplicate typing

5a377b8

Merge remote-tracking branch 'upstream/master' into styler_tooltips_f…

54c52da

…eature # Conflicts: # doc/source/whatsnew/v1.3.0.rst

attack68 force-pushed the styler_tooltips_feature branch from a29719d to 54c52da Compare January 16, 2021 10:41

jreback approved these changes Jan 17, 2021

View reviewed changes

jreback added this to the 1.3 milestone Jan 17, 2021

jreback merged commit 085ba15 into pandas-dev:master Jan 17, 2021

luckyvs1 pushed a commit to luckyvs1/pandas that referenced this pull request Jan 20, 2021

ENH: Styler tooltips feature (pandas-dev#35643)

67baedd

attack68 deleted the styler_tooltips_feature branch January 21, 2021 06:46

nofarm3 pushed a commit to nofarm3/pandas that referenced this pull request Jan 21, 2021

ENH: Styler tooltips feature (pandas-dev#35643)

33c0015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENH: Styler tooltips feature #35643

ENH: Styler tooltips feature #35643

attack68 commented Aug 9, 2020 •

edited

Loading

pep8speaks commented Aug 9, 2020 •

edited

Loading

attack68 commented Aug 20, 2020

attack68 commented Aug 28, 2020

TomAugspurger commented Aug 31, 2020 via email

jreback left a comment

jreback Sep 5, 2020

attack68 Sep 6, 2020

WillAyd Sep 21, 2020

attack68 commented Nov 6, 2020

hamishdarbyshire commented Nov 15, 2020

attack68 commented Nov 15, 2020

attack68 commented Dec 18, 2020

jreback left a comment

jreback Dec 22, 2020

jreback Dec 22, 2020

attack68 Jan 5, 2021

jreback Jan 8, 2021

jreback Jan 14, 2021

attack68 Jan 14, 2021

jreback left a comment

jreback Jan 8, 2021

jreback left a comment

jreback Jan 14, 2021

jreback commented Jan 14, 2021

attack68 commented Jan 17, 2021

jreback left a comment

simonjayhawkins commented Jan 17, 2021

jreback commented Jan 17, 2021

ENH: Styler tooltips feature #35643

ENH: Styler tooltips feature #35643

Conversation

attack68 commented Aug 9, 2020 • edited Loading

Extensions

pep8speaks commented Aug 9, 2020 • edited Loading

Comment last updated at 2021-01-16 10:41:11 UTC

attack68 commented Aug 20, 2020

attack68 commented Aug 28, 2020

TomAugspurger commented Aug 31, 2020 via email

jreback left a 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 commented Nov 6, 2020

hamishdarbyshire commented Nov 15, 2020

attack68 commented Nov 15, 2020

attack68 commented Dec 18, 2020

jreback left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Jan 14, 2021

attack68 commented Jan 17, 2021

jreback left a comment

Choose a reason for hiding this comment

simonjayhawkins commented Jan 17, 2021

jreback commented Jan 17, 2021

attack68 commented Aug 9, 2020 •

edited

Loading

pep8speaks commented Aug 9, 2020 •

edited

Loading