Merge pull request matplotlib#20206 from anntzer/aagi

Cleanup axisartist in preparation for future changes.

Author: timhoffm

doc/api/next_api_changes/deprecations/20206-AL.rst

@@ -0,0 +1,3 @@
+The ``grid_info`` attribute of ``axisartist`` classes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... has been deprecated.

lib/mpl_toolkits/axisartist/floating_axes.py

@@ -44,15 +44,15 @@ def __init__(self, grid_helper, side, nth_coord_ticks=None):
 
     def update_lim(self, axes):
         self.grid_helper.update_lim(axes)
-        self.grid_info = self.grid_helper.grid_info
+        self._grid_info = self.grid_helper._grid_info
 
     def get_tick_iterators(self, axes):
         """tick_loc, tick_angle, tick_label, (optionally) tick_label"""
 
         grid_finder = self.grid_helper.grid_finder
 
-        lat_levs, lat_n, lat_factor = self.grid_info["lat_info"]
-        lon_levs, lon_n, lon_factor = self.grid_info["lon_info"]
+        lat_levs, lat_n, lat_factor = self._grid_info["lat_info"]
+        lon_levs, lon_n, lon_factor = self._grid_info["lon_info"]
 
         lon_levs, lat_levs = np.asarray(lon_levs), np.asarray(lat_levs)
         if lat_factor is not None:
@@ -94,7 +94,7 @@ def transform_xy(x, y):
             xx2a, yy2a = transform_xy(xx0, yy00)
             xx2b, yy2b = transform_xy(xx0, yy00 + dy)
 
-            labels = self.grid_info["lat_labels"]
+            labels = self._grid_info["lat_labels"]
             labels = [l for l, m in zip(labels, mask) if m]
 
         elif self.nth_coord == 1:
@@ -113,7 +113,7 @@ def transform_xy(x, y):
             xx2a, yy2a = transform_xy(xx00, yy0)
             xx2b, yy2b = transform_xy(xx00 + dx, yy0)
 
-            labels = self.grid_info["lon_labels"]
+            labels = self._grid_info["lon_labels"]
             labels = [l for l, m in zip(labels, mask) if m]
 
         def f1():
@@ -138,7 +138,7 @@ def get_line(self, axes):
                     right=("lon_lines0", 1),
                     bottom=("lat_lines0", 0),
                     top=("lat_lines0", 1))[self._side]
-        xx, yy = self.grid_info[k][v]
+        xx, yy = self._grid_info[k][v]
         return Path(np.column_stack([xx, yy]))
 
 
