Skip to content

Commit 5015910

Browse files
anntzeranntzer
committed
Py3fy testing machinery.
1 parent 0d0eb39 commit 5015910

File tree

3 files changed

+31
-59
lines changed

3 files changed

+31
-59
lines changed

‎lib/matplotlib/testing/__init__.py

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,6 @@ def is_called_from_pytest():
1010
return getattr(mpl, '_called_from_pytest', False)
1111

1212

13-
def _copy_metadata(src_func, tgt_func):
14-
"""Replicates metadata of the function. Returns target function."""
15-
functools.update_wrapper(tgt_func, src_func)
16-
tgt_func.__wrapped__ = src_func # Python2 compatibility.
17-
return tgt_func
18-
19-
2013
def set_font_settings_for_testing():
2114
mpl.rcParams['font.family'] = 'DejaVu Sans'
2215
mpl.rcParams['text.hinting'] = False

‎lib/matplotlib/testing/compare.py

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -181,15 +181,14 @@ def __call__(self, orig, dest):
181181
# reported as a regular exception below).
182182
env.pop("DISPLAY", None) # May already be unset.
183183
# Do not load any user options.
184-
# `os.environ` needs native strings on Py2+Windows.
185-
env[str("INKSCAPE_PROFILE_DIR")] = os.devnull
184+
env["INKSCAPE_PROFILE_DIR"] = os.devnull
186185
# Old versions of Inkscape (0.48.3.1, used on Travis as of now)
187186
# seem to sometimes deadlock when stderr is redirected to a pipe,
188187
# so we redirect it to a temporary file instead. This is not
189188
# necessary anymore as of Inkscape 0.92.1.
190189
self._stderr = TemporaryFile()
191190
self._proc = subprocess.Popen(
192-
[str("inkscape"), "--without-gui", "--shell"],
191+
["inkscape", "--without-gui", "--shell"],
193192
stdin=subprocess.PIPE, stdout=subprocess.PIPE,
194193
stderr=self._stderr, env=env)
195194
if not self._read_to_prompt():
@@ -210,7 +209,7 @@ def fsencode(s):
210209
# slow solution (Inkscape uses `fgets` so it will always stop at a
211210
# newline).
212211
return make_external_conversion_command(lambda old, new: [
213-
str('inkscape'), '-z', old, '--export-png', new])(orig, dest)
212+
'inkscape', '-z', old, '--export-png', new])(orig, dest)
214213
self._proc.stdin.write(orig_b + b" --export-png=" + dest_b + b"\n")
215214
self._proc.stdin.flush()
216215
if not self._read_to_prompt():
@@ -329,8 +328,8 @@ def calculate_rms(expectedImage, actualImage):
329328
"Calculate the per-pixel errors, then compute the root mean square error."
330329
if expectedImage.shape != actualImage.shape:
331330
raise ImageComparisonFailure(
332-
"Image sizes do not match expected size: {0} "
333-
"actual size {1}".format(expectedImage.shape, actualImage.shape))
331+
"Image sizes do not match expected size: {} "
332+
"actual size {}".format(expectedImage.shape, actualImage.shape))
334333
# Convert to float to avoid overflowing finite integer types.
335334
return np.sqrt(((expectedImage - actualImage).astype(float) ** 2).mean())
336335

