Widgets cleanup.

anntzer · anntzer · commit a1b5e5d281b9 · 2020-04-13T22:32:21.000+02:00
Mostly docstring cleanups, but also a small simplification to
_SelectorWidget._get_data.
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -69,13 +69,11 @@ class Widget:
     _active = True
 
     def set_active(self, active):
-        """Set whether the widget is active.
-        """
+        """Set whether the widget is active."""
         self._active = active
 
     def get_active(self):
-        """Get whether the widget is active.
-        """
+        """Get whether the widget is active."""
         return self._active
 
     # set_active is overridden by SelectorWidgets.
@@ -1491,9 +1489,7 @@ def ignore(self, event):
                 event.button != self.eventpress.button)
 
     def update(self):
-        """
-        Draw using blit() or draw_idle() depending on ``self.useblit``.
-        """
+        """Draw using blit() or draw_idle(), depending on ``self.useblit``."""
         if not self.ax.get_visible():
             return False
         if self.useblit:
@@ -1507,35 +1503,31 @@ def update(self):
         return False
 
     def _get_data(self, event):
-        """Get the xdata and ydata for event, with limits"""
+        """Get the xdata and ydata for event, with limits."""
         if event.xdata is None:
             return None, None
-        x0, x1 = self.ax.get_xbound()
-        y0, y1 = self.ax.get_ybound()
-        xdata = max(x0, event.xdata)
-        xdata = min(x1, xdata)
-        ydata = max(y0, event.ydata)
-        ydata = min(y1, ydata)
+        xdata = np.clip(event.xdata, *self.ax.get_xbound())
+        ydata = np.clip(event.ydata, *self.ax.get_ybound())
         return xdata, ydata
 
     def _clean_event(self, event):
-        """Clean up an event
+        """
+        Preprocess an event:
 
-        Use prev event if there is no xdata
-        Limit the xdata and ydata to the axes limits
-        Set the prev event
+        - Replace *event* by the previous event if *event* has no ``xdata``.
+        - Clip ``xdata`` and ``ydata`` to the axes limits.
+        - Update the previous event.
         """
         if event.xdata is None:
             event = self._prev_event
         else:
             event = copy.copy(event)
         event.xdata, event.ydata = self._get_data(event)
-
         self._prev_event = event
         return event
 
     def press(self, event):
-        """Button press handler and validator"""
+        """Button press handler and validator."""
         if not self.ignore(event):
             event = self._clean_event(event)
             self.eventpress = event
@@ -1550,10 +1542,10 @@ def press(self, event):
         return False
 
     def _press(self, event):
-        """Button press handler"""
+        """Button press handler."""
 
     def release(self, event):
-        """Button release event handler and validator"""
+        """Button release event handler and validator."""
         if not self.ignore(event) and self.eventpress:
             event = self._clean_event(event)
             self.eventrelease = event
@@ -1565,29 +1557,29 @@ def release(self, event):
         return False
 
     def _release(self, event):
-        """Button release event handler"""
+        """Button release event handler."""
 
     def onmove(self, event):
-        """Cursor move event handler and validator"""
+        """Cursor move event handler and validator."""
         if not self.ignore(event) and self.eventpress:
             event = self._clean_event(event)
             self._onmove(event)
             return True
         return False
 
     def _onmove(self, event):
-        """Cursor move event handler"""
+        """Cursor move event handler."""
 
     def on_scroll(self, event):
-        """Mouse scroll event handler and validator"""
+        """Mouse scroll event handler and validator."""
         if not self.ignore(event):
             self._on_scroll(event)
 
     def _on_scroll(self, event):
-        """Mouse scroll event handler"""
+        """Mouse scroll event handler."""
 
     def on_key_press(self, event):
-        """Key press event handler and validator for all selection widgets"""
+        """Key press event handler and validator for all selection widgets."""
         if self.active:
             key = event.key or ''
             key = key.replace('ctrl', 'control')
