Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit a1b5e5d

Browse filesBrowse files
committed
Widgets cleanup.
Mostly docstring cleanups, but also a small simplification to _SelectorWidget._get_data.
1 parent 0ba2b40 commit a1b5e5d
Copy full SHA for a1b5e5d

File tree

Expand file treeCollapse file tree

1 file changed

+20
-28
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+20
-28
lines changed

‎lib/matplotlib/widgets.py

Copy file name to clipboardExpand all lines: lib/matplotlib/widgets.py
+20-28Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,11 @@ class Widget:
6969
_active = True
7070

7171
def set_active(self, active):
72-
"""Set whether the widget is active.
73-
"""
72+
"""Set whether the widget is active."""
7473
self._active = active
7574

7675
def get_active(self):
77-
"""Get whether the widget is active.
78-
"""
76+
"""Get whether the widget is active."""
7977
return self._active
8078

8179
# set_active is overridden by SelectorWidgets.
@@ -1491,9 +1489,7 @@ def ignore(self, event):
14911489
event.button != self.eventpress.button)
14921490

14931491
def update(self):
1494-
"""
1495-
Draw using blit() or draw_idle() depending on ``self.useblit``.
1496-
"""
1492+
"""Draw using blit() or draw_idle(), depending on ``self.useblit``."""
14971493
if not self.ax.get_visible():
14981494
return False
14991495
if self.useblit:
@@ -1507,35 +1503,31 @@ def update(self):
15071503
return False
15081504

15091505
def _get_data(self, event):
1510-
"""Get the xdata and ydata for event, with limits"""
1506+
"""Get the xdata and ydata for event, with limits."""
15111507
if event.xdata is None:
15121508
return None, None
1513-
x0, x1 = self.ax.get_xbound()
1514-
y0, y1 = self.ax.get_ybound()
1515-
xdata = max(x0, event.xdata)
1516-
xdata = min(x1, xdata)
1517-
ydata = max(y0, event.ydata)
1518-
ydata = min(y1, ydata)
1509+
xdata = np.clip(event.xdata, *self.ax.get_xbound())
1510+
ydata = np.clip(event.ydata, *self.ax.get_ybound())
15191511
return xdata, ydata
15201512

15211513
def _clean_event(self, event):
1522-
"""Clean up an event
1514+
"""
1515+
Preprocess an event:
15231516
1524-
Use prev event if there is no xdata
1525-
Limit the xdata and ydata to the axes limits
1526-
Set the prev event
1517+
- Replace *event* by the previous event if *event* has no ``xdata``.
1518+
- Clip ``xdata`` and ``ydata`` to the axes limits.
1519+
- Update the previous event.
15271520
"""
15281521
if event.xdata is None:
15291522
event = self._prev_event
15301523
else:
15311524
event = copy.copy(event)
15321525
event.xdata, event.ydata = self._get_data(event)
1533-
15341526
self._prev_event = event
15351527
return event
15361528

15371529
def press(self, event):
1538-
"""Button press handler and validator"""
1530+
"""Button press handler and validator."""
15391531
if not self.ignore(event):
15401532
event = self._clean_event(event)
15411533
self.eventpress = event
@@ -1550,10 +1542,10 @@ def press(self, event):
15501542
return False
15511543

15521544
def _press(self, event):
1553-
"""Button press handler"""
1545+
"""Button press handler."""
15541546

15551547
def release(self, event):
1556-
"""Button release event handler and validator"""
1548+
"""Button release event handler and validator."""
15571549
if not self.ignore(event) and self.eventpress:
15581550
event = self._clean_event(event)
15591551
self.eventrelease = event
@@ -1565,29 +1557,29 @@ def release(self, event):
15651557
return False
15661558

15671559
def _release(self, event):
1568-
"""Button release event handler"""
1560+
"""Button release event handler."""
15691561

15701562
def onmove(self, event):
1571-
"""Cursor move event handler and validator"""
1563+
"""Cursor move event handler and validator."""
15721564
if not self.ignore(event) and self.eventpress:
15731565
event = self._clean_event(event)
15741566
self._onmove(event)
15751567
return True
15761568
return False
15771569

15781570
def _onmove(self, event):
1579-
"""Cursor move event handler"""
1571+
"""Cursor move event handler."""
15801572

15811573
def on_scroll(self, event):
1582-
"""Mouse scroll event handler and validator"""
1574+
"""Mouse scroll event handler and validator."""
15831575
if not self.ignore(event):
15841576
self._on_scroll(event)
15851577

15861578
def _on_scroll(self, event):
1587-
"""Mouse scroll event handler"""
1579+
"""Mouse scroll event handler."""
15881580

15891581
def on_key_press(self, event):
1590-
"""Key press event handler and validator for all selection widgets"""
1582+
"""Key press event handler and validator for all selection widgets."""
15911583
if self.active:
15921584
key = event.key or ''
15931585
key = key.replace('ctrl', 'control')

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.