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
|
# (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!
from unittest import TestCase, skipIf
from pyface.action.api import ActionEvent
from traits.api import Any, HasTraits, Bool, TraitError
from traitsui.api import (
Action,
CloseAction,
Handler,
HelpAction,
RedoAction,
RevertAction,
UI,
UndoAction,
)
from traitsui.tests._tools import BaseTestMixin, is_null
class PyfaceAction(Action):
name = "Test Action"
performed = Bool()
def perform(self, event):
self.performed = True
class TraitsUIAction(Action):
name = "Test Action"
performed = Bool()
def perform(self):
self.performed = True
class SampleHandler(Handler):
action_performed = Bool()
info_action_performed = Bool()
click_performed = Bool()
undo_performed = Bool()
redo_performed = Bool()
revert_performed = Bool()
apply_performed = Bool()
close_performed = Bool()
help_performed = Bool()
init_return_value = Any(True)
def init(self, info):
return self.init_return_value
def action_handler(self):
self.action_performed = True
def info_action_handler(self, info):
self.info_action_performed = True
def revert(self, info):
self.revert_perfomed = True
def apply(self, info):
self.apply_perfomed = True
def show_help(self, info, control=None):
self.help_performed = True
def _action_clicked(self):
self.click_performed = True
def _on_undo(self, info):
super()._on_undo(info)
self.undo_performed = True
def _on_redo(self, info):
super()._on_redo(info)
self.redo_performed = True
def _on_revert(self, info):
super()._on_revert(info)
self.revert_performed = True
def _on_close(self, info):
super()._on_close(info)
self.close_performed = True
class SampleObject(HasTraits):
object_action_performed = Bool()
action_performed = Bool()
info_action_performed = Bool()
click_performed = Bool()
def object_action_handler(self):
self.object_action_performed = True
def action_handler(self):
self.action_performed = True
def info_action_handler(self, info):
self.info_action_performed = True
def _action_click(self):
self.click_performed = True
class TestHandler(BaseTestMixin, TestCase):
def setUp(self):
BaseTestMixin.setUp(self)
def tearDown(self):
BaseTestMixin.tearDown(self)
def test_perform_pyface_action(self):
object = SampleObject()
handler = SampleHandler()
action = PyfaceAction()
event = ActionEvent()
ui = UI(handler=handler, context={"object": object})
info = ui.info
handler.perform(info, action, event)
self.assertTrue(action.performed)
def test_perform_traitsui_action(self):
object = SampleObject()
handler = SampleHandler()
action = TraitsUIAction()
event = ActionEvent()
ui = UI(handler=handler, context={"object": object})
info = ui.info
handler.perform(info, action, event)
self.assertTrue(action.performed)
self.assertFalse(handler.action_performed)
self.assertFalse(handler.info_action_performed)
self.assertFalse(handler.click_performed)
self.assertFalse(object.action_performed)
self.assertFalse(object.info_action_performed)
self.assertFalse(object.click_performed)
def test_perform_action_handler(self):
object = SampleObject()
handler = SampleHandler()
action = TraitsUIAction(name="action", action="action_handler")
event = ActionEvent()
ui = UI(handler=handler, context={"object": object})
info = ui.info
handler.perform(info, action, event)
self.assertTrue(handler.action_performed)
self.assertFalse(handler.info_action_performed)
self.assertFalse(handler.click_performed)
self.assertFalse(object.action_performed)
self.assertFalse(object.info_action_performed)
self.assertFalse(object.click_performed)
self.assertFalse(action.performed)
def test_perform_info_action_handler(self):
object = SampleObject()
handler = SampleHandler()
action = TraitsUIAction(name="action", action="info_action_handler")
event = ActionEvent()
ui = UI(handler=handler, context={"object": object})
info = ui.info
handler.perform(info, action, event)
self.assertTrue(handler.info_action_performed)
self.assertFalse(handler.action_performed)
self.assertFalse(handler.click_performed)
self.assertFalse(object.action_performed)
self.assertFalse(object.info_action_performed)
self.assertFalse(object.click_performed)
self.assertFalse(action.performed)
def test_perform_click_handler(self):
object = SampleObject()
handler = SampleHandler()
action = TraitsUIAction(name="action", action="")
event = ActionEvent()
ui = UI(handler=handler, context={"object": object})
info = ui.info
handler.perform(info, action, event)
self.assertTrue(handler.click_performed)
self.assertFalse(handler.action_performed)
self.assertFalse(handler.info_action_performed)
self.assertFalse(object.action_performed)
self.assertFalse(object.info_action_performed)
self.assertFalse(object.click_performed)
self.assertFalse(action.performed)
def test_perform_object_handler(self):
object = SampleObject()
handler = SampleHandler()
action = TraitsUIAction(name="action", action="object_action_handler")
event = ActionEvent()
ui = UI(handler=handler, context={"object": object})
info = ui.info
handler.perform(info, action, event)
self.assertTrue(object.object_action_performed)
self.assertFalse(action.performed)
def test_undo_handler(self):
object = SampleObject()
handler = SampleHandler()
action = UndoAction
event = ActionEvent()
ui = UI(handler=handler, context={"object": object})
info = ui.info
handler.perform(info, action, event)
self.assertTrue(handler.undo_performed)
def test_redo_handler(self):
object = SampleObject()
handler = SampleHandler()
action = RedoAction
event = ActionEvent()
ui = UI(handler=handler, context={"object": object})
info = ui.info
handler.perform(info, action, event)
self.assertTrue(handler.redo_performed)
def test_revert_handler(self):
object = SampleObject()
handler = SampleHandler()
action = RevertAction
event = ActionEvent()
ui = UI(handler=handler, context={"object": object})
info = ui.info
handler.perform(info, action, event)
self.assertTrue(handler.revert_performed)
def test_close_handler(self):
object = SampleObject()
handler = SampleHandler()
action = CloseAction
event = ActionEvent()
ui = UI(handler=handler, context={"object": object})
info = ui.info
handler.perform(info, action, event)
self.assertTrue(handler.close_performed)
def test_help_handler(self):
object = SampleObject()
handler = SampleHandler()
action = HelpAction
event = ActionEvent()
ui = UI(handler=handler, context={"object": object})
info = ui.info
handler.perform(info, action, event)
self.assertTrue(handler.help_performed)
@skipIf(is_null(), "Null toolkit can't create UI")
def test_handler_init_false(self):
object = SampleObject()
handler = SampleHandler(init_return_value=False)
with self.assertRaises(TraitError):
object.edit_traits(handler=handler)
@skipIf(is_null(), "Null toolkit can't create UI")
def test_handler_init_none(self):
object = SampleObject()
handler = SampleHandler(init_return_value=None)
with self.assertRaises(ValueError):
object.edit_traits(handler=handler)
|