Expire deprecations in widgets and keyword only arguments for Selectors

oscargus · oscargus · commit cefb6fd2c2ea · 2022-10-22T14:21:16.000+02:00
diff --git a/lib/matplotlib/tests/test_widgets.py b/lib/matplotlib/tests/test_widgets.py
@@ -24,11 +24,7 @@ def ax():
 
 @pytest.mark.parametrize('kwargs, warning_msg', [
     (dict(), None),
-    (dict(drawtype='line', useblit=False),
-     "Support for drawtype='line' is deprecated"),
     (dict(useblit=True, button=1), None),
-    (dict(drawtype='none', minspanx=10, minspany=10),
-     "Support for drawtype='none' is deprecated"),
     (dict(minspanx=10, minspany=10, spancoords='pixels'), None),
     (dict(props=dict(fill=True)), None),
 ])
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -588,6 +588,7 @@ class RangeSlider(SliderBase):
         Slider value.
     """
 
+    @_api.make_keyword_only("3.7", name="valinit")
     def __init__(
         self,
         ax,
@@ -1124,8 +1125,7 @@ class TextBox(AxesWidget):
         The color of the text box when hovering.
     """
 
-    DIST_FROM_LEFT = _api.deprecate_privatize_attribute("3.5")
-
+    @_api.make_keyword_only("3.7", name="color")
     def __init__(self, ax, label, initial='',
                  color='.95', hovercolor='1', label_pad=.01,
                  textalignment="left"):
