Skip to content

ENH: styler.to_excel to support excel notes as implementation of tooltips #58070

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

Jump to bottom
Open
1 of 3 tasks
sdementen opened this issue Mar 29, 2024 · 6 comments
Open
1 of 3 tasks

ENH: styler.to_excel to support excel notes as implementation of tooltips #58070

sdementen opened this issue Mar 29, 2024 · 6 comments
Assignees
@Dacops @diogomsmiranda
Labels
Enhancement IO Excel read_excel, to_excel Styler conditional formatting using DataFrame.style

Comments

@sdementen
Copy link
Contributor

Feature Type

  • Adding new functionality to pandas

  • Changing existing functionality in pandas

  • Removing existing functionality in pandas

Problem Description

I wish I could use set_tooltips in the styler to generate notes in an excel workbook (via the to_excel)

Feature Description

No real API change, but have the ExcelFormatter use the information set by styler.set_tooltips to create not on the cells with a tooltip

Alternative Solutions

No idea for an alternative except the statu quo...

Additional Context

No response
@sdementen sdementen added Enhancement Needs Triage Issue that has not been reviewed by a pandas team member labels Mar 29, 2024
@rhshadrach
Copy link
Member

Thanks for the request. The proposed behavior here seems intuitive to me, I'm supportive of this as long as the implementation is reasonable.

cc @attack68 for thoughts.

@rhshadrach rhshadrach added Needs Discussion Requires discussion from core team before further action IO Excel read_excel, to_excel Styler conditional formatting using DataFrame.style and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Mar 31, 2024
@rhshadrach
Copy link
Member

One difficulty I've encountered in the past is getting the comment size correct. If you do not set the size of a long comment (at least, using xlsxwriter), the comment is very difficult to read without resizing in Excel.

@attack68
Copy link
Contributor

attack68 commented Apr 1, 2024

I think the implementation would not be too complicated.

The Styler Tooltips object contains a DataFrame of strings that would serve as the data to the written excel cells.

I expect that xlswriter procedure could check for the existence of a Tooltips object. If none writing to excel is unchanged and performance identical. If it exists then the yielded excel cells would have an extended routine to write the comment as provided by the tooltips string.

Not sure that Tooltips is a widely used feature, however, but if someone was willing to explore this implementation I would help review.

@rhshadrach rhshadrach removed the Needs Discussion Requires discussion from core team before further action label Apr 14, 2024
@Dacops
Copy link

Dacops commented Apr 25, 2024

Hi, this seems like an interesting issue that me and my colleague @diogomsmiranda would like to tackle. If we have any doubt about it we'll reply on this thread

@Dacops
Copy link

Dacops commented Apr 25, 2024

take

@diogomsmiranda
Copy link

take

