Skip to content

Commit 9470370

Browse files
committed
Switch get_grid_info to take a single Bbox as parameter.
1 parent b2e8b93 commit 9470370

File tree

3 files changed

+18
-5
lines changed

3 files changed

+18
-5
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff 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.

lib/mpl_toolkits/axisartist/grid_finder.py

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,13 +169,23 @@ def _format_ticks(self, idx, direction, factor, levels):
169169
return (fmt.format_ticks(levels) if isinstance(fmt, mticker.Formatter)
170170
else fmt(direction, factor, levels))
171171

172-
def get_grid_info(self, x1, y1, x2, y2):
172+
def get_grid_info(self, *args, **kwargs):
173173
"""
174-
lon_values, lat_values : list of grid values. if integer is given,
175-
rough number of grids in each direction.
174+
Compute positioning information for grid lines and ticks, given the
175+
axes' data *bbox*.
176176
"""
177+
params = _api.select_matching_signature(
178+
[lambda x1, y1, x2, y2: locals(), lambda bbox: locals()], *args, **kwargs)
179+
if "x1" in params:
180+
_api.warn_deprecated("3.11", message=(
181+
"Passing extents as separate arguments to get_grid_info is deprecated "
182+
"since %(since)s and support will be removed %(removal)s; pass a "
183+
"single bbox instead."))
184+
bbox = Bbox.from_extents(
185+
params["x1"], params["y1"], params["x2"], params["y2"])
186+
else:
187+
bbox = params["bbox"]
177188

178-
bbox = Bbox.from_extents(x1, y1, x2, y2)
179189
tbbox = self.extreme_finder._find_transformed_bbox(
180190
self.get_transform().inverted(), bbox)
181191

lib/mpl_toolkits/axisartist/grid_helper_curvelinear.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ def new_floating_axis(self, nth_coord, value, axes=None, axis_direction="bottom"
341341
return axisline
342342

343343
def _update_grid(self, bbox):
344-
self._grid_info = self.grid_finder.get_grid_info(*bbox.extents)
344+
self._grid_info = self.grid_finder.get_grid_info(bbox)
345345

346346
def get_gridlines(self, which="major", axis="both"):
347347
grid_lines = []

0 commit comments

Comments
 (0)