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

anntzer · anntzer · commit 9c7858d40c13 · 2019-04-03T12:05:58.000+02:00
Directly manipulating the underlying axis' view and data intervals is
clearer (see e.g. the changes in dates.py which ultimately just deletes
code that sets `self.axis`'s view and data intervals to themselves).
diff --git a/doc/api/next_api_changes/2019-04-03-AL.rst b/doc/api/next_api_changes/2019-04-03-AL.rst
@@ -0,0 +1,7 @@
+Deprecations
+````````````
+
+The ``set_view_interval``, ``set_data_interval`` and ``set_bounds`` methods
+of Locators and Formatters (and their common base class, TickHelper) are
+deprecated.  Directly manipulate the view and data intervals on the underlying
+axis instead.
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -959,7 +959,8 @@ 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())
+        fmt.axis.set_view_interval(func(u).min(), func(u).max())
+        fmt.axis.set_data_interval(func(u).min(), func(u).max())
         if num == "auto":
             num = 9
             if len(u) <= num:
diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py
@@ -841,11 +841,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):
diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py
@@ -1567,10 +1567,6 @@ def get_locator(self, dmin, dmax):
                              'documentation for details.')
 
         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
 
 
@@ -1829,14 +1825,6 @@ def set_axis(self, axis):
         self._wrapped_locator.set_axis(axis)
         return DateLocator.set_axis(self, axis)
 
-    def set_view_interval(self, vmin, vmax):
-        self._wrapped_locator.set_view_interval(vmin, vmax)
-        return DateLocator.set_view_interval(self, vmin, vmax)
-
-    def set_data_interval(self, vmin, vmax):
-        self._wrapped_locator.set_data_interval(vmin, vmax)
-        return DateLocator.set_data_interval(self, vmin, vmax)
-
     def __call__(self):
         # if no data have been set, this will tank with a ValueError
         try:
diff --git a/lib/matplotlib/tests/test_dates.py b/lib/matplotlib/tests/test_dates.py
@@ -367,8 +367,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)
@@ -437,8 +436,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),
@@ -563,8 +561,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),
@@ -784,8 +781,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)
 
     np.testing.assert_allclose([733408.208333, 733773.208333, 734138.208333,
                                 734503.208333, 734869.208333,
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -227,12 +227,17 @@ def create_dummy_axis(self, **kwargs):
         if self.axis is None:
             self.axis = _DummyAxis(**kwargs)
 
+    @cbook.deprecated("3.2", alternative=".axis.set_view_interval")
     def set_view_interval(self, vmin, vmax):
         self.axis.set_view_interval(vmin, vmax)
 
+    @cbook.deprecated("3.2", alternative=".axis.set_data_interval")
     def set_data_interval(self, vmin, vmax):
         self.axis.set_data_interval(vmin, vmax)
 
+    @cbook.deprecated(
+        "3.2",
+        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)
diff --git a/lib/mpl_toolkits/axisartist/grid_finder.py b/lib/mpl_toolkits/axisartist/grid_finder.py
@@ -249,14 +249,9 @@ def __init__(self, nbins=10, steps=None,
         self._factor = None
 
     def __call__(self, v1, v2):
-        if self._factor is not None:
-            self.set_bounds(v1*self._factor, v2*self._factor)
-            locs = mticker.MaxNLocator.__call__(self)
-            return np.array(locs), len(locs), self._factor
-        else:
-            self.set_bounds(v1, v2)
-            locs = mticker.MaxNLocator.__call__(self)
-            return np.array(locs), len(locs), None
+        factor = self._factor if self._factor is not None else 1
+        locs = super().tick_values(v1 * factor, v2 * factor)
+        return np.array(locs), len(locs), self._factor
 
     def set_factor(self, f):
         self._factor = f