@@ -229,10 +229,10 @@ def new_fixed_axis(self, loc,
     #     return axis
 
     def _update_grid(self, x1, y1, x2, y2):
-        if self.grid_info is None:
-            self.grid_info = dict()
+        if self._grid_info is None:
+            self._grid_info = dict()
 
-        grid_info = self.grid_info
+        grid_info = self._grid_info
 
         grid_finder = self.grid_finder
         extremes = grid_finder.extreme_finder(grid_finder.inv_transform_xy,
@@ -284,9 +284,9 @@ def _update_grid(self, x1, y1, x2, y2):
     def get_gridlines(self, which="major", axis="both"):
         grid_lines = []
         if axis in ["both", "x"]:
-            grid_lines.extend(self.grid_info["lon_lines"])
+            grid_lines.extend(self._grid_info["lon_lines"])
         if axis in ["both", "y"]:
-            grid_lines.extend(self.grid_info["lat_lines"])
+            grid_lines.extend(self._grid_info["lat_lines"])
         return grid_lines
 
     def get_boundary(self):

lib/mpl_toolkits/axisartist/grid_helper_curvelinear.py

@@ -5,6 +5,7 @@
 
 import numpy as np
 
+from matplotlib import _api
 from matplotlib.path import Path
 from matplotlib.transforms import Affine2D, IdentityTransform
 from .axislines import AxisArtistHelper, GridHelperBase
@@ -75,19 +76,17 @@ def get_tick_iterators(self, axes):
 
 
 class FloatingAxisArtistHelper(AxisArtistHelper.Floating):
+    grid_info = _api.deprecate_privatize_attribute("3.5")
 
     def __init__(self, grid_helper, nth_coord, value, axis_direction=None):
         """
         nth_coord = along which coordinate value varies.
          nth_coord = 0 ->  x axis, nth_coord = 1 -> y axis
         """
-
         super().__init__(nth_coord, value)
         self.value = value
         self.grid_helper = grid_helper
         self._extremes = -np.inf, np.inf
-
-        self._get_line_path = None  # a method that returns a Path.
         self._line_num_points = 100  # number of points to create a line
 
     def set_extremes(self, e1, e2):
@@ -129,7 +128,7 @@ def update_lim(self, axes):
             yy0 = np.full(self._line_num_points, self.value)
             xx, yy = grid_finder.transform_xy(xx0, yy0)
 
-        self.grid_info = {
+        self._grid_info = {
             "extremes": (lon_min, lon_max, lat_min, lat_max),
             "lon_info": (lon_levs, lon_n, lon_factor),
             "lat_info": (lat_levs, lat_n, lat_factor),
@@ -145,7 +144,7 @@ def get_axislabel_transform(self, axes):
 
     def get_axislabel_pos_angle(self, axes):
 
-        extremes = self.grid_info["extremes"]
+        extremes = self._grid_info["extremes"]
 
         if self.nth_coord == 0:
             xx0 = self.value
@@ -180,12 +179,12 @@ def get_tick_iterators(self, axes):
 
         grid_finder = self.grid_helper.grid_finder
 
-        lat_levs, lat_n, lat_factor = self.grid_info["lat_info"]
+        lat_levs, lat_n, lat_factor = self._grid_info["lat_info"]
         lat_levs = np.asarray(lat_levs)
         yy0 = lat_levs / lat_factor
         dy = 0.01 / lat_factor
 
-        lon_levs, lon_n, lon_factor = self.grid_info["lon_info"]
+        lon_levs, lon_n, lon_factor = self._grid_info["lon_info"]
         lon_levs = np.asarray(lon_levs)
         xx0 = lon_levs / lon_factor
         dx = 0.01 / lon_factor
@@ -221,7 +220,7 @@ def transform_xy(x, y):
             xx2a, yy2a = transform_xy(xx0, yy0)
             xx2b, yy2b = transform_xy(xx0, yy0+dy)
 
-            labels = self.grid_info["lat_labels"]
+            labels = self._grid_info["lat_labels"]
             labels = [l for l, m in zip(labels, mask) if m]
 
         elif self.nth_coord == 1:
@@ -237,7 +236,7 @@ def transform_xy(x, y):
             xx2a, yy2a = transform_xy(xx00, yy0)
             xx2b, yy2b = transform_xy(xx00+dx, yy0)
 
-            labels = self.grid_info["lon_labels"]
+            labels = self._grid_info["lon_labels"]
             labels = [l for l, m in zip(labels, mask) if m]
 
         def f1():
@@ -261,15 +260,12 @@ def get_line_transform(self, axes):
 
     def get_line(self, axes):
         self.update_lim(axes)
-        x, y = self.grid_info["line_xy"]
-
-        if self._get_line_path is None:
-            return Path(np.column_stack([x, y]))
-        else:
-            return self._get_line_path(axes, x, y)
+        x, y = self._grid_info["line_xy"]
+        return Path(np.column_stack([x, y]))
 
 
 class GridHelperCurveLinear(GridHelperBase):
+    grid_info = _api.deprecate_privatize_attribute("3.5")
 
     def __init__(self, aux_trans,
                  extreme_finder=None,
@@ -288,7 +284,7 @@ def __init__(self, aux_trans,
         e.g., ``x2, y2 = trans(x1, y1)``
         """
         super().__init__()
-        self.grid_info = None
+        self._grid_info = None
         self._aux_trans = aux_trans
         self.grid_finder = GridFinder(aux_trans,
                                       extreme_finder,
@@ -347,15 +343,15 @@ def new_floating_axis(self, nth_coord,
         return axisline
 
     def _update_grid(self, x1, y1, x2, y2):
-        self.grid_info = self.grid_finder.get_grid_info(x1, y1, x2, y2)
+        self._grid_info = self.grid_finder.get_grid_info(x1, y1, x2, y2)
 
     def get_gridlines(self, which="major", axis="both"):
         grid_lines = []
         if axis in ["both", "x"]:
-            for gl in self.grid_info["lon"]["lines"]:
+            for gl in self._grid_info["lon"]["lines"]:
                 grid_lines.extend(gl)
         if axis in ["both", "y"]:
-            for gl in self.grid_info["lat"]["lines"]:
+            for gl in self._grid_info["lat"]["lines"]:
                 grid_lines.extend(gl)
         return grid_lines
 
@@ -367,15 +363,15 @@ def get_tick_iterator(self, nth_coord, axis_side, minor=False):
         lon_or_lat = ["lon", "lat"][nth_coord]
         if not minor:  # major ticks
             for (xy, a), l in zip(
-                    self.grid_info[lon_or_lat]["tick_locs"][axis_side],
-                    self.grid_info[lon_or_lat]["tick_labels"][axis_side]):
+                    self._grid_info[lon_or_lat]["tick_locs"][axis_side],
+                    self._grid_info[lon_or_lat]["tick_labels"][axis_side]):
                 angle_normal = a
                 yield xy, angle_normal, angle_tangent, l
         else:
             for (xy, a), l in zip(
-                    self.grid_info[lon_or_lat]["tick_locs"][axis_side],
-                    self.grid_info[lon_or_lat]["tick_labels"][axis_side]):
+                    self._grid_info[lon_or_lat]["tick_locs"][axis_side],
+                    self._grid_info[lon_or_lat]["tick_labels"][axis_side]):
                 angle_normal = a
                 yield xy, angle_normal, angle_tangent, ""
-            # for xy, a, l in self.grid_info[lon_or_lat]["ticks"][axis_side]:
+            # for xy, a, l in self._grid_info[lon_or_lat]["ticks"][axis_side]:
             #     yield xy, a, ""