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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
""" Tests to help find out if we can do type-safe casting. """
# Standard library imports.
import unittest
import warnings
# Enthought library imports.
from traits.adaptation.api import reset_global_adaptation_manager
from traits.api import (
Adapter,
HasTraits,
Instance,
Int,
Interface,
provides,
register_factory,
)
# Local imports.
from traits.interface_checker import InterfaceError, check_implements
# Make sure implicit interface checking is turned off, so that we can make the
# checks explicitly:
from traits import has_traits
class InterfaceCheckerTestCase(unittest.TestCase):
""" Tests to help find out if we can do type-safe casting. """
###########################################################################
# 'TestCase' interface.
###########################################################################
def setUp(self):
""" Prepares the test fixture before each test method is called. """
# Make sure implicit interface checking is turned off, so that we can
# make the checks explicitly:
self._old_check_interfaces = has_traits.CHECK_INTERFACES
has_traits.CHECK_INTERFACES = 0
reset_global_adaptation_manager()
def tearDown(self):
has_traits.CHECK_INTERFACES = self._old_check_interfaces
###########################################################################
# Tests.
###########################################################################
def test_non_traits_class(self):
""" non-traits class """
class IFoo(Interface):
def foo(self):
pass
# A class that *does* implement the interface.
@provides(IFoo)
class Foo(object):
def foo(self):
pass
# The checker will raise an exception if the class does not implement
# the interface.
check_implements(Foo, IFoo, 2)
def test_single_interface(self):
""" single interface """
class IFoo(Interface):
x = Int
# A class that *does* implement the interface.
@provides(IFoo)
class Foo(HasTraits):
x = Int
# The checker will raise an exception if the class does not implement
# the interface.
check_implements(Foo, IFoo, 2)
def test_single_interface_with_invalid_method_signature(self):
""" single interface with invalid method signature """
class IFoo(Interface):
def foo(self):
pass
# A class that does *not* implement the interface.
@provides(IFoo)
class Foo(HasTraits):
# Extra argument!
def foo(self, x):
pass
self.assertRaises(InterfaceError, check_implements, Foo, IFoo, 2)
def test_single_interface_with_missing_trait(self):
""" single interface with missing trait """
class IFoo(Interface):
x = Int
# A class that does *not* implement the interface.
@provides(IFoo)
class Foo(HasTraits):
pass
self.assertRaises(InterfaceError, check_implements, Foo, IFoo, 2)
def test_single_interface_with_missing_method(self):
""" single interface with missing method """
class IFoo(Interface):
def method(self):
pass
# A class that does *not* implement the interface.
@provides(IFoo)
class Foo(HasTraits):
pass
self.assertRaises(InterfaceError, check_implements, Foo, IFoo, 2)
def test_multiple_interfaces(self):
""" multiple interfaces """
class IFoo(Interface):
x = Int
class IBar(Interface):
y = Int
class IBaz(Interface):
z = Int
# A class that *does* implement the interface.
@provides(IFoo, IBar, IBaz)
class Foo(HasTraits):
x = Int
y = Int
z = Int
# The checker will raise an exception if the class does not implement
# the interface.
check_implements(Foo, [IFoo, IBar, IBaz], 2)
def test_multiple_interfaces_with_invalid_method_signature(self):
""" multiple interfaces with invalid method signature """
class IFoo(Interface):
def foo(self):
pass
class IBar(Interface):
def bar(self):
pass
class IBaz(Interface):
def baz(self):
pass
# A class that does *not* implement the interface.
@provides(IFoo, IBar, IBaz)
class Foo(HasTraits):
def foo(self):
pass
def bar(self):
pass
# Extra argument!
def baz(self, x):
pass
self.assertRaises(
InterfaceError, check_implements, Foo, [IFoo, IBar, IBaz], 2
)
def test_multiple_interfaces_with_missing_trait(self):
""" multiple interfaces with missing trait """
class IFoo(Interface):
x = Int
class IBar(Interface):
y = Int
class IBaz(Interface):
z = Int
# A class that does *not* implement the interface.
@provides(IFoo, IBar, IBaz)
class Foo(HasTraits):
x = Int
y = Int
self.assertRaises(
InterfaceError, check_implements, Foo, [IFoo, IBar, IBaz], 2
)
def test_multiple_interfaces_with_missing_method(self):
""" multiple interfaces with missing method """
class IFoo(Interface):
def foo(self):
pass
class IBar(Interface):
def bar(self):
pass
class IBaz(Interface):
def baz(self):
pass
# A class that does *not* implement the interface.
@provides(IFoo, IBar, IBaz)
class Foo(HasTraits):
def foo(self):
pass
def bar(self):
pass
self.assertRaises(
InterfaceError, check_implements, Foo, [IFoo, IBar, IBaz], 2
)
def test_inherited_interfaces(self):
""" inherited interfaces """
class IFoo(Interface):
x = Int
class IBar(IFoo):
y = Int
class IBaz(IBar):
z = Int
# A class that *does* implement the interface.
@provides(IBaz)
class Foo(HasTraits):
x = Int
y = Int
z = Int
# The checker will raise an exception if the class does not implement
# the interface.
check_implements(Foo, IBaz, 2)
def test_inherited_interfaces_with_invalid_method_signature(self):
""" inherited with invalid method signature """
class IFoo(Interface):
def foo(self):
pass
class IBar(IFoo):
def bar(self):
pass
class IBaz(IBar):
def baz(self):
pass
# A class that does *not* implement the interface.
@provides(IBaz)
class Foo(HasTraits):
def foo(self):
pass
def bar(self):
pass
# Extra argument!
def baz(self, x):
pass
self.assertRaises(InterfaceError, check_implements, Foo, IBaz, 2)
def test_inherited_interfaces_with_missing_trait(self):
""" inherited interfaces with missing trait """
class IFoo(Interface):
x = Int
class IBar(IFoo):
y = Int
class IBaz(IBar):
z = Int
# A class that does *not* implement the interface.
@provides(IBaz)
class Foo(HasTraits):
x = Int
y = Int
self.assertRaises(InterfaceError, check_implements, Foo, IBaz, 2)
def test_inherited_interfaces_with_missing_method(self):
""" inherited interfaces with missing method """
class IFoo(Interface):
def foo(self):
pass
class IBar(IFoo):
def bar(self):
pass
class IBaz(IBar):
def baz(self):
pass
# A class that does *not* implement the interface.
@provides(IBaz)
class Foo(HasTraits):
def foo(self):
pass
def bar(self):
pass
self.assertRaises(InterfaceError, check_implements, Foo, IBaz, 2)
def test_subclasses_with_wrong_signature_methods(self):
""" Subclasses with incorrect method signatures """
class IFoo(Interface):
def foo(self, argument):
pass
@provides(IFoo)
class Foo(HasTraits):
def foo(self, argument):
pass
class Bar(Foo):
def foo(self):
pass
self.assertRaises(InterfaceError, check_implements, Bar, IFoo, 2)
# Make sure interfaces and adaptation etc still work with the 'HasTraits'
# version of 'Interface'!
def test_instance(self):
""" instance """
class IFoo(Interface):
pass
@provides(IFoo)
class Foo(HasTraits):
pass
class Bar(HasTraits):
foo = Instance(IFoo)
Bar(foo=Foo())
def test_callable(self):
""" callable """
class IFoo(Interface):
pass
@provides(IFoo)
class Foo(HasTraits):
pass
f = Foo()
# Adaptation via direct instantiation of interfaces is deprecated, so
# catch the warning to keep the test run output clean.
with warnings.catch_warnings(record=True) as warn_msgs:
warnings.simplefilter("always", DeprecationWarning)
self.assertEqual(f, IFoo(f))
self.assertEqual(len(warn_msgs), 1)
warn_msg = warn_msgs[0]
self.assertIn(
'use "adapt(adaptee, protocol)" instead', str(warn_msg.message))
self.assertIn("test_interface_checker", warn_msg.filename)
def test_adaptation(self):
""" adaptation """
class IFoo(Interface):
pass
class Foo(HasTraits):
pass
@provides(IFoo)
class FooToIFooAdapter(Adapter):
pass
register_factory(FooToIFooAdapter, Foo, IFoo)
f = Foo()
# Make sure adaptation works. Adaptation via direct instantiation of
# Interface classes is deprecated, so suppress the warning.
with warnings.catch_warnings(record=True) as warn_msgs:
warnings.simplefilter("always", DeprecationWarning)
i_foo = IFoo(f)
self.assertNotEqual(None, i_foo)
self.assertEqual(FooToIFooAdapter, type(i_foo))
self.assertEqual(len(warn_msgs), 1)
warn_msg = warn_msgs[0]
self.assertIn(
'use "adapt(adaptee, protocol)" instead', str(warn_msg.message))
self.assertIn("test_interface_checker", warn_msg.filename)
|