@@ -361,7 +360,7 @@ def compare_images(expected, actual, tol, in_decorator=False):
361360
--------
362361
img1 = "./baseline/plot.png"
363362
img2 = "./output/plot.png"
364-
compare_images( img1, img2, 0.001 ):
363+
compare_images(img1, img2, 0.001):
365364
366365
"""
367366
if not os.path.exists(actual):
@@ -391,7 +390,7 @@ def compare_images(expected, actual, tol, in_decorator=False):
391390

392391
diff_image = make_test_filename(actual, 'failed-diff')
393392

394-
if tol <= 0.0:
393+
if tol <= 0:
395394
if np.array_equal(expectedImage, actualImage):
396395
return None
397396

@@ -431,8 +430,8 @@ def save_diff_image(expected, actual, output):
431430
actualImage = np.array(actualImage).astype(float)
432431
if expectedImage.shape != actualImage.shape:
433432
raise ImageComparisonFailure(
434-
"Image sizes do not match expected size: {0} "
435-
"actual size {1}".format(expectedImage.shape, actualImage.shape))
433+
"Image sizes do not match expected size: {} "
434+
"actual size {}".format(expectedImage.shape, actualImage.shape))
436435
absDiffImage = np.abs(expectedImage - actualImage)
437436

438437
# expand differences in luminance domain

‎lib/matplotlib/testing/decorators.py

Lines changed: 22 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from distutils.version import StrictVersion
22
import functools
3-
import inspect
3+
import importlib
44
import os
55
from pathlib import Path
66
import shutil
@@ -23,7 +23,7 @@
2323
from matplotlib import ft2font
2424
from matplotlib.testing.compare import (
2525
comparable_formats, compare_images, make_test_filename)
26-
from . import _copy_metadata, is_called_from_pytest
26+
from . import is_called_from_pytest
2727
from .exceptions import ImageComparisonFailure
2828

2929

@@ -250,9 +250,9 @@ def copy_baseline(self, baseline, extension):
250250
if os.path.exists(orig_expected_fname):
251251
shutil.copyfile(orig_expected_fname, expected_fname)
252252
else:
253-
reason = ("Do not have baseline image {0} because this "
254-
"file does not exist: {1}".format(expected_fname,
255-
orig_expected_fname))
253+
reason = ("Do not have baseline image {} because this "
254+
"file does not exist: {}".format(expected_fname,
255+
orig_expected_fname))
256256
raise ImageComparisonFailure(reason)
257257
return expected_fname
258258

@@ -327,11 +327,12 @@ def __call__(self, func):
327327
self.delayed_init(func)
328328
import nose.tools
329329

330+
@functools.wraps(func)
330331
@nose.tools.with_setup(self.setup, self.teardown)
331332
def runner_wrapper():
332333
yield from self.nose_runner()
333334

334-
return _copy_metadata(func, runner_wrapper)
335+
return runner_wrapper
335336

336337

337338
def _pytest_image_comparison(baseline_images, extensions, tol,
@@ -350,6 +351,7 @@ def _pytest_image_comparison(baseline_images, extensions, tol,
350351
extensions = map(_mark_xfail_if_format_is_uncomparable, extensions)
351352

352353
def decorator(func):
354+
@functools.wraps(func)
353355
# Parameter indirection; see docstring above and comment below.
354356
@pytest.mark.usefixtures('mpl_image_comparison_parameters')
355357
@pytest.mark.parametrize('extension', extensions)
@@ -379,8 +381,7 @@ def wrapper(*args, **kwargs):
379381
for idx, baseline in enumerate(baseline_images):
380382
img.compare(idx, baseline, extension)
381383

382-
wrapper.__wrapped__ = func # For Python 2.7.
383-
return _copy_metadata(func, wrapper)
384+
return wrapper
384385

385386
return decorator
386387

@@ -408,7 +409,7 @@ def image_comparison(baseline_images, extensions=None, tol=0,
408409
extensions : [ None | list ]
409410
410411
If None, defaults to all supported extensions.
411-
Otherwise, a list of extensions to test. For example ['png','pdf'].
412+
Otherwise, a list of extensions to test, e.g. ``['png', 'pdf']``.
412413
413414
tol : float, optional, default: 0
414415
The RMS threshold above which the test is considered failed.
@@ -464,10 +465,10 @@ def _image_directories(func):
464465
# FIXME: this won't work for nested packages in matplotlib.tests
465466
warnings.warn(
466467
'Test module run as script. Guessing baseline image locations.')
467-
script_name = sys.argv[0]
468-
basedir = os.path.abspath(os.path.dirname(script_name))
469-
subdir = os.path.splitext(os.path.split(script_name)[1])[0]
468+
module_path = Path(sys.argv[0]).resolve()
469+
subdir = module_path.stem
470470
else:
471+
module_path = Path(importlib.util.find_spec(func.__module__).origin)
471472
mods = module_name.split('.')
472473
if len(mods) >= 3:
473474
mods.pop(0)
@@ -486,50 +487,29 @@ def _image_directories(func):
486487
"file (can be empty).".format(module_name))
487488
subdir = os.path.join(*mods)
488489

489-
import imp
490-
def find_dotted_module(module_name, path=None):
491-
"""A version of imp which can handle dots in the module name.
492-
As for imp.find_module(), the return value is a 3-element
493-
tuple (file, pathname, description)."""
494-
res = None
495-
for sub_mod in module_name.split('.'):
496-
try:
497-
res = file, path, _ = imp.find_module(sub_mod, path)
498-
path = [path]
499-
if file is not None:
500-
file.close()
501-
except ImportError:
502-
# assume namespace package
503-
path = list(sys.modules[sub_mod].__path__)
504-
res = None, path, None
505-
return res
506-
507-
mod_file = find_dotted_module(func.__module__)[1]
508-
basedir = os.path.dirname(mod_file)
490+
baseline_dir = module_path.parent / 'baseline_images' / subdir
491+
result_dir = Path('result_images', subdir).resolve()
492+
result_dir.mkdir(parents=True, exist_ok=True)
509493

510-
baseline_dir = os.path.join(basedir, 'baseline_images', subdir)
511-
result_dir = os.path.abspath(os.path.join('result_images', subdir))
512-
Path(result_dir).mkdir(parents=True, exist_ok=True)
513-
514-
return baseline_dir, result_dir
494+
return str(baseline_dir), str(result_dir)
515495

516496

517497
def switch_backend(backend):
518-
# Local import to avoid a hard nose dependency and only incur the
519-
# import time overhead at actual test-time.
498+
520499
def switch_backend_decorator(func):
500+
521501
@functools.wraps(func)
522502
def backend_switcher(*args, **kwargs):
523503
try:
524504
prev_backend = mpl.get_backend()
525505
matplotlib.testing.setup()
526506
plt.switch_backend(backend)
527-
result = func(*args, **kwargs)
507+
return func(*args, **kwargs)
528508
finally:
529509
plt.switch_backend(prev_backend)
530-
return result
531510

532-
return _copy_metadata(func, backend_switcher)
511+
return backend_switcher
512+
533513
return switch_backend_decorator
534514

535515

0 commit comments

Comments
 (0)