Skip to content

Deprecate {Locator,Formatter}.set_{{view,data}_interval,bounds}. #13860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 22, 2021
Merged

Deprecate {Locator,Formatter}.set_{{view,data}_interval,bounds}. #13860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/api/next_api_changes/deprecations/13860-AL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Locator and Formatter wrapper methods
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``set_view_interval``, ``set_data_interval`` and ``set_bounds`` methods of
`.Locator`\s and `.Formatter`\s (and their common base class, TickHelper) are
deprecated. Directly manipulate the view and data intervals on the underlying
axis instead.
4 changes: 3 additions & 1 deletion lib/matplotlib/collections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1128,7 +1128,9 @@ def legend_elements(self, prop="colors", num="auto",
raise ValueError("Valid values for `prop` are 'colors' or "
f"'sizes'. You supplied '{prop}' instead.")

fmt.set_bounds(func(u).min(), func(u).max())
fu = func(u)
fmt.axis.set_view_interval(fu.min(), fu.max())
fmt.axis.set_data_interval(fu.min(), fu.max())
if num == "auto":
num = 9
if len(u) <= num:
Expand Down
8 changes: 3 additions & 5 deletions lib/matplotlib/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -869,11 +869,9 @@ def _ticker(self, locator, formatter):
else:
intv = self.vmin, self.vmax
locator.create_dummy_axis(minpos=intv[0])
formatter.create_dummy_axis(minpos=intv[0])
locator.set_view_interval(*intv)
locator.set_data_interval(*intv)
formatter.set_view_interval(*intv)
formatter.set_data_interval(*intv)
locator.axis.set_view_interval(*intv)
locator.axis.set_data_interval(*intv)
formatter.set_axis(locator.axis)

b = np.array(locator())
if isinstance(locator, ticker.LogLocator):
Expand Down
6 changes: 2 additions & 4 deletions lib/matplotlib/dates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1480,10 +1480,6 @@ def get_locator(self, dmin, dmax):
'epoch.')

locator.set_axis(self.axis)

if self.axis is not None:
locator.set_view_interval(*self.axis.get_view_interval())
locator.set_data_interval(*self.axis.get_data_interval())
return locator


Expand Down Expand Up @@ -1727,10 +1723,12 @@ def set_axis(self, axis):
self._wrapped_locator.set_axis(axis)
return super().set_axis(axis)

@_api.deprecated("3.5", alternative=".axis.set_view_interval")
def set_view_interval(self, vmin, vmax):
self._wrapped_locator.set_view_interval(vmin, vmax)
return super().set_view_interval(vmin, vmax)

@_api.deprecated("3.5", alternative=".axis.set_data_interval")
def set_data_interval(self, vmin, vmax):
self._wrapped_locator.set_data_interval(vmin, vmax)
return super().set_data_interval(vmin, vmax)
Expand Down
21 changes: 9 additions & 12 deletions lib/matplotlib/tests/test_dates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ def test_date_formatter_usetex(delta, expected):

locator = mdates.AutoDateLocator(interval_multiples=False)
locator.create_dummy_axis()
locator.set_view_interval(mdates.date2num(d1), mdates.date2num(d2))
locator.axis.set_view_interval(mdates.date2num(d1), mdates.date2num(d2))

formatter = mdates.AutoDateFormatter(locator, usetex=True)
assert [formatter(loc) for loc in locator()] == expected
Expand Down Expand Up @@ -319,8 +319,7 @@ def test_auto_date_locator():
def _create_auto_date_locator(date1, date2):
locator = mdates.AutoDateLocator(interval_multiples=False)
locator.create_dummy_axis()
locator.set_view_interval(mdates.date2num(date1),
mdates.date2num(date2))
locator.axis.set_view_interval(*mdates.date2num([date1, date2]))
return locator

d1 = datetime.datetime(1990, 1, 1)
Expand Down Expand Up @@ -391,8 +390,7 @@ def test_auto_date_locator_intmult():
def _create_auto_date_locator(date1, date2):
locator = mdates.AutoDateLocator(interval_multiples=True)
locator.create_dummy_axis()
locator.set_view_interval(mdates.date2num(date1),
mdates.date2num(date2))
locator.axis.set_view_interval(*mdates.date2num([date1, date2]))
return locator

