ENH: Allow writing excel comments, via tooltips (xlsxwriter engine) (pandas-dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>

Author: Dacops

pandas/io/excel/_base.py

@@ -1209,6 +1209,7 @@ def book(self) -> _WorkbookT:
     def _write_cells(
         self,
         cells,
+        notes,
         sheet_name: str | None = None,
         startrow: int = 0,
         startcol: int = 0,
@@ -1221,6 +1222,8 @@ def _write_cells(
         ----------
         cells : generator
             cell of formatted data to save to Excel sheet
+        notes : dataframe
+            dataframe that holds notes to write
         sheet_name : str, default None
             Name of Excel sheet, if None, then use self.cur_sheet
         startrow : upper left cell row to dump data frame

pandas/io/excel/_xlsxwriter.py

@@ -241,6 +241,7 @@ def _save(self) -> None:
     def _write_cells(
         self,
         cells,
+        notes,
         sheet_name: str | None = None,
         startrow: int = 0,
         startcol: int = 0,
@@ -258,6 +259,8 @@ def _write_cells(
         if validate_freeze_panes(freeze_panes):
             wks.freeze_panes(*(freeze_panes))
 
+        notes_col = None
+
         for cell in cells:
             val, fmt = self._value_with_fmt(cell.val)
 
@@ -281,4 +284,17 @@ def _write_cells(
                     style,
                 )
             else:
+                if notes_col is None:
+                    notes_col = startcol + cell.col
                 wks.write(startrow + cell.row, startcol + cell.col, val, style)
+
+        if notes is None:
+            return
+
+        for row_idx, (_, row) in enumerate(notes.iterrows()):
+            for col_idx, note in enumerate(row):
+                wks.write_comment(
+                    row_idx + 1,  # first row has columns
+                    col_idx + notes_col,  # n columns with indexes
+                    str(note),
+                )

pandas/io/formats/excel.py

@@ -554,6 +554,9 @@ def __init__(
         self.rowcounter = 0
         self.na_rep = na_rep
         if not isinstance(df, DataFrame):
+            self.notes = None
+            if df.tooltips is not None:
+                self.notes = df.tooltips.tt_data
             self.styler = df
             self.styler._compute()  # calculate applied styles
             df = df.data
@@ -880,6 +883,9 @@ def get_formatted_cells(self) -> Iterable[ExcelCell]:
             cell.val = self._format_value(cell.val)
             yield cell
 
+    def get_notes(self) -> Iterable[str]:
+        yield from self.notes.iterrows()
+
     @doc(storage_options=_shared_docs["storage_options"])
     def write(
         self,
@@ -941,6 +947,7 @@ def write(
         try:
             writer._write_cells(
                 formatted_cells,
+                self.notes,
                 sheet_name,
                 startrow=startrow,
                 startcol=startcol,