diogomsmiranda added a commit to Dacops/pandas that referenced this issue May 24, 2024
@Dacops @diogomsmiranda
ENH: Allow writing excel comments, via tooltips (xlsxwriter engine) (p…
c5c4854 
…andas-dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>
diogomsmiranda added a commit to Dacops/pandas that referenced this issue May 24, 2024
@Dacops @diogomsmiranda
ENH: Add support to read excel notes (xlrd engine) (pandas-dev#58070)
2f2d3a0 
Co-authored-by: diogomsmiranda <[email protected]>
diogomsmiranda added a commit to Dacops/pandas that referenced this issue May 24, 2024
@Dacops @diogomsmiranda
ENH: Add support for writing excel comments (openpyxl engine) (pandas…
780c3d1 
…-dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>
diogomsmiranda added a commit to Dacops/pandas that referenced this issue May 24, 2024
@diogomsmiranda @Dacops
ENH: Add support to read notes from excel (openpyxl engine) (pandas-d…
b5fc90f 
…ev#58070)

Co-authored-by: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
DOC: Showcase writing comments in Styler.to_excel() (pandas-dev#58070)
bd039d4 
Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
ENH: Add support to read excel notes (xlrd engine) (pandas-dev#58070)
6c2d5b7 
Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
DOC: Showcase usage of argument notes in pandas.read_excel() (pandas-…
3404fa3 
…dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
ENH: Add support for writing excel comments (openpyxl engine) (pandas…
6b40c6c 
…-dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
CLN: Simplify _xlrd engine method to get notes (pandas-dev#58070)
c99dba3 
Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@diogomsmiranda @Dacops
ENH: Add support to read notes from excel (openpyxl engine) (pandas-d…
1bb8678 
…ev#58070)

Co-authored-by: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
CLN: Raise exceptions when trying to write notes while using unsuppor…
0045601 
…ted engines (pandas-dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@diogomsmiranda @Dacops
CLN: Raise exceptions when trying to read notes while using unsupport…
716de7b 
…ed engines (pandas-dev#58070)

Co-authored-by: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@diogomsmiranda @Dacops
TST: Add test cases for xlsxwriter, openpyxl, odswriter and odfreader (…
702eefa 
…pandas-dev#58070)

Co-authored-by: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@diogomsmiranda @Dacops
ENH: Add new "default" engine argument when notes is not None (openpy…
56fe9bb 
…xl engine) (pandas-dev#58070)

Co-Authored-By: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
ENH: Allow writing excel comments, via tooltips (xlsxwriter engine) (p…
31f1c9d 
…andas-dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
ENH: Add support to read excel notes (xlrd engine) (pandas-dev#58070)
d8a6705 
Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
DOC: Showcase usage of argument notes in pandas.read_excel() (pandas-…
fc3b368 
…dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
ENH: Add support for writing excel comments (openpyxl engine) (pandas…
5b7390b 
…-dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
CLN: Simplify _xlrd engine method to get notes (pandas-dev#58070)
f6d6387 
Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@diogomsmiranda @Dacops
ENH: Add support to read notes from excel (openpyxl engine) (pandas-d…
0bf6364 
…ev#58070)

Co-authored-by: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@Dacops @diogomsmiranda
CLN: Raise note writing exceptions for unsupported engines (pandas-de…
400e97b 
…v#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@diogomsmiranda @Dacops
CLN: Raise note reading exceptions for unsupported engines (pandas-de…
4767491 
…v#58070)

Co-authored-by: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@diogomsmiranda @Dacops
TST: Add test cases for note reading/writing (pandas-dev#58070)
cf75c28 
Co-authored-by: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue May 25, 2024
@diogomsmiranda @Dacops
ENH: Add "default" engine argument for note reading (openpyxl) (panda…
364995f 
…s-dev#58070)

Co-Authored-By: Dacops <[email protected]>
@diogomsmiranda diogomsmiranda mentioned this issue May 26, 2024
Closed
5 tasks
Dacops added a commit to Dacops/pandas that referenced this issue Jun 6, 2024
@Dacops @diogomsmiranda
ENH: Write excel comments, via tooltips (xlsxwriter engine) (pandas-d…
f036b41 
…ev#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 6, 2024
@Dacops @diogomsmiranda
DOC: Showcase writing comments in Styler.to_excel() (pandas-dev#58070)
c928775 
Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 6, 2024
@Dacops @diogomsmiranda
ENH: Add support to read excel notes (xlrd engine) (pandas-dev#58070)
29d56c2 
Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 6, 2024
@Dacops @diogomsmiranda
DOC: Showcase usage of argument notes in pandas.read_excel() (pandas-…
752813d 
…dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 6, 2024
@Dacops @diogomsmiranda
ENH: Add support for writing excel comments (openpyxl engine) (pandas…
206562e 
…-dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 6, 2024
@Dacops @diogomsmiranda
CLN: Simplify _xlrd engine method to get notes (pandas-dev#58070)
5b9d700 
Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 6, 2024
@diogomsmiranda @Dacops
ENH: Add support to read notes from excel (openpyxl engine) (pandas-d…
948deac 
…ev#58070)

Co-authored-by: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 6, 2024
@Dacops @diogomsmiranda
CLN: Raise note writing exceptions for unsupported engines (pandas-de…
aba54de 
…v#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 6, 2024
@diogomsmiranda @Dacops
CLN: Raise note reading exceptions for unsupported engines (pandas-de…
8deb2ef 
…v#58070)

Co-authored-by: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 6, 2024
@diogomsmiranda @Dacops
TST: Add test cases for note reading/writing (pandas-dev#58070)
ecd10d8 
Co-authored-by: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 8, 2024
@Dacops @diogomsmiranda
ENH: Write excel comments, via tooltips (pandas-dev#58070)
9dd415a 
Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 9, 2024
@Dacops @diogomsmiranda
ENH: Write excel comments, via tooltips (pandas-dev#58070)
a0f4b3b 
Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 9, 2024
@Dacops @diogomsmiranda
ENH: Write excel comments, via tooltips (pandas-dev#58070)
2913e11 
Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 9, 2024
@Dacops @diogomsmiranda
ENH: Write excel comments, via styler.to_excel() tooltips (pandas-dev…
7ed8fb5 
…#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 16, 2024
@Dacops @diogomsmiranda
ENH: Write excel comments, via styler.to_excel() tooltips (pandas-dev…
83896cf 
…#58070)

Co-authored-by: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 16, 2024
@Dacops @diogomsmiranda
ENH: Write excel comments, via styler.to_excel() tooltips (pandas-dev…
f57b587 
…#58070)

Co-authored-by: diogomsmiranda <[email protected]>
diogomsmiranda pushed a commit to Dacops/pandas that referenced this issue Jun 17, 2024
@Dacops @diogomsmiranda
ENH: Write excel comments, via styler.to_excel() tooltips (pandas-dev…
7d3558c 
…#58070)

Co-Authored-By: Dacops <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 20, 2024
@Dacops @diogomsmiranda
ENH: Write excel comments, via styler.to_excel() tooltips (pandas-dev…
ab68132 
…#58070)

Co-Authored-By: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jun 20, 2024
@Dacops @diogomsmiranda
ENH: Write excel comments, via styler.to_excel() tooltips (pandas-dev…
9ac1ea4 
…#58070)

Co-Authored-By: diogomsmiranda <[email protected]>
Dacops added a commit to Dacops/pandas that referenced this issue Jul 12, 2024
@Dacops @diogomsmiranda
ENH: Write excel comments, via styler.to_excel() tooltips (pandas-dev…
b45f14a 
…#58070)

Co-Authored-By: diogomsmiranda <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Dacops Dacops

@diogomsmiranda diogomsmiranda

Labels
Enhancement IO Excel read_excel, to_excel Styler conditional formatting using DataFrame.style
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Support writing/reading notes to/from excel files Dacops/pandas
5 participants
@sdementen @attack68 @rhshadrach @Dacops @diogomsmiranda