Privatize state_modifier_keys

ericpre · ericpre · commit ba764bd2d105 · 2021-08-25T09:29:42.000+01:00
diff --git a/doc/api/next_api_changes/deprecations/20839-EP.rst b/doc/api/next_api_changes/deprecations/20839-EP.rst
@@ -0,0 +1,4 @@
+Selector widget state internals
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+*state_modifier_keys* have to be defined when creating the selector widget. The 
+*state_modifier_keys* attribute is deprecated.
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -1795,9 +1795,9 @@ def __init__(self, ax, onselect, useblit=False, button=None,
         self.useblit = useblit and self.canvas.supports_blit
         self.connect_default_events()
 
-        self.state_modifier_keys = dict(move=' ', clear='escape',
-                                        square='shift', center='control')
-        self.state_modifier_keys.update(state_modifier_keys or {})
+        self._state_modifier_keys = dict(move=' ', clear='escape',
+                                         square='shift', center='control')
+        self._state_modifier_keys.update(state_modifier_keys or {})
 
         self.background = None
 
@@ -1820,6 +1820,7 @@ def __init__(self, ax, onselect, useblit=False, button=None,
     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.5")
 
     def set_active(self, active):
         super().set_active(active)
@@ -1930,7 +1931,7 @@ def press(self, event):
             key = event.key or ''
             key = key.replace('ctrl', 'control')
             # move state is locked in on a button press
-            if key == self.state_modifier_keys['move']:
+            if key == self._state_modifier_keys['move']:
                 self._state.add('move')
             self._press(event)
             return True
@@ -1978,12 +1979,12 @@ def on_key_press(self, event):
         if self.active:
             key = event.key or ''
             key = key.replace('ctrl', 'control')
-            if key == self.state_modifier_keys['clear']:
+            if key == self._state_modifier_keys['clear']:
                 for artist in self.artists:
                     artist.set_visible(False)
                 self.update()
                 return
-            for (state, modifier) in self.state_modifier_keys.items():
+            for (state, modifier) in self._state_modifier_keys.items():
                 if modifier in key:
                     self._state.add(state)
             self._on_key_press(event)
@@ -1995,7 +1996,7 @@ def on_key_release(self, event):
         """Key release event handler and validator."""
         if self.active:
             key = event.key or ''
-            for (state, modifier) in self.state_modifier_keys.items():
+            for (state, modifier) in self._state_modifier_keys.items():
                 if modifier in key:
                     self._state.discard(state)
             self._on_key_release(event)
@@ -2070,7 +2071,7 @@ def add_default_state(self, value):
 
         """
         supported_default_state = [
-            key for key, value in self.state_modifier_keys.items()
+            key for key, value in self._state_modifier_keys.items()
             if key != 'clear' and value != 'not-applicable'
             ]
         if value not in supported_default_state:
@@ -3606,13 +3607,13 @@ def _on_key_release(self, event):
         # 'move_all' mode (by checking the released key)
         if (not self._selection_completed
                 and
-                (event.key == self.state_modifier_keys.get('move_vertex')
-                 or event.key == self.state_modifier_keys.get('move_all'))):
+                (event.key == self._state_modifier_keys.get('move_vertex')
+                 or event.key == self._state_modifier_keys.get('move_all'))):
             self._xs.append(event.xdata)
             self._ys.append(event.ydata)
             self._draw_polygon()
         # Reset the polygon if the released key is the 'clear' key.
-        elif event.key == self.state_modifier_keys.get('clear'):
+        elif event.key == self._state_modifier_keys.get('clear'):
             event = self._clean_event(event)
             self._xs, self._ys = [event.xdata], [event.ydata]
             self._selection_completed = False
