8000 Deprecate selector `visible` attribute by ericpre · Pull Request #22167 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Deprecate selector visible attribute #22167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 23, 2022
Merged

Deprecate selector visible attribute #22167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54f274a
Deprecate visible setter of selectors in favour of get_visible/set_vi…
ericpre Jun 22, 2022
a2540ac
Add internal method to clear without update to simplify code
ericpre Jun 9, 2022
File filter

Filter by extension

Filter by extension
Conversations 10000
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/api/next_api_changes/deprecations/22167-EP.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Selector widget state internals
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The *visible* attribute has been deprecated, use *set_visible* or
*get_visible* instead.
19 changes: 16 additions & 3 deletions lib/matplotlib/tests/test_widgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)]])
Expand Down Expand Up @@ -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)

Expand Down
47 changes: 29 additions & 18 deletions lib/matplotlib/widgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down Expand Up @@ -2052,16 +2052,32 @@ 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._clear_without_update()
self.update()

def _clear_without_update(self):
self._selection_completed = False
self.set_visible(False)
self.update()

@property
def artists(self):
Expand Down Expand Up @@ -2266,8 +2282,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

Expand Down Expand Up @@ -2405,11 +2419,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)

Expand Down Expand Up @@ -2598,7 +2612,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()


Expand Down Expand Up @@ -2912,7 +2926,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
Expand All @@ -2931,14 +2944,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)
Expand Down Expand Up @@ -3035,9 +3048,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)

Expand Down Expand Up @@ -3082,12 +3095,10 @@ def _release(self, event):
# either x or y-direction
minspanxy = (spanx <= self.minspanx or spany <= self.minspany)
if (self._drawtype != 'none' and minspanxy):
for artist in self.artists:
artist.set_visible(False)
if self._selection_completed:
# Call onselect, only when the selection is already existing
self.onselect(self._eventpress, self._eventrelease)
self._selection_completed = False
self._clear_without_update()
else:
self.onselect(self._eventpress, self._eventrelease)
self._selection_completed = True
Expand Down Expand Up @@ -3331,7 +3342,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
Expand Down
0