rename: applymap_header -->> applymap_index

pandas-dev · jreback · Aug 11, 2021 · Jun 9, 2021 · Jun 9, 2021 · Jun 9, 2021
commit 81f3a3c04629f0c162dc3519798d8217de9aca25
diff --git a/doc/source/reference/style.rst b/doc/source/reference/style.rst
@@ -36,8 +36,8 @@ Style application
 
    Styler.apply
    Styler.applymap
-   Styler.apply_header
-   Styler.applymap_header
+   Styler.apply_index
+   Styler.applymap_index
    Styler.format
    Styler.hide_index
    Styler.hide_columns

diff --git a/doc/source/whatsnew/v1.4.0.rst b/doc/source/whatsnew/v1.4.0.rst
@@ -38,7 +38,7 @@ Other enhancements
 - :meth:`Series.ewm`, :meth:`DataFrame.ewm`, now support a ``method`` argument with a ``'table'`` option that performs the windowing operation over an entire :class:`DataFrame`. See :ref:`Window Overview <window.overview>` for performance and functional benefits (:issue:`42273`)
 - Added ``sparse_index`` and ``sparse_columns`` keyword arguments to :meth:`.Styler.to_html` (:issue:`41946`)
 - Added keyword argument ``environment`` to :meth:`.Styler.to_latex` also allowing a specific "longtable" entry with a separate jinja2 template (:issue:`41866`)
-- :meth:`.Styler.apply_header` and :meth:`.Styler.applymap_header` added to allow conditional styling of index and column header values (:issue:`41893`)
+- :meth:`.Styler.apply_index` and :meth:`.Styler.applymap_index` added to allow conditional styling of index and column header values (:issue:`41893`)
 - :meth:`.GroupBy.cummin` and :meth:`.GroupBy.cummax` now support the argument ``skipna`` (:issue:`34047`)
 -
 

