Merge pull request #22412 from timhoffm/propertize

oscargus · web-flow · commit 81e955935a26 · 2022-02-21T15:16:26.000+01:00
Turn _get_axis_map() into a property and remove _get_axis_list()
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -235,7 +235,7 @@ def remove(self):
     def have_units(self):
         """Return whether units are set on any axis."""
         ax = self.axes
-        return ax and any(axis.have_units() for axis in ax._get_axis_list())
+        return ax and any(axis.have_units() for axis in ax._axis_map.values())
 
     def convert_xunits(self, x):
         """
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -5590,7 +5590,7 @@ def _interp_grid(X):
 
     def _pcolor_grid_deprecation_helper(self):
         grid_active = any(axis._major_tick_kw["gridOn"]
-                          for axis in self._get_axis_list())
+                          for axis in self._axis_map.values())
         # explicit is-True check because get_axisbelow() can also be 'line'
         grid_hidden_by_pcolor = self.get_axisbelow() is True
         if grid_active and not grid_hidden_by_pcolor:
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -541,10 +541,23 @@ def _plot_args(self, tup, kwargs, return_kwargs=False):
 class _AxesBase(martist.Artist):
     name = "rectilinear"
 
-    _axis_names = ("x", "y")  # See _get_axis_map.
+    # axis names are the prefixes for the attributes that contain the
+    # respective axis; e.g. 'x' <-> self.xaxis, containing an XAxis.
+    # Note that PolarAxes uses these attributes as well, so that we have
+    # 'x' <-> self.xaxis, containing a ThetaAxis. In particular we do not
+    # have 'theta' in _axis_names.
+    # In practice, this is ('x', 'y') for all 2D Axes and ('x', 'y', 'z')
+    # for Axes3D.
+    _axis_names = ("x", "y")
     _shared_axes = {name: cbook.Grouper() for name in _axis_names}
     _twinned_axes = cbook.Grouper()
 
+    @property
+    def _axis_map(self):
+        """A mapping of axis names, e.g. 'x', to `Axis` instances."""
+        return {name: getattr(self, f"{name}axis")
+                for name in self._axis_names}
+
     def __str__(self):
         return "{0}({1[0]:g},{1[1]:g};{1[2]:g}x{1[3]:g})".format(
             type(self).__name__, self._position.bounds)
@@ -644,7 +657,7 @@ def __init__(self, fig, rect,
 
         self._internal_update(kwargs)
 
-        for name, axis in self._get_axis_map().items():
+        for name, axis in self._axis_map.items():
             axis.callbacks._pickled_cids.add(
                 axis.callbacks.connect(
                     'units', self._unit_change_handler(name)))
@@ -2437,7 +2450,7 @@ def _unit_change_handler(self, axis_name, event=None):
         if event is None:  # Allow connecting `self._unit_change_handler(name)`
             return functools.partial(
                 self._unit_change_handler, axis_name, event=object())
-        _api.check_in_list(self._get_axis_map(), axis_name=axis_name)
+        _api.check_in_list(self._axis_map, axis_name=axis_name)
         for line in self.lines:
             line.recache_always()
         self.relim()
@@ -2503,7 +2516,7 @@ def _process_unit_info(self, datasets=None, kwargs=None, *, convert=True):
         ----------
         datasets : list
             List of (axis_name, dataset) pairs (where the axis name is defined
-            as in `._get_axis_map`).  Individual datasets can also be None
+            as in `._axis_map`).  Individual datasets can also be None
             (which gets passed through).
         kwargs : dict
             Other parameters from which unit info (i.e., the *xunits*,
@@ -2525,7 +2538,7 @@ def _process_unit_info(self, datasets=None, kwargs=None, *, convert=True):
         # (e.g. if some are scalars, etc.).
         datasets = datasets or []
         kwargs = kwargs or {}
-        axis_map = self._get_axis_map()
+        axis_map = self._axis_map
         for axis_name, data in datasets:
             try:
                 axis = axis_map[axis_name]
@@ -2953,22 +2966,6 @@ def handle_single_axis(scale, autoscaleon, shared_axes, name,
             scaley, self._autoscaleYon, self._shared_axes["y"], 'y',
             self.yaxis, self._ymargin, y_stickies, self.set_ybound)
 
-    def _get_axis_list(self):
-        return tuple(getattr(self, f"{name}axis") for name in self._axis_names)
-
-    def _get_axis_map(self):
-        """
-        Return a mapping of `Axis` "names" to `Axis` instances.
-
-        The `Axis` name is derived from the attribute under which the instance
-        is stored, so e.g. for polar Axes, the theta-axis is still named "x"
-        and the r-axis is still named "y" (for back-compatibility).
-
-        In practice, this means that the entries are typically "x" and "y", and
-        additionally "z" for 3D Axes.
-        """
-        return dict(zip(self._axis_names, self._get_axis_list()))
-
     def _update_title_position(self, renderer):
         """
         Update the title position based on the bounding box enclosing
