File: test_widget.py

package info (click to toggle)
python-pyface 8.0.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 13,944 kB
  • sloc: python: 54,107; makefile: 82
file content (345 lines) | stat: -rw-r--r-- 10,799 bytes parent folder | download
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
# (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!


import sys
import unittest

from traits.api import Instance
from traits.testing.api import UnittestTools

from pyface.testing.widget_mixin import WidgetMixin
from ..application_window import ApplicationWindow
from ..toolkit import toolkit_object
from ..widget import Widget

GuiTestAssistant = toolkit_object("util.gui_test_assistant:GuiTestAssistant")
no_gui_test_assistant = GuiTestAssistant.__name__ == "Unimplemented"

is_qt = (toolkit_object.toolkit in {"qt4", "qt"})
is_linux = (sys.platform == "linux")
is_mac = (sys.platform == "darwin")


class ConcreteWidget(Widget):
    def _create_control(self, parent):
        if toolkit_object.toolkit == "wx":
            import wx

            control = wx.Window(parent)
            control.Enable(self.enabled)
            control.Show(self.visible)
        elif toolkit_object.toolkit in {"qt4", "qt"}:
            from pyface.qt import QtGui
            from pyface.qt.QtCore import Qt

            control = QtGui.QWidget(parent)
            control.setEnabled(self.enabled)
            control.setVisible(self.visible)
            control.setFocusPolicy(Qt.FocusPolicy.StrongFocus)
        else:
            control = None
        return control


class MainWindow(ApplicationWindow):

    widget = Instance(ConcreteWidget)

    def _create_contents(self, parent):
        """ Create and return the window's contents.
        Parameters
        ----------
        parent : toolkit control
            The window's toolkit control to be used as the parent for
            widgets in the contents.

        Returns
        -------
        control : toolkit control
            A control to be used for contents of the window.
        """
        self.widget = ConcreteWidget(parent=parent)
        self.widget.create()
        return self.widget.control


class TestWidget(unittest.TestCase, UnittestTools):
    def setUp(self):
        self.widget = Widget()

    def tearDown(self):
        del self.widget

    def test_defaults(self):
        self.assertTrue(self.widget.enabled)
        self.assertTrue(self.widget.visible)

    def test_create(self):
        # create is not Implemented
        with self.assertRaises(NotImplementedError):
            self.widget.create()

    def test__create(self):
        # _create is not Implemented
        with self.assertRaises(NotImplementedError):
            self.widget._create()

    def test_destroy(self):
        # test that destroy works even when no control
        self.widget.destroy()

    def test_show(self):
        with self.assertTraitChanges(self.widget, "visible", count=1):
            self.widget.show(False)

        self.assertFalse(self.widget.visible)

    def test_visible(self):
        with self.assertTraitChanges(self.widget, "visible", count=1):
            self.widget.visible = False

        self.assertFalse(self.widget.visible)

    def test_enable(self):
        with self.assertTraitChanges(self.widget, "enabled", count=1):
            self.widget.enable(False)

        self.assertFalse(self.widget.enabled)

    def test_enabled(self):
        with self.assertTraitChanges(self.widget, "enabled", count=1):
            self.widget.enabled = False

        self.assertFalse(self.widget.enabled)


