An attempt to make a image_comparison decorator that doesn't fail

pizzathief · pizzathief · commit 4fff1464ee4c · 2016-01-21T12:09:06.000+11:00
while being used on test_pickle.test_complete()
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
@@ -252,6 +252,35 @@ def do_test():
 
                 yield (do_test,)
 
+
+def image_comparison_2(baseline_images=None, extensions=None, tol=0,
+                     freetype_version=None, remove_text=False,
+                     savefig_kwarg=None, style='classic'):
+    if baseline_images is None:
+        raise ValueError('baseline_images must be specified')
+
+    if extensions is None:
+        # default extensions to test
+        extensions = ['png', 'pdf', 'svg']
+
+    if savefig_kwarg is None:
+        #default no kwargs to savefig
+        savefig_kwarg = dict()
+
+    def compare_images_decorator(func):
+        newtest = ImageComparisonTest()
+        newtest._baseline_images = baseline_images
+        newtest._extensions = extensions
+        newtest._tol = tol
+        newtest._freetype_version = freetype_version
+        newtest._remove_text = remove_text
+        newtest._savefig_kwarg = savefig_kwarg
+        newtest._style = style
+        func = newtest.test
+        return func
+    return compare_images_decorator
+
+
 def image_comparison(baseline_images=None, extensions=None, tol=0,
                      freetype_version=None, remove_text=False,
                      savefig_kwarg=None, style='classic'):
@@ -338,6 +367,7 @@ def compare_images_decorator(func):
         return new_class
     return compare_images_decorator
 
+
 def _image_directories(func):
     """
     Compute the baseline and result image directories for testing *func*.
diff --git a/lib/matplotlib/tests/test_pickle.py b/lib/matplotlib/tests/test_pickle.py
@@ -10,7 +10,8 @@
 from nose.tools import assert_equal, assert_not_equal
 import numpy as np
 
-from matplotlib.testing.decorators import cleanup, image_comparison
+from matplotlib.testing.decorators import cleanup, image_comparison,
+                                            image_comparison_2
 import matplotlib.pyplot as plt
 import matplotlib.transforms as mtransforms
 
@@ -128,7 +129,7 @@ def test_simple():
 
 
 @cleanup
-@image_comparison(baseline_images=['multi_pickle'],
+@image_comparison_2(baseline_images=['multi_pickle'],
                   extensions=['png'], remove_text=True)
 def test_complete():
     fig = plt.figure('Figure with a label?', figsize=(10, 6))
@@ -191,7 +192,9 @@ def test_complete():
     fig = pickle.load(result_fh)
 
     # make sure there is now a figure manager
-    assert not plt._pylab_helpers.Gcf.figs
+    # simply asserting 'not plt._pylab_helpers.Gcf.figs' resulted in
+    # a strange error
+    assert len(plt._pylab_helpers.Gcf.figs) > 0
 
     assert fig.get_label() == 'Figure with a label?'
 
