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
|
# (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 for the Map handler.
"""
import pickle
import unittest
from traits.api import HasTraits, Int, List, Map, on_trait_change, TraitError
class Preferences(HasTraits):
"""
Example class with a Map that records changes to that map.
"""
# Changes to primary trait of the mapped trait pair
primary_changes = List()
# Changes to the shadow trait of the mapped trait pair
shadow_changes = List()
color = Map({"red": 4, "green": 2, "yellow": 6}, default_value="yellow")
@on_trait_change("color")
def _record_primary_trait_change(self, obj, name, old, new):
change = obj, name, old, new
self.primary_changes.append(change)
@on_trait_change("color_")
def _record_shadow_trait_change(self, obj, name, old, new):
change = obj, name, old, new
self.shadow_changes.append(change)
class TestMap(unittest.TestCase):
def test_assignment(self):
class Person(HasTraits):
married = Map({"yes": 1, "yeah": 1, "no": 0, "nah": 0})
person = Person()
person.married = "yes"
self.assertEqual("yes", person.married)
self.assertEqual(1, person.married_)
person.married = "no"
self.assertEqual("no", person.married)
self.assertEqual(0, person.married_)
with self.assertRaises(TraitError):
person.married = "dont know"
with self.assertRaises(TraitError):
person.married = []
def test_no_default(self):
mapping = {"yes": 1, "yeah": 1, "no": 0, "nah": 0}
class Person(HasTraits):
married = Map(mapping)
p = Person()
# Since we're using Python >= 3.6, we can rely on dictionaries
# being ordered, and then the default is predictable.
self.assertEqual(p.married, "yes")
self.assertEqual(p.married_, 1)
def test_no_default_reverse_access_order(self):
mapping = {"yes": 1, "yeah": 1, "no": 0, "nah": 0}
class Person(HasTraits):
married = Map(mapping)
p = Person()
shadow_value = p.married_
primary_value = p.married
# For Python >= 3.6, dictionary ordering and hence the default
# value are predictable.
self.assertEqual(primary_value, "yes")
self.assertEqual(shadow_value, 1)
def test_default(self):
class Person(HasTraits):
married = Map({"yes": 1, "yeah": 1, "no": 0, "nah": 0,
None: 2}, default_value=None)
p = Person()
self.assertIsNone(p.married)
self.assertEqual(p.married_, 2)
def test_default_reverse_access_order(self):
class Person(HasTraits):
married = Map({"yes": 1, "yeah": 1, "no": 0, "nah": 0,
None: 2}, default_value=None)
p = Person()
self.assertEqual(p.married_, 2)
self.assertIsNone(p.married)
def test_default_method(self):
class Person(HasTraits):
married = Map({"yes": 1, "yeah": 1, "no": 0, "nah": 0,
None: 2})
default_calls = Int(0)
def _married_default(self):
self.default_calls += 1
return None
p = Person()
self.assertIsNone(p.married)
self.assertEqual(p.married_, 2)
self.assertEqual(p.default_calls, 1)
# Check that the order doesn't matter
p2 = Person()
self.assertEqual(p2.married_, 2)
self.assertIsNone(p2.married)
self.assertEqual(p2.default_calls, 1)
def test_default_static_override_static(self):
class BasePerson(HasTraits):
married = Map({"yes": 1, "yeah": 1, "no": 0, "nah": 0,
None: 2}, default_value=None)
class Person(BasePerson):
married = "yes"
p = Person()
self.assertEqual(p.married, "yes")
self.assertEqual(p.married_, 1)
def test_default_static_override_method(self):
class BasePerson(HasTraits):
married = Map({"yes": 1, "yeah": 1, "no": 0, "nah": 0,
None: 2}, default_value=None)
class Person(BasePerson):
default_calls = Int(0)
def _married_default(self):
self.default_calls += 1
return "yes"
p = Person()
self.assertEqual(p.married, "yes")
self.assertEqual(p.married_, 1)
self.assertEqual(p.default_calls, 1)
def test_default_method_override_static(self):
class BasePerson(HasTraits):
married = Map({"yes": 1, "yeah": 1, "no": 0, "nah": 0,
None: 2})
default_calls = Int(0)
def _married_default(self):
self.default_calls += 1
return None
class Person(BasePerson):
married = "yes"
p = Person()
self.assertEqual(p.married, "yes")
self.assertEqual(p.married_, 1)
self.assertEqual(p.default_calls, 0)
def test_default_method_override_method(self):
class BasePerson(HasTraits):
married = Map({"yes": 1, "yeah": 1, "no": 0, "nah": 0,
None: 2})
default_calls = Int(0)
def _married_default(self):
self.default_calls += 1
return None
class Person(BasePerson):
def _married_default(self):
self.default_calls += 1
return "yes"
p = Person()
self.assertEqual(p.married, "yes")
self.assertEqual(p.married_, 1)
self.assertEqual(p.default_calls, 1)
def test_empty_map(self):
with self.assertRaises(ValueError):
Map({})
def test_notification(self):
preferences = Preferences()
self.assertEqual(len(preferences.primary_changes), 0)
self.assertEqual(len(preferences.shadow_changes), 0)
preferences.color = "red"
self.assertEqual(len(preferences.primary_changes), 1)
self.assertEqual(len(preferences.shadow_changes), 1)
preferences.color = "green"
self.assertEqual(len(preferences.primary_changes), 2)
self.assertEqual(len(preferences.shadow_changes), 2)
with self.assertRaises(TraitError):
preferences.color = "blue"
self.assertEqual(len(preferences.primary_changes), 2)
self.assertEqual(len(preferences.shadow_changes), 2)
def test_notification_init_value(self):
preferences = Preferences(color="green")
self.assertEqual(len(preferences.primary_changes), 1)
self.assertEqual(len(preferences.shadow_changes), 1)
def test_notification_change_shadow_value(self):
class PreferencesWithDynamicDefault(Preferences):
def _color_default(self):
return "yellow"
preferences = PreferencesWithDynamicDefault()
self.assertEqual(len(preferences.primary_changes), 0)
self.assertEqual(len(preferences.shadow_changes), 0)
# access the dynamic default of color_ should not trigger event
# because the value has not changed.
preferences.color_
self.assertEqual(len(preferences.primary_changes), 0)
self.assertEqual(len(preferences.shadow_changes), 0)
def test_pickle_roundtrip(self):
class Person(HasTraits):
married = Map({"yes": 1, "yeah": 1, "no": 0, "nah": 0},
default_value="yes")
p = Person()
married_trait = p.traits()["married"]
reconstituted = pickle.loads(pickle.dumps(married_trait))
self.assertEqual(married_trait.validate(p, "married", "yes"), "yes")
self.assertEqual(reconstituted.validate(p, "married", "yes"), "yes")
with self.assertRaises(TraitError):
reconstituted.validate(p, "married", "unknown")
def test_pickle_shadow_trait(self):
class Person(HasTraits):
married = Map({"yes": 1, "yeah": 1, "no": 0, "nah": 0},
default_value="yes")
p = Person()
married_shadow_trait = p.trait("married_")
reconstituted = pickle.loads(pickle.dumps(married_shadow_trait))
default_value_callable = reconstituted.default_value()[1]
self.assertEqual(default_value_callable(p), 1)
|
