Remove artist-specific deprecations from 3.3.

QuLogic · QuLogic · commit c51ae6d54d0e · 2021-06-29T05:28:56.000-04:00
diff --git a/doc/api/artist_api.rst b/doc/api/artist_api.rst
@@ -36,8 +36,6 @@ Interactive
    Artist.format_cursor_data
    Artist.mouseover
    Artist.contains
-   Artist.set_contains
-   Artist.get_contains
    Artist.pick
    Artist.pickable
    Artist.set_picker
diff --git a/doc/api/next_api_changes/removals/20465-ES.rst b/doc/api/next_api_changes/removals/20465-ES.rst
@@ -28,3 +28,20 @@ to force the use of avconv by using the FFmpeg-based writers with
 * *clear_temp* parameter and attribute of `.FileMovieWriter`; files placed in a
   temporary directory (using ``frame_prefix=None``, the default) will be
   cleared; files placed elsewhere will not.
+
+Artist-specific removals
+~~~~~~~~~~~~~~~~~~~~~~~~
+* Setting a custom method overriding `.Artist.contains` using
+  ``Artist.set_contains`` has been removed, as has ``Artist.get_contains``.
+  There is no replacement, but you may still customize pick events using
+  `.Artist.set_picker`.
+* Passing the dash offset as ``None`` is no longer accepted, as this was never
+  universally implemented, e.g. for vector output. Set the offset to 0 instead.
+* The parameter *props* of `.Shadow` has been removed. Use keyword arguments
+  instead.
+* Arbitrary keyword arguments to ``StreamplotSet`` have no effect and have been
+  removed.
+* ``NonUniformImage.is_grayscale`` and ``PcolorImage.is_grayscale`` attributes
+  have been removed, for consistency with ``AxesImage.is_grayscale``. (Note
+  that previously, these attributes were only available *after rendering the
+  image*).
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -109,7 +109,6 @@ def __init__(self):
         self._clipon = True
         self._label = ''
         self._picker = None
-        self._contains = None
         self._rasterized = False
         self._agg_filter = None
         # Normally, artist classes need to be queried for mouseover info if and
@@ -401,10 +400,9 @@ def _default_contains(self, mouseevent, figure=None):
         """
         Base impl. for checking whether a mouseevent happened in an artist.
 
-        1. If the artist defines a custom checker, use it (deprecated).
-        2. If the artist figure is known and the event did not occur in that
+        1. If the artist figure is known and the event did not occur in that
            figure (by checking its ``canvas`` attribute), reject it.
-        3. Otherwise, return `None, {}`, indicating that the subclass'
+        2. Otherwise, return `None, {}`, indicating that the subclass'
            implementation should be used.
 
         Subclasses should start their definition of `contains` as follows:
@@ -417,8 +415,6 @@ def _default_contains(self, mouseevent, figure=None):
         The *figure* kwarg is provided for the implementation of
         `.Figure.contains`.
         """
-        if callable(self._contains):
-            return self._contains(self, mouseevent)
         if figure is not None and mouseevent.canvas is not figure.canvas:
             return False, {}
         return None, {}
@@ -446,45 +442,6 @@ def contains(self, mouseevent):
         _log.warning("%r needs 'contains' method", self.__class__.__name__)
         return False, {}
 
