| 1 |
from __future__ import annotations |
| 2 |
|
| 3 |
from pathlib import Path |
| 4 |
|
| 5 |
from IPython.display import IFrame |
| 6 |
import numpy as np |
| 7 |
import pytest |
| 8 |
|
| 9 |
import pyvista as pv |
| 10 |
from pyvista import examples |
| 11 |
|
| 12 |
has_trame = True |
| 13 |
try: |
| 14 |
from trame.app import get_server |
| 15 |
|
| 16 |
from pyvista.trame.jupyter import EmbeddableWidget |
| 17 |
from pyvista.trame.jupyter import Widget |
| 18 |
from pyvista.trame.jupyter import build_url |
| 19 |
from pyvista.trame.jupyter import elegantly_launch |
| 20 |
from pyvista.trame.ui import base_viewer |
| 21 |
from pyvista.trame.ui import get_viewer |
| 22 |
from pyvista.trame.ui import plotter_ui |
| 23 |
from pyvista.trame.ui.vuetify2 import divider as vue2_divider |
| 24 |
from pyvista.trame.ui.vuetify2 import select as vue2_select |
| 25 |
from pyvista.trame.ui.vuetify2 import slider as vue2_slider |
| 26 |
from pyvista.trame.ui.vuetify2 import text_field as vue2_text_field |
| 27 |
from pyvista.trame.ui.vuetify3 import divider as vue3_divider |
| 28 |
from pyvista.trame.ui.vuetify3 import select as vue3_select |
| 29 |
from pyvista.trame.ui.vuetify3 import slider as vue3_slider |
| 30 |
from pyvista.trame.ui.vuetify3 import text_field as vue3_text_field |
| 31 |
from pyvista.trame.views import PyVistaLocalView |
| 32 |
from pyvista.trame.views import PyVistaRemoteLocalView |
| 33 |
from pyvista.trame.views import PyVistaRemoteView |
| 34 |
from pyvista.trame.views import _BasePyVistaView |
| 35 |
except ImportError: |
| 36 |
has_trame = False |
| 37 |
|
| 38 |
pytestmark = [ |
| 39 |
pytest.mark.skipif(not has_trame, reason='Requires trame'), |
| 40 |
pytest.mark.skip_plotting, |
| 41 |
pytest.mark.skip_check_gc, |
| 42 |
pytest.mark.filterwarnings( |
| 43 |
r'ignore:It is recommended to use web\.AppKey instances for ' |
| 44 |
r'keys:aiohttp.web_exceptions.NotAppKeyWarning' |
| 45 |
), |
| 46 |
pytest.mark.filterwarnings( |
| 47 |
r'ignore:Call to deprecated method GetData\. ' |
| 48 |
r'\(Use ExportLegacyFormat, or GetOffsetsArray/GetConnectivityArray instead\.\)' |
| 49 |
':DeprecationWarning:trame_vtk' |
| 50 |
), |
| 51 |
pytest.mark.filterwarnings( |
| 52 |
r'ignore:Call to deprecated method GetSize\. ' |
| 53 |
r'\(Use GetCapacity\(\) instead\)' |
| 54 |
r':DeprecationWarning:trame_vtk' |
| 55 |
), |
| 56 |
] |
| 57 |
|
| 58 |
|
| 59 |
def test_set_jupyter_backend_trame(): |
| 60 |
try: |
| 61 |
pv.global_theme.jupyter_backend = 'trame' |
| 62 |
assert pv.global_theme.jupyter_backend == 'trame' |
| 63 |
pv.global_theme.jupyter_backend = 'client' |
| 64 |
assert pv.global_theme.jupyter_backend == 'client' |
| 65 |
pv.global_theme.jupyter_backend = 'server' |
| 66 |
assert pv.global_theme.jupyter_backend == 'server' |
| 67 |
finally: |
| 68 |
pv.global_theme.jupyter_backend = None |
| 69 |
|
| 70 |
|
| 71 |
def test_trame_server_launch(): |
| 72 |
pv.set_jupyter_backend('trame') |
| 73 |
name = pv.global_theme.trame.jupyter_server_name |
| 74 |
elegantly_launch(name) |
| 75 |
server = get_server(name=name) |
| 76 |
assert server.running |
| 77 |
|
| 78 |
|
| 79 |
def test_base_viewer_ui(): |
| 80 |
pl = pv.Plotter(notebook=True) |
| 81 |
viewer = base_viewer.BaseViewer(pl) |
| 82 |
with pytest.raises(NotImplementedError): |
| 83 |
viewer.ui() |
| 84 |
|
| 85 |
|
| 86 |
@pytest.mark.parametrize('client_type', ['vue2', 'vue3']) |
| 87 |
@pytest.mark.filterwarnings( |
| 88 |
'ignore:Suppress rendering on the plotter is changed to .*:UserWarning' |
| 89 |
) |
| 90 |
def test_trame_plotter_ui(client_type): |
| 91 |
# give different names for servers so different instances are created |
| 92 |
name = f'{pv.global_theme.trame.jupyter_server_name}-{client_type}' |
| 93 |
pv.set_jupyter_backend('trame') |
| 94 |
elegantly_launch(name, client_type=client_type) |
| 95 |
server = get_server(name=name) |
| 96 |
assert server.running |
| 97 |
|
| 98 |
pl = pv.Plotter(notebook=True) |
| 99 |
|
| 100 |
for mode in ['trame', 'client', 'server']: |
| 101 |
ui = plotter_ui(pl, mode=mode, server=server) |
| 102 |
assert isinstance(ui, _BasePyVistaView) |
| 103 |
|
| 104 |
# Test invalid mode |
| 105 |
mode = 'invalid' |
| 106 |
with pytest.raises(ValueError, match=f'`{mode}` is not a valid mode choice. Use one of: (.*)'): |
| 107 |
ui = plotter_ui(pl, mode=mode, server=server) |
| 108 |
|
| 109 |
# Test when mode and server are None |
| 110 |
ui = plotter_ui(pl) |
| 111 |
assert isinstance(ui, _BasePyVistaView) |
| 112 |
|
| 113 |
|
| 114 |
@pytest.mark.parametrize('client_type', ['vue2', 'vue3']) |
| 115 |
def test_trame(client_type): |
| 116 |
# give different names for servers so different instances are created |
| 117 |
name = f'{pv.global_theme.trame.jupyter_server_name}-{client_type}' |
| 118 |
pv.set_jupyter_backend('trame') |
| 119 |
elegantly_launch(name, client_type=client_type) |
| 120 |
server = get_server(name=name) |
| 121 |
assert server.running |
| 122 |
|
| 123 |
pl = pv.Plotter(notebook=True) |
| 124 |
actor = pl.add_mesh(pv.Cone()) |
| 125 |
widget = pl.show(return_viewer=True) |
| 126 |
assert isinstance(widget, Widget) |
| 127 |
|
| 128 |
if pv.global_theme.trame.server_proxy_enabled: |
| 129 |
assert pv.global_theme.trame.server_proxy_prefix in widget.src |
| 130 |
else: |
| 131 |
assert 'http://' in widget.src |
| 132 |
|
| 133 |
viewer = get_viewer(pl) |
| 134 |
|
| 135 |
for cp in ['xy', 'xz', 'yz', 'isometric']: |
| 136 |
exec(f'viewer.view_{cp}()') # noqa: S102 |
| 137 |
cpos = list(pl.camera_position) |
| 138 |
pl.camera_position = cp[:3] |
| 139 |
assert cpos == pl.camera_position |
| 140 |
|
| 141 |
orig_value = actor.prop.show_edges |
| 142 |
server.state[viewer.EDGES] = not orig_value |
| 143 |
viewer.on_edge_visibility_change(**server.state.to_dict()) |
| 144 |
assert actor.prop.show_edges != orig_value |
| 145 |
|
| 146 |
server.state[viewer.GRID] = True |
| 147 |
assert len(pl.actors) == 1 |
| 148 |
viewer.on_grid_visibility_change(**server.state.to_dict()) |
| 149 |
assert len(pl.actors) == 2 |
| 150 |
server.state[viewer.GRID] = False |
| 151 |
viewer.on_grid_visibility_change(**server.state.to_dict()) |
| 152 |
assert len(pl.actors) == 1 |
| 153 |
|
| 154 |
server.state[viewer.OUTLINE] = True |
| 155 |
assert len(pl.actors) == 1 |
| 156 |
viewer.on_outline_visibility_change(**server.state.to_dict()) |
| 157 |
assert len(pl.actors) == 2 |
| 158 |
server.state[viewer.OUTLINE] = False |
| 159 |
viewer.on_outline_visibility_change(**server.state.to_dict()) |
| 160 |
assert len(pl.actors) == 1 |
| 161 |
|
| 162 |
server.state[viewer.AXIS] = True |
| 163 |
assert pl.renderer.axes_actor is None |
| 164 |
viewer.on_axis_visibility_change(**server.state.to_dict()) |
| 165 |
assert pl.renderer.axes_actor is not None |
| 166 |
server.state[viewer.AXIS] = False |
| 167 |
viewer.on_axis_visibility_change(**server.state.to_dict()) |
| 168 |
|
| 169 |
server.state[viewer.SERVER_RENDERING] = False |
| 170 |
viewer.on_rendering_mode_change(**server.state.to_dict()) |
| 171 |
server.state[viewer.SERVER_RENDERING] = True |
| 172 |
viewer.on_rendering_mode_change(**server.state.to_dict()) |
| 173 |
|
| 174 |
assert viewer.actors == pl.actors |
| 175 |
|
| 176 |
# Test update methods |
| 177 |
viewer.update_image() |
| 178 |
viewer.reset_camera() |
| 179 |
viewer.push_camera() |
| 180 |
assert len(viewer.views) == 1 |
| 181 |
|
| 182 |
viewer.export() |
| 183 |
assert isinstance(viewer.screenshot(), memoryview) |
| 184 |
|
| 185 |
|
| 186 |
@pytest.mark.parametrize('client_type', ['vue2', 'vue3']) |
| 187 |
def test_trame_custom_menu_items(client_type): |
| 188 |
# give different names for servers so different instances are created |
| 189 |
name = f'{pv.global_theme.trame.jupyter_server_name}-{client_type}' |
| 190 |
pv.set_jupyter_backend('trame') |
| 191 |
elegantly_launch(name, client_type=client_type) |
| 192 |
server = get_server(name=name) |
| 193 |
assert server.running |
| 194 |
|
| 195 |
pl = pv.Plotter(notebook=True) |
| 196 |
algo = pv.ConeSource() |
| 197 |
mesh_actor = pl.add_mesh(algo) |
| 198 |
|
| 199 |
viewer = get_viewer(pl, server=server) |
| 200 |
|
| 201 |
# setup vuetify items |
| 202 |
slider = vue2_slider if client_type == 'vue2' else vue3_slider |
| 203 |
text_field = vue2_text_field if client_type == 'vue2' else vue3_text_field |
| 204 |
select = vue2_select if client_type == 'vue2' else vue3_select |
| 205 |
divider = vue2_divider if client_type == 'vue2' else vue3_divider |
| 206 |
|
| 207 |
# vuetify items to pass as argument |
| 208 |
def custom_tools(): |
| 209 |
divider(vertical=True, classes='mx-1') |
| 210 |
slider( |
| 211 |
('resolution', 3), |
| 212 |
'Resolution slider', |
| 213 |
min=3, |
| 214 |
max=20, |
| 215 |
step=1, |
| 216 |
) |
| 217 |
text_field(('resolution', 3), 'Resolution value', type='number') |
| 218 |
divider(vertical=True, classes='mx-1') |
| 219 |
select( |
| 220 |
model=('visibility', 'Show'), |
| 221 |
tooltip='Toggle visibility', |
| 222 |
items=['Visibility', ['Hide', 'Show']], |
| 223 |
) |
| 224 |
|
| 225 |
with viewer.make_layout(server, template_name=pl._id_name): |
| 226 |
viewer.ui( |
| 227 |
mode='trame', |
| 228 |
default_server_rendering=True, |
| 229 |
collapse_menu=False, |
| 230 |
add_menu_items=custom_tools, |
| 231 |
) |
| 232 |
|
| 233 |
src = build_url(server, ui=pl._id_name, host='localhost', protocol='http') |
| 234 |
widget = Widget(viewer, src, '99%', '600px') |
| 235 |
|
| 236 |
state, ctrl = server.state, server.controller |
| 237 |
ctrl.view_update = widget.viewer.update |
| 238 |
|
| 239 |
@state.change('resolution') |
| 240 |
def update_resolution(resolution, **kwargs): # noqa: ARG001 |
| 241 |
algo.resolution = resolution |
| 242 |
ctrl.view_update() |
| 243 |
|
| 244 |
@state.change('visibility') |
| 245 |
def set_visibility(visibility, **kwargs): # noqa: ARG001 |
| 246 |
toggle = {'Hide': 0, 'Show': 1} |
| 247 |
mesh_actor.visibility = toggle[visibility] |
| 248 |
ctrl.view_update() |
| 249 |
|
| 250 |
assert server.state['resolution'] == 3 |
| 251 |
server.state.update({'resolution': 5, 'visibility': 'Hide'}) |
| 252 |
server.state.flush() |
| 253 |
assert algo.resolution == 5 |
| 254 |
assert not mesh_actor.visibility |
| 255 |
|
| 256 |
|
| 257 |
def test_trame_jupyter_modes(): |
| 258 |
pv.set_jupyter_backend('trame') |
| 259 |
|
| 260 |
pl = pv.Plotter(notebook=True) |
| 261 |
pl.add_mesh(pv.Cone()) |
| 262 |
widget = pl.show(jupyter_backend='server', return_viewer=True) |
| 263 |
assert isinstance(widget, Widget) |
| 264 |
assert not pl.suppress_rendering |
| 265 |
assert not pl._closed |
| 266 |
|
| 267 |
pl = pv.Plotter(notebook=True) |
| 268 |
pl.add_mesh(pv.Cone()) |
| 269 |
widget = pl.show(jupyter_backend='trame', return_viewer=True) |
| 270 |
assert isinstance(widget, Widget) |
| 271 |
assert not pl.suppress_rendering |
| 272 |
assert not pl._closed |
| 273 |
|
| 274 |
pl = pv.Plotter(notebook=True) |
| 275 |
pl.add_mesh(pv.Cone()) |
| 276 |
widget = pl.show(jupyter_backend='client', return_viewer=True) |
| 277 |
assert isinstance(widget, Widget) |
| 278 |
assert pl.suppress_rendering |
| 279 |
assert not pl._closed |
| 280 |
|
| 281 |
|
| 282 |
def test_trame_closed_plotter(): |
| 283 |
pl = pv.Plotter(notebook=True) |
| 284 |
pl.add_mesh(pv.Cone()) |
| 285 |
pl.close() |
| 286 |
with pytest.raises( |
| 287 |
RuntimeError, match='The render window for this plotter has been destroyed' |
| 288 |
): |
| 289 |
PyVistaRemoteLocalView(pl) |
| 290 |
|
| 291 |
|
| 292 |
@pytest.mark.skipif(True, reason='#5262') |
| 293 |
def test_trame_views(): |
| 294 |
server = get_server('foo') |
| 295 |
|
| 296 |
pl = pv.Plotter(notebook=True) |
| 297 |
pl.add_mesh(pv.Cone()) |
| 298 |
|
| 299 |
assert PyVistaRemoteLocalView(pl, trame_server=server) |
| 300 |
assert PyVistaRemoteView(pl, trame_server=server) |
| 301 |
assert PyVistaLocalView(pl, trame_server=server) |
| 302 |
|
| 303 |
|
| 304 |
def test_trame_jupyter_custom_size(): |
| 305 |
w, h = 200, 150 |
| 306 |
pl = pv.Plotter(notebook=True, window_size=(w, h)) |
| 307 |
_ = pl.add_mesh(pv.Cone()) |
| 308 |
widget = pl.show(jupyter_backend='trame', return_viewer=True) |
| 309 |
html = widget.value |
| 310 |
assert f'width: {w}px' in html |
| 311 |
assert f'height: {h}px' in html |
| 312 |
|
| 313 |
pl = pv.Plotter(notebook=True) |
| 314 |
pl.window_size = (w, h) |
| 315 |
_ = pl.add_mesh(pv.Cone()) |
| 316 |
widget = pl.show(jupyter_backend='trame', return_viewer=True) |
| 317 |
html = widget.value |
| 318 |
assert f'width: {w}px' in html |
| 319 |
assert f'height: {h}px' in html |
| 320 |
|
| 321 |
# Make sure that if size is default theme, it uses 99%/600px |
| 322 |
previous_size = pv.global_theme.window_size |
| 323 |
pv.global_theme.window_size = pv.themes.Theme().window_size |
| 324 |
try: |
| 325 |
pl = pv.Plotter(notebook=True) |
| 326 |
_ = pl.add_mesh(pv.Cone()) |
| 327 |
widget = pl.show(jupyter_backend='trame', return_viewer=True) |
| 328 |
html = widget.value |
| 329 |
assert 'width: 100%' in html |
| 330 |
assert 'height: 600px' in html |
| 331 |
finally: |
| 332 |
pv.global_theme.window_size = previous_size |
| 333 |
|
| 334 |
|
| 335 |
def test_trame_jupyter_custom_handler(): |
| 336 |
def handler(viewer, src, **kwargs): # noqa: ARG001 |
| 337 |
return IFrame(src, '75%', '500px') |
| 338 |
|
| 339 |
pl = pv.Plotter(notebook=True) |
| 340 |
_ = pl.add_mesh(pv.Cone()) |
| 341 |
iframe = pl.show( |
| 342 |
jupyter_backend='trame', |
| 343 |
jupyter_kwargs=dict(handler=handler), |
| 344 |
return_viewer=True, |
| 345 |
) |
| 346 |
assert isinstance(iframe, IFrame) |
| 347 |
|
| 348 |
|
| 349 |
def test_trame_int64(): |
| 350 |
mesh = pv.Sphere() |
| 351 |
mesh['int64'] = np.arange(mesh.n_cells, dtype=np.int64) |
| 352 |
|
| 353 |
pl = pv.Plotter(notebook=True) |
| 354 |
_ = pl.add_mesh(mesh, scalars='int64') |
| 355 |
widget = pl.show( |
| 356 |
jupyter_backend='trame', |
| 357 |
return_viewer=True, |
| 358 |
) |
| 359 |
# Basically just assert that it didn't error out |
| 360 |
assert isinstance(widget, Widget) |
| 361 |
|
| 362 |
|
| 363 |
@pytest.mark.skip_plotting |
| 364 |
def test_trame_export_html(tmpdir): |
| 365 |
filename = str(tmpdir.join('tmp.html')) |
| 366 |
pl = pv.Plotter() |
| 367 |
pl.add_mesh(pv.Wavelet()) |
| 368 |
pl.export_html(filename) |
| 369 |
assert Path(filename).is_file() |
| 370 |
|
| 371 |
|
| 372 |
def test_export_single(tmpdir): |
| 373 |
filename = str(tmpdir.mkdir('tmpdir').join('scene-single')) |
| 374 |
data = examples.load_airplane() |
| 375 |
# Create the scene |
| 376 |
pl = pv.Plotter() |
| 377 |
pl.add_mesh(data) |
| 378 |
pl.export_vtksz(filename) |
| 379 |
# Now make sure the file is there |
| 380 |
assert Path(f'{filename}').is_file() |
| 381 |
|
| 382 |
|
| 383 |
def test_export_multi(tmpdir): |
| 384 |
filename = str(tmpdir.mkdir('tmpdir').join('scene-multi')) |
| 385 |
multi = pv.MultiBlock() |
| 386 |
# Add examples |
| 387 |
multi.append(examples.load_ant()) |
| 388 |
multi.append(examples.load_sphere()) |
| 389 |
multi.append(examples.load_uniform()) |
| 390 |
multi.append(examples.load_airplane()) |
| 391 |
multi.append(examples.load_rectilinear()) |
| 392 |
# Create the scene |
| 393 |
pl = pv.Plotter() |
| 394 |
pl.add_mesh(multi) |
| 395 |
pl.export_vtksz(filename) |
| 396 |
# Now make sure the file is there |
| 397 |
assert Path(f'{filename}').is_file() |
| 398 |
|
| 399 |
|
| 400 |
def test_export_texture(tmpdir): |
| 401 |
filename = str(tmpdir.mkdir('tmpdir').join('scene-texture')) |
| 402 |
data = examples.load_globe() |
| 403 |
texture = examples.load_globe_texture() |
| 404 |
# Create the scene |
| 405 |
pl = pv.Plotter() |
| 406 |
pl.add_mesh(data, texture=texture) |
| 407 |
pl.export_vtksz(filename) |
| 408 |
# Now make sure the file is there |
| 409 |
assert Path(f'{filename}').is_file() |
| 410 |
|
| 411 |
|
| 412 |
def test_export_verts(tmpdir): |
| 413 |
filename = str(tmpdir.mkdir('tmpdir').join('scene-verts')) |
| 414 |
data = pv.PolyData(np.random.default_rng().random((100, 3))) |
| 415 |
# Create the scene |
| 416 |
pl = pv.Plotter() |
| 417 |
pl.add_mesh(data) |
| 418 |
pl.export_vtksz(filename) |
| 419 |
# Now make sure the file is there |
| 420 |
assert Path(f'{filename}').is_file() |
| 421 |
|
| 422 |
|
| 423 |
def test_export_color(tmpdir): |
| 424 |
filename = str(tmpdir.mkdir('tmpdir').join('scene-color')) |
| 425 |
data = examples.load_airplane() |
| 426 |
# Create the scene |
| 427 |
pl = pv.Plotter() |
| 428 |
pl.add_mesh(data, color='yellow') |
| 429 |
pl.export_vtksz(filename) |
| 430 |
# Now make sure the file is there |
| 431 |
assert Path(f'{filename}').is_file() |
| 432 |
|
| 433 |
|
| 434 |
def test_embeddable_widget(): |
| 435 |
pl = pv.Plotter(notebook=True) |
| 436 |
pl.add_mesh(pv.Sphere()) |
| 437 |
widget = pl.show(jupyter_backend='html', return_viewer=True) |
| 438 |
# Basically just assert that it didn't error out |
| 439 |
assert isinstance(widget, EmbeddableWidget) |
| 440 |
|
| 441 |
|
| 442 |
def test_ipywidgets_raises(monkeypatch: pytest.MonkeyPatch): |
| 443 |
from pyvista.trame import jupyter |
| 444 |
|
| 445 |
monkeypatch.setattr(jupyter, 'HTML', object) |
| 446 |
with pytest.raises(ImportError, match=r'Please install `ipywidgets`.'): |
| 447 |
jupyter.Widget(viewer=None, src=None) |
| 448 |
|
| 449 |
with pytest.raises(ImportError, match=r'Please install `ipywidgets`.'): |
| 450 |
jupyter.EmbeddableWidget(plotter=None, width=None, height=None) |