Skip to content

Commit c8dd978

Browse files
lijake8lijake8
committed
[MNT]: make Axes.cla an alias for Axes.clear in all cases
1 parent 9caa261 commit c8dd978

File tree

16 files changed

+86
-67
lines changed

16 files changed

+86
-67
lines changed

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

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Removal of deprecated methods in `matplotlib.projections.polar`
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
The ``cla`` method in both ``ThetaAxis`` and ``RadialAxis`` has been removed
5+
after being deprecated in 3.4. Use ``clear`` instead.
6+
7+
Removal of deprecated methods in `matplotlib.spines`
8+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9+
The ``cla`` method in ``Spine`` is removed after being deprecated in 3.4.
10+
Use ``clear`` instead.

‎examples/misc/custom_projection.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,9 @@ def _init_axis(self):
5252
# self.spines['geo'].register_axis(self.yaxis)
5353
self._update_transScale()
5454

55-
def cla(self):
56-
super().cla()
55+
def clear(self):
56+
# docstring inherited
57+
super().clear()
5758

5859
self.set_longitude_grid(30)
5960
self.set_latitude_grid(15)
@@ -424,7 +425,7 @@ def __init__(self, *args, **kwargs):
424425
self._longitude_cap = np.pi / 2.0
425426
super().__init__(*args, **kwargs)
426427
self.set_aspect(0.5, adjustable='box', anchor='C')
427-
self.cla()
428+
self.clear()
428429

429430
def _get_core_transform(self, resolution):
430431
return self.HammerTransform(resolution)