-    @_api.deprecated("3.3", alternative="set_picker")
-    def set_contains(self, picker):
-        """
-        Define a custom contains test for the artist.
-
-        The provided callable replaces the default `.contains` method
-        of the artist.
-
-        Parameters
-        ----------
-        picker : callable
-            A custom picker function to evaluate if an event is within the
-            artist. The function must have the signature::
-
-                def contains(artist: Artist, event: MouseEvent) -> bool, dict
-
-            that returns:
-
-            - a bool indicating if the event is within the artist
-            - a dict of additional information. The dict should at least
-              return the same information as the default ``contains()``
-              implementation of the respective artist, but may provide
-              additional information.
-        """
-        if not callable(picker):
-            raise TypeError("picker is not a callable")
-        self._contains = picker
-
-    @_api.deprecated("3.3", alternative="get_picker")
-    def get_contains(self):
-        """
-        Return the custom contains function of the artist if set, or *None*.
-
-        See Also
-        --------
-        set_contains
-        """
-        return self._contains
-
     def pickable(self):
         """
         Return whether the artist is pickable.
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -1015,8 +1015,6 @@ def _check_unsampled_image(self):
         """Return False. Do not use unsampled image."""
         return False
 
-    is_grayscale = _api.deprecate_privatize_attribute("3.3")
-
     def make_image(self, renderer, magnification=1.0, unsampled=False):
         # docstring inherited
         if self._A is None:
@@ -1027,11 +1025,9 @@ def make_image(self, renderer, magnification=1.0, unsampled=False):
         if A.ndim == 2:
             if A.dtype != np.uint8:
                 A = self.to_rgba(A, bytes=True)
-                self._is_grayscale = self.cmap.is_gray()
             else:
                 A = np.repeat(A[:, :, np.newaxis], 4, 2)
                 A[:, :, 3] = 255
-                self._is_grayscale = True
         else:
             if A.dtype != np.uint8:
                 A = (255*A).astype(np.uint8)
@@ -1040,7 +1036,6 @@ def make_image(self, renderer, magnification=1.0, unsampled=False):
                 B[:, :, 0:3] = A
                 B[:, :, 3] = 255
                 A = B
-            self._is_grayscale = False
         vl = self.axes.viewLim
         l, b, r, t = self.axes.bbox.extents
         width = int(((round(r) + 0.5) - (round(l) - 0.5)) * magnification)
@@ -1203,8 +1198,6 @@ def __init__(self, ax,
         if A is not None:
             self.set_data(x, y, A)
 
-    is_grayscale = _api.deprecate_privatize_attribute("3.3")
-
     def make_image(self, renderer, magnification=1.0, unsampled=False):
         # docstring inherited
         if self._A is None:
@@ -1215,8 +1208,6 @@ def make_image(self, renderer, magnification=1.0, unsampled=False):
         if self._rgbacache is None:
             A = self.to_rgba(self._A, bytes=True)
             self._rgbacache = np.pad(A, [(1, 1), (1, 1), (0, 0)], "constant")
-            if self._A.ndim == 2:
-                self._is_grayscale = self.cmap.is_gray()
         padded_A = self._rgbacache
         bg = mcolors.to_rgba(self.axes.patch.get_facecolor(), 0)
         bg = (np.array(bg) * 255).astype(np.uint8)
@@ -1277,15 +1268,10 @@ def set_data(self, x, y, A):
                 (A.shape[:2], (y.size - 1, x.size - 1)))
         if A.ndim not in [2, 3]:
             raise ValueError("A must be 2D or 3D")
-        if A.ndim == 3 and A.shape[2] == 1:
-            A = A.squeeze(axis=-1)
-        self._is_grayscale = False
         if A.ndim == 3:
-            if A.shape[2] in [3, 4]:
-                if ((A[:, :, 0] == A[:, :, 1]).all() and
-                        (A[:, :, 0] == A[:, :, 2]).all()):
-                    self._is_grayscale = True
-            else:
+            if A.shape[2] == 1:
+                A = A.squeeze(axis=-1)
+            elif A.shape[2] not in [3, 4]:
                 raise ValueError("3D arrays must have RGB or RGBA as last dim")
 
         # For efficient cursor readout, ensure x and y are increasing.
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -45,13 +45,9 @@ def _get_dash_pattern(style):
     elif isinstance(style, tuple):
         offset, dashes = style
         if offset is None:
-            _api.warn_deprecated(
-                "3.3", message="Passing the dash offset as None is deprecated "
-                "since %(since)s and support for it will be removed "
-                "%(removal)s; pass it as zero instead.")
-            offset = 0
+            raise ValueError(f'Unrecognized linestyle: {style!r}')
     else:
-        raise ValueError('Unrecognized linestyle: %s' % str(style))
+        raise ValueError(f'Unrecognized linestyle: {style!r}')
 
     # normalize offset to be positive and shorter than the dash cycle
     if dashes is not None:
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -636,9 +636,8 @@ class Shadow(Patch):
     def __str__(self):
         return "Shadow(%s)" % (str(self.patch))
 
-    @_api.delete_parameter("3.3", "props")
     @docstring.dedent_interpd
-    def __init__(self, patch, ox, oy, props=None, **kwargs):
+    def __init__(self, patch, ox, oy, **kwargs):
         """
         Create a shadow of the given *patch*.
 
@@ -652,38 +651,22 @@ def __init__(self, patch, ox, oy, props=None, **kwargs):
         ox, oy : float
             The shift of the shadow in data coordinates, scaled by a factor
             of dpi/72.
-        props : dict
-            *deprecated (use kwargs instead)* Properties of the shadow patch.
         **kwargs
             Properties of the shadow patch. Supported keys are:
 
             %(Patch:kwdoc)s
         """
         super().__init__()
         self.patch = patch
-        # Note: when removing props, we can directly pass kwargs to _update()
-        # and remove self._props
-        if props is None:
-            color = .3 * np.asarray(colors.to_rgb(self.patch.get_facecolor()))
-            props = {
-                'facecolor': color,
-                'edgecolor': color,
-                'alpha': 0.5,
-            }
-        self._props = {**props, **kwargs}
         self._ox, self._oy = ox, oy
         self._shadow_transform = transforms.Affine2D()
-        self._update()
 
-    props = _api.deprecate_privatize_attribute("3.3")
-
-    def _update(self):
         self.update_from(self.patch)
-
-        # Place the shadow patch directly behind the inherited patch.
-        self.set_zorder(np.nextafter(self.patch.zorder, -np.inf))
-
-        self.update(self._props)
+        color = .3 * np.asarray(colors.to_rgb(self.patch.get_facecolor()))
+        self.update({'facecolor': color, 'edgecolor': color, 'alpha': 0.5,
+                     # Place shadow patch directly behind the inherited patch.
+                     'zorder': np.nextafter(self.patch.zorder, -np.inf),
+                     **kwargs})
 
     def _update_transform(self, renderer):
         ox = renderer.points_to_pixels(self._ox)
diff --git a/lib/matplotlib/streamplot.py b/lib/matplotlib/streamplot.py
@@ -236,13 +236,7 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
 
 class StreamplotSet:
 
-    def __init__(self, lines, arrows, **kwargs):
-        if kwargs:
-            _api.warn_deprecated(
-                "3.3",
-                message="Passing arbitrary keyword arguments to StreamplotSet "
-                        "is deprecated since %(since) and will become an "
-                        "error %(removal)s.")
+    def __init__(self, lines, arrows):
         self.lines = lines
         self.arrows = arrows
 
