Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 4286537

Browse files
jklymakjklymak
authored
Merge pull request #16100 from timhoffm/callback_naming
Consistently name event callbacks on_[event]
2 parents a6f5a28 + 1d65625 commit 4286537

16 files changed

+59
-59
lines changed

‎examples/event_handling/data_browser.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def __init__(self):
2727
self.selected, = ax.plot([xs[0]], [ys[0]], 'o', ms=12, alpha=0.4,
2828
color='yellow', visible=False)
2929

30-
def onpress(self, event):
30+
def on_press(self, event):
3131
if self.lastind is None:
3232
return
3333
if event.key not in ('n', 'p'):
@@ -41,7 +41,7 @@ def onpress(self, event):
4141
self.lastind = np.clip(self.lastind, 0, len(xs) - 1)
4242
self.update()
4343

44-
def onpick(self, event):
44+
def on_pick(self, event):
4545

4646
if event.artist != line:
4747
return True
@@ -95,7 +95,7 @@ def update(self):
9595

9696
browser = PointBrowser()
9797

98-
fig.canvas.mpl_connect('pick_event', browser.onpick)
99-
fig.canvas.mpl_connect('key_press_event', browser.onpress)
98+
fig.canvas.mpl_connect('pick_event', browser.on_pick)
99+
fig.canvas.mpl_connect('key_press_event', browser.on_press)
100100

101101
plt.show()

‎examples/event_handling/figure_axes_enter_leave.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,25 @@
99
import matplotlib.pyplot as plt
1010

1111

12-
def enter_axes(event):
12+
def on_enter_axes(event):
1313
print('enter_axes', event.inaxes)
1414
event.inaxes.patch.set_facecolor('yellow')
1515
event.canvas.draw()
1616

1717

18-
def leave_axes(event):
18+
def on_leave_axes(event):
1919
print('leave_axes', event.inaxes)
2020
event.inaxes.patch.set_facecolor('white')
2121
event.canvas.draw()
2222

2323

24-
def enter_figure(event):
24+
def on_enter_figure(event):
2525
print('enter_figure', event.canvas.figure)
2626
event.canvas.figure.patch.set_facecolor('red')
2727
event.canvas.draw()
2828

2929

30-
def leave_figure(event):
30+
def on_leave_figure(event):
3131
print('leave_figure', event.canvas.figure)
3232
event.canvas.figure.patch.set_facecolor('grey')
3333
event.canvas.draw()
@@ -37,19 +37,19 @@ def leave_figure(event):
3737
fig1, (ax, ax2) = plt.subplots(2, 1)
3838
fig1.suptitle('mouse hover over figure or axes to trigger events')
3939

40-
fig1.canvas.mpl_connect('figure_enter_event', enter_figure)
41-
fig1.canvas.mpl_connect('figure_leave_event', leave_figure)
42-
fig1.canvas.mpl_connect('axes_enter_event', enter_axes)
43-
fig1.canvas.mpl_connect('axes_leave_event', leave_axes)
40+
fig1.canvas.mpl_connect('figure_enter_event', on_enter_figure)
41+
fig1.canvas.mpl_connect('figure_leave_event', on_leave_figure)
42+
fig1.canvas.mpl_connect('axes_enter_event', on_enter_axes)
43+
fig1.canvas.mpl_connect('axes_leave_event', on_leave_axes)
4444

4545
###############################################################################
4646

4747
fig2, (ax, ax2) = plt.subplots(2, 1)
4848
fig2.suptitle('mouse hover over figure or axes to trigger events')
4949

50-
fig2.canvas.mpl_connect('figure_enter_event', enter_figure)
51-
fig2.canvas.mpl_connect('figure_leave_event', leave_figure)
52-
fig2.canvas.mpl_connect('axes_enter_event', enter_axes)
53-
fig2.canvas.mpl_connect('axes_leave_event', leave_axes)
50+
fig2.canvas.mpl_connect('figure_enter_event', on_enter_figure)
51+
fig2.canvas.mpl_connect('figure_leave_event', on_leave_figure)
52+
fig2.canvas.mpl_connect('axes_enter_event', on_enter_axes)
53+
fig2.canvas.mpl_connect('axes_leave_event', on_leave_axes)
5454

5555
plt.show()