‎lib/matplotlib/axes/_base.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@ def __init__(self, fig, rect,
641641
self.set_axisbelow(mpl.rcParams['axes.axisbelow'])
642642

643643
self._rasterization_zorder = None
644-
self.cla()
644+
self.clear()
645645

646646
# funcs used to format x and y - fall back on major formatters
647647
self.fmt_xdata = None
@@ -1193,7 +1193,7 @@ def sharey(self, other):
11931193
self.set_ylim(y0, y1, emit=False, auto=other.get_autoscaley_on())
11941194
self.yaxis._scale = other.yaxis._scale
11951195

1196-
def cla(self):
1196+
def clear(self):
11971197
"""Clear the Axes."""
11981198
# Note: this is called by Axes.__init__()
11991199

@@ -1487,9 +1487,9 @@ def texts(self):
14871487
return self.ArtistList(self, 'texts', 'add_artist',
14881488
valid_types=mtext.Text)
14891489

1490-
def clear(self):
1490+
def cla(self):
14911491
"""Clear the Axes."""
1492-
self.cla()
1492+
self.clear()
14931493

14941494
def get_facecolor(self):
14951495
"""Get the facecolor of the Axes."""

‎lib/matplotlib/figure.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -932,7 +932,7 @@ def clear(self, keep_observers=False):
932932
self.subfigs = []
933933

934934
for ax in tuple(self.axes): # Iterate over the copy.
935-
ax.cla()
935+
ax.clear()
936936
self.delaxes(ax) # Remove ax from self._axstack.
937937

938938
self.artists = []

‎lib/matplotlib/projections/geo.py

+10-8
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ def _init_axis(self):
3636
# self.spines['geo'].register_axis(self.yaxis)
3737
self._update_transScale()
3838

39-
def cla(self):
40-
super().cla()
39+
def clear(self):
40+
# docstring inherited
41+
super().clear()
4142

4243
self.set_longitude_grid(30)
4344
self.set_latitude_grid(15)
@@ -284,7 +285,7 @@ def __init__(self, *args, **kwargs):
284285
self._longitude_cap = np.pi / 2.0
285286
super().__init__(*args, **kwargs)
286287
self.set_aspect(0.5, adjustable='box', anchor='C')
287-
self.cla()
288+
self.clear()
288289

289290
def _get_core_transform(self, resolution):
290291
return self.AitoffTransform(resolution)
@@ -329,7 +330,7 @@ def __init__(self, *args, **kwargs):
329330
self._longitude_cap = np.pi / 2.0
330331
super().__init__(*args, **kwargs)
331332
self.set_aspect(0.5, adjustable='box', anchor='C')
332-
self.cla()
333+
self.clear()
333334

334335
def _get_core_transform(self, resolution):
335336
return self.HammerTransform(resolution)
@@ -399,7 +400,7 @@ def __init__(self, *args, **kwargs):
399400
self._longitude_cap = np.pi / 2.0
400401
super().__init__(*args, **kwargs)
401402
self.set_aspect(0.5, adjustable='box', anchor='C')
402-
self.cla()
403+
self.clear()
403404

404405
def _get_core_transform(self, resolution):
405406
return self.MollweideTransform(resolution)
@@ -484,10 +485,11 @@ def __init__(self, *args, center_longitude=0, center_latitude=0, **kwargs):
484485
self._center_latitude = center_latitude
485486
super().__init__(*args, **kwargs)
486487
self.set_aspect('equal', adjustable='box', anchor='C')
487-
self.cla()
488+
self.clear()
488489

489-
def cla(self):
490-
super().cla()
490+
def clear(self):
491+
# docstring inherited
492+
super().clear()
491493
self.yaxis.set_major_formatter(NullFormatter())
492494

493495
def _get_core_transform(self, resolution):

‎lib/matplotlib/projections/polar.py

+6-11
Original file line numberDiff line numberDiff line change
@@ -373,14 +373,11 @@ def _wrap_locator_formatter(self):
373373
self.isDefault_majfmt = True
374374

375375
def clear(self):
376+
# docstring inherited
376377
super().clear()
377378
self.set_ticks_position('none')
378379
self._wrap_locator_formatter()
379380

380-
@_api.deprecated("3.4", alternative="ThetaAxis.clear()")
381-
def cla(self):
382-
self.clear()
383-
384381
def _set_scale(self, value, **kwargs):
385382
if value != 'linear':
386383
raise NotImplementedError(
@@ -671,14 +668,11 @@ def _wrap_locator_formatter(self):
671668
self.isDefault_majloc = True
672669

673670
def clear(self):
671+
# docstring inherited
674672
super().clear()
675673
self.set_ticks_position('none')
676674
self._wrap_locator_formatter()
677675

678-
@_api.deprecated("3.4", alternative="RadialAxis.clear()")
679-
def cla(self):
680-
self.clear()
681-
682676
def _set_scale(self, value, **kwargs):
683677
super()._set_scale(value, **kwargs)
684678
self._wrap_locator_formatter()
@@ -776,10 +770,11 @@ def __init__(self, *args,
776770
super().__init__(*args, **kwargs)
777771
self.use_sticky_edges = True
778772
self.set_aspect('equal', adjustable='box', anchor='C')
779-
self.cla()
773+
self.clear()
780774

781-
def cla(self):
782-
super().cla()
775+
def clear(self):
776+
# docstring inherited
777+
super().clear()
783778

784779
self.title.set_y(1.05)
785780

‎lib/matplotlib/pyplot.py

+15-16
Original file line numberDiff line numberDiff line change
@@ -953,7 +953,7 @@ def close(fig=None):
953953

954954
def clf():
955955
"""Clear the current figure."""
956-
gcf().clear()
956+
gcf().clf()
957957

958958

959959
def draw():
@@ -1303,13 +1303,13 @@ def subplot(*args, **kwargs):
13031303

13041304
fig.sca(ax)
13051305

1306-
axes_to_delete = [other for other in fig.axes
1307-
if other != ax and ax.bbox.fully_overlaps(other.bbox)]
1308-
if axes_to_delete:
1309-
_api.warn_deprecated(
1310-
"3.6", message="Auto-removal of overlapping axes is deprecated "
1311-
"since %(since)s and will be removed %(removal)s; explicitly call "
1312-
"ax.remove() as needed.")
1306+
bbox = ax.bbox
1307+
axes_to_delete = []
1308+
for other_ax in fig.axes:
1309+
if other_ax == ax:
1310+
continue
1311+
if bbox.fully_overlaps(other_ax.bbox):
1312+
axes_to_delete.append(other_ax)
13131313
for ax_to_del in axes_to_delete:
13141314
delaxes(ax_to_del)
13151315

@@ -1596,14 +1596,13 @@ def subplot2grid(shape, loc, rowspan=1, colspan=1, fig=None, **kwargs):
15961596

15971597
subplotspec = gs.new_subplotspec(loc, rowspan=rowspan, colspan=colspan)
15981598
ax = fig.add_subplot(subplotspec, **kwargs)
1599-
1600-
axes_to_delete = [other for other in fig.axes
1601-
if other != ax and ax.bbox.fully_overlaps(other.bbox)]
1602-
if axes_to_delete:
1603-
_api.warn_deprecated(
1604-
"3.6", message="Auto-removal of overlapping axes is deprecated "
1605-
"since %(since)s and will be removed %(removal)s; explicitly call "
1606-
"ax.remove() as needed.")
1599+
bbox = ax.bbox
1600+
axes_to_delete = []
1601+
for other_ax in fig.axes:
1602+
if other_ax == ax:
1603+
continue
1604+
if bbox.fully_overlaps(other_ax.bbox):
1605+
axes_to_delete.append(other_ax)
16071606
for ax_to_del in axes_to_delete:
16081607
delaxes(ax_to_del)
16091608

‎lib/matplotlib/spines.py

-4
Original file line numberDiff line numberDiff line change
@@ -222,10 +222,6 @@ def clear(self):
222222
if self.axis is not None:
223223
self.axis.clear()
224224

225-
@_api.deprecated("3.4", alternative="`.Spine.clear`")
226-
def cla(self):
227-
self.clear()
228-
229225
def _adjust_location(self):
230226
"""Automatically set spine bounds to the view interval."""
231227

‎lib/matplotlib/tests/test_axes.py

+7
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import matplotlib.colors as mcolors
2323
import matplotlib.dates as mdates
2424
from matplotlib.figure import Figure
25+
from matplotlib.axes import Axes
2526
import matplotlib.font_manager as mfont_manager
2627
import matplotlib.markers as mmarkers
2728
import matplotlib.patches as mpatches
@@ -468,6 +469,12 @@ def test_inverted_cla():
468469
plt.close(fig)
469470

470471

472+
def test_cla_not_redefined():
473+
for klass in Axes.__subclasses__():
474+
# check that cla does not get redefined in our Axes subclasses
475+
assert 'cla' not in klass.__dict__
476+
477+
471478
@check_figures_equal(extensions=["png"])
472479
def test_minorticks_on_rcParams_both(fig_test, fig_ref):
473480
with matplotlib.rc_context({"xtick.minor.visible": True,

‎lib/matplotlib/tests/test_figure.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -791,12 +791,11 @@ def test_figure_clear(clear_meth):
791791
assert fig.axes == []
792792

793793

794-
def test_clf_not_refedined():
794+
def test_clf_not_redefined():
795795
for klass in FigureBase.__subclasses__():
796796
# check that subclasses do not get redefined in our Figure subclasses
797797
assert 'clf' not in klass.__dict__
798798

799-
800799
@mpl.style.context('mpl20')
801800
def test_picking_does_not_stale():
802801
fig, ax = plt.subplots()

‎lib/mpl_toolkits/axes_grid1/axes_grid.py

+8-2
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,17 @@ def toggle_label(self, b):
3737
axis = self.axis[self.orientation]
3838
axis.toggle(ticklabels=b, label=b)
3939

40-
def cla(self):
40+
def clear(self):
41+
# docstring inherited
42+
4143
orientation = self.orientation
42-
super().cla()
44+
super().clear()
4345
self.orientation = orientation
4446

47+
def cla(self):
48+
"""Clear the current axes."""
49+
self.clear()
50+
4551

4652
@_api.deprecated("3.5")
4753
class CbarAxes(CbarAxesBase, Axes):

‎lib/mpl_toolkits/axes_grid1/mpl_axes.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,9 @@ def _init_axis_artists(self):
5252
def axis(self):
5353
return self._axislines
5454

55-
def cla(self):
56-
super().cla()
55+
def clear(self):
56+
# docstring inherited
57+
super().clear()
5758
self._init_axis_artists()
5859

5960

‎lib/mpl_toolkits/axes_grid1/parasite_axes.py

+7-5
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ def __init__(self, parent_axes, aux_transform=None,
1717
kwargs["frameon"] = False
1818
super().__init__(parent_axes.figure, parent_axes._position, **kwargs)
1919

20-
def cla(self):
21-
super().cla()
20+
def clear(self):
21+
# docstring inherited
22+
super().clear()
2223
martist.setp(self.get_children(), visible=False)
2324
self._get_lines = self._parent_axes._get_lines
2425

@@ -138,10 +139,11 @@ def draw(self, renderer):
138139
super().draw(renderer)
139140
self._children = self._children[:orig_children_len]
140141

141-
def cla(self):
142+
def clear(self):
143+
# docstring inherited
142144
for ax in self.parasites:
143-
ax.cla()
144-
super().cla()
145+
ax.clear()
146+
super().clear()
145147

146148
def pick(self, mouseevent):
147149
super().pick(mouseevent)

‎lib/mpl_toolkits/axisartist/axislines.py

+5-4
Original file line numberDiff line numberDiff line change
@@ -499,12 +499,13 @@ def _init_gridlines(self, grid_helper=None):
499499
# It is done inside the cla.
500500
self.gridlines = self.new_gridlines(grid_helper)
501501

502-
def cla(self):
503-
# gridlines need to b created before cla() since cla calls grid()
502+
def clear(self):
503+
# docstring inherited
504+
# gridlines need to b created before clear() since clear calls grid()
504505
self._init_gridlines()
505-
super().cla()
506+
super().clear()
506507

507-
# the clip_path should be set after Axes.cla() since that's
508+
# the clip_path should be set after Axes.clear() since that's
508509
# when a patch is created.
509510
self.gridlines.set_clip_path(self.axes.patch)
510511

‎lib/mpl_toolkits/axisartist/floating_axes.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -329,8 +329,9 @@ def _gen_axes_patch(self):
329329
patch.get_path()._interpolation_steps = 100
330330
return patch
331331

332-
def cla(self):
333-
super().cla()
332+
def clear(self):
333+
# docstring inherited
334+
super().clear()
334335
self.patch.set_transform(
335336
self.get_grid_helper().grid_finder.get_transform()
336337
+ self.transData)

‎lib/mpl_toolkits/mplot3d/axes3d.py

+2-3
Original file line numberDiff line numberDiff line change
@@ -932,10 +932,9 @@ def can_pan(self):
932932
"""
933933
return False
934934

935-
def cla(self):
935+
def clear(self):
936936
# docstring inherited.
937-
938-
super().cla()
937+
super().clear()
939938
self.zaxis.clear()
940939

941940
if self._sharez is not None:

0 commit comments

Comments
 (0)