@@ -1839,9 +1839,6 @@ def __init__(self, ax, onselect, useblit=False, button=None,
         self._prev_event = None
         self._state = set()
 
-    eventpress = _api.deprecate_privatize_attribute("3.5")
-    eventrelease = _api.deprecate_privatize_attribute("3.5")
-    state = _api.deprecate_privatize_attribute("3.5")
     state_modifier_keys = _api.deprecate_privatize_attribute("3.6")
 
     def set_active(self, active):
@@ -2266,8 +2263,7 @@ def on_select(min: float, max: float) -> Any
     See also: :doc:`/gallery/widgets/span_selector`
     """
 
-    @_api.rename_parameter("3.5", "rectprops", "props")
-    @_api.rename_parameter("3.5", "span_stays", "interactive")
+    @_api.make_keyword_only("3.7", name="minspan")
     def __init__(self, ax, onselect, direction, minspan=0, useblit=False,
                  props=None, onmove_callback=None, interactive=False,
                  button=None, handle_props=None, grab_range=10,
@@ -2323,24 +2319,6 @@ def __init__(self, ax, onselect, direction, minspan=0, useblit=False,
         # prev attribute is deprecated but we still need to maintain it
         self._prev = (0, 0)
 
-    rect = _api.deprecated("3.5")(
-        property(lambda self: self._selection_artist)
-        )
-
-    rectprops = _api.deprecated("3.5")(
-        property(lambda self: self._props)
-        )
-
-    active_handle = _api.deprecate_privatize_attribute("3.5")
-
-    pressv = _api.deprecate_privatize_attribute("3.5")
-
-    span_stays = _api.deprecated("3.5")(
-        property(lambda self: self._interactive)
-        )
-
-    prev = _api.deprecate_privatize_attribute("3.5")
-
     def new_axes(self, ax):
         """Set SpanSelector to operate on a new Axes."""
         self.ax = ax
@@ -2916,11 +2894,7 @@ class RectangleSelector(_SelectorWidget):
     See also: :doc:`/gallery/widgets/rectangle_selector`
     """
 
-    @_api.rename_parameter("3.5", "maxdist", "grab_range")
-    @_api.rename_parameter("3.5", "marker_props", "handle_props")
-    @_api.rename_parameter("3.5", "rectprops", "props")
-    @_api.delete_parameter("3.5", "drawtype")
-    @_api.delete_parameter("3.5", "lineprops")
+    @_api.make_keyword_only("3.7", name="drawtype")
     def __init__(self, ax, onselect, drawtype='box',
                  minspanx=0, minspany=0, useblit=False,
                  lineprops=None, props=None, spancoords='data',
@@ -2943,36 +2917,15 @@ def __init__(self, ax, onselect, drawtype='box',
         # interactive bounding box to allow the polygon to be easily resized
         self._allow_creation = True
 
-        if drawtype == 'none':  # draw a line but make it invisible
-            _api.warn_deprecated(
-                "3.5", message="Support for drawtype='none' is deprecated "
-                               "since %(since)s and will be removed "
-                               "%(removal)s."
-                               "Use props=dict(visible=False) instead.")
-            drawtype = 'line'
-            self._visible = False
-
-        if drawtype == 'box':
-            if props is None:
-                props = dict(facecolor='red', edgecolor='black',
-                             alpha=0.2, fill=True)
-            props['animated'] = self.useblit
-            self._visible = props.pop('visible', self._visible)
-            self._props = props
-            to_draw = self._init_shape(**self._props)
-            self.ax.add_patch(to_draw)
-        if drawtype == 'line':
-            _api.warn_deprecated(
-                "3.5", message="Support for drawtype='line' is deprecated "
-                               "since %(since)s and will be removed "
-                               "%(removal)s.")
-            if lineprops is None:
-                lineprops = dict(color='black', linestyle='-',
-                                 linewidth=2, alpha=0.5)
-            lineprops['animated'] = self.useblit
-            self._props = lineprops
-            to_draw = Line2D([0, 0], [0, 0], visible=False, **self._props)
-            self.ax.add_line(to_draw)
+        _api.check_in_list(['box'], drawtype=drawtype)
+        if props is None:
+            props = dict(facecolor='red', edgecolor='black',
+                         alpha=0.2, fill=True)
+        props['animated'] = self.useblit
+        self._visible = props.pop('visible', self._visible)
+        self._props = props
+        to_draw = self._init_shape(**self._props)
+        self.ax.add_patch(to_draw)
 
         self._selection_artist = to_draw
         self._set_aspect_ratio_correction()
@@ -3013,20 +2966,6 @@ def __init__(self, ax, onselect, drawtype='box',
 
         self._extents_on_press = None
 
-    to_draw = _api.deprecated("3.5")(
-        property(lambda self: self._selection_artist)
-        )
-
-    drawtype = _api.deprecate_privatize_attribute("3.5")
-
-    active_handle = _api.deprecate_privatize_attribute("3.5")
-
-    interactive = _api.deprecate_privatize_attribute("3.5")
-
-    maxdist = _api.deprecated("3.5", name="maxdist", alternative="grab_range")(
-        property(lambda self: self.grab_range,
-                 lambda self, value: setattr(self, "grab_range", value)))
-
     @property
     def _handles_artists(self):
         return (*self._center_handle.artists, *self._corner_handles.artists,
@@ -3368,8 +3307,6 @@ def rotation(self, value):
             # call extents setter to draw shape and update handles positions
             self.extents = self.extents
 
-    draw_shape = _api.deprecate_privatize_attribute('3.5')
-
     def _draw_shape(self, extents):
         x0, x1, y0, y1 = extents
         xmin, xmax = sorted([x0, x1])
@@ -3458,9 +3395,6 @@ class EllipseSelector(RectangleSelector):
     --------
     :doc:`/gallery/widgets/rectangle_selector`
     """
-
-    draw_shape = _api.deprecate_privatize_attribute('3.5')
-
     def _init_shape(self, **props):
         return Ellipse((0, 0), 0, 1, visible=False, **props)
 
@@ -3538,7 +3472,7 @@ def onselect(verts):
         which corresponds to all buttons.
     """
 
-    @_api.rename_parameter("3.5", "lineprops", "props")
+    @_api.make_keyword_only("3.7", name="useblit")
     def __init__(self, ax, onselect=None, useblit=True, props=None,
                  button=None):
         super().__init__(ax, onselect, useblit=useblit, button=button)
@@ -3551,18 +3485,10 @@ def __init__(self, ax, onselect=None, useblit=True, props=None,
         self.ax.add_line(line)
         self._selection_artist = line
 
-    @_api.deprecated("3.5", alternative="press")
-    def onpress(self, event):
-        self.press(event)
-
     def _press(self, event):
         self.verts = [self._get_data(event)]
         self._selection_artist.set_visible(True)
 
-    @_api.deprecated("3.5", alternative="release")
-    def onrelease(self, event):
-        self.release(event)
-
     def _release(self, event):
         if self.verts is not None:
             self.verts.append(self._get_data(event))
@@ -3657,9 +3583,7 @@ class PolygonSelector(_SelectorWidget):
     point.
     """
 
-    @_api.rename_parameter("3.5", "lineprops", "props")
-    @_api.rename_parameter("3.5", "markerprops", "handle_props")
-    @_api.rename_parameter("3.5", "vertex_select_radius", "grab_range")
+    @_api.make_keyword_only("3.7", name="useblit")
     def __init__(self, ax, onselect, useblit=False,
                  props=None, handle_props=None, grab_range=10, *,
                  draw_bounding_box=False, box_handle_props=None,
@@ -3767,16 +3691,6 @@ def _scale_polygon(self, event):
         self._draw_polygon()
         self._old_box_extents = self._box.extents
 
-    line = _api.deprecated("3.5")(
-        property(lambda self: self._selection_artist)
-        )
-
-    vertex_select_radius = _api.deprecated("3.5", name="vertex_select_radius",
-                                           alternative="grab_range")(
-        property(lambda self: self.grab_range,
-                 lambda self, value: setattr(self, "grab_range", value))
-        )
-
     @property
     def _handles_artists(self):
         return self._polygon_handles.artists
@@ -3968,15 +3882,16 @@ class Lasso(AxesWidget):
         The parent Axes for the widget.
     xy : (float, float)
         Coordinates of the start of the lasso.
+    callback : callable
+        Whenever the lasso is released, the *callback* function is called and
+        passed the vertices of the selected path.
     useblit : bool, default: True
         Whether to use blitting for faster drawing (if supported by the
         backend). See the tutorial :doc:`/tutorials/advanced/blitting`
         for details.
-    callback : callable
-        Whenever the lasso is released, the *callback* function is called and
-        passed the vertices of the selected path.
     """
 
+    @_api.make_keyword_only("3.7", name="useblit")
     def __init__(self, ax, xy, callback=None, useblit=True):
         super().__init__(ax)
 
