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
|
# (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 pyface.api import ImageResource
from pyface.ui_traits import Image
from traits.api import Bool, Button, HasTraits, List, Str
from traits.testing.api import UnittestTools
from traitsui.api import ButtonEditor, Item, UItem, View
import traitsui.extras
from traitsui.tests._tools import (
BaseTestMixin,
requires_toolkit,
reraise_exceptions,
ToolkitName,
)
from traitsui.testing.api import DisplayedText, IsEnabled, MouseClick, UITester
class ButtonTextEdit(HasTraits):
play_button = Button("Play")
play_button_label = Str("I'm a play button")
play_button_image = Image(ImageResource("run", [traitsui.extras]))
values = List()
button_enabled = Bool(True)
traits_view = View(
Item("play_button", style="simple"),
Item("play_button", style="custom"),
Item("play_button", style="readonly"),
Item("play_button", style="text"),
)
simple_view = View(
UItem("play_button", editor=ButtonEditor(label_value="play_button_label")),
Item("play_button_label"),
resizable=True,
)
custom_view = View(
UItem("play_button", editor=ButtonEditor(label_value="play_button_label")),
Item("play_button_label"),
resizable=True,
style="custom",
)
custom_image_view = View(
UItem("play_button", editor=ButtonEditor(image_value="play_button_image")),
resizable=True,
style="custom",
)
@requires_toolkit([ToolkitName.qt, ToolkitName.wx])
class TestButtonEditor(BaseTestMixin, unittest.TestCase, UnittestTools):
def setUp(self):
BaseTestMixin.setUp(self)
def tearDown(self):
BaseTestMixin.tearDown(self)
def check_button_text_update(self, view):
button_text_edit = ButtonTextEdit()
tester = UITester()
with tester.create_ui(button_text_edit, dict(view=view)) as ui:
button = tester.find_by_name(ui, "play_button")
actual = button.inspect(DisplayedText())
self.assertEqual(actual, "I'm a play button")
button_text_edit.play_button_label = "New Label"
actual = button.inspect(DisplayedText())
self.assertEqual(actual, "New Label")
def test_styles(self):
# simple smoke test of buttons
button_text_edit = ButtonTextEdit()
with UITester().create_ui(button_text_edit):
pass
def test_simple_button_editor(self):
self.check_button_text_update(simple_view)
# this currently fails on wx, see enthought/traitsui#1654
@requires_toolkit([ToolkitName.qt])
def test_custom_button_editor(self):
self.check_button_text_update(custom_view)
def check_button_fired_event(self, view):
button_text_edit = ButtonTextEdit()
tester = UITester()
with tester.create_ui(button_text_edit, dict(view=view)) as ui:
button = tester.find_by_name(ui, "play_button")
with self.assertTraitChanges(
button_text_edit, "play_button", count=1
):
button.perform(MouseClick())
def test_simple_button_editor_clicked(self):
self.check_button_fired_event(simple_view)
def test_custom_button_editor_clicked(self):
self.check_button_fired_event(custom_view)
def check_button_disabled(self, style):
button_text_edit = ButtonTextEdit(
button_enabled=False,
)
view = View(
Item(
"play_button",
editor=ButtonEditor(),
enabled_when="button_enabled",
style=style,
),
)
tester = UITester()
with tester.create_ui(button_text_edit, dict(view=view)) as ui:
button = tester.find_by_name(ui, "play_button")
self.assertFalse(button.inspect(IsEnabled()))
with self.assertTraitDoesNotChange(
button_text_edit, "play_button"
):
button.perform(MouseClick())
button_text_edit.button_enabled = True
self.assertTrue(button.inspect(IsEnabled()))
with self.assertTraitChanges(
button_text_edit, "play_button", count=1
):
button.perform(MouseClick())
def test_simple_button_editor_disabled(self):
self.check_button_disabled("simple")
def test_custom_button_editor_disabled(self):
self.check_button_disabled("custom")
def test_custom_image_value(self):
button_text_edit = ButtonTextEdit()
tester = UITester()
with tester.create_ui(
button_text_edit, dict(view=custom_image_view)
) as ui:
button = tester.find_by_name(ui, "play_button")
default_image = button._target.image
self.assertIsInstance(default_image, ImageResource)
button_text_edit.play_button_image = ImageResource(
'next', [traitsui.extras]
)
self.assertIsInstance(button._target.image, ImageResource)
self.assertIsNot(button._target.image, default_image)
@requires_toolkit([ToolkitName.qt])
class TestButtonEditorValuesTrait(BaseTestMixin, unittest.TestCase):
"""The values_trait is only supported by Qt.
See discussion enthought/traitsui#879
"""
def setUp(self):
BaseTestMixin.setUp(self)
def tearDown(self):
BaseTestMixin.tearDown(self)
def get_view(self, style):
return View(
Item(
"play_button",
editor=ButtonEditor(values_trait="values"),
style=style,
),
)
def check_editor_values_trait_init_and_dispose(self, style):
# Smoke test to check init and dispose when values_trait is used.
instance = ButtonTextEdit(values=["Item1", "Item2"])
view = self.get_view(style=style)
with reraise_exceptions():
with UITester().create_ui(instance, dict(view=view)):
pass
# It is okay to mutate trait after the GUI is disposed.
instance.values = ["Item3"]
def test_simple_editor_values_trait_init_and_dispose(self):
# Smoke test to check init and dispose when values_trait is used.
self.check_editor_values_trait_init_and_dispose(style="simple")
def test_custom_editor_values_trait_init_and_dispose(self):
# Smoke test to check init and dispose when values_trait is used.
self.check_editor_values_trait_init_and_dispose(style="custom")
|