‎examples/event_handling/image_slices_viewer.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def __init__(self, ax, X):
2222
self.im = ax.imshow(self.X[:, :, self.ind])
2323
self.update()
2424

25-
def onscroll(self, event):
25+
def on_scroll(self, event):
2626
print("%s %s" % (event.button, event.step))
2727
if event.button == 'up':
2828
self.ind = (self.ind + 1) % self.slices
@@ -43,5 +43,5 @@ def update(self):
4343
tracker = IndexTracker(ax, X)
4444

4545

46-
fig.canvas.mpl_connect('scroll_event', tracker.onscroll)
46+
fig.canvas.mpl_connect('scroll_event', tracker.on_scroll)
4747
plt.show()

‎examples/event_handling/keypress_demo.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import matplotlib.pyplot as plt
1111

1212

13-
def press(event):
13+
def on_press(event):
1414
print('press', event.key)
1515
sys.stdout.flush()
1616
if event.key == 'x':
@@ -24,7 +24,7 @@ def press(event):
2424

2525
fig, ax = plt.subplots()
2626

27-
fig.canvas.mpl_connect('key_press_event', press)
27+
fig.canvas.mpl_connect('key_press_event', on_press)
2828

2929
ax.plot(np.random.rand(12), np.random.rand(12), 'go')
3030
xl = ax.set_xlabel('easy come, easy go')

‎examples/event_handling/lasso_demo.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ def __init__(self, ax, data):
4949

5050
ax.add_collection(self.collection)
5151

52-
self.cid = self.canvas.mpl_connect('button_press_event', self.onpress)
52+
self.cid = self.canvas.mpl_connect('button_press_event', self.on_press)
5353

5454
def callback(self, verts):
5555
facecolors = self.collection.get_facecolors()
@@ -65,7 +65,7 @@ def callback(self, verts):
6565
self.canvas.widgetlock.release(self.lasso)
6666
del self.lasso
6767

68-
def onpress(self, event):
68+
def on_press(self, event):
6969
if self.canvas.widgetlock.locked():
7070
return
7171
if event.inaxes is None:

‎examples/event_handling/legend_picking.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
lined[legline] = origline
3030

3131

32-
def onpick(event):
32+
def on_pick(event):
3333
# on the pick event, find the orig line corresponding to the
3434
# legend proxy line, and toggle the visibility
3535
legline = event.artist
@@ -44,6 +44,6 @@ def onpick(event):
4444
legline.set_alpha(0.2)
4545
fig.canvas.draw()
4646

47-
fig.canvas.mpl_connect('pick_event', onpick)
47+
fig.canvas.mpl_connect('pick_event', on_pick)
4848

4949
plt.show()

‎examples/event_handling/looking_glass.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@
2626

2727
class EventHandler:
2828
def __init__(self):
29-
fig.canvas.mpl_connect('button_press_event', self.onpress)
30-
fig.canvas.mpl_connect('button_release_event', self.onrelease)
31-
fig.canvas.mpl_connect('motion_notify_event', self.onmove)
29+
fig.canvas.mpl_connect('button_press_event', self.on_press)
30+
fig.canvas.mpl_connect('button_release_event', self.on_release)
31+
fig.canvas.mpl_connect('motion_notify_event', self.on_move)
3232
self.x0, self.y0 = circ.center
3333
self.pressevent = None
3434

35-
def onpress(self, event):
35+
def on_press(self, event):
3636
if event.inaxes != ax:
3737
return
3838

@@ -41,11 +41,11 @@ def onpress(self, event):
4141

4242
self.pressevent = event
4343

44-
def onrelease(self, event):
44+
def on_release(self, event):
4545
self.pressevent = None
4646
self.x0, self.y0 = circ.center
4747

48-
def onmove(self, event):
48+
def on_move(self, event):
4949
if self.pressevent is None or event.inaxes != self.pressevent.inaxes:
5050
return
5151

‎examples/event_handling/path_editor.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ def __init__(self, pathpatch):
6666
canvas.mpl_connect('button_press_event', self.on_button_press)
6767
canvas.mpl_connect('key_press_event', self.on_key_press)
6868
canvas.mpl_connect('button_release_event', self.on_button_release)
69-
canvas.mpl_connect('motion_notify_event', self.on_motion_notify)
69+
canvas.mpl_connect('motion_notify_event', self.on_mouse_move)
7070
self.canvas = canvas
7171

