1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
# -*- coding: utf-8 -*-
# Copyright (c) Vispy Development Team. All Rights Reserved.
# Distributed under the (new) BSD License. See LICENSE.txt for more info.
import unittest
import copy
from vispy.util.event import Event, EventEmitter, EmitterGroup
from vispy.util import use_log_level
from vispy.testing import run_tests_if_main, assert_true, assert_raises
class BasicEvent(Event):
pass
class TypedEvent(Event):
def __init__(self, **kwargs):
kwargs['type'] = 'typed_event'
Event.__init__(self, **kwargs)
class TestGroups(unittest.TestCase):
def test_group_construction(self):
"""The EmitterGroup basic construction"""
grp = EmitterGroup(em1=Event,
em2=BasicEvent,
em3=TypedEvent)
grp.em1.connect(self.record_event)
grp.em2.connect(self.record_event)
grp.em3.connect(self.record_event)
self.result = None
ev = grp.em1()
self.assert_result(event=ev, type='em1', event_class=Event)
ev = grp.em2()
self.assert_result(event=ev, type='em2', event_class=BasicEvent)
ev = grp.em3()
self.assert_result(
event=ev,
type='typed_event',
event_class=TypedEvent)
def test_group_add_emitter(self):
"""The EmitterGroup.add"""
grp = EmitterGroup(em1=Event)
grp.em1.connect(self.record_event)
self.result = None
ev = grp.em1()
self.assert_result(event=ev, type='em1')
grp.add(em2=BasicEvent)
grp.em2.connect(self.record_event)
ev = grp.em2()
self.assert_result(event=ev, type='em2', event_class=BasicEvent)
grp.add(em3=TypedEvent)
grp.em3.connect(self.record_event)
ev = grp.em3(test_key=2)
self.assert_result(
event=ev,
type='typed_event',
event_class=TypedEvent,
test_key=2)
try:
grp.add(em3=Event)
assert False, "Double-added emitter"
except ValueError:
pass
try:
grp.add(add=Event)
assert False, "Added event with invalid name"
except ValueError:
pass
def test_group_block(self):
"""EmitterGroup.block_all"""
grp = EmitterGroup(em1=Event, em2=Event)
def cb(ev):
self.result = 1
grp.em1.connect(self.record_event)
grp.em2.connect(self.record_event)
grp.connect(cb)
self.result = None
grp.block_all()
try:
grp.em1()
grp.em2()
grp(type='test_event')
finally:
grp.unblock_all()
assert self.result is None
def test_group_ignore(self):
"""EmitterGroup.block_all"""
grp = EmitterGroup(em1=Event)
grp.em1.connect(self.error_event)
with use_log_level('warning',
record=True, print_msg=False) as emit_list:
grp.em1()
assert_true(len(emit_list) >= 1)
grp.ignore_callback_errors = False
assert_raises(RuntimeError, grp.em1)
grp.ignore_callback_errors = True
with use_log_level('warning',
record=True, print_msg=False) as emit_list:
grp.em1()
assert_true(len(emit_list) >= 1)
def test_group_disconnect(self):
"""EmitterGroup.disconnect"""
grp = EmitterGroup(em1=Event)
assert len(grp.em1.callbacks) == 0, grp.em1.callbacks
grp.connect(self.record_event)
assert len(grp.em1.callbacks) == 1
grp.add(em2=Event)
assert len(grp.em2.callbacks) == 1
grp.disconnect()
assert len(grp.em1.callbacks) == 0
assert len(grp.em2.callbacks) == 0
def test_group_autoconnect(self):
"""The EmitterGroup auto-connect"""
class Source:
def on_em1(self, ev):
self.result = 1
def em2_event(self, ev):
self.result = 2
def em3_event(self, ev):
self.result = 3
src = Source()
grp = EmitterGroup(source=src, em1=Event, auto_connect=False)
src.result = None
grp.em1()
assert src.result is None
grp = EmitterGroup(source=src, em1=Event, auto_connect=True)
src.result = None
grp.em1()
assert src.result == 1
grp.auto_connect_format = "%s_event"
grp.add(em2=Event)
src.result = None
grp.em2()
assert src.result == 2
grp.add(em3=Event, auto_connect=False)
src.result = None
grp.em3()
assert src.result is None
def test_add_custom_emitter(self):
class Emitter(EventEmitter):
def _prepare_event(self, *args, **kwargs):
ev = super(Emitter, self)._prepare_event(*args, **kwargs)
ev.test_key = 1
return ev
class Source:
pass
src = Source()
grp = EmitterGroup(source=src, em1=Emitter(type='test_event1'))
grp.em1.connect(self.record_event)
self.result = None
ev = grp.em1()
self.assert_result(
event=ev,
test_key=1,
type='test_event1',
source=src)
grp.add(em2=Emitter(type='test_event2'))
grp.em2.connect(self.record_event)
self.result = None
ev = grp.em2()
self.assert_result(
event=ev,
test_key=1,
type='test_event2',
source=src)
def test_group_connect(self):
grp = EmitterGroup(source=self, em1=Event)
grp.connect(self.record_event)
self.result = None
ev = grp.em1(test_key=1)
self.assert_result(
event=ev,
source=self,
sources=[
self,
self],
test_key=1)
def record_event(self, ev, key=None):
# get a copy of all event attributes because these may change
# as the event is passed around; we want to know exactly what the event
# looked like when it reached this callback.
names = [name for name in dir(ev) if name[0] != '_']
attrs = {}
for name in names:
val = getattr(ev, name)
if name == 'source':
attrs[name] = val
elif name == 'sources':
attrs[name] = val[:]
else:
try:
attrs[name] = copy.deepcopy(val)
except Exception:
try:
attrs[name] = copy.copy(val)
except Exception:
attrs[name] = val
if key is None:
self.result = ev, attrs
else:
if not hasattr(self, 'result') or self.result is None:
self.result = {}
self.result[key] = ev, attrs
def error_event(self, ev, key=None):
raise RuntimeError('Errored')
def assert_result(self, key=None, **kwargs):
assert (hasattr(self, 'result') and self.result is not None), \
"No event recorded"
if key is None:
event, event_attrs = self.result
else:
event, event_attrs = self.result[key]
assert isinstance(event, Event), "Emitted object is not Event instance"
for name, val in kwargs.items():
if name == 'event':
assert event is val, "Event objects do not match"
elif name == 'event_class':
assert isinstance(event, val), \
"Emitted object is not instance of %s" % val.__name__
else:
attr = event_attrs[name]
assert (attr == val), "Event.%s != %s (%s)" % (
name, str(val), str(attr))
run_tests_if_main()
|
