Merge pull request #24376 from timhoffm/label_outer

tacaswell · web-flow · commit 4a34961a97ae · 2023-08-08T23:00:41.000-04:00
Support removing inner ticks in label_outer()
diff --git a/doc/users/next_whats_new/label_outer.rst b/doc/users/next_whats_new/label_outer.rst
@@ -0,0 +1,26 @@
+Remove inner ticks in ``label_outer()``
+---------------------------------------
+Up to now, ``label_outer()`` has only removed the ticklabels. The ticks lines
+were left visible. This is now configurable through a new parameter
+``label_outer(remove_inner_ticks=True)``.
+
+
+.. plot::
+   :include-source: true
+
+    import numpy as np
+    import matplotlib.pyplot as plt
+
+    x = np.linspace(0, 2 * np.pi, 100)
+
+    fig, axs = plt.subplots(2, 2, sharex=True, sharey=True,
+                            gridspec_kw=dict(hspace=0, wspace=0))
+
+    axs[0, 0].plot(x, np.sin(x))
+    axs[0, 1].plot(x, np.cos(x))
+    axs[1, 0].plot(x, -np.cos(x))
+    axs[1, 1].plot(x, -np.sin(x))
+
+    for ax in axs.flat:
+        ax.grid(color='0.9')
+        ax.label_outer(remove_inner_ticks=True)
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -4490,18 +4490,28 @@ def get_shared_y_axes(self):
         """Return an immutable view on the shared y-axes Grouper."""
         return cbook.GrouperView(self._shared_axes["y"])
 
-    def label_outer(self):
+    def label_outer(self, remove_inner_ticks=False):
         """
         Only show "outer" labels and tick labels.
 
         x-labels are only kept for subplots on the last row (or first row, if
         labels are on the top side); y-labels only for subplots on the first
         column (or last column, if labels are on the right side).
+
+        Parameters
+        ----------
+        remove_inner_ticks : bool, default: False
+            If True, remove the inner ticks as well (not only tick labels).
+
+            .. versionadded:: 3.8
         """
-        self._label_outer_xaxis(skip_non_rectangular_axes=False)
-        self._label_outer_yaxis(skip_non_rectangular_axes=False)
+        self._label_outer_xaxis(skip_non_rectangular_axes=False,
+                                remove_inner_ticks=remove_inner_ticks)
+        self._label_outer_yaxis(skip_non_rectangular_axes=False,
+                                remove_inner_ticks=remove_inner_ticks)
 
-    def _label_outer_xaxis(self, *, skip_non_rectangular_axes):
+    def _label_outer_xaxis(self, *, skip_non_rectangular_axes,
+                           remove_inner_ticks=False):
         # see documentation in label_outer.
         if skip_non_rectangular_axes and not isinstance(self.patch,
                                                         mpl.patches.Rectangle):
@@ -4513,17 +4523,22 @@ def _label_outer_xaxis(self, *, skip_non_rectangular_axes):
         if not ss.is_first_row():  # Remove top label/ticklabels/offsettext.
             if label_position == "top":
                 self.set_xlabel("")
-            self.xaxis.set_tick_params(which="both", labeltop=False)
+            top_kw = {'top': False} if remove_inner_ticks else {}
+            self.xaxis.set_tick_params(
+                which="both", labeltop=False, **top_kw)
             if self.xaxis.offsetText.get_position()[1] == 1:
                 self.xaxis.offsetText.set_visible(False)
         if not ss.is_last_row():  # Remove bottom label/ticklabels/offsettext.
             if label_position == "bottom":
                 self.set_xlabel("")
-            self.xaxis.set_tick_params(which="both", labelbottom=False)
+            bottom_kw = {'bottom': False} if remove_inner_ticks else {}
+            self.xaxis.set_tick_params(
+                which="both", labelbottom=False, **bottom_kw)
             if self.xaxis.offsetText.get_position()[1] == 0:
                 self.xaxis.offsetText.set_visible(False)
 
-    def _label_outer_yaxis(self, *, skip_non_rectangular_axes):
+    def _label_outer_yaxis(self, *, skip_non_rectangular_axes,
+                           remove_inner_ticks=False):
         # see documentation in label_outer.
         if skip_non_rectangular_axes and not isinstance(self.patch,
                                                         mpl.patches.Rectangle):
@@ -4535,13 +4550,17 @@ def _label_outer_yaxis(self, *, skip_non_rectangular_axes):
         if not ss.is_first_col():  # Remove left label/ticklabels/offsettext.
             if label_position == "left":
                 self.set_ylabel("")
-            self.yaxis.set_tick_params(which="both", labelleft=False)
+            left_kw = {'left': False} if remove_inner_ticks else {}
+            self.yaxis.set_tick_params(
+                which="both", labelleft=False, **left_kw)
             if self.yaxis.offsetText.get_position()[0] == 0:
                 self.yaxis.offsetText.set_visible(False)
         if not ss.is_last_col():  # Remove right label/ticklabels/offsettext.
             if label_position == "right":
                 self.set_ylabel("")
