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
|
# (C) Copyright 2004-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!
import unittest
from traitsui.testing.tester.target_registry import (
TargetRegistry,
)
from traitsui.testing.tester.exceptions import (
InteractionNotSupported,
LocationNotSupported,
)
class TestInteractionRegistry(unittest.TestCase):
def test_registry_empty(self):
class SpecificTarget:
pass
class Action:
pass
registry = TargetRegistry()
with self.assertRaises(InteractionNotSupported) as exception_context:
registry._get_handler(SpecificTarget(), Action())
self.assertEqual(
str(exception_context.exception),
f"No handler is found for target {SpecificTarget!r} with "
f"interaction {Action!r}. Supported these: []",
)
def test_register_editor_with_action(self):
registry = TargetRegistry()
class SpecificEditor:
pass
class UserAction:
pass
def handler(wrapper, interaction):
pass
# when
registry.register_interaction(
target_class=SpecificEditor,
interaction_class=UserAction,
handler=handler,
)
# then
actual = registry._get_handler(SpecificEditor(), UserAction())
self.assertIs(actual, handler)
def test_get_interactions_supported(self):
registry = TargetRegistry()
class SpecificEditor:
pass
class UserAction:
pass
class UserAction2:
pass
def handler(wrapper, interaction):
pass
# when
registry.register_interaction(
target_class=SpecificEditor,
interaction_class=UserAction,
handler=handler,
)
registry.register_interaction(
target_class=SpecificEditor,
interaction_class=UserAction2,
handler=handler,
)
# then
self.assertEqual(
registry._get_interactions(SpecificEditor()),
{UserAction, UserAction2},
)
def test_action_not_supported_report_supported_action(self):
# Test raise InteractionNotSupported contains information about what
# actions are supported.
class SpecificEditor:
pass
class SpecificEditor2:
pass
class UserAction:
pass
class UserAction2:
pass
class UserAction3:
pass
def handler(wrapper, interaction):
pass
registry = TargetRegistry()
registry.register_interaction(SpecificEditor, UserAction, handler)
registry.register_interaction(SpecificEditor2, UserAction2, handler)
registry.register_interaction(SpecificEditor2, UserAction3, handler)
with self.assertRaises(InteractionNotSupported) as exception_context:
registry._get_handler(SpecificEditor2(), None)
self.assertIn(UserAction2, exception_context.exception.supported)
self.assertIn(UserAction3, exception_context.exception.supported)
self.assertNotIn(UserAction, exception_context.exception.supported)
def test_error_conflict(self):
# Test the same target + interaction type cannot be registered twice.
class SpecificEditor:
pass
class UserAction:
pass
def handler(wrapper, interaction):
pass
registry = TargetRegistry()
registry.register_interaction(SpecificEditor, UserAction, handler)
with self.assertRaises(ValueError):
registry.register_interaction(SpecificEditor, UserAction, handler)
def test_error_get_interaction_doc(self):
# The registry is empty
registry = TargetRegistry()
with self.assertRaises(InteractionNotSupported):
registry._get_interaction_doc(2.1, int)
def test_get_default_interaction_doc(self):
class Action:
"""Some action."""
pass
def handler(wrapper, interaction):
pass
registry = TargetRegistry()
registry.register_interaction(
target_class=float,
interaction_class=Action,
handler=handler,
)
actual = registry._get_interaction_doc(
target=21.2,
interaction_class=Action,
)
self.assertEqual(actual, "Some action.")
class TestLocationRegistry(unittest.TestCase):
def test_location_registry_empty(self):
class SpecificTarget:
pass
class Locator:
pass
registry = TargetRegistry()
with self.assertRaises(LocationNotSupported) as exception_context:
registry._get_solver(SpecificTarget(), Locator())
self.assertEqual(exception_context.exception.supported, [])
self.assertEqual(
str(exception_context.exception),
f"Location {Locator!r} is not supported for {SpecificTarget!r}. "
"Supported these: []",
)
def test_register_location(self):
def solver(wrapper, location):
return 1
registry = TargetRegistry()
registry.register_location(
target_class=float, locator_class=str, solver=solver
)
self.assertIs(registry._get_solver(2.1, "dummy"), solver)
def test_register_location_report_existing(self):
def solver(wrapper, location):
return 1
registry = TargetRegistry()
registry.register_location(
target_class=float, locator_class=str, solver=solver
)
with self.assertRaises(LocationNotSupported) as exception_context:
registry._get_solver(3.4, None)
self.assertEqual(exception_context.exception.supported, [str])
def test_get_locations_supported(self):
# Test _get_locations return the supported location types.
registry = TargetRegistry()
class SpecificEditor:
pass
class Locator1:
pass
class Locator2:
pass
def solver(wrapper, location):
return 1
# when
registry.register_location(
target_class=SpecificEditor,
locator_class=Locator1,
solver=solver,
)
registry.register_location(
target_class=SpecificEditor,
locator_class=Locator2,
solver=solver,
)
# then
self.assertEqual(
registry._get_locations(SpecificEditor()), {Locator1, Locator2}
)
def test_get_location_help_default(self):
class Locator:
"""Some default documentation."""
pass
registry = TargetRegistry()
registry.register_location(
target_class=float,
locator_class=Locator,
solver=lambda w, l: 1,
)
help_text = registry._get_location_doc(
target=2.345,
locator_class=Locator,
)
self.assertEqual(help_text, "Some default documentation.")
def test_error_get_interaction_doc(self):
# The registry is empty
registry = TargetRegistry()
with self.assertRaises(LocationNotSupported):
registry._get_location_doc(3.456, int)
|