@unittest.skipIf(no_gui_test_assistant, "No GuiTestAssistant")
class TestConcreteWidget(unittest.TestCase, GuiTestAssistant):
    def setUp(self):
        GuiTestAssistant.setUp(self)
        self.widget = ConcreteWidget()

    def tearDown(self):
        if self.widget.control is not None:
            with self.delete_widget(self.widget.control):
                self.widget.destroy()
        del self.widget
        GuiTestAssistant.tearDown(self)

    def test_lifecycle(self):
        with self.event_loop():
            self.widget.create()
        with self.event_loop():
            self.widget.destroy()

    def test_initialize(self):
        self.widget.visible = False
        self.widget.enabled = False
        with self.event_loop():
            self.widget.create()

        self.assertFalse(self.widget.control.isVisible())
        self.assertFalse(self.widget.control.isEnabled())

    def test_show(self):
        with self.event_loop():
            self.widget.create()

        with self.assertTraitChanges(self.widget, "visible", count=1):
            with self.event_loop():
                self.widget.show(False)

        self.assertFalse(self.widget.control.isVisible())

    def test_visible(self):
        with self.event_loop():
            self.widget.create()

        with self.assertTraitChanges(self.widget, "visible", count=1):
            with self.event_loop():
                self.widget.visible = False

        self.assertFalse(self.widget.control.isVisible())

    def test_contents_visible(self):
        window = MainWindow()
        window.create()

        try:
            with self.event_loop():
                window.open()

            # widget visible trait stays True when parent is hidden
            with self.assertTraitDoesNotChange(window.widget, "visible"):
                with self.event_loop():
                    window.visible = False

            # widget visible trait stays True when parent is shown
            with self.assertTraitDoesNotChange(window.widget, "visible"):
                with self.event_loop():
                    window.visible = True
        finally:
            window.destroy()

    def test_contents_hidden(self):
        window = MainWindow()
        window.create()

        try:
            with self.event_loop():
                window.open()
                window.widget.visible = False

            # widget visible trait stays False when parent is hidden
            with self.assertTraitDoesNotChange(window.widget, "visible"):
                with self.event_loop():
                    window.visible = False

            # widget visible trait stays False when parent is shown
            with self.assertTraitDoesNotChange(window.widget, "visible"):
                with self.event_loop():
                    window.visible = True
        finally:
            window.destroy()

    @unittest.skipUnless(is_qt, "Qt-specific test of hidden state")
    def test_contents_hide_external_change(self):
        window = MainWindow()
        window.create()

        try:
            with self.event_loop():
                window.open()

            # widget visibile trait stays True when parent is hidden
            with self.assertTraitDoesNotChange(window.widget, "visible"):
                with self.event_loop():
                    window.visible = False

            self.assertFalse(window.widget.control.isVisible())
            self.assertFalse(window.widget.control.isHidden())

            # widget visibile trait becomes False when widget is hidden
            with self.assertTraitChanges(window.widget, "visible"):
                with self.event_loop():
                    window.widget.control.hide()

            self.assertFalse(window.widget.visible)
            self.assertFalse(window.widget.control.isVisible())
            self.assertTrue(window.widget.control.isHidden())

            # widget visibile trait stays False when parent is shown
            with self.assertTraitDoesNotChange(window.widget, "visible"):
                with self.event_loop():
                    window.visible = True

            self.assertFalse(window.widget.control.isVisible())
            self.assertTrue(window.widget.control.isHidden())
        finally:
            window.destroy()

    @unittest.skipUnless(is_qt, "Qt-specific test of hidden state")
    def test_show_widget_with_parent_is_invisible_qt(self):
        # Test setting the widget visible to true when its parent visibility
        # is false.
        window = MainWindow()
        window.create()

        try:
            # given
            with self.event_loop():
                window.open()
                window.widget.visible = False

            with self.event_loop():
                window.visible = False

            # when
            with self.event_loop():
                window.widget.visible = True

            # then
            self.assertTrue(window.widget.visible)
            self.assertFalse(window.widget.control.isVisible())
            self.assertFalse(window.widget.control.isHidden())

        finally:
            window.destroy()

    @unittest.skipUnless(is_qt, "Qt-specific test of hidden state")
    def test_show_widget_then_parent_is_invisible_qt(self):
        # Test showing the widget when the parent is also visible, and then
        # make the parent invisible
        window = MainWindow()
        window.create()

        try:
            # given
            with self.event_loop():
                window.open()
                window.visible = True

            with self.event_loop():
                window.widget.visible = True

            # when
            with self.event_loop():
                window.visible = False

            # then
            self.assertTrue(window.widget.visible)
            self.assertFalse(window.widget.control.isVisible())
            self.assertFalse(window.widget.control.isHidden())

        finally:
            window.destroy()

    def test_enable(self):
        with self.event_loop():
            self.widget.create()

        with self.assertTraitChanges(self.widget, "enabled", count=1):
            with self.event_loop():
                self.widget.enable(False)

        self.assertFalse(self.widget.control.isEnabled())

    def test_enabled(self):
        with self.event_loop():
            self.widget.create()

        with self.assertTraitChanges(self.widget, "enabled", count=1):
            with self.event_loop():
                self.widget.enabled = False

        self.assertFalse(self.widget.control.isEnabled())

    @unittest.skipUnless(
        is_mac,
        "Broken on Linux and Windows",
    )
    def test_focus(self):
        with self.event_loop():
            self.widget.create()

        self.assertFalse(self.widget.has_focus())

        with self.event_loop():
            self.widget.focus()

        self.assertTrue(self.widget.has_focus())


class TestWidgetCommon(WidgetMixin, unittest.TestCase):

    def _create_widget_simple(self, **traits):
        traits.setdefault("tooltip", "Dummy")
        return ConcreteWidget(**traits)