8000 Privatize state_modifier_keys · matplotlib/matplotlib@15fbb09 · GitHub
[go: up one dir, main page]
Skip to content

Commit 15fbb09

Browse files
ericpreericpre
committed
Privatize state_modifier_keys
1 parent 3821aac commit 15fbb09

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

‎doc/api/next_api_changes/deprecations/20839-EP.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Selector widget state internals
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
The *state_modifier_keys* attribute has been privatized and deprecated. Use
4+
*state_modifier_keys* argument when creating the selector instead.

‎lib/matplotlib/widgets.py

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1795,9 +1795,9 @@ def __init__(self, ax, onselect, useblit=False, button=None,
17951795
self.useblit = useblit and self.canvas.supports_blit
17961796
self.connect_default_events()
17971797

1798-
self.state_modifier_keys = dict(move=' ', clear='escape',
1799-
square='shift', center='control')
1800-
self.state_modifier_keys.update(state_modifier_keys or {})
1798+
self._state_modifier_keys = dict(move=' ', clear='escape',
1799+
square='shift', center='control')
1800+
self._state_modifier_keys.update(state_modifier_keys or {})
18011801

18021802
self.background = None
18031803
self.artists = []
@@ -1821,6 +1821,7 @@ def __init__(self, ax, onselect, useblit=False, button=None,
18211821
eventpress = _api.deprecate_privatize_attribute("3.5")
18221822
eventrelease = _api.deprecate_privatize_attribute("3.5")
18231823
state = _api.deprecate_privatize_attribute("3.5")
1824+
state_modifier_keys = _api.deprecate_privatize_attribute("3.5")
18241825

18251826
def set_active(self, active):
18261827
super().set_active(active)
@@ -1931,7 +1932,7 @@ def press(self, event):
19311932
key = event.key or ''
19321933
key = key.replace('ctrl', 'control')
19331934
# move state is locked in on a button press
1934-
if key == self.state_modifier_keys['move']:
1935+
if key == self._state_modifier_keys['move']:
19351936
self._state.add('move')
19361937
self._press(event)
19371938
return True
@@ -1979,12 +1980,12 @@ def on_key_press(self, event):
19791980
if self.active:
19801981
key = event.key or ''
19811982
key = key.replace('ctrl', 'control')
1982-
if key == self.state_modifier_keys['clear']:
1983+
if key == self._state_modifier_keys['clear']:
19831984
for artist in self.artists:
19841985
artist.set_visible(False)
19851986
self.update()
19861987
return
1987-
for (state, modifier) in self.state_modifier_keys.items():
1988+
for (state, modifier) in self._state_modifier_keys.items():
19881989
if modifier in key:
19891990
self._state.add(state)
19901991
8000 self._on_key_press(event)
@@ -1996,7 +1997,7 @@ def on_key_release(self, event):
19961997
"""Key release event handler and validator."""
19971998
if self.active:
19981999
key = event.key or ''
1999-
for (state, modifier) in self.state_modifier_keys.items():
2000+
for (state, modifier) in self._state_modifier_keys.items():
20002001
if modifier in key:
20012002
self._state.discard(state)
20022003
self._on_key_release(event)
@@ -2036,7 +2037,7 @@ def add_default_state(self, value):
20362037
20372038
"""
20382039
supported_default_state = [
2039-
key for key, value in self.state_modifier_keys.items()
2040+
key for key, value in self._state_modifier_keys.items()
20402041
if key != 'clear' and value != 'not-applicable'
20412042
]
20422043
if value not in supported_default_state:
@@ -3550,13 +3551,13 @@ def _on_key_release(self, event):
35503551
# 'move_all' mode (by checking the released key)
35513552
if (not self._selection_completed
35523553
and
3553-
(event.key == self.state_modifier_keys.get('move_vertex')
3554-
or event.key == self.state_modifier_keys.get('move_all'))):
3554+
(event.key == self._state_modifier_keys.get('move_vertex')
3555+
or event.key == self._state_modifier_keys.get('move_all'))):
35553556
self._xs.append(event.xdata)
35563557
self._ys.append(event.ydata)
35573558
self._draw_polygon()
35583559
# Reset the polygon if the released key is the 'clear' key.
3559-
elif event.key == self.state_modifier_keys.get('clear'):
3560+
elif event.key == self._state_modifier_keys.get('clear'):
35603561
event = self._clean_event(event)
35613562
self._xs, self._ys = [event.xdata], [event.ydata]
35623563
self._selection_completed = False

0 commit comments

Comments
 (0)
0