CLN: Cleanup code according to code checks

Co-Authored-By: Dacops <[email protected]>

Author: diogomsmiranda

doc/source/whatsnew/v3.0.0.rst

@@ -39,6 +39,8 @@ Other enhancements
 - Users can globally disable any ``PerformanceWarning`` by setting the option ``mode.performance_warnings`` to ``False`` (:issue:`56920`)
 - :meth:`Styler.format_index_names` can now be used to format the index and column names (:issue:`48936` and :issue:`47489`)
 - :class:`.errors.DtypeWarning` improved to include column names when mixed data types are detected (:issue:`58174`)
+- :func:`DataFrame.to_excel` now supports writing notes to an excel files via :meth:`Styler.set_tooltips` (:issue:`58070`)
+- :func:`read_excel` now supports reading notes from an excel file (:issue:`58070`)
 - :meth:`DataFrame.corrwith` now accepts ``min_periods`` as optional arguments, as in :meth:`DataFrame.corr` and :meth:`Series.corr` (:issue:`9490`)
 - :meth:`DataFrame.cummin`, :meth:`DataFrame.cummax`, :meth:`DataFrame.cumprod` and :meth:`DataFrame.cumsum` methods now have a ``numeric_only`` parameter (:issue:`53072`)
 - :meth:`DataFrame.fillna` and :meth:`Series.fillna` can now accept ``value=None``; for non-object dtype the corresponding NA value will be used (:issue:`57723`)

pandas/core/generic.py

@@ -2131,7 +2131,6 @@ def _repr_data_resource_(self):
             Arbitrary keyword arguments passed to excel engine.
     """
         ),
-        extra_examples="",
     )
     def to_excel(
         self,
@@ -2263,7 +2262,6 @@ def to_excel(
         automatically chosen depending on the file extension):
 
         >>> df1.to_excel("output1.xlsx", engine="xlsxwriter")  # doctest: +SKIP
-        {extra_examples}
         """
         if engine_kwargs is None:
             engine_kwargs = {}

pandas/io/excel/_base.py

@@ -281,7 +281,7 @@
 engine_kwargs : dict, optional
     Arbitrary keyword arguments passed to excel engine.
 
-notes: DataFrame, default None
+notes : DataFrame, default None
     A DataFrame to hold the notes extracted from the Excel file.
 
 Returns
@@ -369,6 +369,10 @@
 ``set_tooltips(notes)`` method of ``Styler.to_excel``, like in
 the example below:
 
+>>> df = pd.DataFrame(
+...     [[1, 100, 200], [2, 200, 300], [3, 300, 400]],
+... )  # doctest: +SKIP
+
 >>> notes = pd.DataFrame(
 ...     [["note 1", "note 2"], ["", "note 4"], ["note 5", ""]],
 ... )  # doctest: +SKIP
@@ -1254,11 +1258,11 @@ def book(self) -> _WorkbookT:
     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 given formatted cells into Excel an excel sheet
@@ -1788,6 +1792,8 @@ def parse(
               DataFrame.
 
             .. versionadded:: 2.0
+        notes : DataFrame, default None
+            A DataFrame to hold the notes extracted from the Excel file.
         **kwds : dict, optional
             Arbitrary keyword arguments passed to excel engine.
 

pandas/io/excel/_openpyxl.py

@@ -539,7 +539,7 @@ def _write_cells(
                             for k, v in style_kwargs.items():
                                 setattr(xcell, k, v)
 
-        if notes is None:
+        if notes is None or notes_col is None:
             return
 
         for row_idx, (_, row) in enumerate(notes.iterrows()):

pandas/io/excel/_xlsxwriter.py

@@ -290,7 +290,7 @@ def _write_cells(
                     notes_col = startcol + cell.col
                 wks.write(startrow + cell.row, startcol + cell.col, val, style)
 
-        if notes is None:
+        if notes is None or notes_col is None:
             return
 
         for row_idx, (_, row) in enumerate(notes.iterrows()):

pandas/tests/io/excel/test_openpyxl.py

@@ -436,5 +436,5 @@ def test_read_notes_from_xlsx_files(datapath, ext):
     expected = DataFrame([["note 1", "note 2"], ["", "note 4"], ["note 5", ""]])
     result = DataFrame()
     pd.read_excel(path, engine="openpyxl", notes=result)
-    
+
     tm.assert_frame_equal(result, expected)

pandas/tests/io/excel/test_xlrd.py

@@ -82,4 +82,3 @@ def test_read_notes_from_xls_files(datapath, read_ext_xlrd):
     pd.read_excel(path, engine="xlrd", notes=result)
 
     tm.assert_frame_equal(result, expected)
-    

pandas/tests/io/excel/test_xlsxwriter.py

@@ -7,10 +7,6 @@
 
 from pandas.io.excel import ExcelWriter
 
-import pandas as pd
-
-import pandas._testing as tm
-
 xlsxwriter = pytest.importorskip("xlsxwriter")