Privatize more attributes, which are not expected to be used by users.

ericpre · ericpre · commit 5587bb428216 · 2021-06-04T10:09:45.000+01:00
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -2022,11 +2022,19 @@ def __init__(self, ax, onselect, direction, minspan=0, useblit=False,
                                              line_props=props,
                                              useblit=self.useblit)
 
-        self.active_handle = None
+        self._active_handle = None
 
         if self.interactive:
             self.artists.extend([line for line in self._edge_handles.artists])
 
+    rect = _api.deprecate_privatize_attribute("3.5")
+
+    rectprops = _api.deprecate_privatize_attribute("3.5")
+
+    active_handle = _api.deprecate_privatize_attribute("3.5")
+
+    pressv = _api.deprecate_privatize_attribute("3.5")
+
     def new_axes(self, ax):
         """Set SpanSelector to operate on a new Axes."""
         self.ax = ax
@@ -2056,9 +2064,9 @@ def _press(self, event):
         if self.interactive and self._rect.get_visible():
             self._set_active_handle(event)
         else:
-            self.active_handle = None
+            self._active_handle = None
 
-        if self.active_handle is None or not self.interactive:
+        if self._active_handle is None or not self.interactive:
             # Clear previous rectangle before drawing new rectangle.
             self.update()
 
@@ -2072,26 +2080,6 @@ def _press(self, event):
 
         return False
 
-    @_api.deprecated("3.5")
-    @property
-    def rect(self):
-        return self._rect
-
-    @_api.deprecated("3.5")
-    @property
-    def pressv(self):
-        return self._pressv
-
-    @_api.deprecated("3.5")
-    @pressv.setter
-    def pressv(self, value):
-        self._pressv = value
-
-    @_api.deprecated("3.5")
-    @property
-    def rectprops(self):
-        return self._rectprops
-
     @property
     def direction(self):
         """Direction of the span selector: 'vertical' or 'horizontal'."""
@@ -2127,18 +2115,18 @@ def _onmove(self, event):
             vpress = self.eventpress.ydata
 
         # move existing span
-        # When "dragging from anywhere", the `self.active_handle` is set to 'C'
+        # When "dragging from anywhere", the `self._active_handle` is set to 'C'
         # in _set_active_handle (match notation used in the RectangleSelector)
-        if self.active_handle == 'C' and self._extents_on_press is not None:
+        if self._active_handle == 'C' and self._extents_on_press is not None:
             vmin, vmax = self._extents_on_press
             dv = v - vpress
             vmin += dv
             vmax += dv
 
         # resize an existing shape
-        elif self.active_handle and self.active_handle != 'C':
+        elif self._active_handle and self._active_handle != 'C':
             vmin, vmax = self._extents_on_press
-            if self.active_handle == 'min':
+            if self._active_handle == 'min':
                 vmin = v
             else:
                 vmax = v
@@ -2173,20 +2161,20 @@ def _set_active_handle(self, event):
         # Prioritise center handle over other handles
         # Use 'C' to match the notation used in the RectangleSelector
         if 'move' in self.state:
-            self.active_handle = 'C'
+            self._active_handle = 'C'
         elif e_dist > self.maxdist:
             # Not close to any handles
-            self.active_handle = None
+            self._active_handle = None
             if self.drag_from_anywhere and self._contains(event):
                 # Check if we've clicked inside the region
-                self.active_handle = 'C'
+                self._active_handle = 'C'
                 self._extents_on_press = self.extents
             else:
-                self.active_handle = None
+                self._active_handle = None
                 return
         else:
             # Closest to an edge handle
-            self.active_handle = self._edge_order[e_idx]
+            self._active_handle = self._edge_order[e_idx]
 
         # Save coordinates of rectangle at the start of handle movement.
         self._extents_on_press = self.extents
@@ -2511,7 +2499,7 @@ def onselect(eclick: MouseEvent, erelease: MouseEvent)
 
         _api.check_in_list(['data', 'pixels'], spancoords=spancoords)
         self.spancoords = spancoords
-        self.drawtype = drawtype
+        self._drawtype = drawtype
 
         self.maxdist = maxdist
 
@@ -2536,7 +2524,7 @@ def onselect(eclick: MouseEvent, erelease: MouseEvent)
                                           marker_props=props,
                                           useblit=self.useblit)
 
-        self.active_handle = None
+        self._active_handle = None
 
         self.artists = [self._to_draw, self._center_handle.artist,
                         self._corner_handles.artist,
@@ -2547,10 +2535,11 @@ def onselect(eclick: MouseEvent, erelease: MouseEvent)
 
         self._extents_on_press = None
 
-    @_api.deprecated("3.5")
-    @property
-    def to_draw(self):
-        return self._to_draw
+    to_draw = _api.deprecate_privatize_attribute("3.5")
+
+    drawtype = _api.deprecate_privatize_attribute("3.5")
+
+    active_handle = _api.deprecate_privatize_attribute("3.5")
 
     def _press(self, event):
         """Button press event handler."""
@@ -2559,9 +2548,9 @@ def _press(self, event):
         if self.interactive and self._to_draw.get_visible():
             self._set_active_handle(event)
         else:
-            self.active_handle = None
+            self._active_handle = None
 
-        if self.active_handle is None or not self.interactive:
+        if self._active_handle is None or not self.interactive:
             # Clear previous rectangle before drawing new rectangle.
             self.update()
 
@@ -2601,7 +2590,7 @@ def _release(self, event):
                                spancoords=self.spancoords)
         # check if drawn distance (if it exists) is not too small in
         # either x or y-direction
