Make more of testing/ pytest-independent.

anntzer · anntzer · commit f28bc2dd2ab9 · 2019-06-23T13:49:33.000+02:00
This makes it actually possible to write tests independently of pytest
(the API is still private, but could be made public):

```
import unittest
from matplotlib import pyplot as plt
from matplotlib.testing.decorators import _make_image_comparator

class TestFoo(unittest.TestCase):

    @_make_image_comparator(baseline_images=["foo"], extension="png")
    def test_bar(self):
        fig, ax = plt.subplots()
```

works as expected.
diff --git a/doc/api/next_api_changes/2019-05-19-AL.rst b/doc/api/next_api_changes/2019-05-19-AL.rst
@@ -0,0 +1,6 @@
+API changes
+```````````
+
+``testing.compare.convert`` now raises ``unittest.SkipTest`` instead of a
+pytest skip for incomparable formats.  Note that pytest will correctly handle
+such tests as being skipped.
diff --git a/lib/matplotlib/testing/compare.py b/lib/matplotlib/testing/compare.py
@@ -12,6 +12,7 @@
 import subprocess
 import sys
 from tempfile import TemporaryFile
+import unittest
 
 import numpy as np
 
@@ -255,6 +256,12 @@ def comparable_formats():
     return ['png', *converter]
 
 
+def _skip_if_incomparable(ext):
+    """Raise `unittest.SkipTest` if an *ext* files cannot be compared."""
+    if ext not in comparable_formats():
+        raise unittest.SkipTest(f"Lacking dependency to compare {ext} files")
+
+
 def convert(filename, cache):
     """
     Convert the named file to png; return the name of the created file.
@@ -265,9 +272,7 @@ def convert(filename, cache):
     size of the cache, so it may need to be manually cleared periodically.
     """
     base, extension = os.fspath(filename).rsplit('.', 1)
-    if extension not in converter:
-        import pytest
-        pytest.skip(f"Don't know how to convert {extension} files to png")
+    _skip_if_incomparable(extension)
     newname = base + '_' + extension + '.png'
     if not os.path.exists(filename):
         raise IOError("'%s' does not exist" % filename)
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
@@ -18,7 +18,7 @@
 from matplotlib import pyplot as plt
 from matplotlib import ticker
 from . import is_called_from_pytest
-from .compare import comparable_formats, compare_images, make_test_filename
+from .compare import compare_images, make_test_filename, _skip_if_incomparable
 from .exceptions import ImageComparisonFailure
 
 
@@ -135,54 +135,33 @@ def _raise_on_image_difference(expected, actual, tol):
              % err)
 
 
-def _skip_if_format_is_uncomparable(extension):
-    import pytest
-    return pytest.mark.skipif(
-        extension not in comparable_formats(),
-        reason='Cannot compare {} files on this system'.format(extension))
-
-
-def _mark_skip_if_format_is_uncomparable(extension):
-    import pytest
-    if isinstance(extension, str):
-        name = extension
-        marks = []
-    elif isinstance(extension, tuple):
-        # Extension might be a pytest ParameterSet instead of a plain string.
-        # Unfortunately, this type is not exposed, so since it's a namedtuple,
-        # check for a tuple instead.
-        name, = extension.values
-        marks = [*extension.marks]
-    else:
-        # Extension might be a pytest marker instead of a plain string.
-        name, = extension.args
-        marks = [extension.mark]
-    return pytest.param(name,
-                        marks=[*marks, _skip_if_format_is_uncomparable(name)])
-
-
-class _ImageComparisonBase:
+def _make_image_comparator(func=None,
+                           baseline_images=None, *, extension=None, tol=0,
+                           remove_text=False, savefig_kwargs=None):
     """
-    Image comparison base class
+    Image comparison base helper.
 
-    This class provides *just* the comparison-related functionality and avoids
+    This helper provides *just* the comparison-related functionality and avoids
     any code that would be specific to any testing framework.
     """
+    if func is None:
+        return functools.partial(
+            _make_image_comparator,
+            baseline_images=baseline_images, extension=extension, tol=tol,
+            remove_text=remove_text, savefig_kwargs=savefig_kwargs)
+
+    if savefig_kwargs is None:
+        savefig_kwargs = {}
 
-    def __init__(self, func, tol, remove_text, savefig_kwargs):
-        self.func = func
-        self.baseline_dir, self.result_dir = _image_directories(func)
-        self.tol = tol
-        self.remove_text = remove_text
-        self.savefig_kwargs = savefig_kwargs
+    baseline_dir, result_dir = _image_directories(func)
 
-    def copy_baseline(self, baseline, extension):
-        baseline_path = self.baseline_dir / baseline
+    def _copy_baseline(baseline):
+        baseline_path = baseline_dir / baseline
         orig_expected_path = baseline_path.with_suffix(f'.{extension}')
         if extension == 'eps' and not orig_expected_path.exists():
             orig_expected_fname = baseline_path.with_suffix('.pdf')
         expected_fname = make_test_filename(
-            self.result_dir / orig_expected_path.name, 'expected')
+            result_dir / orig_expected_path.name, 'expected')
         try:
             # os.symlink errors if the target already exists.
             with contextlib.suppress(OSError):
@@ -197,24 +176,33 @@ def copy_baseline(self, baseline, extension):
                 f"following file cannot be accessed: {orig_expected_fname}")
         return expected_fname
 
-    def compare(self, idx, baseline, extension):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
         __tracebackhide__ = True
-        fignum = plt.get_fignums()[idx]
-        fig = plt.figure(fignum)
-
-        if self.remove_text:
-            remove_ticks_and_titles(fig)
-
-        actual_path = (self.result_dir / baseline).with_suffix(f'.{extension}')
-        kwargs = self.savefig_kwargs.copy()
-        if extension == 'pdf':
-            kwargs.setdefault('metadata',
-                              {'Creator': None, 'Producer': None,
-                               'CreationDate': None})
-        fig.savefig(actual_path, **kwargs)
-
-        expected_path = self.copy_baseline(baseline, extension)
-        _raise_on_image_difference(expected_path, actual_path, self.tol)
+        _skip_if_incomparable(extension)
+
+        func(*args, **kwargs)
+
+        fignums = plt.get_fignums()
+        assert len(fignums) == len(baseline_images), (
+            "Test generated {} images but there are {} baseline images"
+            .format(len(fignums), len(baseline_images)))
+        for baseline_image, fignum in zip(baseline_images, fignums):
+            fig = plt.figure(fignum)
+            if remove_text:
+                remove_ticks_and_titles(fig)
+            actual_path = ((result_dir / baseline_image)
+                           .with_suffix(f'.{extension}'))
+            kwargs = savefig_kwargs.copy()
+            if extension == 'pdf':
+                kwargs.setdefault('metadata',
+                                  {'Creator': None, 'Producer': None,
+                                   'CreationDate': None})
+            fig.savefig(actual_path, **kwargs)
+            expected_path = _copy_baseline(baseline_image)
+            _raise_on_image_difference(expected_path, actual_path, tol)
+
+    return wrapper
 
 
 def _pytest_image_comparison(baseline_images, extensions, tol,
@@ -230,8 +218,6 @@ def _pytest_image_comparison(baseline_images, extensions, tol,
     """
     import pytest
 
-    extensions = map(_mark_skip_if_format_is_uncomparable, extensions)
-
     def decorator(func):
         @functools.wraps(func)
         # Parameter indirection; see docstring above and comment below.
@@ -244,23 +230,19 @@ def decorator(func):
         @functools.wraps(func)
         def wrapper(*args, **kwargs):
             __tracebackhide__ = True
-            img = _ImageComparisonBase(func, tol=tol, remove_text=remove_text,
-                                       savefig_kwargs=savefig_kwargs)
-            matplotlib.testing.set_font_settings_for_testing()
-            func(*args, **kwargs)
-
             # Parameter indirection:
             # This is hacked on via the mpl_image_comparison_parameters fixture
             # so that we don't need to modify the function's real signature for
             # any parametrization. Modifying the signature is very very tricky
             # and likely to confuse pytest.
             baseline_images, extension = func.parameters
 
-            assert len(plt.get_fignums()) == len(baseline_images), (
-                "Test generated {} images but there are {} baseline images"
-                .format(len(plt.get_fignums()), len(baseline_images)))
-            for idx, baseline in enumerate(baseline_images):
-                img.compare(idx, baseline, extension)
+            matplotlib.testing.set_font_settings_for_testing()
+            comparator = _make_image_comparator(
+                func,
+                baseline_images=baseline_images, extension=extension, tol=tol,
+                remove_text=remove_text, savefig_kwargs=savefig_kwargs)
+            comparator(*args, **kwargs)
 
         return wrapper
 
@@ -344,8 +326,6 @@ def image_comparison(baseline_images, extensions=None, tol=0,
     if extensions is None:
         # Default extensions to test, if not set via baseline_images.
         extensions = ['png', 'pdf', 'svg']
-    if savefig_kwarg is None:
-        savefig_kwarg = dict()  # default no kwargs to savefig
     return _pytest_image_comparison(
         baseline_images=baseline_images, extensions=extensions, tol=tol,
         freetype_version=freetype_version, remove_text=remove_text,
@@ -390,6 +370,7 @@ def decorator(func):
             # Free-standing function.
             @pytest.mark.parametrize("ext", extensions)
             def wrapper(ext):
+                _skip_if_incomparable(ext)
                 fig_test = plt.figure("test")
                 fig_ref = plt.figure("reference")
                 func(fig_test, fig_ref)
@@ -405,6 +386,7 @@ def wrapper(ext):
             # Method.
             @pytest.mark.parametrize("ext", extensions)
             def wrapper(self, ext):
+                _skip_if_incomparable(ext)
                 fig_test = plt.figure("test")
                 fig_ref = plt.figure("reference")
                 func(self, fig_test, fig_ref)
