CLN: Raise exceptions when trying to write notes while using unsupported engines (pandas-dev#58070)

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

Author: Dacops

pandas/io/excel/_odswriter.py

@@ -27,6 +27,8 @@
         WriteExcelBuffer,
     )
 
+    from pandas.core.frame import DataFrame
+
     from pandas.io.formats.excel import ExcelCell
 
 
@@ -99,6 +101,7 @@ def _write_cells(
         startrow: int = 0,
         startcol: int = 0,
         freeze_panes: tuple[int, int] | None = None,
+        notes: DataFrame | None = None,
     ) -> None:
         """
         Write the frame cells using odf
@@ -110,6 +113,14 @@ def _write_cells(
         )
         from odf.text import P
 
+        if notes is not None:
+            raise NotImplementedError(
+                """
+                Notes are not supported by the odswriter engine,
+                see https://github.com/mmulqueen/odswriter
+                """
+            )
+
         sheet_name = self._get_sheet_name(sheet_name)
         assert sheet_name is not None
 

pandas/io/excel/_openpyxl.py

@@ -445,11 +445,11 @@ def _convert_to_protection(cls, protection_dict):
     def _write_cells(
         self,
         cells,
-        notes,
         sheet_name: str | None = None,
         startrow: int = 0,
         startcol: int = 0,
         freeze_panes: tuple[int, int] | None = None,
+        notes: DataFrame | None = None,
     ) -> None:
         from openpyxl.comments import Comment
 

pandas/io/excel/_xlsxwriter.py

@@ -20,6 +20,8 @@
         WriteExcelBuffer,
     )
 
+    from pandas.core.frame import DataFrame
+
 
 class _XlsxStyler:
     # Map from openpyxl-oriented styles to flatter xlsxwriter representation
@@ -241,11 +243,11 @@ def _save(self) -> None:
     def _write_cells(
         self,
         cells,
-        notes,
         sheet_name: str | None = None,
         startrow: int = 0,
         startcol: int = 0,
         freeze_panes: tuple[int, int] | None = None,
+        notes: DataFrame | None = None,
     ) -> None:
         # Write the frame cells using xlsxwriter.
         sheet_name = self._get_sheet_name(sheet_name)

pandas/io/formats/excel.py

@@ -553,8 +553,8 @@ def __init__(
     ) -> None:
         self.rowcounter = 0
         self.na_rep = na_rep
+        self.notes = None
         if not isinstance(df, DataFrame):
-            self.notes = None
             if df.tooltips is not None:
                 self.notes = df.tooltips.tt_data
             self.styler = df
@@ -947,11 +947,11 @@ def write(
         try:
             writer._write_cells(
                 formatted_cells,
-                self.notes,
                 sheet_name,
                 startrow=startrow,
                 startcol=startcol,
                 freeze_panes=freeze_panes,
+                notes=self.notes,
             )
         finally:
             # make sure to close opened file handles