Merge pull request matplotlib#22802 from lijake8/mnt-make-cla-an-alias-for-clear

MNT: make Axes.cla an alias for Axes.clear in all cases

Author: timhoffm

doc/api/next_api_changes/removals/22738-JL.rst

@@ -0,0 +1,10 @@
+Removal of deprecated methods in `matplotlib.projections.polar`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``cla`` method in both ``ThetaAxis`` and ``RadialAxis`` has been removed
+after being deprecated in 3.4. Use ``clear`` instead.
+
+Removal of deprecated methods in `matplotlib.spines`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The ``cla`` method in ``Spine`` is removed after being deprecated in 3.4.
+Use ``clear`` instead.

examples/misc/custom_projection.py

@@ -52,8 +52,9 @@ def _init_axis(self):
         # self.spines['geo'].register_axis(self.yaxis)
         self._update_transScale()
 
-    def cla(self):
-        super().cla()
+    def clear(self):
+        # docstring inherited
+        super().clear()
 
         self.set_longitude_grid(30)
         self.set_latitude_grid(15)
@@ -424,7 +425,7 @@ def __init__(self, *args, **kwargs):
         self._longitude_cap = np.pi / 2.0
         super().__init__(*args, **kwargs)
         self.set_aspect(0.5, adjustable='box', anchor='C')
-        self.cla()
+        self.clear()
 
     def _get_core_transform(self, resolution):
         return self.HammerTransform(resolution)

lib/matplotlib/axes/_base.py