-            self.yaxis.set_tick_params(which="both", labelright=False)
+            right_kw = {'right': False} if remove_inner_ticks else {}
+            self.yaxis.set_tick_params(
+                which="both", labelright=False, **right_kw)
             if self.yaxis.offsetText.get_position()[0] == 1:
                 self.yaxis.offsetText.set_visible(False)
 
diff --git a/lib/matplotlib/axes/_base.pyi b/lib/matplotlib/axes/_base.pyi
@@ -376,7 +376,7 @@ class _AxesBase(martist.Artist):
     def twiny(self) -> _AxesBase: ...
     def get_shared_x_axes(self) -> cbook.GrouperView: ...
     def get_shared_y_axes(self) -> cbook.GrouperView: ...
-    def label_outer(self) -> None: ...
+    def label_outer(self, remove_inner_ticks: bool = ...) -> None: ...
 
     # The methods underneath this line are added via the `_axis_method_wrapper` class
     # Initially they are set to an object, but that object uses `__set_name__` to override
diff --git a/lib/matplotlib/tests/test_subplots.py b/lib/matplotlib/tests/test_subplots.py
@@ -24,7 +24,8 @@ def check_shared(axs, x_shared, y_shared):
                 i1, i2, "not " if shared[i1, i2] else "", name)
 
 
-def check_visible(axs, x_visible, y_visible):
+def check_ticklabel_visible(axs, x_visible, y_visible):
+    """Check that the x and y ticklabel visibility is as specified."""
     for i, (ax, vx, vy) in enumerate(zip(axs, x_visible, y_visible)):
         for l in ax.get_xticklabels() + [ax.xaxis.offsetText]:
             assert l.get_visible() == vx, \
@@ -40,6 +41,20 @@ def check_visible(axs, x_visible, y_visible):
             assert ax.get_ylabel() == ""
 
 
+def check_tick1_visible(axs, x_visible, y_visible):
+    """
+    Check that the x and y tick visibility is as specified.
+
+    Note: This only checks the tick1line, i.e. bottom / left ticks.
+    """
+    for ax, visible, in zip(axs, x_visible):
+        for tick in ax.xaxis.get_major_ticks():
+            assert tick.tick1line.get_visible() == visible
+    for ax, y_visible, in zip(axs, y_visible):
+        for tick in ax.yaxis.get_major_ticks():
+            assert tick.tick1line.get_visible() == visible
+
+
 def test_shared():
     rdim = (4, 4, 2)
     share = {
@@ -90,16 +105,24 @@ def test_shared():
             f, ((a1, a2), (a3, a4)) = plt.subplots(2, 2, sharex=xo, sharey=yo)
             axs = [a1, a2, a3, a4]
             check_shared(axs, share[xo], share[yo])
-            check_visible(axs, visible['x'][xo], visible['y'][yo])
+            check_ticklabel_visible(axs, visible['x'][xo], visible['y'][yo])
             plt.close(f)
 
-    # test label_outer
-    f, ((a1, a2), (a3, a4)) = plt.subplots(2, 2, sharex=True, sharey=True)
-    axs = [a1, a2, a3, a4]
-    for ax in axs:
+
+@pytest.mark.parametrize('remove_ticks', [True, False])
+def test_label_outer(remove_ticks):
+    f, axs = plt.subplots(2, 2, sharex=True, sharey=True)
+    for ax in axs.flat:
         ax.set(xlabel="foo", ylabel="bar")
-        ax.label_outer()
-    check_visible(axs, [False, False, True, True], [True, False, True, False])
+        ax.label_outer(remove_inner_ticks=remove_ticks)
+    check_ticklabel_visible(
+        axs.flat, [False, False, True, True], [True, False, True, False])
+    if remove_ticks:
+        check_tick1_visible(
+            axs.flat, [False, False, True, True], [True, False, True, False])
+    else:
+        check_tick1_visible(
+            axs.flat, [True, True, True, True], [True, True, True, True])
 
 
 def test_label_outer_span():
@@ -118,28 +141,28 @@ def test_label_outer_span():
     a4 = fig.add_subplot(gs[2, 1])
     for ax in fig.axes:
         ax.label_outer()
-    check_visible(
+    check_ticklabel_visible(
         fig.axes, [False, True, False, True], [True, True, False, False])
 
 
 def test_label_outer_non_gridspec():
     ax = plt.axes((0, 0, 1, 1))
     ax.label_outer()  # Does nothing.
-    check_visible([ax], [True], [True])
+    check_ticklabel_visible([ax], [True], [True])
 
 
 def test_shared_and_moved():
     # test if sharey is on, but then tick_left is called that labels don't
     # re-appear.  Seaborn does this just to be sure yaxis is on left...
     f, (a1, a2) = plt.subplots(1, 2, sharey=True)
-    check_visible([a2], [True], [False])
+    check_ticklabel_visible([a2], [True], [False])
     a2.yaxis.tick_left()
-    check_visible([a2], [True], [False])
+    check_ticklabel_visible([a2], [True], [False])
 
     f, (a1, a2) = plt.subplots(2, 1, sharex=True)
-    check_visible([a1], [False], [True])
+    check_ticklabel_visible([a1], [False], [True])
     a2.xaxis.tick_bottom()
-    check_visible([a1], [False], [True])
+    check_ticklabel_visible([a1], [False], [True])
 
 
 def test_exceptions():
