Deprecate visible setter of selectors in favour of get_visible/set_visible

ericpre · ericpre · commit 54f274a695ea · 2022-06-22T11:20:47.000+01:00
diff --git a/doc/api/next_api_changes/deprecations/22167-EP.rst b/doc/api/next_api_changes/deprecations/22167-EP.rst
@@ -0,0 +1,4 @@
+Selector widget state internals
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The *visible* attribute has been deprecated, use *set_visible* or
+*get_visible* instead.
diff --git a/lib/matplotlib/tests/test_widgets.py b/lib/matplotlib/tests/test_widgets.py
@@ -104,6 +104,19 @@ def onselect(epress, erelease):
     assert ax._erelease.ydata == y1
 
 
+def test_deprecation_selector_visible_attribute():
+    ax = get_ax()
+    tool = widgets.RectangleSelector(ax, lambda *args: None)
+
+    assert tool.get_visible()
+
+    with pytest.warns(
+        MatplotlibDeprecationWarning,
+            match="was deprecated in Matplotlib 3.6"):
+        tool.visible = False
+    assert not tool.get_visible()
+
+
 @pytest.mark.parametrize('drag_from_anywhere, new_center',
                          [[True, (60, 75)],
                           [False, (30, 20)]])
@@ -789,18 +802,18 @@ def test_selector_clear_method(ax, selector):
         tool = widgets.RectangleSelector(ax, onselect=noop, interactive=True)
     click_and_drag(tool, start=(10, 10), end=(100, 120))
     assert tool._selection_completed
-    assert tool.visible
+    assert tool.get_visible()
     if selector == 'span':
         assert tool.extents == (10, 100)
 
     tool.clear()
     assert not tool._selection_completed
-    assert not tool.visible
+    assert not tool.get_visible()
 
     # Do another cycle of events to make sure we can
     click_and_drag(tool, start=(10, 10), end=(50, 120))
     assert tool._selection_completed
-    assert tool.visible
+    assert tool.get_visible()
     if selector == 'span':
         assert tool.extents == (10, 50)
 
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -1804,7 +1804,7 @@ def __init__(self, ax, onselect, useblit=False, button=None,
                  state_modifier_keys=None, use_data_coordinates=False):
         super().__init__(ax)
 
-        self.visible = True
+        self._visible = True
         self.onselect = onselect
         self.useblit = useblit and self.canvas.supports_blit
         self.connect_default_events()
@@ -2052,11 +2052,24 @@ def _on_key_release(self, event):
         """Key release event handler."""
 
     def set_visible(self, visible):
-        """Set the visibility of our artists."""
-        self.visible = visible
+        """Set the visibility of the selector artists."""
+        self._visible = visible
         for artist in self.artists:
             artist.set_visible(visible)
 
+    def get_visible(self):
+        """Get the visibility of the selector artists."""
+        return self._visible
+
+    @property
+    def visible(self):
+        return self.get_visible()
+
+    @visible.setter
+    def visible(self, visible):
+        _api.warn_deprecated("3.6", alternative="set_visible")
+        self.set_visible(visible)
+
     def clear(self):
         """Clear the selection and set the selector ready to make a new one."""
         self._selection_completed = False
@@ -2266,8 +2279,6 @@ def __init__(self, ax, onselect, direction, minspan=0, useblit=False,
         props['animated'] = self.useblit
 
         self.direction = direction
-
-        self.visible = True
         self._extents_on_press = None
         self.snap_values = snap_values
 
@@ -2405,11 +2416,11 @@ def _press(self, event):
             # when the press event outside the span, we initially set the
             # visibility to False and extents to (v, v)
             # update will be called when setting the extents
-            self.visible = False
+            self._visible = False
             self.extents = v, v
             # We need to set the visibility back, so the span selector will be
             # drawn when necessary (span width > 0)
-            self.visible = True
+            self._visible = True
         else:
             self.set_visible(True)
 
@@ -2598,7 +2609,7 @@ def extents(self, extents):
         if self._interactive:
             # Update displayed handles
             self._edge_handles.set_data(self.extents)
-        self.set_visible(self.visible)
+        self.set_visible(self._visible)
         self.update()
 
 
@@ -2912,7 +2923,6 @@ def __init__(self, ax, onselect, drawtype='box',
                          state_modifier_keys=state_modifier_keys,
                          use_data_coordinates=use_data_coordinates)
 
-        self.visible = True
         self._interactive = interactive
         self.drag_from_anywhere = drag_from_anywhere
         self.ignore_event_outside = ignore_event_outside
@@ -2931,14 +2941,14 @@ def __init__(self, ax, onselect, drawtype='box',
                                "%(removal)s."
                                "Use props=dict(visible=False) instead.")
             drawtype = 'line'
-            self.visible = False
+            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._visible = props.pop('visible', self._visible)
             self._props = props
             to_draw = self._init_shape(**self._props)
             self.ax.add_patch(to_draw)
@@ -3035,9 +3045,9 @@ def _press(self, event):
                 self._allow_creation):
             x = event.xdata
             y = event.ydata
-            self.visible = False
+            self._visible = False
             self.extents = x, x, y, y
-            self.visible = True
+            self._visible = True
         else:
             self.set_visible(True)
 
@@ -3331,7 +3341,7 @@ def extents(self, extents):
             self._corner_handles.set_data(*self.corners)
             self._edge_handles.set_data(*self.edge_centers)
             self._center_handle.set_data(*self.center)
-        self.set_visible(self.visible)
+        self.set_visible(self._visible)
         self.update()
 
     @property