-        if (self.drawtype != 'none'
+        if (self._drawtype != 'none'
                 and (self.minspanx is not None and spanx < self.minspanx
                      or self.minspany is not None and spany < self.minspany)):
             for artist in self.artists:
@@ -2618,15 +2607,15 @@ def _release(self, event):
     def _onmove(self, event):
         """Motion notify event handler."""
         # resize an existing shape
-        if self.active_handle and self.active_handle != 'C':
+        if self._active_handle and self._active_handle != 'C':
             x0, x1, y0, y1 = self._extents_on_press
-            if self.active_handle in ['E', 'W'] + self._corner_order:
+            if self._active_handle in ['E', 'W'] + self._corner_order:
                 x1 = event.xdata
-            if self.active_handle in ['N', 'S'] + self._corner_order:
+            if self._active_handle in ['N', 'S'] + self._corner_order:
                 y1 = event.ydata
 
         # move existing shape
-        elif (('move' in self.state or self.active_handle == 'C' or
+        elif (('move' in self.state or self._active_handle == 'C' or
                (self.drag_from_anywhere and self._contains(event))) and
               self._extents_on_press is not None):
             x0, x1, y0, y1 = self._extents_on_press
@@ -2673,7 +2662,7 @@ def _onmove(self, event):
 
     @property
     def _rect_bbox(self):
-        if self.drawtype == 'box':
+        if self._drawtype == 'box':
             x0 = self._to_draw.get_x()
             y0 = self._to_draw.get_y()
             width = self._to_draw.get_width()
@@ -2742,13 +2731,13 @@ def _draw_shape(self, extents):
         xmax = min(xmax, xlim[1])
         ymax = min(ymax, ylim[1])
 
-        if self.drawtype == 'box':
+        if self._drawtype == 'box':
             self._to_draw.set_x(xmin)
             self._to_draw.set_y(ymin)
             self._to_draw.set_width(xmax - xmin)
             self._to_draw.set_height(ymax - ymin)
 
-        elif self.drawtype == 'line':
+        elif self._drawtype == 'line':
             self._to_draw.set_data([xmin, xmax], [ymin, ymax])
 
     def _set_active_handle(self, event):
@@ -2759,34 +2748,34 @@ def _set_active_handle(self, event):
         m_idx, m_dist = self._center_handle.closest(event.x, event.y)
 
         if 'move' in self.state:
-            self.active_handle = 'C'
+            self._active_handle = 'C'
             self._extents_on_press = self.extents
         # Set active handle as closest handle, if mouse click is close enough.
         elif m_dist < self.maxdist * 2:
             # Prioritise center handle over other handles
-            self.active_handle = 'C'
+            self._active_handle = 'C'
         elif c_dist > self.maxdist and e_dist > self.maxdist:
             # Not close to any handles
             if self.drag_from_anywhere and self._contains(event):
                 # Check if we've clicked inside the region
-                self.active_handle = 'C'
+                self._active_handle = 'C'
                 self._extents_on_press = self.extents
             else:
-                self.active_handle = None
+                self._active_handle = None
                 return
         elif c_dist < e_dist:
             # Closest to a corner handle
-            self.active_handle = self._corner_order[c_idx]
+            self._active_handle = self._corner_order[c_idx]
         else:
             # Closest to an edge handle
-            self.active_handle = self._edge_order[e_idx]
+            self._active_handle = self._edge_order[e_idx]
 
         # Save coordinates of rectangle at the start of handle movement.
         x0, x1, y0, y1 = self.extents
         # Switch variables so that only x1 and/or y1 are updated on move.
-        if self.active_handle in ['W', 'SW', 'NW']:
+        if self._active_handle in ['W', 'SW', 'NW']:
             x0, x1 = x1, event.xdata
-        if self.active_handle in ['N', 'NW', 'NE']:
+        if self._active_handle in ['N', 'NW', 'NE']:
             y0, y1 = y1, event.ydata
         self._extents_on_press = x0, x1, y0, y1
 
@@ -2858,7 +2847,7 @@ def _draw_shape(self, extents):
         a = (xmax - xmin) / 2.
         b = (ymax - ymin) / 2.
 
-        if self.drawtype == 'box':
+        if self._drawtype == 'box':
             self._to_draw.center = center
             self._to_draw.width = 2 * a
             self._to_draw.height = 2 * b
@@ -2870,7 +2859,7 @@ def _draw_shape(self, extents):
 
     @property
     def _rect_bbox(self):
-        if self.drawtype == 'box':
+        if self._drawtype == 'box':
             x, y = self._to_draw.center
             width = self._to_draw.width
             height = self._to_draw.height