@@ -641,7 +641,7 @@ def __init__(self, fig, rect,
         self.set_axisbelow(mpl.rcParams['axes.axisbelow'])
 
         self._rasterization_zorder = None
-        self.cla()
+        self.clear()
 
         # funcs used to format x and y - fall back on major formatters
         self.fmt_xdata = None
@@ -1193,7 +1193,7 @@ def sharey(self, other):
         self.set_ylim(y0, y1, emit=False, auto=other.get_autoscaley_on())
         self.yaxis._scale = other.yaxis._scale
 
-    def cla(self):
+    def clear(self):
         """Clear the Axes."""
         # Note: this is called by Axes.__init__()
 
@@ -1487,9 +1487,9 @@ def texts(self):
         return self.ArtistList(self, 'texts', 'add_artist',
                                valid_types=mtext.Text)
 
-    def clear(self):
+    def cla(self):
         """Clear the Axes."""
-        self.cla()
+        self.clear()
 
     def get_facecolor(self):
         """Get the facecolor of the Axes."""

lib/matplotlib/figure.py

@@ -931,7 +931,7 @@ def clear(self, keep_observers=False):
         self.subfigs = []
 
         for ax in tuple(self.axes):  # Iterate over the copy.
-            ax.cla()
+            ax.clear()
             self.delaxes(ax)  # Remove ax from self._axstack.
 
         self.artists = []

lib/matplotlib/projections/geo.py

@@ -36,8 +36,9 @@ def _init_axis(self):
         # self.spines['geo'].register_axis(self.yaxis)
         self._update_transScale()
 
-    def cla(self):
-        super().cla()
+    def clear(self):
+        # docstring inherited
+        super().clear()
 
         self.set_longitude_grid(30)
         self.set_latitude_grid(15)
@@ -284,7 +285,7 @@ def __init__(self, *args, **kwargs):
         self._longitude_cap = np.pi / 2.0
         super().__init__(*args, **kwargs)
         self.set_aspect(0.5, adjustable='box', anchor='C')
-        self.cla()
+        self.clear()
 
     def _get_core_transform(self, resolution):
         return self.AitoffTransform(resolution)
@@ -329,7 +330,7 @@ def __init__(self, *args, **kwargs):
         self._longitude_cap = np.pi / 2.0
         super().__init__(*args, **kwargs)
         self.set_aspect(0.5, adjustable='box', anchor='C')
-        self.cla()
+        self.clear()
 
     def _get_core_transform(self, resolution):
         return self.HammerTransform(resolution)
@@ -399,7 +400,7 @@ def __init__(self, *args, **kwargs):
         self._longitude_cap = np.pi / 2.0
         super().__init__(*args, **kwargs)
         self.set_aspect(0.5, adjustable='box', anchor='C')
-        self.cla()
+        self.clear()
 
     def _get_core_transform(self, resolution):
         return self.MollweideTransform(resolution)
@@ -484,10 +485,11 @@ def __init__(self, *args, center_longitude=0, center_latitude=0, **kwargs):
         self._center_latitude = center_latitude
         super().__init__(*args, **kwargs)
         self.set_aspect('equal', adjustable='box', anchor='C')
-        self.cla()
+        self.clear()
 
-    def cla(self):
-        super().cla()
+    def clear(self):
+        # docstring inherited
+        super().clear()
         self.yaxis.set_major_formatter(NullFormatter())
 
     def _get_core_transform(self, resolution):

lib/matplotlib/projections/polar.py

@@ -367,14 +367,11 @@ def _wrap_locator_formatter(self):
         self.isDefault_majfmt = True
 
     def clear(self):
+        # docstring inherited
         super().clear()
         self.set_ticks_position('none')
         self._wrap_locator_formatter()
 
-    @_api.deprecated("3.4", alternative="ThetaAxis.clear()")
-    def cla(self):
-        self.clear()
-
     def _set_scale(self, value, **kwargs):
         if value != 'linear':
             raise NotImplementedError(
@@ -659,14 +656,11 @@ def _wrap_locator_formatter(self):
         self.isDefault_majloc = True
 
     def clear(self):
+        # docstring inherited
         super().clear()
         self.set_ticks_position('none')
         self._wrap_locator_formatter()
 
-    @_api.deprecated("3.4", alternative="RadialAxis.clear()")
-    def cla(self):
-        self.clear()
-
     def _set_scale(self, value, **kwargs):
         super()._set_scale(value, **kwargs)
         self._wrap_locator_formatter()
@@ -764,10 +758,11 @@ def __init__(self, *args,
         super().__init__(*args, **kwargs)
         self.use_sticky_edges = True
         self.set_aspect('equal', adjustable='box', anchor='C')
-        self.cla()
+        self.clear()
 
-    def cla(self):
-        super().cla()
+    def clear(self):
+        # docstring inherited
+        super().clear()
 
         self.title.set_y(1.05)
 

lib/matplotlib/spines.py

@@ -222,10 +222,6 @@ def clear(self):
         if self.axis is not None:
             self.axis.clear()
 
-    @_api.deprecated("3.4", alternative="`.Spine.clear`")
-    def cla(self):
-        self.clear()
-
     def _adjust_location(self):
         """Automatically set spine bounds to the view interval."""
 

lib/matplotlib/tests/test_axes.py

@@ -22,6 +22,7 @@
 import matplotlib.colors as mcolors
 import matplotlib.dates as mdates
 from matplotlib.figure import Figure
+from matplotlib.axes import Axes
 import matplotlib.font_manager as mfont_manager
 import matplotlib.markers as mmarkers
 import matplotlib.patches as mpatches
@@ -468,6 +469,12 @@ def test_inverted_cla():
     plt.close(fig)
 
 
+def test_cla_not_redefined():
+    for klass in Axes.__subclasses__():
+        # check that cla does not get redefined in our Axes subclasses
+        assert 'cla' not in klass.__dict__
+
+
 @check_figures_equal(extensions=["png"])
 def test_minorticks_on_rcParams_both(fig_test, fig_ref):
     with matplotlib.rc_context({"xtick.minor.visible": True,

lib/mpl_toolkits/axes_grid1/mpl_axes.py

@@ -52,8 +52,9 @@ def _init_axis_artists(self):
     def axis(self):
         return self._axislines
 
-    def cla(self):
-        super().cla()
+    def clear(self):
+        # docstring inherited
+        super().clear()
         self._init_axis_artists()
 
 

lib/mpl_toolkits/axes_grid1/parasite_axes.py

@@ -17,8 +17,8 @@ def __init__(self, parent_axes, aux_transform=None,
         kwargs["frameon"] = False
         super().__init__(parent_axes.figure, parent_axes._position, **kwargs)
 
-    def cla(self):
-        super().cla()
+    def clear(self):
+        super().clear()
         martist.setp(self.get_children(), visible=False)
         self._get_lines = self._parent_axes._get_lines
 
@@ -138,10 +138,10 @@ def draw(self, renderer):
         super().draw(renderer)
         self._children = self._children[:orig_children_len]
 
-    def cla(self):
+    def clear(self):
         for ax in self.parasites:
-            ax.cla()
-        super().cla()
+            ax.clear()
+        super().clear()
 
     def pick(self, mouseevent):
         super().pick(mouseevent)