results = ([datetime.timedelta(weeks=52 * 200),
Expand Down Expand Up @@ -574,7 +572,7 @@ def test_concise_formatter_usetex(t_delta, expected):

locator = mdates.AutoDateLocator(interval_multiples=True)
locator.create_dummy_axis()
locator.set_view_interval(mdates.date2num(d1), mdates.date2num(d2))
locator.axis.set_view_interval(mdates.date2num(d1), mdates.date2num(d2))

formatter = mdates.ConciseDateFormatter(locator, usetex=True)
assert formatter.format_ticks(locator()) == expected
Expand Down Expand Up @@ -732,8 +730,7 @@ def test_auto_date_locator_intmult_tz():
def _create_auto_date_locator(date1, date2, tz):
locator = mdates.AutoDateLocator(interval_multiples=True, tz=tz)
locator.create_dummy_axis()
locator.set_view_interval(mdates.date2num(date1),
mdates.date2num(date2))
locator.axis.set_view_interval(*mdates.date2num([date1, date2]))
return locator

results = ([datetime.timedelta(weeks=52*200),
Expand Down Expand Up @@ -951,8 +948,8 @@ def test_yearlocator_pytz():
+ datetime.timedelta(i) for i in range(2000)]
locator = mdates.AutoDateLocator(interval_multiples=True, tz=tz)
locator.create_dummy_axis()
locator.set_view_interval(mdates.date2num(x[0])-1.0,
mdates.date2num(x[-1])+1.0)
locator.axis.set_view_interval(mdates.date2num(x[0])-1.0,
mdates.date2num(x[-1])+1.0)
t = np.array([733408.208333, 733773.208333, 734138.208333,
734503.208333, 734869.208333, 735234.208333, 735599.208333])
# convert to new epoch from old...
Expand Down Expand Up @@ -1035,8 +1032,8 @@ def test_warn_notintervals():
locator = mdates.AutoDateLocator(interval_multiples=False)
locator.intervald[3] = [2]
locator.create_dummy_axis()
locator.set_view_interval(mdates.date2num(dates[0]),
mdates.date2num(dates[-1]))
locator.axis.set_view_interval(mdates.date2num(dates[0]),
mdates.date2num(dates[-1]))
with pytest.warns(UserWarning, match="AutoDateLocator was unable") as rec:
locs = locator()

Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/tests/test_ticker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,7 +558,7 @@ def test_use_locale(self):
assert tmp_form.get_useLocale()

tmp_form.create_dummy_axis()
tmp_form.set_bounds(0, 10)
tmp_form.axis.set_data_interval(0, 10)
tmp_form.set_locs([1, 2, 3])
assert sep in tmp_form(1e9)

Expand Down Expand Up @@ -589,7 +589,7 @@ def test_cursor_dummy_axis(self, data, expected):
# Issue #17624
sf = mticker.ScalarFormatter()
sf.create_dummy_axis()
sf.set_bounds(0, 10)
sf.axis.set_view_interval(0, 10)
fmt = sf.format_data_short
assert fmt(data) == expected

Expand Down
5 changes: 5 additions & 0 deletions lib/matplotlib/ticker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,12 +231,17 @@ def create_dummy_axis(self, **kwargs):
if self.axis is None:
self.axis = _DummyAxis(**kwargs)

@_api.deprecated("3.5", alternative=".axis.set_view_interval")
def set_view_interval(self, vmin, vmax):
self.axis.set_view_interval(vmin, vmax)

@_api.deprecated("3.5", alternative=".axis.set_data_interval")
def set_data_interval(self, vmin, vmax):
self.axis.set_data_interval(vmin, vmax)

@_api.deprecated(
"3.5",
alternative=".axis.set_view_interval and .axis.set_data_interval")
def set_bounds(self, vmin, vmax):
self.set_view_interval(vmin, vmax)
self.set_data_interval(vmin, vmax)
Expand Down
3 changes: 1 addition & 2 deletions lib/mpl_toolkits/axisartist/grid_finder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,7 @@ def __init__(self, nbins=10, steps=None,
self._factor = 1

def __call__(self, v1, v2):
self.set_bounds(v1 * self._factor, v2 * self._factor)
locs = super().__call__()
locs = super().tick_values(v1 * self._factor, v2 * self._factor)
return np.array(locs), len(locs), self._factor

@_api.deprecated("3.3")
Expand Down