Merge pull request #30368 from anntzer/ggib

QuLogic · web-flow · commit e99f7f8d2568 · 2025-07-30T22:39:30.000-04:00
Switch get_grid_info to take a single Bbox as parameter.
diff --git a/doc/api/next_api_changes/deprecations/30368-AL.rst b/doc/api/next_api_changes/deprecations/30368-AL.rst
@@ -0,0 +1,3 @@
+``GridFinder.get_grid_info`` now takes a single bbox as parameter
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Passing ``x1, y1, x2, y2`` as separate parameters is deprecated.
diff --git a/lib/mpl_toolkits/axisartist/grid_finder.py b/lib/mpl_toolkits/axisartist/grid_finder.py
@@ -169,13 +169,23 @@ def _format_ticks(self, idx, direction, factor, levels):
         return (fmt.format_ticks(levels) if isinstance(fmt, mticker.Formatter)
                 else fmt(direction, factor, levels))
 
-    def get_grid_info(self, x1, y1, x2, y2):
+    def get_grid_info(self, *args, **kwargs):
         """
-        lon_values, lat_values : list of grid values. if integer is given,
-                           rough number of grids in each direction.
+        Compute positioning information for grid lines and ticks, given the
+        axes' data *bbox*.
         """
+        params = _api.select_matching_signature(
+            [lambda x1, y1, x2, y2: locals(), lambda bbox: locals()], *args, **kwargs)
+        if "x1" in params:
+            _api.warn_deprecated("3.11", message=(
+                "Passing extents as separate arguments to get_grid_info is deprecated "
+                "since %(since)s and support will be removed %(removal)s; pass a "
+                "single bbox instead."))
+            bbox = Bbox.from_extents(
+                params["x1"], params["y1"], params["x2"], params["y2"])
+        else:
+            bbox = params["bbox"]
 
-        bbox = Bbox.from_extents(x1, y1, x2, y2)
         tbbox = self.extreme_finder._find_transformed_bbox(
             self.get_transform().inverted(), bbox)
 
diff --git a/lib/mpl_toolkits/axisartist/grid_helper_curvelinear.py b/lib/mpl_toolkits/axisartist/grid_helper_curvelinear.py
@@ -341,7 +341,7 @@ def new_floating_axis(self, nth_coord, value, axes=None, axis_direction="bottom"
         return axisline
 
     def _update_grid(self, bbox):
-        self._grid_info = self.grid_finder.get_grid_info(*bbox.extents)
+        self._grid_info = self.grid_finder.get_grid_info(bbox)
 
     def get_gridlines(self, which="major", axis="both"):
         grid_lines = []

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+``GridFinder.get_grid_info`` now takes a single bbox as parameter
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	+Passing ``x1, y1, x2, y2`` as separate parameters is deprecated.