Merge pull request #15506 from anntzer/locator-den

tacaswell · web-flow · commit 09c83816ac57 · 2019-10-24T21:13:14.000-04:00
API: Rename locator.den to the clearer locator.nbins in mpl_toolkits.
diff --git a/doc/api/next_api_changes/deprecations.rst b/doc/api/next_api_changes/deprecations.rst
@@ -22,3 +22,10 @@ logging.
 These attributes are deprecated, for consistency with ``AxesImage.is_grayscale``,
 which was removed back in Matplotlib 2.0.0.  (Note that previously, these
 attributes were only available *after rendering the image*).
+
+``den`` parameter and attribute to :mod:`mpl_toolkits.axisartist.angle_helper`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+For all locator classes defined in :mod:`mpl_toolkits.axisartist.angle_helper`,
+the ``den`` parameter has been renamed to ``nbins``, and the ``den`` attribute
+deprecated in favor of its (preexisting) synonym ``nbins``, for consistency
+with locator classes defined in :mod:`matplotlib.ticker`.
diff --git a/lib/mpl_toolkits/axisartist/angle_helper.py b/lib/mpl_toolkits/axisartist/angle_helper.py
@@ -1,6 +1,7 @@
 import numpy as np
 import math
 
+from matplotlib import cbook
 from mpl_toolkits.axisartist.grid_finder import ExtremeFinderSimple
 
 
@@ -156,54 +157,56 @@ def select_step360(v1, v2, nv, include_last=True, threshold_factor=3600):
 
 
 class LocatorBase:
-    def __init__(self, den, include_last=True):
-        self.den = den
+    @cbook._rename_parameter("3.3", "den", "nbins")
+    def __init__(self, nbins, include_last=True):
+        self.nbins = nbins
         self._include_last = include_last
 
+    @cbook.deprecated("3.3", alternative="nbins")
     @property
-    def nbins(self):
-        return self.den
+    def den(self):
+        return self.nbins
 
-    @nbins.setter
-    def nbins(self, v):
-        self.den = v
+    @den.setter
+    def den(self, v):
+        self.nbins = v
 
     def set_params(self, nbins=None):
         if nbins is not None:
-            self.den = int(nbins)
+            self.nbins = int(nbins)
 
 
 class LocatorHMS(LocatorBase):
     def __call__(self, v1, v2):
-        return select_step24(v1, v2, self.den, self._include_last)
+        return select_step24(v1, v2, self.nbins, self._include_last)
 
 
 class LocatorHM(LocatorBase):
     def __call__(self, v1, v2):
-        return select_step24(v1, v2, self.den, self._include_last,
+        return select_step24(v1, v2, self.nbins, self._include_last,
                              threshold_factor=60)
 
 
 class LocatorH(LocatorBase):
     def __call__(self, v1, v2):
-        return select_step24(v1, v2, self.den, self._include_last,
+        return select_step24(v1, v2, self.nbins, self._include_last,
                              threshold_factor=1)
 
 
 class LocatorDMS(LocatorBase):
     def __call__(self, v1, v2):
-        return select_step360(v1, v2, self.den, self._include_last)
+        return select_step360(v1, v2, self.nbins, self._include_last)
 
 
 class LocatorDM(LocatorBase):
     def __call__(self, v1, v2):
-        return select_step360(v1, v2, self.den, self._include_last,
+        return select_step360(v1, v2, self.nbins, self._include_last,
                               threshold_factor=60)
 
 
 class LocatorD(LocatorBase):
     def __call__(self, v1, v2):
-        return select_step360(v1, v2, self.den, self._include_last,
+        return select_step360(v1, v2, self.nbins, self._include_last,
                               threshold_factor=1)
 
 
diff --git a/lib/mpl_toolkits/tests/test_axisartist_grid_helper_curvelinear.py b/lib/mpl_toolkits/tests/test_axisartist_grid_helper_curvelinear.py
@@ -206,8 +206,8 @@ def test_axis_direction():
     axis.major_ticklabels.set_axis_direction("top")
     axis.label.set_axis_direction("top")
 
-    grid_helper.grid_finder.grid_locator1.den = 5
-    grid_helper.grid_finder.grid_locator2._nbins = 5
+    grid_helper.grid_finder.grid_locator1.set_params(nbins=5)
+    grid_helper.grid_finder.grid_locator2.set_params(nbins=5)
 
     ax1.set_aspect(1.)
     ax1.set_xlim(-8, 8)