7272
def get_ind_under_point(self, event):
@@ -119,7 +119,7 @@ def on_key_press(self, event):
119119
self._ind = None
120120
self.canvas.draw()
121121

122-
def on_motion_notify(self, event):
122+
def on_mouse_move(self, event):
123123
"""Callback for mouse movements."""
124124
if (self._ind is None
125125
or event.inaxes is None

‎examples/event_handling/pipong.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ def __init__(self, ax):
179179
multialignment='left',
180180
textcoords='axes fraction',
181181
animated=False)
182-
self.canvas.mpl_connect('key_press_event', self.key_press)
182+
self.canvas.mpl_connect('key_press_event', self.on_key_press)
183183

184184
def draw(self, evt):
185185
draw_artist = self.ax.draw_artist
@@ -237,7 +237,7 @@ def draw(self, evt):
237237
self.cnt += 1
238238
return True
239239

240-
def key_press(self, event):
240+
def on_key_press(self, event):
241241
if event.key == '3':
242242
self.res *= 5.0
243243
if event.key == '4':

‎examples/event_handling/poly_editor.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,14 @@ def __init__(self, ax, poly):
7575
self.cid = self.poly.add_callback(self.poly_changed)
7676
self._ind = None # the active vert
7777

78-
canvas.mpl_connect('draw_event', self.draw_callback)
79-
canvas.mpl_connect('button_press_event', self.button_press_callback)
80-
canvas.mpl_connect('key_press_event', self.key_press_callback)
81-
canvas.mpl_connect('button_release_event', self.button_release_callback)
82-
canvas.mpl_connect('motion_notify_event', self.motion_notify_callback)
78+
canvas.mpl_connect('draw_event', self.on_draw)
79+
canvas.mpl_connect('button_press_event', self.on_button_press)
80+
canvas.mpl_connect('key_press_event', self.on_key_press)
81+
canvas.mpl_connect('button_release_event', self.on_button_release)
82+
canvas.mpl_connect('motion_notify_event', self.on_mouse_move)
8383
self.canvas = canvas
8484

85-
def draw_callback(self, event):
85+
def on_draw(self, event):
8686
self.background = self.canvas.copy_from_bbox(self.ax.bbox)
8787
self.ax.draw_artist(self.poly)
8888
self.ax.draw_artist(self.line)
@@ -114,7 +114,7 @@ def get_ind_under_point(self, event):
114114

115115
return ind
116116

117-
def button_press_callback(self, event):
117+
def on_button_press(self, event):
118118
"""Callback for mouse button presses."""
119119
if not self.showverts:
120120
return
@@ -124,15 +124,15 @@ def button_press_callback(self, event):
124124
return
125125
self._ind = self.get_ind_under_point(event)
126126

127-
def button_release_callback(self, event):
127+
def on_button_release(self, event):
128128
"""Callback for mouse button releases."""
129129
if not self.showverts:
130130
return
131131
if event.button != 1:
132132
return
133133
self._ind = None
134134

135-
def key_press_callback(self, event):
135+
def on_key_press(self, event):
136136
"""Callback for key presses."""
137137
if not event.inaxes:
138138
return
@@ -164,7 +164,7 @@ def key_press_callback(self, event):
164164
if self.line.stale:
165165
self.canvas.draw_idle()
166166

167-
def motion_notify_callback(self, event):
167+
def on_mouse_move(self, event):
168168
"""Callback for mouse movements."""
169169
if not self.showverts:
170170
return

‎examples/event_handling/pong_sgskip.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828

2929
# reset the blitting background on redraw
30-
def handle_redraw(event):
30+
def on_redraw(event):
3131
animation.background = None
3232

3333

@@ -40,7 +40,7 @@ def local_draw():
4040
animation.draw(None)
4141
start_anim.timer.add_callback(local_draw)
4242
start_anim.timer.start()
43-
canvas.mpl_connect('draw_event', handle_redraw)
43+
canvas.mpl_connect('draw_event', on_redraw)
4444

4545

4646
start_anim.cid = canvas.mpl_connect('draw_event', start_anim)

‎examples/event_handling/trifinder_event_demo.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ def update_polygon(tri):
2323
polygon.set_xy(np.column_stack([xs, ys]))
2424

2525