diff --git a/pandas/io/formats/style.py b/pandas/io/formats/style.py
@@ -1199,8 +1199,8 @@ def apply(
 
         See Also
         --------
-        Styler.applymap_header: Apply a CSS-styling function to headers elementwise.
-        Styler.apply_header: Apply a CSS-styling function to headers level-wise.
+        Styler.applymap_index: Apply a CSS-styling function to headers elementwise.
+        Styler.apply_index: Apply a CSS-styling function to headers level-wise.
         Styler.applymap: Apply a CSS-styling function elementwise.
 
         Notes
@@ -1244,7 +1244,7 @@ def apply(
         )
         return self
 
-    def _apply_header(
+    def _apply_index(
         self,
         func: Callable[..., Styler],
         axis: int | str = 0,
@@ -1288,7 +1288,7 @@ def _apply_header(
         ret='np.where(s == "B", "background-color: yellow;", "")',
         ret2='["background-color: yellow;" if "x" in v else "" for v in s]',
     )
-    def apply_header(
+    def apply_index(
         self,
         func: Callable[..., Styler],
         axis: int | str = 0,
@@ -1319,7 +1319,7 @@ def apply_header(
 
         See Also
         --------
-        Styler.{alt}_header: Apply a CSS-styling function to headers {altwise}.
+        Styler.{alt}_index: Apply a CSS-styling function to headers {altwise}.
         Styler.apply: Apply a CSS-styling function column-wise, row-wise, or table-wise.
         Styler.applymap: Apply a CSS-styling function elementwise.
 
@@ -1336,7 +1336,7 @@ def apply_header(
         >>> df = pd.DataFrame([[1,2], [3,4]], index=["A", "B"])
         >>> def color_b(s):
         ...     return {ret}
-        >>> df.style.{this}_header(color_b)
+        >>> df.style.{this}_index(color_b)
 
         .. figure:: ../../_static/style/appmaphead1.png
 
@@ -1346,21 +1346,21 @@ def apply_header(
         >>> df = pd.DataFrame([np.arange(8)], columns=midx)
         >>> def highlight_x({var}):
         ...     return {ret2}
-        >>> df.style.{this}_header(highlight_x, axis="columns", levels=[0, 2])
+        >>> df.style.{this}_index(highlight_x, axis="columns", levels=[0, 2])
 
         .. figure:: ../../_static/style/appmaphead2.png
         """
         self._todo.append(
             (
-                lambda instance: getattr(instance, "_apply_header"),
+                lambda instance: getattr(instance, "_apply_index"),
                 (func, axis, levels, "apply"),
                 kwargs,
             )
         )
         return self
 
     @doc(
-        apply_header,
+        apply_index,
         this="applymap",
         wise="elementwise",
         alt="apply",
@@ -1373,7 +1373,7 @@ def apply_header(
         ret='"background-color: yellow;" if v == "B" else None',
         ret2='"background-color: yellow;" if "x" in v else None',
     )
-    def applymap_header(
+    def applymap_index(
         self,
         func: Callable[..., Styler],
         axis: int | str = 0,
@@ -1382,7 +1382,7 @@ def applymap_header(
     ) -> Styler:
         self._todo.append(
             (
-                lambda instance: getattr(instance, "_apply_header"),
+                lambda instance: getattr(instance, "_apply_index"),
                 (func, axis, levels, "applymap"),
                 kwargs,
             )
@@ -1425,8 +1425,8 @@ def applymap(
 
         See Also
         --------
-        Styler.applymap_header: Apply a CSS-styling function to headers elementwise.
-        Styler.apply_header: Apply a CSS-styling function to headers level-wise.
+        Styler.applymap_index: Apply a CSS-styling function to headers elementwise.
+        Styler.apply_index: Apply a CSS-styling function to headers level-wise.
         Styler.apply: Apply a CSS-styling function column-wise, row-wise, or table-wise.
 
         Notes

diff --git a/pandas/io/formats/style_render.py b/pandas/io/formats/style_render.py
@@ -500,7 +500,6 @@ def _translate_body(
                     f"{row_heading_class} level{c} row{r}",
                     value,
                     (_is_visible(r, c, idx_lengths) and not self.hide_index_[c]),
-                    id=f"level{c}_row{r}",
                     attributes=(
                         f'rowspan="{idx_lengths.get((c, r), 0)}"'
                         if idx_lengths.get((c, r), 0) > 1

diff --git a/pandas/tests/io/formats/style/test_html.py b/pandas/tests/io/formats/style/test_html.py
@@ -406,9 +406,9 @@ def test_applymap_header_cell_ids(styler, index, columns):
     func = lambda v: "attr: val;"
     styler.uuid, styler.cell_ids = "", False
     if index:
-        styler.applymap_header(func, axis="index")
+        styler.applymap_index(func, axis="index")
     if columns:
-        styler.applymap_header(func, axis="columns")
+        styler.applymap_index(func, axis="columns")
 
     result = styler.to_html()
 

diff --git a/pandas/tests/io/formats/style/test_style.py b/pandas/tests/io/formats/style/test_style.py
@@ -52,8 +52,8 @@ def mi_styler_comp(mi_styler):
     mi_styler.set_table_attributes('class="box"')
     mi_styler.format(na_rep="MISSING", precision=3)
     mi_styler.highlight_max(axis=None)
-    mi_styler.applymap_header(lambda x: "color: white;", axis=0)
-    mi_styler.applymap_header(lambda x: "color: black;", axis=1)
+    mi_styler.applymap_index(lambda x: "color: white;", axis=0)
+    mi_styler.applymap_index(lambda x: "color: black;", axis=1)
     mi_styler.set_td_classes(
         DataFrame(
             [["a", "b"], ["a", "c"]], index=mi_styler.index, columns=mi_styler.columns
@@ -308,7 +308,7 @@ def test_apply_map_header(method, axis):
     }
 
     # test execution added to todo
-    result = getattr(df.style, f"{method}_header")(func[method], axis=axis)
+    result = getattr(df.style, f"{method}_index")(func[method], axis=axis)
     assert len(result._todo) == 1
     assert len(getattr(result, f"ctx_{axis}")) == 0
 
@@ -328,15 +328,15 @@ def test_apply_map_header_mi(mi_styler, method, axis):
         "apply": lambda s: ["attr: val;" if "b" in v else "" for v in s],
         "applymap": lambda v: "attr: val" if "b" in v else "",
     }
-    result = getattr(mi_styler, f"{method}_header")(func[method], axis=axis)._compute()
+    result = getattr(mi_styler, f"{method}_index")(func[method], axis=axis)._compute()
     expected = {(1, 1): [("attr", "val")]}
     assert getattr(result, f"ctx_{axis}") == expected
 
 
 def test_apply_map_header_raises(mi_styler):
     # GH 41893
     with pytest.raises(ValueError, match="`axis` must be one of 0, 1, 'index', 'col"):
-        mi_styler.applymap_header(lambda v: "attr: val;", axis="bad-axis")._compute()
+        mi_styler.applymap_index(lambda v: "attr: val;", axis="bad-axis")._compute()
 
 
 class TestStyler: