Deprecate Path.has_nonfinite. (#12846)

anntzer · timhoffm · commit 0ed35b1a132e · 2018-11-24T15:49:50.000+01:00
The attribute was introduced in c7837e4 (Oct. 2008) for optimization pruposes, but it is internally unused since 0ad0ee4 (Jan. 2009) when the path nan-handling moved to C++. Since then it's only been touched by additional commits to make sure it is correctly updated by APIs like `cleaned`, but it has far outlived its utility (plus, directly checking the vertices is just as good if you really care -- don't make everyone else pay for it when instantiating Paths).
diff --git a/doc/api/next_api_changes/2018-11-20-AL.rst b/doc/api/next_api_changes/2018-11-20-AL.rst
@@ -0,0 +1,5 @@
+Deprecations
+````````````
+
+The ``Path.has_nonfinite`` attribute is deprecated (use ``not
+np.isfinite(path.vertices).all()`` instead).
diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py
@@ -166,9 +166,8 @@ def _fast_from_codes_and_verts(cls, verts, codes, internals=None):
         verts : numpy array
         codes : numpy array
         internals : dict or None
-            The attributes that the resulting path should have.
-            Allowed keys are ``readonly``, ``should_simplify``,
-            ``simplify_threshold``, ``has_nonfinite`` and
+            The attributes that the resulting path should have.  Allowed keys
+            are ``readonly``, ``should_simplify``, ``simplify_threshold``, and
             ``interpolation_steps``.
 
         """
@@ -182,7 +181,6 @@ def _fast_from_codes_and_verts(cls, verts, codes, internals=None):
             internals.pop('simplify_threshold',
                           rcParams['path.simplify_threshold'])
         )
-        pth._has_nonfinite = internals.pop('has_nonfinite', False)
         pth._interpolation_steps = internals.pop('interpolation_steps', 1)
         if internals:
             raise ValueError('Unexpected internals provided to '
@@ -198,7 +196,6 @@ def _update_values(self):
             len(self._vertices) >= 128 and
             (self._codes is None or np.all(self._codes <= Path.LINETO))
         )
-        self._has_nonfinite = not np.isfinite(self._vertices).all()
 
     @property
     def vertices(self):
@@ -245,12 +242,14 @@ def simplify_threshold(self):
     def simplify_threshold(self, threshold):
         self._simplify_threshold = threshold
 
+    @cbook.deprecated(
+        "3.1", alternative="not np.isfinite(self.vertices).all()")
     @property
     def has_nonfinite(self):
         """
         `True` if the vertices array has nonfinite values.
         """
-        return self._has_nonfinite
+        return not np.isfinite(self._vertices).all()
 
     @property
     def should_simplify(self):
@@ -442,7 +441,6 @@ def cleaned(self, transform=None, remove_nans=False, clip=None,
                                              snap, stroke_width,
                                              simplify, curves, sketch)
         internals = {'should_simplify': self.should_simplify and not simplify,
-                     'has_nonfinite': self.has_nonfinite and not remove_nans,
                      'simplify_threshold': self.simplify_threshold,
                      'interpolation_steps': self._interpolation_steps}
         return Path._fast_from_codes_and_verts(vertices, codes, internals)
diff --git a/lib/matplotlib/textpath.py b/lib/matplotlib/textpath.py
@@ -480,7 +480,6 @@ def __init__(self, xy, s, size=None, prop=None,
 
         self._should_simplify = False
         self._simplify_threshold = rcParams['path.simplify_threshold']
-        self._has_nonfinite = False
         self._interpolation_steps = _interpolation_steps
 
     def set_size(self, size):