26-
def motion_notify(event):
26+
def on_mouse_move(event):
2727
if event.inaxes is None:
2828
tri = -1
2929
else:
@@ -57,5 +57,5 @@ def motion_notify(event):
5757
polygon = Polygon([[0, 0], [0, 0]], facecolor='y') # dummy data for (xs, ys)
5858
update_polygon(-1)
5959
plt.gca().add_patch(polygon)
60-
plt.gcf().canvas.mpl_connect('motion_notify_event', motion_notify)
60+
plt.gcf().canvas.mpl_connect('motion_notify_event', on_mouse_move)
6161
plt.show()

‎examples/event_handling/zoom_window.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131
axzoom.scatter(x, y, s, c)
3232

3333

34-
def onpress(event):
34+
def on_press(event):
3535
if event.button != 1:
3636
return
3737
x, y = event.xdata, event.ydata
3838
axzoom.set_xlim(x - 0.1, x + 0.1)
3939
axzoom.set_ylim(y - 0.1, y + 0.1)
4040
figzoom.canvas.draw()
4141

42-
figsrc.canvas.mpl_connect('button_press_event', onpress)
42+
figsrc.canvas.mpl_connect('button_press_event', on_press)
4343
plt.show()

‎examples/misc/cursor_demo_sgskip.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def __init__(self, ax):
3030
# text location in axes coords
3131
self.txt = ax.text(0.7, 0.9, '', transform=ax.transAxes)
3232

33-
def mouse_move(self, event):
33+
def on_mouse_move(self, event):
3434
if not event.inaxes:
3535
return
3636

@@ -58,7 +58,7 @@ def __init__(self, ax, x, y):
5858
# text location in axes coords
5959
self.txt = ax.text(0.7, 0.9, '', transform=ax.transAxes)
6060

61-
def mouse_move(self, event):
61+
def on_mouse_move(self, event):
6262
if not event.inaxes:
6363
return
6464

@@ -81,11 +81,11 @@ def mouse_move(self, event):
8181
fig, ax = plt.subplots()
8282
ax.plot(t, s, 'o')
8383
cursor = Cursor(ax)
84-
fig.canvas.mpl_connect('motion_notify_event', cursor.mouse_move)
84+
fig.canvas.mpl_connect('motion_notify_event', cursor.on_mouse_move)
8585

8686
fig, ax = plt.subplots()
8787
ax.plot(t, s, 'o')
8888
snap_cursor = SnaptoCursor(ax, t, s)
89-
fig.canvas.mpl_connect('motion_notify_event', snap_cursor.mouse_move)
89+
fig.canvas.mpl_connect('motion_notify_event', snap_cursor.on_mouse_move)
9090

9191
plt.show()

‎lib/matplotlib/animation.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1249,10 +1249,10 @@ def _setup_blit(self):
12491249
self._blit_cache = dict()
12501250
self._drawn_artists = []
12511251
self._resize_id = self._fig.canvas.mpl_connect('resize_event',
1252-
self._handle_resize)
1252+
self._on_resize)
12531253
self._post_draw(None, self._blit)
12541254

1255-
def _handle_resize(self, *args):
1255+
def _on_resize(self, event):
12561256
# On resize, we need to disable the resize event handling so we don't
12571257
# get too many events. Also stop the animation events, so that
12581258
# we're paused. Reset the cache and re-init. Set up an event handler
@@ -1271,7 +1271,7 @@ def _end_redraw(self, evt):
12711271
self.event_source.start()
12721272
self._fig.canvas.mpl_disconnect(self._resize_id)
12731273
self._resize_id = self._fig.canvas.mpl_connect('resize_event',
1274-
self._handle_resize)
1274+
self._on_resize)
12751275

12761276
def to_html5_video(self, embed_limit=None):
12771277
"""

‎lib/matplotlib/tests/test_backend_qt.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,11 +183,11 @@ def isAutoRepeat(self): return False
183183
def key(self): return getattr(qt_core.Qt, qt_key)
184184
def modifiers(self): return qt_mod
185185

186-
def receive(event):
186+
def on_key_press(event):
187187
assert event.key == answer
188188

189189
qt_canvas = plt.figure().canvas
190-
qt_canvas.mpl_connect('key_press_event', receive)
190+
qt_canvas.mpl_connect('key_press_event', on_key_press)
191191
qt_canvas.keyPressEvent(_Event())
192192

193193

0 commit comments

Comments
 (0)