chore: move autofilter tests from test_style to test_writers

fix: Handle multindex columns offset
feat: If autofilter is set together with merge_cells, raise an exception

Author: jarent-nvidia

pandas/io/formats/excel.py

@@ -949,26 +949,41 @@ def write(
             )
 
         if self.autofilter:
+            # default offset for header row
+            startrowsoffset = 1
+            endrowsoffset = 1
+
             if num_cols == 0:
                 indexoffset = 0
             elif self.index:
+                indexoffset = 0
                 if isinstance(self.df.index, MultiIndex):
-                    indexoffset = self.df.index.nlevels - 1
                     if self.merge_cells:
-                        warnings.warn(
-                            "Excel filters merged cells by showing only the first row."
-                            "'autofiler' and 'merge_cells' should not "
-                            "be used simultaneously.",
-                            UserWarning,
-                            stacklevel=find_stack_level(),
+                        raise ValueError(
+                            "Excel filters merged cells by showing only the first row. "
+                            "'autofilter' and 'merge_cells' cannot "
+                            "be used simultaneously."
+                        )
+                    else:
+                        indexoffset = self.df.index.nlevels - 1
+
+                if isinstance(self.columns, MultiIndex):
+                    if self.merge_cells:
+                        raise ValueError(
+                            "Excel filters merged cells by showing only the first row. "
+                            "'autofilter' and 'merge_cells' cannot "
+                            "be used simultaneously."
                         )
-                else:
-                    indexoffset = 0
+                    else:
+                        startrowsoffset = self.columns.nlevels
+                        # multindex columns add a blank row between header and data
+                        endrowsoffset = self.columns.nlevels + 1
             else:
+                # no index column
                 indexoffset = -1
-            start = f"{self._num2excel(startcol)}{startrow + 1}"
+            start = f"{self._num2excel(startcol)}{startrow + startrowsoffset}"
             autofilter_end_column = self._num2excel(startcol + num_cols + indexoffset)
-            end = f"{autofilter_end_column}{startrow + num_rows + 1}"
+            end = f"{autofilter_end_column}{startrow + num_rows + endrowsoffset}"
             autofilter_range = f"{start}:{end}"
         else:
             autofilter_range = None

pandas/tests/io/excel/test_style.py

@@ -350,89 +350,3 @@ def test_format_hierarchical_rows_periodindex(merge_cells):
             assert isinstance(cell.val, Timestamp), (
                 "Period should be converted to Timestamp"
             )
-
-
-@pytest.mark.parametrize("engine", ["xlsxwriter", "openpyxl"])
-@pytest.mark.parametrize("with_index", [True, False])
-def test_autofilter(engine, with_index, tmp_excel):
-    # GH 61194
-    df = DataFrame.from_dict([{"A": 1, "B": 2, "C": 3}, {"A": 4, "B": 5, "C": 6}])
-
-    with ExcelWriter(tmp_excel, engine=engine) as writer:
-        df.to_excel(writer, autofilter=True, index=with_index)
-
-    openpyxl = pytest.importorskip("openpyxl")  # test loading only with openpyxl
-    with contextlib.closing(openpyxl.load_workbook(tmp_excel)) as wb:
-        ws = wb.active
-
-        assert ws.auto_filter.ref is not None
-        assert ws.auto_filter.ref == "A1:D3" if with_index else "A1:C3"
-
-
-@pytest.mark.parametrize("engine", ["xlsxwriter", "openpyxl"])
-def test_autofilter_with_startrow_startcol(engine, tmp_excel):
-    # GH 61194
-    df = DataFrame.from_dict([{"A": 1, "B": 2, "C": 3}, {"A": 4, "B": 5, "C": 6}])
-    with ExcelWriter(tmp_excel, engine=engine) as writer:
-        df.to_excel(writer, autofilter=True, startrow=10, startcol=10)
-
-    openpyxl = pytest.importorskip("openpyxl")  # test loading only with openpyxl
-    with contextlib.closing(openpyxl.load_workbook(tmp_excel)) as wb:
-        ws = wb.active
-        assert ws.auto_filter.ref is not None
-        # Autofiler range moved by 10x10 cells
-        assert ws.auto_filter.ref == "K11:N13"
-
-
-def test_autofilter_not_supported_by_odf(tmp_path):
-    # GH 61194
-    # odf needs 'ods' extension
-    tmp_excel_ods = tmp_path / f"{uuid.uuid4()}.ods"
-    tmp_excel_ods.touch()
-
-    with pytest.raises(ValueError, match="Autofilter is not supported with odf!"):
-        with ExcelWriter(str(tmp_excel_ods), engine="odf") as writer:
-            DataFrame().to_excel(writer, autofilter=True, index=False)
-
-
-@pytest.mark.parametrize("engine", ["xlsxwriter", "openpyxl"])
-def test_autofilter_with_multiindex(engine, tmp_excel):
-    # GH 61194
-    df = DataFrame(
-        {
-            "animal": ("horse", "horse", "dog", "dog"),
-            "color of fur": ("black", "white", "grey", "black"),
-            "name": ("Blacky", "Wendy", "Rufus", "Catchy"),
-        }
-    )
-    # setup hierarchical index
-    mi_df = df.set_index(["animal", "color of fur"])
-    with ExcelWriter(tmp_excel, engine=engine) as writer:
-        mi_df.to_excel(writer, autofilter=True, index=True, merge_cells=False)
-
-    openpyxl = pytest.importorskip("openpyxl")  # test loading only with openpyxl
-    with contextlib.closing(openpyxl.load_workbook(tmp_excel)) as wb:
-        ws = wb.active
-
-        assert ws.auto_filter.ref is not None
-        assert ws.auto_filter.ref == "A1:C5"
-
-
-def test_autofilter_with_multiindex_and_merge_cells_shows_warning(tmp_excel):
-    # GH 61194
-    df = DataFrame(
-        {
-            "animal": ("horse", "horse", "dog", "dog"),
-            "color of fur": ("black", "white", "grey", "black"),
-            "name": ("Blacky", "Wendy", "Rufus", "Catchy"),
-        }
-    )
-    # setup hierarchical index
-    mi_df = df.set_index(["animal", "color of fur"])
-    with ExcelWriter(tmp_excel, engine="openpyxl") as writer:
-        with tm.assert_produces_warning(
-            UserWarning,
-            match="Excel filters merged cells by showing only the first row."
-            "'autofiler' and 'merge_cells' should not be used simultaneously.",
-        ):
-            mi_df.to_excel(writer, autofilter=True, index=True, merge_cells=True)

pandas/tests/io/excel/test_writers.py

@@ -1,3 +1,4 @@
+import contextlib
 from datetime import (
     date,
     datetime,
@@ -1510,6 +1511,163 @@ def test_to_excel_raising_warning_when_cell_character_exceed_limit(self):
             buf = BytesIO()
             df.to_excel(buf)
 
+    @pytest.mark.parametrize("with_index", [True, False])
+    def test_autofilter(self, engine, with_index, tmp_excel):
+        # GH 61194
+        df = DataFrame.from_dict([{"A": 1, "B": 2, "C": 3}, {"A": 4, "B": 5, "C": 6}])
+
+        if engine in ["odf"]:
+            with pytest.raises(
+                ValueError, match="Autofilter is not supported with odf!"
+            ):
+                df.to_excel(tmp_excel, engine=engine, autofilter=True, index=False)
+        else:
+            df.to_excel(tmp_excel, engine=engine, autofilter=True, index=with_index)
+
+            openpyxl = pytest.importorskip(
+                "openpyxl"
+            )  # test loading only with openpyxl
+            with contextlib.closing(openpyxl.load_workbook(tmp_excel)) as wb:
+                ws = wb.active
+
+                assert ws.auto_filter.ref is not None
+                assert ws.auto_filter.ref == "A1:D3" if with_index else "A1:C3"
+
+    def test_autofilter_with_startrow_startcol(self, engine, tmp_excel):
+        # GH 61194
+        df = DataFrame.from_dict([{"A": 1, "B": 2, "C": 3}, {"A": 4, "B": 5, "C": 6}])
+
+        if engine in ["odf"]:
+            # odf does not support autofilter
+            with pytest.raises(
+                ValueError, match="Autofilter is not supported with odf!"
+            ):
+                df.to_excel(tmp_excel, engine=engine, autofilter=True, index=False)
+        else:
+            df.to_excel(
+                tmp_excel, engine=engine, autofilter=True, startrow=10, startcol=10
+            )
+
+            openpyxl = pytest.importorskip(
+                "openpyxl"
+            )  # test loading only with openpyxl
+            with contextlib.closing(openpyxl.load_workbook(tmp_excel)) as wb:
+                ws = wb.active
+                assert ws.auto_filter.ref is not None
+                # Autofiler range moved by 10x10 cells
+                assert ws.auto_filter.ref == "K11:N13"
+
+    @pytest.mark.parametrize("merge_cells", [True, False])
+    def test_autofilter_with_multiindex_index(self, engine, tmp_excel, merge_cells):
+        # GH 61194
+        df = DataFrame(
+            {
+                "animal": ("horse", "horse", "dog", "dog"),
+                "color of fur": ("black", "white", "grey", "black"),
+                "name": ("Blacky", "Wendy", "Rufus", "Catchy"),
+            }
+        )
+        # setup hierarchical index
+        mi_df = df.set_index(["animal", "color of fur"])
+        if engine in ["odf"]:
+            # odf does not support autofilter
+            with pytest.raises(
+                ValueError, match="Autofilter is not supported with odf!"
+            ):
+                mi_df.to_excel(
+                    tmp_excel,
+                    engine=engine,
+                    autofilter=True,
+                    index=False,
+                    merge_cells=merge_cells,
+                )
+        elif merge_cells:
+            # multiindex and merge cells cannot be used simultaneously
+            with pytest.raises(
+                ValueError,
+                match="Excel filters merged cells by showing only the first row. "
+                "'autofilter' and 'merge_cells' cannot be used simultaneously.",
+            ):
+                mi_df.to_excel(
+                    tmp_excel,
+                    engine=engine,
+                    autofilter=True,
+                    index=True,
+                    merge_cells=merge_cells,
+                )
+        else:
+            mi_df.to_excel(
+                tmp_excel,
+                engine=engine,
+                autofilter=True,
+                index=True,
+                merge_cells=merge_cells,
+            )
+
+            # validate autofilter range
+            openpyxl = pytest.importorskip(
+                "openpyxl"
+            )  # test loading only with openpyxl
+            with contextlib.closing(openpyxl.load_workbook(tmp_excel)) as wb:
+                ws = wb.active
+
+                assert ws.auto_filter.ref is not None
+                assert ws.auto_filter.ref == "A1:C5"
+
+    @pytest.mark.parametrize("merge_cells", [True, False])
+    def test_autofilter_with_multiindex_columns(self, engine, tmp_excel, merge_cells):
+        # GH 61194
+        columns = MultiIndex(
+            levels=[["x", "y"], ["w", "t"]],
+            codes=[[0, 0, 1], [0, 1, 0]],
+        )
+        df = DataFrame([[1, 2, 3], [4, 5, 6]], columns=columns)
+
+        if engine in ["odf"]:
+            # odf does not support autofilter
+            with pytest.raises(
+                ValueError, match="Autofilter is not supported with odf!"
+            ):
+                df.to_excel(
+                    tmp_excel,
+                    engine=engine,
+                    autofilter=True,
+                    index=False,
+                    merge_cells=merge_cells,
+                )
+        elif merge_cells:
+            # multiindex and merge cells cannot be used simultaneously
+            with pytest.raises(
+                ValueError,
+                match="Excel filters merged cells by showing only the first row. "
+                "'autofilter' and 'merge_cells' cannot be used simultaneously.",
+            ):
+                df.to_excel(
+                    tmp_excel,
+                    engine=engine,
+                    autofilter=True,
+                    index=True,
+                    merge_cells=merge_cells,
+                )
+        else:
+            df.to_excel(
+                tmp_excel,
+                engine=engine,
+                autofilter=True,
+                index=True,
+                merge_cells=merge_cells,
+            )
+
+            # validate autofilter range
+            openpyxl = pytest.importorskip(
+                "openpyxl"
+            )  # test loading only with openpyxl
+            with contextlib.closing(openpyxl.load_workbook(tmp_excel)) as wb:
+                ws = wb.active
+
+                assert ws.auto_filter.ref is not None
+                assert ws.auto_filter.ref == "A2:D5"
+
 
 class TestExcelWriterEngineTests:
     @pytest.mark.parametrize(