@@ -3069,7 +3066,7 @@ def draw(self, renderer):
         self._update_title_position(renderer)
 
         if not self.axison:
-            for _axis in self._get_axis_list():
+            for _axis in self._axis_map.values():
                 artists.remove(_axis)
 
         if not self.figure.canvas.is_saving():
@@ -3131,7 +3128,7 @@ def redraw_in_frame(self):
             raise AttributeError("redraw_in_frame can only be used after an "
                                  "initial draw which caches the renderer")
         with ExitStack() as stack:
-            for artist in [*self._get_axis_list(),
+            for artist in [*self._axis_map.values(),
                            self.title, self._left_title, self._right_title]:
                 stack.enter_context(artist._cm_set(visible=False))
             self.draw(self.figure._cachedRenderer)
@@ -3202,7 +3199,7 @@ def set_axisbelow(self, b):
             zorder = 1.5
         else:
             raise ValueError("Unexpected axisbelow value")
-        for axis in self._get_axis_list():
+        for axis in self._axis_map.values():
             axis.set_zorder(zorder)
         self.stale = True
 
@@ -3306,8 +3303,8 @@ def ticklabel_format(self, *, axis='both', style='', scilimits=None,
                                  ) from err
         STYLES = {'sci': True, 'scientific': True, 'plain': False, '': None}
         is_sci_style = _api.check_getitem(STYLES, style=style)
-        axis_map = {**{k: [v] for k, v in self._get_axis_map().items()},
-                    'both': self._get_axis_list()}
+        axis_map = {**{k: [v] for k, v in self._axis_map.items()},
+                    'both': list(self._axis_map.values())}
         axises = _api.check_getitem(axis_map, axis=axis)
         try:
             for axis in axises:
@@ -3361,7 +3358,7 @@ def locator_params(self, axis='both', tight=None, **kwargs):
         _api.check_in_list([*self._axis_names, "both"], axis=axis)
         for name in self._axis_names:
             if axis in [name, "both"]:
-                loc = self._get_axis_map()[name].get_major_locator()
+                loc = self._axis_map[name].get_major_locator()
                 loc.set_params(**kwargs)
                 self._request_autoscale_view(name, tight=tight)
         self.stale = True
@@ -4412,7 +4409,7 @@ def get_children(self):
         return [
             *self._children,
             *self.spines.values(),
-            *self._get_axis_list(),
+            *self._axis_map.values(),
             self.title, self._left_title, self._right_title,
             *self.child_axes,
             *([self.legend_] if self.legend_ is not None else []),
@@ -4444,10 +4441,10 @@ def get_default_bbox_extra_artists(self):
 
         artists = self.get_children()
 
-        for _axis in self._get_axis_list():
+        for axis in self._axis_map.values():
             # axis tight bboxes are calculated separately inside
             # Axes.get_tightbbox() using for_layout_only=True
-            artists.remove(_axis)
+            artists.remove(axis)
         if not (self.axison and self._frameon):
             # don't do bbox on spines if frame not on.
             for spine in self.spines.values():
@@ -4520,7 +4517,7 @@ def get_tightbbox(self, renderer, call_axes_locator=True,
         else:
             self.apply_aspect()
 
-        for axis in self._get_axis_list():
+        for axis in self._axis_map.values():
             if self.axison and axis.get_visible():
                 ba = martist._get_tightbbox_for_layout_only(axis, renderer)
                 if ba:
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -1046,7 +1046,7 @@ def _set_lim(self, v0, v1, *, emit=True, auto):
             Whether to turn on autoscaling of the x-axis. True turns on, False
             turns off, None leaves unchanged.
         """
-        name, = [name for name, axis in self.axes._get_axis_map().items()
+        name, = [name for name, axis in self.axes._axis_map.items()
                  if axis is self]  # The axis name.
 
         self.axes._process_unit_info([(name, (v0, v1))], convert=False)
@@ -1095,7 +1095,7 @@ def _set_lim(self, v0, v1, *, emit=True, auto):
             # Call all of the other axes that are shared with this one
             for other in self.axes._shared_axes[name].get_siblings(self.axes):
                 if other is not self.axes:
-                    other._get_axis_map()[name]._set_lim(
+                    other._axis_map[name]._set_lim(
                         v0, v1, emit=False, auto=auto)
                     if other.figure != self.figure:
                         other.figure.canvas.draw_idle()
@@ -1604,7 +1604,7 @@ def set_units(self, u):
         """
         if u == self.units:
             return
-        for name, axis in self.axes._get_axis_map().items():
+        for name, axis in self.axes._axis_map.items():
             if self is axis:
                 shared = [
                     getattr(ax, f"{name}axis")
@@ -1883,7 +1883,7 @@ def _set_tick_locations(self, ticks, *, minor=False):
 
         # XXX if the user changes units, the information will be lost here
         ticks = self.convert_units(ticks)
-        for name, axis in self.axes._get_axis_map().items():
+        for name, axis in self.axes._axis_map.items():
             if self is axis:
                 shared = [
                     getattr(ax, f"{name}axis")
@@ -1952,7 +1952,7 @@ def _get_tick_boxes_siblings(self, renderer):
         """
         # Get the Grouper keeping track of x or y label groups for this figure.
         axis_names = [
-            name for name, axis in self.axes._get_axis_map().items()
+            name for name, axis in self.axes._axis_map.items()
             if name in self.figure._align_label_groups and axis is self]
         if len(axis_names) != 1:
             return [], []
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -424,7 +424,7 @@ def draw(self, renderer):
             # Calculate projection of collections and patches and zorder
             # them. Make sure they are drawn above the grids.
             zorder_offset = max(axis.get_zorder()
-                                for axis in self._get_axis_list()) + 1
+                                for axis in self._axis_map.values()) + 1
             collection_zorder = patch_zorder = zorder_offset
 
             for artist in sorted(collections_and_patches,
@@ -442,10 +442,10 @@ def draw(self, renderer):
 
         if self._axis3don:
             # Draw panes first
-            for axis in self._get_axis_list():
+            for axis in self._axis_map.values():
                 axis.draw_pane(renderer)
             # Then axes
-            for axis in self._get_axis_list():
+            for axis in self._axis_map.values():
                 axis.draw(renderer)
 
         # Then rest
@@ -3165,7 +3165,7 @@ def get_tightbbox(self, renderer, call_axes_locator=True,
                                     for_layout_only=for_layout_only)
         batch = [ret]
         if self._axis3don:
-            for axis in self._get_axis_list():
+            for axis in self._axis_map.values():
                 if axis.get_visible():
                     axis_bb = martist._get_tightbbox_for_layout_only(
                         axis, renderer)
