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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
"""
:copyright: Copyright 2006-2009 by Oliver Schoenborn, all rights reserved.
:license: BSD, see LICENSE.txt for details.
"""
import unittest
from unittests import wtc
from wx.lib.pubsub.core.weakmethod import WeakMethod
from wx.lib.pubsub.core import listener
from wx.lib.pubsub.core.listener import (
Listener, ListenerValidator,
ListenerMismatchError,
CallArgsInfo,
getArgs)
#---------------------------------------------------------------------------
class ArgsInfoMock:
def __init__(self, autoTopicArgName=None):
self.autoTopicArgName = autoTopicArgName
self.acceptsAllKwargs = False
#---------------------------------------------------------------------------
class lib_pubsub_ArgsInfo(wtc.PubsubTestCase):
def test0_ArgsInfo(self):
def listener0(msgTopic = Listener.AUTO_TOPIC):
pass
CallArgsInfo(listener0, 0)
def listener1(arg1, msgTopic = Listener.AUTO_TOPIC):
pass
CallArgsInfo(listener1, 1)
def test2_Validation0(self):
# Test when ValidatorSameKwargsOnly used, ie when args in
# listener and topic must be exact match (unless *arg).
AA = Listener.AUTO_TOPIC
# test for topic that has no arg/kwargs in topic message spec (TMS)
def same():
pass
def varargs(*args, **kwargs):
pass
def autoArg(msgTopic=AA):
pass
def extraArg(a):
pass
def extraKwarg(a=1):
pass
# no arg/kwarg in topic message spec (TMS)
validator = ListenerValidator([], [])
validate = validator.validate
validate(same) # ok: same
validate(varargs) # ok: *args/**kwargs
validate(autoArg) # ok: extra but AUTO_TOPIC
self.assertRaises(ListenerMismatchError, validate, extraArg) # E: extra arg
self.assertRaises(ListenerMismatchError, validate, extraKwarg) # E: extra kwarg
def test2_Validation1(self):
# one arg/kwarg in topic
validator = ListenerValidator(['a'], ['b'])
validate = validator.validate
def same(a, b=1):
pass
def same2(a=2, b=1):
pass
def varkwargs(**kwargs):
pass
def varkwargs_a(a, **kwargs):
pass
def opt_reqd(b, **kwargs):
pass
def missing_arg(b=1):
pass
def missing_kwarg(a):
pass
def extra_kwarg1(a,b=1,c=2):
pass
def extra_kwarg2(c=1, *args, **kwargs):
pass
def extra_arg1(a,c,b=1):
pass
def extra_arg2(a,b,c=2):
pass
validate(same) # ok: same
validate(same2) # ok: same even if a now has default value
validate(varkwargs_a) # ok: has **kwargs
validate(varkwargs) # ok: has **kwargs
self.assertRaises(ListenerMismatchError, validate, opt_reqd) # E: b now required
self.assertRaises(ListenerMismatchError, validate, missing_arg) # E: missing arg
self.assertRaises(ListenerMismatchError, validate, missing_kwarg) # E: missing kwarg
self.assertRaises(ListenerMismatchError, validate, extra_kwarg1) # E: extra kwarg
self.assertRaises( ListenerMismatchError, validate, extra_kwarg2) # E: extra kwarg
self.assertRaises( ListenerMismatchError, validate, extra_arg1) # E: extra arg
self.assertRaises( ListenerMismatchError, validate, extra_arg2) # E: extra arg
def test3_IsCallable(self):
# Test the proper trapping of non-callable and certain types of
# callable objects.
# validate different types of callables
validator = ListenerValidator([], [])
# not a function:
notAFunc = 1 # just pick something that is not a function
self.assertRaises(ListenerMismatchError, validator.validate, notAFunc)
# a regular function:
def aFunc():
pass
validator.validate(aFunc)
# a functor and a method
class Foo(object):
def __call__(self):
pass
def meth(self):
pass
foo = Foo()
validator.validate(foo)
validator.validate(foo.meth)
def test4_WantTopic(self):
# Test the correct determination of whether want topic
# auto-passed during sendMessage() calls.
# first check proper breakdown of listener args:
def listener(a, b=1):
pass
argsInfo = CallArgsInfo(listener, 0)
self.assertEqual(None, argsInfo.autoTopicArgName )
msgTopic = 'auto'
class MyListener:
def method(self, a, b=1, auto=Listener.AUTO_TOPIC):
pass
listener = MyListener()
argsInfo = getArgs(listener.method)
self.assertEqual(msgTopic, argsInfo.autoTopicArgName )
self.assertEqual(['a','b'], argsInfo.allParams )
# now some white box testing of validator that makes use of args info:
def checkWantTopic(validate, listener, wantTopicAsArg=None):
argsInfo = getArgs(listener)
self.assertEqual(argsInfo.autoTopicArgName, wantTopicAsArg)
validate(listener)
validator = ListenerValidator([], ['a'])
validate = validator.validate
def noWant(a=1):
pass
def want1(a=1, auto=Listener.AUTO_TOPIC):
pass
checkWantTopic(validate, noWant)
checkWantTopic(validate, want1, msgTopic)
validator = ListenerValidator(['a'], ['b'])
validate = validator.validate
def noWant2(a, b=1):
pass
def want2(a, auto=Listener.AUTO_TOPIC, b=1):
pass
checkWantTopic(validate, noWant2)
checkWantTopic(validate, want2, msgTopic)
# topic that has Listener.AUTO_TOPIC as an arg rather than kwarg
validator = ListenerValidator([msgTopic], ['b'])
validate = validator.validate
def noWant3(auto, b=1):
pass
checkWantTopic(validate, noWant3)
def test5_DOAListeners(self):
# Test "dead on arrival"
# test DOA of unbound method
def getListener1():
class DOA:
def tmpFn(self):
pass
Listener( DOA.tmpFn, ArgsInfoMock() )
# test DOA of tmp callable:
def getListener2():
def fn():
pass
class Wrapper:
def __init__(self, func):
self.func = func
def __call__(self):
pass
def onDead(listenerObj):
pass
# check dead-on-arrival when no death callback specified:
doa1 = Listener( Wrapper(fn), ArgsInfoMock() )
assert doa1.getCallable() is None
assert doa1.isDead()
self.assertRaises(RuntimeError, doa1, None, {})
# check dead-on-arrival when a death callback specified:
doa2 = Listener( Wrapper(fn), ArgsInfoMock(), onDead )
assert doa2.getCallable() is None
assert doa2.isDead()
self.assertRaises(RuntimeError, doa2, None, {})
getListener2()
def test6_ListenerEq(self):
# Test equality tests of two listeners
def listener1():
pass
def listener2():
pass
l1 = Listener(listener1, ArgsInfoMock())
l2 = Listener(listener2, ArgsInfoMock())
# verify that Listener can be compared for equality to another Listener, weakref, or callable
self.assertEqual (l1, l1)
self.assertNotEqual (l1, l2)
self.assertEqual (l1, listener1)
self.assertNotEqual (l1, listener2)
ll = [l1]
assert listener1 in ll
assert listener2 not in ll
self.assertEqual(ll.index(listener1), 0)
# now for class method listener:
class MyListener:
def __call__(self):
pass
def meth(self):
pass
listener3 = MyListener()
l3 = Listener(listener3, ArgsInfoMock() )
self.assertNotEqual (l3, l1)
self.assertNotEqual (l3, l2)
self.assertNotEqual (l3, listener2)
self.assertEqual (l3, l3)
self.assertEqual (l3, listener3)
self.assertNotEqual (l3, listener3.__call__)
l4 = Listener(listener3.meth, ArgsInfoMock())
self.assertEqual (l4, l4)
self.assertNotEqual (l4, l3)
self.assertNotEqual (l4, l2)
self.assertNotEqual (l4, listener3.__call__)
self.assertEqual (l4, listener3.meth)
def test7_DyingListenersClass(self):
# Test notification callbacks when listener dies
# test dead listener notification
def onDead(weakListener):
lsrs.remove(weakListener)
def listener1():
pass
def listener2():
pass
def listener3():
pass
lsrs = []
lsrs.append(Listener(listener1, ArgsInfoMock(False), onDead=onDead))
lsrs.append(Listener(listener2, ArgsInfoMock(False), onDead=onDead))
lsrs.append(Listener(listener3, ArgsInfoMock(False), onDead=onDead))
# now force some listeners to die, verify lsrs list
self.assertEqual(len(lsrs), 3)
del listener1
self.assertEqual(len(lsrs), 2)
self.assertEqual(lsrs[0], listener2)
self.assertEqual(lsrs[1], listener3)
del listener2
self.assertEqual(len(lsrs), 1)
self.assertEqual(lsrs[0], listener3)
del listener3
self.assertEqual(len(lsrs), 0)
def test8_getArgsBadListener(self):
self.assertRaises(ListenerMismatchError, getArgs, 1)
try:
getArgs(1)
except ListenerMismatchError as exc:
msg = 'Listener "int" (from module "__main__") inadequate: type "int" not supported'
self.assertEqual(str(exc), msg)
def test10_weakMethod(self):
class Foo:
def meth(self):
pass
foo = Foo()
wm = WeakMethod(foo.meth)
str(wm)
def test11_testNaming(self):
aiMock = ArgsInfoMock()
# define various type of listeners
def fn():
pass
class Foo:
def __call__(self):
pass
def meth(self):
pass
ll = Listener(fn, aiMock)
self.assertEqual(ll.typeName(), "fn")
self.assertEqual(ll.module(), __name__)
assert not ll.wantsTopicObjOnCall()
foo = Foo()
ll = Listener(foo, aiMock)
self.assertEqual(ll.typeName(), "Foo")
self.assertEqual(ll.module(), __name__)
assert not ll.wantsTopicObjOnCall()
ll = Listener(foo.meth, ArgsInfoMock('argName'))
self.assertEqual(ll.typeName(), "Foo.meth")
self.assertEqual(ll.module(), __name__)
assert ll.wantsTopicObjOnCall()
#---------------------------------------------------------------------------
if __name__ == '__main__':
unittest.main()
|
