Deprecate ImageComparisonTest.

anntzer · anntzer · commit f77735b1b4cf · 2018-03-28T13:25:56.000-07:00
It's a weird leftover at that point that tries to set up a nose test
class but uses pytest markers (via e.g. _checked_on_freetype_version,
which uses _knownfailureif, which itself unconditionally relies on
pytest) -- basically, it can't actually be used for nose-based testing
unless nose somehow learns to interpret pytest markers.

A (fairly trivial...) PR has been opened on pytest-mpl to fix their use.
diff --git a/doc/api/next_api_changes/2018-02-15-AL-deprecations.rst b/doc/api/next_api_changes/2018-02-15-AL-deprecations.rst
@@ -11,16 +11,17 @@ The following modules are deprecated:
 The following classes, methods, functions, and attributes are deprecated:
 
 - ``afm.parse_afm``,
-- ``Annotation.arrow``,
+- ``backend_wx.FigureCanvasWx.macros``,
 - ``cbook.GetRealpathAndStat``, ``cbook.Locked``,
 - ``cbook.is_numlike`` (use ``isinstance(..., numbers.Number)`` instead),
   ``cbook.listFiles``, ``cbook.unicode_safe``
 - ``container.Container.set_remove_method``,
 - ``dates.DateFormatter.strftime_pre_1900``, ``dates.DateFormatter.strftime``,
 - ``font_manager.TempCache``,
 - ``mathtext.unichr_safe`` (use ``chr`` instead),
-- ``FigureCanvasWx.macros``,
+- ``testing.ImageComparisonTest``,
 - ``texmanager.dvipng_hack_alpha``,
+- ``text.Annotation.arrow``,
 
 The following rcParams are deprecated:
 - ``pgf.debug`` (the pgf backend relies on logging),
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
@@ -251,6 +251,7 @@ def compare(self, idx, baseline, extension):
         _raise_on_image_difference(expected_fname, actual_fname, self.tol)
 
 
+@cbook.deprecated("3.0")
 class ImageComparisonTest(CleanupTest, _ImageComparisonBase):
     """
     Nose-based image comparison class
