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 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
|
# Authors: Guillaume Favelier <guillaume.favelier@gmail.com>
#
# License: Simplified BSD
import sys
import pytest
from mne.utils import _check_qt_version
# This will skip all tests in this scope
pytestmark = pytest.mark.skipif(
sys.platform.startswith('win'), reason='nbexec does not work on Windows')
def test_gui_api(renderer_notebook, nbexec, n_warn=0):
"""Test GUI API."""
import contextlib
import mne
import warnings
import sys
try:
# Function
n_warn # noqa
except Exception:
# Notebook standalone mode
n_warn = 0
# nbexec does not expose renderer_notebook so I use a
# temporary variable to synchronize the tests
try:
assert mne.MNE_PYVISTAQT_BACKEND_TEST
except AttributeError:
mne.viz.set_3d_backend('notebook')
backend = 'notebook'
else:
backend = 'qt'
renderer = mne.viz.backends.renderer._get_renderer(size=(300, 300))
# theme
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter('always')
renderer._window_set_theme('/does/not/exist')
if backend == 'qt':
assert len(w) == 1
assert 'not found' in str(w[0].message), str(w[0].message)
else:
assert len(w) == 0
with mne.utils._record_warnings() as w:
renderer._window_set_theme('dark')
w = [ww for ww in w if 'is not yet supported' in str(ww.message)]
if sys.platform != 'darwin': # sometimes this is fine
assert len(w) == n_warn
# window without 3d plotter
if backend == 'qt':
window = renderer._window_create()
widget = renderer._window_create()
central_layout = renderer._layout_create(orientation='grid')
renderer._layout_add_widget(central_layout, widget, row=0, col=0)
renderer._window_initialize(window=window,
central_layout=central_layout)
from unittest.mock import Mock
mock = Mock()
@contextlib.contextmanager
def _check_widget_trigger(widget, mock, before, after, call_count=True,
get_value=True):
if get_value:
assert widget.get_value() == before
old_call_count = mock.call_count
try:
yield
finally:
if get_value:
assert widget.get_value() == after
if call_count:
assert mock.call_count == old_call_count + 1
# --- BEGIN: dock ---
renderer._dock_initialize(name='', area='left')
# label (not interactive)
widget = renderer._dock_add_label(
value='',
align=False,
selectable=True,
)
widget = renderer._dock_add_label(
value='',
align=True,
)
widget.update()
# labels are disabled by default with the notebook backend
widget.set_enabled(False)
assert not widget.is_enabled()
widget.set_enabled(True)
assert widget.is_enabled()
# ToolButton
widget = renderer._dock_add_button(
name='',
callback=mock,
style='toolbutton',
tooltip='button',
)
with _check_widget_trigger(widget, mock, None, None, get_value=False):
widget.set_value(True)
# PushButton
widget = renderer._dock_add_button(
name='',
callback=mock,
)
with _check_widget_trigger(widget, mock, None, None, get_value=False):
widget.set_value(True)
# slider
widget = renderer._dock_add_slider(
name='',
value=0,
rng=[0, 10],
callback=mock,
tooltip='slider',
)
with _check_widget_trigger(widget, mock, 0, 5):
widget.set_value(5)
# check box
widget = renderer._dock_add_check_box(
name='',
value=False,
callback=mock,
tooltip='check box',
)
with _check_widget_trigger(widget, mock, False, True):
widget.set_value(True)
# spin box
renderer._dock_add_spin_box(
name='',
value=0,
rng=[0, 1],
callback=mock,
step=0.1,
tooltip='spin box',
)
widget = renderer._dock_add_spin_box(
name='',
value=0,
rng=[0, 1],
callback=mock,
step=None,
)
with _check_widget_trigger(widget, mock, 0, 0.5):
widget.set_value(0.5)
# combo box
widget = renderer._dock_add_combo_box(
name='',
value='foo',
rng=['foo', 'bar'],
callback=mock,
tooltip='combo box',
)
with _check_widget_trigger(widget, mock, 'foo', 'bar'):
widget.set_value('bar')
# radio buttons
widget = renderer._dock_add_radio_buttons(
value='foo',
rng=['foo', 'bar'],
callback=mock,
)
with _check_widget_trigger(widget, mock, None, None, get_value=False):
widget.set_value(1, 'bar')
assert widget.get_value(0) == 'foo'
assert widget.get_value(1) == 'bar'
widget.set_enabled(False)
# text field
widget = renderer._dock_add_text(
name='',
value='foo',
placeholder='',
callback=mock,
)
with _check_widget_trigger(widget, mock, 'foo', 'bar'):
widget.set_value('bar')
widget.set_style(dict(border="2px solid #ff0000"))
# file button
renderer._dock_add_file_button(
name='',
desc='',
func=mock,
is_directory=True,
tooltip='file button',
)
renderer._dock_add_file_button(
name='',
desc='',
func=mock,
initial_directory='',
)
renderer._dock_add_file_button(
name='',
desc='',
func=mock,
)
widget = renderer._dock_add_file_button(
name='',
desc='',
func=mock,
save=True
)
# XXX: the internal file dialogs may hang without signals
widget.set_enabled(False)
renderer._dock_initialize(name='', area='right')
renderer._dock_named_layout(name='')
for collapse in (None, True, False):
renderer._dock_add_group_box(name='', collapse=collapse)
renderer._dock_add_stretch()
renderer._dock_add_layout()
renderer._dock_finalize()
renderer._dock_hide()
renderer._dock_show()
# --- END: dock ---
# --- BEGIN: tool bar ---
renderer._tool_bar_initialize(
name="default",
window=None,
)
# button
assert 'reset' not in renderer.actions
renderer._tool_bar_add_button(
name='reset',
desc='',
func=mock,
icon_name='help',
)
assert 'reset' in renderer.actions
# icon
renderer._tool_bar_update_button_icon(
name='reset',
icon_name='reset',
)
# text
renderer._tool_bar_add_text(
name='',
value='',
placeholder='',
)
# spacer
renderer._tool_bar_add_spacer()
# file button
assert 'help' not in renderer.actions
renderer._tool_bar_add_file_button(
name='help',
desc='',
func=mock,
shortcut=None,
)
renderer.actions['help'].trigger()
# play button
assert 'play' not in renderer.actions
renderer._tool_bar_add_play_button(
name='play',
desc='',
func=mock,
shortcut=None,
)
assert 'play' in renderer.actions
# --- END: tool bar ---
# --- BEGIN: menu bar ---
renderer._menu_initialize()
# submenu
renderer._menu_add_submenu(name='foo', desc='foo')
assert 'foo' in renderer._menus
assert 'foo' in renderer._menu_actions
# button
renderer._menu_add_button(
menu_name='foo',
name='bar',
desc='bar',
func=mock,
)
assert 'bar' in renderer._menu_actions['foo']
with _check_widget_trigger(None, mock, '', '', get_value=False):
renderer._menu_actions['foo']['bar'].trigger()
# --- END: menu bar ---
# --- BEGIN: status bar ---
renderer._status_bar_initialize()
renderer._status_bar_update()
# label
widget = renderer._status_bar_add_label(value='foo', stretch=0)
assert widget.get_value() == 'foo'
# progress bar
widget = renderer._status_bar_add_progress_bar(stretch=0)
# by default, get_value() is -1 for Qt and 0 for Ipywidgets
widget.set_value(0)
assert widget.get_value() == 0
# --- END: status bar ---
# --- BEGIN: tooltips ---
widget = renderer._dock_add_button(
name='',
callback=mock,
tooltip='foo'
)
assert widget.get_tooltip() == 'foo'
# Change it …
widget.set_tooltip('bar')
assert widget.get_tooltip() == 'bar'
# --- END: tooltips ---
# --- BEGIN: dialog ---
# dialogs are not supported yet on notebook
if renderer._kind == 'qt':
# warning
buttons = ["Save", "Cancel"]
widget = renderer._dialog_create(
title='',
text='',
info_text='',
callback=mock,
buttons=buttons,
modal=False,
)
widget.show()
for button in buttons:
with _check_widget_trigger(None, mock, '', '', get_value=False):
widget.trigger(button=button)
assert mock.call_args.args == (button,)
# buttons list empty means OK button (default)
button = 'Ok'
widget = renderer._dialog_create(
title='',
text='',
info_text='',
callback=mock,
icon='NoIcon',
modal=False,
)
widget.show()
with _check_widget_trigger(None, mock, '', '', get_value=False):
widget.trigger(button=button)
assert mock.call_args.args == (button,)
# --- END: dialog ---
# --- BEGIN: keypress ---
renderer._keypress_initialize()
renderer._keypress_add('a', mock)
# keypress is not supported yet on notebook
if renderer._kind == 'qt':
with _check_widget_trigger(None, mock, '', '', get_value=False):
renderer._keypress_trigger('a')
# --- END: keypress ---
renderer.show()
renderer._window_close_connect(lambda: mock('first'), after=False)
renderer._window_close_connect(lambda: mock('last'))
old_call_count = mock.call_count
renderer.close()
if renderer._kind == 'qt':
assert mock.call_count == old_call_count + 2
assert mock.call_args_list[-1].args == ('last',)
assert mock.call_args_list[-2].args == ('first',)
def test_gui_api_qt(renderer_interactive_pyvistaqt):
"""Test GUI API with the Qt backend."""
import mne
mne.MNE_PYVISTAQT_BACKEND_TEST = True
_, api = _check_qt_version(return_api=True)
n_warn = int(api in ('PySide6', 'PyQt6'))
test_gui_api(None, None, n_warn=n_warn)
|