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
|
# (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!
""" Test cases for dictionary (Dict) traits. """
import unittest
from unittest import mock
from traits.trait_types import Any, Dict, Event, Str, TraitDictObject
from traits.has_traits import HasTraits, on_trait_change
from traits.trait_errors import TraitError
# fixme: We'd like to use a callable instance for the listener so that we
# can maintain state, but traits barfs trying to determine the signature 8^()
def create_listener():
""" Create a listener for testing trait notifications. """
def listener(obj, trait_name, old, new):
listener.obj = obj
listener.trait_name = trait_name
listener.new = new
listener.old = old
listener.called += 1
listener.initialize = lambda: initialize_listener(listener)
return initialize_listener(listener)
def initialize_listener(listener):
""" Initialize a listener so it looks like it hasn't been called.
This allows us to re-use the listener without having to create and
wire-up a new one.
"""
listener.obj = None
listener.trait_name = None
listener.old = None
listener.new = None
listener.called = 0
return listener # For convenience
class TestDict(unittest.TestCase):
""" Test cases for dictionary (Dict) traits. """
def test_modified_event(self):
class Foo(HasTraits):
name = Str
modified = Event
@on_trait_change("name")
def _fire_modified_event(self):
self.modified = True
class Bar(HasTraits):
foos = Dict(Str, Foo)
modified = Event
@on_trait_change("foos_items,foos.modified")
def _fire_modified_event(self, obj, trait_name, old, new):
self.modified = True
bar = Bar()
listener = create_listener()
bar.on_trait_change(listener, "modified")
# Assign a completely new dictionary.
bar.foos = {"dino": Foo(name="dino")}
self.assertEqual(1, listener.called)
self.assertEqual("modified", listener.trait_name)
# Add an item to an existing dictionary.
listener.initialize()
fred = Foo(name="fred")
bar.foos["fred"] = fred
self.assertEqual(1, listener.called)
self.assertEqual("modified", listener.trait_name)
# Modify an item already in the dictionary.
listener.initialize()
fred.name = "barney"
self.assertEqual(1, listener.called)
self.assertEqual("modified", listener.trait_name)
# Overwrite an item in the dictionary. This is the one that fails!
listener.initialize()
bar.foos["fred"] = Foo(name="wilma")
self.assertEqual(1, listener.called)
self.assertEqual("modified", listener.trait_name)
def test_validate(self):
""" Check the validation method.
"""
foo = Dict()
# invalid value
with self.assertRaises(TraitError):
foo.validate(object=HasTraits(), name="bar", value=None)
# valid value
result = foo.validate(object=HasTraits(), name="bar", value={})
self.assertIsInstance(result, TraitDictObject)
# object is None (check for issue #71)
result = foo.validate(object=None, name="bar", value={})
self.assertEqual(result, {})
def test_validate_key(self):
class Foo(HasTraits):
mapping = Dict(Str)
foo = Foo(mapping={})
# This is okay
foo.mapping["a"] = 1
# This raises
with self.assertRaises(TraitError):
foo.mapping[1] = 1
def test_validate_value(self):
class Foo(HasTraits):
mapping = Dict(Any, Str)
foo = Foo(mapping={})
# This is okay
foo.mapping["a"] = "1"
# This raises
with self.assertRaises(TraitError):
foo.mapping["a"] = 1
def test_items_set_to_false(self):
class Foo(HasTraits):
mapping = Dict(items=False)
handler = mock.Mock()
# Setting items to false effectively switches off
# notifications on mapping_items
foo = Foo(mapping={})
foo.on_trait_change(lambda: handler(), name="mapping_items")
# when
foo.mapping["1"] = 1
# then
handler.assert_not_called()
|
