MNT: Make transforms.nonsingular private

Author: timhoffm

doc/api/next_api_changes/deprecations/30889-TH.rst

@@ -0,0 +1,8 @@
+Transforms helper functions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following functions in the `transforms` module are deprecated,
+because they are considerer internal functionality and should not be used
+by end users:
+
+- ``matplotlib.transforms.nonsingular``

lib/matplotlib/axes/_axes.py

@@ -5662,8 +5662,8 @@ def reduce_C_function(C: array) -> float
             ymin, ymax = (ty.min(), ty.max()) if len(y) else (0, 1)
 
             # to avoid issues with singular data, expand the min/max pairs
-            xmin, xmax = mtransforms.nonsingular(xmin, xmax, expander=0.1)
-            ymin, ymax = mtransforms.nonsingular(ymin, ymax, expander=0.1)
+            xmin, xmax = mtransforms._nonsingular(xmin, xmax, expander=0.1)
+            ymin, ymax = mtransforms._nonsingular(ymin, ymax, expander=0.1)
 
         nx1 = nx + 1
         ny1 = ny + 1

lib/matplotlib/axes/_base.py

@@ -3050,7 +3050,7 @@ def handle_single_axis(
                 x0, x1 = (-np.inf, np.inf)
             # If x0 and x1 are nonfinite, get default limits from the locator.
             locator = axis.get_major_locator()
-            x0, x1 = locator.nonsingular(x0, x1)
+            x0, x1 = locator._nonsingular(x0, x1)
             # Find the minimum minpos for use in the margin calculation.
             minimum_minpos = min(
                 getattr(ax.dataLim, f"minpos{name}") for ax in shared)

lib/matplotlib/colorbar.py

@@ -1098,7 +1098,7 @@ def _process_values(self):
             # If we still aren't scaled after autoscaling, use 0, 1 as default
             self.norm.vmin = 0
             self.norm.vmax = 1
-        self.norm.vmin, self.norm.vmax = mtransforms.nonsingular(
+        self.norm.vmin, self.norm.vmax = mtransforms._nonsingular(
             self.norm.vmin, self.norm.vmax, expander=0.1)
         if (not isinstance(self.norm, colors.BoundaryNorm) and
                 (self.boundaries is None)):

lib/matplotlib/projections/polar.py

@@ -469,7 +469,7 @@ def view_limits(self, vmin, vmax):
         if self._zero_in_bounds() and vmax > vmin:
             # this allows inverted r/y-lims
             vmin = min(0, vmin)
-        return mtransforms.nonsingular(vmin, vmax)
+        return mtransforms._nonsingular(vmin, vmax)
 
 
 class _ThetaShift(mtransforms.ScaledTranslation):

lib/matplotlib/tests/test_transforms.py

@@ -977,7 +977,7 @@ def test_nonsingular():
     zero_expansion = np.array([-0.001, 0.001])
     cases = [(0, np.nan), (0, 0), (0, 7.9e-317)]
     for args in cases:
-        out = np.array(mtransforms.nonsingular(*args))
+        out = np.array(mtransforms._nonsingular(*args))
         assert_array_equal(out, zero_expansion)
 
 

lib/matplotlib/ticker.py

@@ -1029,7 +1029,7 @@ def __call__(self, x, pos=None):
             return ''
 
         vmin, vmax = self.axis.get_view_interval()
-        vmin, vmax = mtransforms.nonsingular(vmin, vmax, expander=0.05)
+        vmin, vmax = mtransforms._nonsingular(vmin, vmax, expander=0.05)
         s = self._num_to_string(x, vmin, vmax)
         return self.fix_minus(s)
 
@@ -1730,15 +1730,15 @@ def nonsingular(self, v0, v1):
           default view limits.
         - Otherwise, ``(v0, v1)`` is returned without modification.
         """
-        return mtransforms.nonsingular(v0, v1, expander=.05)
+        return mtransforms._nonsingular(v0, v1, expander=.05)
 
     def view_limits(self, vmin, vmax):
         """
         Select a scale for the range from vmin to vmax.
 
         Subclasses should override this method to change locator behaviour.
         """
-        return mtransforms.nonsingular(vmin, vmax)
+        return mtransforms._nonsingular(vmin, vmax)
 
 
 class IndexLocator(Locator):
@@ -1881,7 +1881,7 @@ def __call__(self):
         return self.tick_values(vmin, vmax)
 
     def tick_values(self, vmin, vmax):
-        vmin, vmax = mtransforms.nonsingular(vmin, vmax, expander=0.05)
+        vmin, vmax = mtransforms._nonsingular(vmin, vmax, expander=0.05)
 
         if (vmin, vmax) in self.presets:
             return self.presets[(vmin, vmax)]
@@ -1910,7 +1910,7 @@ def view_limits(self, vmin, vmax):
             vmin = math.floor(scale * vmin) / scale
             vmax = math.ceil(scale * vmax) / scale
 
-        return mtransforms.nonsingular(vmin, vmax)
+        return mtransforms._nonsingular(vmin, vmax)
 
 
 class MultipleLocator(Locator):
@@ -1980,7 +1980,7 @@ def view_limits(self, dmin, dmax):
             vmin = dmin
             vmax = dmax
 
-        return mtransforms.nonsingular(vmin, vmax)
+        return mtransforms._nonsingular(vmin, vmax)
 
 
 def scale_range(vmin, vmax, n=1, threshold=100):
@@ -2236,7 +2236,7 @@ def tick_values(self, vmin, vmax):
         if self._symmetric:
             vmax = max(abs(vmin), abs(vmax))
             vmin = -vmax
-        vmin, vmax = mtransforms.nonsingular(
+        vmin, vmax = mtransforms._nonsingular(
             vmin, vmax, expander=1e-13, tiny=1e-14)
         locs = self._raw_ticks(vmin, vmax)
 
@@ -2254,7 +2254,7 @@ def view_limits(self, dmin, dmax):
             dmax = max(abs(dmin), abs(dmax))
             dmin = -dmax
 
-        dmin, dmax = mtransforms.nonsingular(
+        dmin, dmax = mtransforms._nonsingular(
             dmin, dmax, expander=1e-12, tiny=1e-13)
 
         if mpl.rcParams['axes.autolimit_mode'] == 'round_numbers':
@@ -2718,7 +2718,7 @@ def view_limits(self, vmin, vmax):
                 vmin = _decade_less(vmin, b)
                 vmax = _decade_greater(vmax, b)
 
-        return mtransforms.nonsingular(vmin, vmax)
+        return mtransforms._nonsingular(vmin, vmax)
 
 
 class AsinhLocator(Locator):

lib/matplotlib/transforms.py

@@ -2865,7 +2865,7 @@ def _revalidate(self):
         super()._revalidate()
 
 
-def nonsingular(vmin, vmax, expander=0.001, tiny=1e-15, increasing=True):
+def _nonsingular(vmin, vmax, expander=0.001, tiny=1e-15, increasing=True):
     """
     Modify the endpoints of a range as needed to avoid singularities.
 
@@ -2923,6 +2923,12 @@ def nonsingular(vmin, vmax, expander=0.001, tiny=1e-15, increasing=True):
     return vmin, vmax
 
 
+@_api.deprecated("3.11")
+def nonsingular(vmin, vmax, expander=0.001, tiny=1e-15, increasing=True):
+    return _nonsingular(vmin, vmax, expander, tiny, increasing)
+nonsingular.__doc__ = _nonsingular.__doc__
+
+
 def interval_contains(interval, val):
     """
     Check, inclusively, whether an interval includes a given value.

lib/matplotlib/transforms.pyi

@@ -316,6 +316,13 @@ class TransformedPath(TransformNode):
 class TransformedPatchPath(TransformedPath):
     def __init__(self, patch: Patch) -> None: ...
 
+def _nonsingular(
+    vmin: float,
+    vmax: float,
+    expander: float = ...,
+    tiny: float = ...,
+    increasing: bool = ...,
+) -> tuple[float, float]: ...
 def nonsingular(
     vmin: float,
     vmax: float,