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
|
"""Support dynamic or static jupyter notebook plotting.
Includes:
* ``trame``
* ``client``
* ``server``
* ``html``
"""
from __future__ import annotations
from typing import TYPE_CHECKING
import numpy as np
from pyvista._warn_external import warn_external
if TYPE_CHECKING:
import io
from pathlib import Path
from IPython.lib.display import IFrame
from PIL.Image import Image
from pyvista.jupyter import JupyterBackendOptions
from pyvista.plotting.plotter import Plotter
from pyvista.trame.jupyter import EmbeddableWidget
from pyvista.trame.jupyter import Widget
def handle_plotter(
plotter: Plotter,
backend: JupyterBackendOptions | None = None,
screenshot: str | Path | io.BytesIO | bool | None = None, # noqa: FBT001
**kwargs,
) -> EmbeddableWidget | IFrame | Widget | Image:
"""Show the ``pyvista`` plot in a jupyter environment.
Returns
-------
IPython Widget
IPython widget or image.
"""
if screenshot is False:
screenshot = None
try:
if backend in ['server', 'client', 'trame', 'html']:
from pyvista.trame.jupyter import show_trame # noqa: PLC0415
return show_trame(plotter, mode=backend, **kwargs)
except ImportError as e:
warn_external(
f'Failed to use notebook backend: \n\n{e}\n\nFalling back to a static output.',
)
return show_static_image(plotter, screenshot)
def show_static_image(
plotter: Plotter,
screenshot: str | Path | io.BytesIO | bool | None, # noqa: FBT001
) -> Image: # numpydoc ignore=RT01
"""Display a static image to be displayed within a jupyter notebook."""
import PIL.Image # noqa: PLC0415
if plotter.last_image is None:
# Must render here, otherwise plotter will segfault.
plotter.render()
plotter.last_image = plotter.screenshot(screenshot, return_img=True)
assert isinstance(plotter.last_image, np.ndarray)
return PIL.Image.fromarray(plotter.last_image)
|
