test_pylabtools.py
352 lines
| 10.5 KiB
| text/x-python
|
PythonLexer
|
r3734 | """Tests for pylab tools module. | ||
""" | ||||
|
r21765 | |||
# Copyright (c) IPython Development Team. | ||||
|
r3734 | # Distributed under the terms of the Modified BSD License. | ||
|
r26812 | from binascii import a2b_base64 | ||
from io import BytesIO | ||||
|
r15684 | |||
|
r26998 | import pytest | ||
matplotlib = pytest.importorskip("matplotlib") | ||||
|
r15390 | matplotlib.use('Agg') | ||
from matplotlib.figure import Figure | ||||
|
r3734 | |||
from matplotlib import pyplot as plt | ||||
|
r26907 | from matplotlib_inline import backend_inline | ||
|
r5468 | import numpy as np | ||
|
r3734 | |||
|
r15390 | from IPython.core.getipython import get_ipython | ||
|
r11329 | from IPython.core.interactiveshell import InteractiveShell | ||
|
r15390 | from IPython.core.display import _PNG, _JPEG | ||
|
r3734 | from .. import pylabtools as pt | ||
|
r14777 | from IPython.testing import decorators as dec | ||
|
r3734 | |||
def test_figure_to_svg(): | ||||
# simple empty-figure test | ||||
fig = plt.figure() | ||||
|
r26907 | assert pt.print_figure(fig, "svg") is None | ||
|
r3734 | |||
plt.close('all') | ||||
# simple check for at least svg-looking output | ||||
|
r3745 | fig = plt.figure() | ||
ax = fig.add_subplot(1,1,1) | ||||
|
r3734 | ax.plot([1,2,3]) | ||
plt.draw() | ||||
|
r26907 | svg = pt.print_figure(fig, "svg")[:100].lower() | ||
assert "doctype svg" in svg | ||||
|
r5468 | |||
|
r15684 | def _check_pil_jpeg_bytes(): | ||
"""Skip if PIL can't write JPEGs to BytesIO objects""" | ||||
|
r15686 | # PIL's JPEG plugin can't write to BytesIO objects | ||
# Pillow fixes this | ||||
|
r15684 | from PIL import Image | ||
buf = BytesIO() | ||||
img = Image.new("RGB", (4,4)) | ||||
try: | ||||
img.save(buf, 'jpeg') | ||||
except Exception as e: | ||||
ename = e.__class__.__name__ | ||||
|
r26907 | raise pytest.skip("PIL can't write JPEG to BytesIO: %s: %s" % (ename, e)) from e | ||
|
r15684 | |||
|
r14777 | @dec.skip_without("PIL.Image") | ||
|
r15684 | def test_figure_to_jpeg(): | ||
_check_pil_jpeg_bytes() | ||||
# simple check for at least jpeg-looking output | ||||
|
r14777 | fig = plt.figure() | ||
ax = fig.add_subplot(1,1,1) | ||||
ax.plot([1,2,3]) | ||||
plt.draw() | ||||
|
r25633 | jpeg = pt.print_figure(fig, 'jpeg', pil_kwargs={'optimize': 50})[:100].lower() | ||
|
r15684 | assert jpeg.startswith(_JPEG) | ||
|
r14775 | |||
|
r15390 | def test_retina_figure(): | ||
|
r21813 | # simple empty-figure test | ||
fig = plt.figure() | ||||
|
r26907 | assert pt.retina_figure(fig) == None | ||
|
r21813 | plt.close('all') | ||
|
r15390 | fig = plt.figure() | ||
ax = fig.add_subplot(1,1,1) | ||||
ax.plot([1,2,3]) | ||||
plt.draw() | ||||
png, md = pt.retina_figure(fig) | ||||
assert png.startswith(_PNG) | ||||
|
r26907 | assert "width" in md | ||
assert "height" in md | ||||
|
r15390 | |||
_fmt_mime_map = { | ||||
'png': 'image/png', | ||||
'jpeg': 'image/jpeg', | ||||
'pdf': 'application/pdf', | ||||
'retina': 'image/png', | ||||
'svg': 'image/svg+xml', | ||||
} | ||||
def test_select_figure_formats_str(): | ||||
ip = get_ipython() | ||||
for fmt, active_mime in _fmt_mime_map.items(): | ||||
pt.select_figure_formats(ip, fmt) | ||||
for mime, f in ip.display_formatter.formatters.items(): | ||||
if mime == active_mime: | ||||
|
r26907 | assert Figure in f | ||
|
r15390 | else: | ||
|
r26907 | assert Figure not in f | ||
|
r15390 | |||
def test_select_figure_formats_kwargs(): | ||||
ip = get_ipython() | ||||
|
r27009 | kwargs = dict(bbox_inches="tight") | ||
pt.select_figure_formats(ip, "png", **kwargs) | ||||
formatter = ip.display_formatter.formatters["image/png"] | ||||
|
r15390 | f = formatter.lookup_by_type(Figure) | ||
|
r26812 | cell = f.keywords | ||
expected = kwargs | ||||
expected["base64"] = True | ||||
expected["fmt"] = "png" | ||||
assert cell == expected | ||||
|
r24290 | |||
|
r15390 | # check that the formatter doesn't raise | ||
fig = plt.figure() | ||||
ax = fig.add_subplot(1,1,1) | ||||
ax.plot([1,2,3]) | ||||
plt.draw() | ||||
formatter.enabled = True | ||||
png = formatter(fig) | ||||
|
r26812 | assert isinstance(png, str) | ||
png_bytes = a2b_base64(png) | ||||
assert png_bytes.startswith(_PNG) | ||||
|
r5468 | |||
|
r15390 | def test_select_figure_formats_set(): | ||
|
r5468 | ip = get_ipython() | ||
|
r15390 | for fmts in [ | ||
{'png', 'svg'}, | ||||
['png'], | ||||
('jpeg', 'pdf', 'retina'), | ||||
{'svg'}, | ||||
]: | ||||
active_mimes = {_fmt_mime_map[fmt] for fmt in fmts} | ||||
pt.select_figure_formats(ip, fmts) | ||||
for mime, f in ip.display_formatter.formatters.items(): | ||||
if mime in active_mimes: | ||||
|
r26907 | assert Figure in f | ||
|
r15390 | else: | ||
|
r26907 | assert Figure not in f | ||
|
r15390 | |||
def test_select_figure_formats_bad(): | ||||
ip = get_ipython() | ||||
|
r26907 | with pytest.raises(ValueError): | ||
|
r15390 | pt.select_figure_formats(ip, 'foo') | ||
|
r26907 | with pytest.raises(ValueError): | ||
|
r15390 | pt.select_figure_formats(ip, {'png', 'foo'}) | ||
|
r26907 | with pytest.raises(ValueError): | ||
|
r15390 | pt.select_figure_formats(ip, ['retina', 'pdf', 'bar', 'bad']) | ||
def test_import_pylab(): | ||||
|
r5469 | ns = {} | ||
pt.import_pylab(ns, import_all=False) | ||||
|
r26907 | assert "plt" in ns | ||
assert ns["np"] == np | ||||
|
r7966 | |||
class TestPylabSwitch(object): | ||||
|
r11329 | class Shell(InteractiveShell): | ||
|
r26428 | def init_history(self): | ||
"""Sets up the command history, and starts regular autosaves.""" | ||||
self.config.HistoryManager.hist_file = ":memory:" | ||||
super().init_history() | ||||
|
r11329 | def enable_gui(self, gui): | ||
pass | ||||
|
r24290 | |||
|
r28734 | def setup_method(self): | ||
|
r8003 | import matplotlib | ||
def act_mpl(backend): | ||||
matplotlib.rcParams['backend'] = backend | ||||
# Save rcParams since they get modified | ||||
self._saved_rcParams = matplotlib.rcParams | ||||
|
r12924 | self._saved_rcParamsOrig = matplotlib.rcParamsOrig | ||
|
r28351 | matplotlib.rcParams = dict(backend="QtAgg") | ||
matplotlib.rcParamsOrig = dict(backend="QtAgg") | ||||
|
r8003 | |||
# Mock out functions | ||||
|
r7966 | self._save_am = pt.activate_matplotlib | ||
|
r8003 | pt.activate_matplotlib = act_mpl | ||
|
r7966 | self._save_ip = pt.import_pylab | ||
pt.import_pylab = lambda *a,**kw:None | ||||
|
r26907 | self._save_cis = backend_inline.configure_inline_support | ||
backend_inline.configure_inline_support = lambda *a, **kw: None | ||||
|
r7966 | |||
|
r28734 | def teardown_method(self): | ||
|
r7966 | pt.activate_matplotlib = self._save_am | ||
pt.import_pylab = self._save_ip | ||||
|
r26907 | backend_inline.configure_inline_support = self._save_cis | ||
|
r8003 | import matplotlib | ||
matplotlib.rcParams = self._saved_rcParams | ||||
|
r12924 | matplotlib.rcParamsOrig = self._saved_rcParamsOrig | ||
|
r7966 | |||
def test_qt(self): | ||||
s = self.Shell() | ||||
|
r11329 | gui, backend = s.enable_matplotlib(None) | ||
|
r26907 | assert gui == "qt" | ||
assert s.pylab_gui_select == "qt" | ||||
|
r7966 | |||
|
r26907 | gui, backend = s.enable_matplotlib("inline") | ||
|
r28714 | assert gui is None | ||
|
r26907 | assert s.pylab_gui_select == "qt" | ||
|
r7966 | |||
|
r26907 | gui, backend = s.enable_matplotlib("qt") | ||
assert gui == "qt" | ||||
assert s.pylab_gui_select == "qt" | ||||
|
r7966 | |||
|
r26907 | gui, backend = s.enable_matplotlib("inline") | ||
|
r28714 | assert gui is None | ||
|
r26907 | assert s.pylab_gui_select == "qt" | ||
|
r7966 | |||
|
r11329 | gui, backend = s.enable_matplotlib() | ||
|
r26907 | assert gui == "qt" | ||
assert s.pylab_gui_select == "qt" | ||||
|
r7966 | |||
def test_inline(self): | ||||
s = self.Shell() | ||||
|
r26907 | gui, backend = s.enable_matplotlib("inline") | ||
|
r28714 | assert gui is None | ||
|
r26907 | assert s.pylab_gui_select == None | ||
|
r7966 | |||
|
r26907 | gui, backend = s.enable_matplotlib("inline") | ||
|
r28714 | assert gui is None | ||
|
r26907 | assert s.pylab_gui_select == None | ||
|
r7966 | |||
|
r26907 | gui, backend = s.enable_matplotlib("qt") | ||
assert gui == "qt" | ||||
assert s.pylab_gui_select == "qt" | ||||
|
r7966 | |||
|
r21756 | def test_inline_twice(self): | ||
"Using '%matplotlib inline' twice should not reset formatters" | ||||
|
r21765 | ip = self.Shell() | ||
|
r26907 | gui, backend = ip.enable_matplotlib("inline") | ||
|
r28714 | assert gui is None | ||
|
r21756 | |||
fmts = {'png'} | ||||
active_mimes = {_fmt_mime_map[fmt] for fmt in fmts} | ||||
pt.select_figure_formats(ip, fmts) | ||||
|
r26907 | gui, backend = ip.enable_matplotlib("inline") | ||
|
r28714 | assert gui is None | ||
|
r21756 | |||
for mime, f in ip.display_formatter.formatters.items(): | ||||
if mime in active_mimes: | ||||
|
r26907 | assert Figure in f | ||
|
r21756 | else: | ||
|
r26907 | assert Figure not in f | ||
|
r21756 | |||
|
r7966 | def test_qt_gtk(self): | ||
s = self.Shell() | ||||
|
r26907 | gui, backend = s.enable_matplotlib("qt") | ||
assert gui == "qt" | ||||
assert s.pylab_gui_select == "qt" | ||||
|
r7966 | |||
|
r28714 | gui, backend = s.enable_matplotlib("gtk3") | ||
|
r26907 | assert gui == "qt" | ||
assert s.pylab_gui_select == "qt" | ||||
|
r7966 | |||
|
r24290 | |||
def test_no_gui_backends(): | ||||
for k in ['agg', 'svg', 'pdf', 'ps']: | ||||
assert k not in pt.backend2gui | ||||
|
r25419 | |||
def test_figure_no_canvas(): | ||||
fig = Figure() | ||||
fig.canvas = None | ||||
pt.print_figure(fig) | ||||
|
r28717 | |||
@pytest.mark.parametrize( | ||||
"name, expected_gui, expected_backend", | ||||
[ | ||||
# name is gui | ||||
("gtk3", "gtk3", "gtk3agg"), | ||||
("gtk4", "gtk4", "gtk4agg"), | ||||
|
r28752 | ("headless", None, "agg"), | ||
|
r28717 | ("osx", "osx", "macosx"), | ||
("qt", "qt", "qtagg"), | ||||
("qt5", "qt5", "qt5agg"), | ||||
|
r28751 | ("qt6", "qt6", "qtagg"), | ||
|
r28717 | ("tk", "tk", "tkagg"), | ||
("wx", "wx", "wxagg"), | ||||
# name is backend | ||||
("agg", None, "agg"), | ||||
("cairo", None, "cairo"), | ||||
("pdf", None, "pdf"), | ||||
("ps", None, "ps"), | ||||
("svg", None, "svg"), | ||||
("template", None, "template"), | ||||
("gtk3agg", "gtk3", "gtk3agg"), | ||||
("gtk3cairo", "gtk3", "gtk3cairo"), | ||||
("gtk4agg", "gtk4", "gtk4agg"), | ||||
("gtk4cairo", "gtk4", "gtk4cairo"), | ||||
("macosx", "osx", "macosx"), | ||||
("nbagg", "nbagg", "nbagg"), | ||||
("notebook", "nbagg", "notebook"), | ||||
("qtagg", "qt", "qtagg"), | ||||
("qtcairo", "qt", "qtcairo"), | ||||
("qt5agg", "qt5", "qt5agg"), | ||||
("qt5cairo", "qt5", "qt5cairo"), | ||||
("tkagg", "tk", "tkagg"), | ||||
("tkcairo", "tk", "tkcairo"), | ||||
("webagg", "webagg", "webagg"), | ||||
("wxagg", "wx", "wxagg"), | ||||
("wxcairo", "wx", "wxcairo"), | ||||
], | ||||
) | ||||
def test_backend_builtin(name, expected_gui, expected_backend): | ||||
# Test correct identification of Matplotlib built-in backends without importing and using them, | ||||
# otherwise we would need to ensure all the complex dependencies such as windowing toolkits are | ||||
# installed. | ||||
mpl_manages_backends = pt._matplotlib_manages_backends() | ||||
if not mpl_manages_backends: | ||||
# Backends not supported before _matplotlib_manages_backends or supported | ||||
# but with different expected_gui or expected_backend. | ||||
if ( | ||||
name.endswith("agg") | ||||
or name.endswith("cairo") | ||||
or name in ("headless", "macosx", "pdf", "ps", "svg", "template") | ||||
): | ||||
pytest.skip() | ||||
elif name == "qt6": | ||||
expected_backend = "qtagg" | ||||
elif name == "notebook": | ||||
expected_backend, expected_gui = expected_gui, expected_backend | ||||
gui, backend = pt.find_gui_and_backend(name) | ||||
if not mpl_manages_backends: | ||||
gui = gui.lower() if gui else None | ||||
backend = backend.lower() if backend else None | ||||
assert gui == expected_gui | ||||
assert backend == expected_backend | ||||
def test_backend_entry_point(): | ||||
gui, backend = pt.find_gui_and_backend("inline") | ||||
assert gui is None | ||||
expected_backend = ( | ||||
"inline" | ||||
if pt._matplotlib_manages_backends() | ||||
else "module://matplotlib_inline.backend_inline" | ||||
) | ||||
assert backend == expected_backend | ||||
def test_backend_unknown(): | ||||
with pytest.raises(RuntimeError if pt._matplotlib_manages_backends() else KeyError): | ||||
pt.find_gui_and_backend("name-does-not-exist") | ||||