MNT: Make transforms.interval_contains private

Author: timhoffm

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

@@ -6,4 +6,5 @@ because they are considerer internal functionality and should not be used
 by end users:
 
 - ``matplotlib.transforms.nonsingular``
+- ``matplotlib.transforms.interval_contains``
 - ``matplotlib.transforms.interval_contains_open``

galleries/examples/specialty_plots/skewt.py

@@ -34,9 +34,9 @@ def draw(self, renderer):
             for artist in [self.gridline, self.tick1line, self.tick2line,
                            self.label1, self.label2]:
                 stack.callback(artist.set_visible, artist.get_visible())
-            needs_lower = transforms.interval_contains(
+            needs_lower = transforms._interval_contains(
                 self.axes.lower_xlim, self.get_loc())
-            needs_upper = transforms.interval_contains(
+            needs_upper = transforms._interval_contains(
                 self.axes.upper_xlim, self.get_loc())
             self.tick1line.set_visible(
                 self.tick1line.get_visible() and needs_lower)

lib/matplotlib/tests/test_skew.py

@@ -25,9 +25,9 @@ def draw(self, renderer):
             for artist in [self.gridline, self.tick1line, self.tick2line,
                            self.label1, self.label2]:
                 stack.callback(artist.set_visible, artist.get_visible())
-            needs_lower = transforms.interval_contains(
+            needs_lower = transforms._interval_contains(
                 self.axes.lower_xlim, self.get_loc())
-            needs_upper = transforms.interval_contains(
+            needs_upper = transforms._interval_contains(
                 self.axes.upper_xlim, self.get_loc())
             self.tick1line.set_visible(
                 self.tick1line.get_visible() and needs_lower)

lib/matplotlib/tests/test_transforms.py

@@ -1093,12 +1093,12 @@ def test_transformedbbox_contains():
 
 
 def test_interval_contains():
-    assert mtransforms.interval_contains((0, 1), 0.5)
-    assert mtransforms.interval_contains((0, 1), 0)
-    assert mtransforms.interval_contains((0, 1), 1)
-    assert not mtransforms.interval_contains((0, 1), -1)
-    assert not mtransforms.interval_contains((0, 1), 2)
-    assert mtransforms.interval_contains((1, 0), 0.5)
+    assert mtransforms._interval_contains((0, 1), 0.5)
+    assert mtransforms._interval_contains((0, 1), 0)
+    assert mtransforms._interval_contains((0, 1), 1)
+    assert not mtransforms._interval_contains((0, 1), -1)
+    assert not mtransforms._interval_contains((0, 1), 2)
+    assert mtransforms._interval_contains((1, 0), 0.5)
 
 
 def test_interval_contains_open():

lib/matplotlib/transforms.py

@@ -2929,7 +2929,7 @@ def nonsingular(vmin, vmax, expander=0.001, tiny=1e-15, increasing=True):
 nonsingular.__doc__ = _nonsingular.__doc__
 
 
-def interval_contains(interval, val):
+def _interval_contains(interval, val):
     """
     Check, inclusively, whether an interval includes a given value.
 
@@ -2951,6 +2951,12 @@ def interval_contains(interval, val):
     return a <= val <= b
 
 
+@_api.deprecated("3.11")
+def interval_contains(interval, val):
+    return _interval_contains(interval, val)
+interval_contains.__doc__ = _interval_contains.__doc__
+
+
 def _interval_contains_close(interval, val, rtol=1e-10):
     """
     Check, inclusively, whether an interval includes a given value, with the

lib/matplotlib/transforms.pyi

@@ -330,6 +330,7 @@ def nonsingular(
     tiny: float = ...,
     increasing: bool = ...,
 ) -> tuple[float, float]: ...
+def _interval_contains(interval: tuple[float, float], val: float) -> bool: ...
 def interval_contains(interval: tuple[float, float], val: float) -> bool: ...
 def _interval_contains_open(interval: tuple[float, float], val: float) -> bool: ...
 def interval_contains_open(interval: tuple[float, float], val: float) -> bool: ...