Handle comments from PR.

QuLogic · QuLogic · commit c1864083bd4e · 2017-04-15T18:48:55.000-04:00
* Install nose in one build.
* Add docstrings and comments on new functions/classes to clarify what
  they do.
* Use consistent `yield` pattern for fixture.
diff --git a/.travis.yml b/.travis.yml
@@ -45,14 +45,15 @@ env:
     - NPROC=2
     - INSTALL_PEP8=
     - RUN_PEP8=
+    - NOSE=
     - PYTEST_ARGS="-ra --maxfail=1 --timeout=300 --durations=25 --cov-report= --cov=lib -n $NPROC"
     - PYTHON_ARGS=
     - DELETE_FONT_CACHE=
 
 matrix:
   include:
     - python: 2.7
-      env: MOCK=mock NUMPY=numpy==1.7.1 PANDAS=pandas
+      env: MOCK=mock NUMPY=numpy==1.7.1 PANDAS=pandas NOSE=nose
     - python: 2.7
       env: BUILD_DOCS=true
     - python: 3.4
@@ -114,7 +115,7 @@ install:
     pip install --upgrade setuptools
   - |
     # Install dependencies from pypi
-    pip install $PRE python-dateutil $NUMPY pyparsing!=2.1.6 $PANDAS cycler codecov coverage $MOCK
+    pip install $PRE python-dateutil $NUMPY pyparsing!=2.1.6 $PANDAS cycler codecov coverage $MOCK $NOSE
     pip install $PRE -r doc-requirements.txt
 
     # pytest-cov>=2.3.1 due to https://github.com/pytest-dev/pytest-cov/issues/124
diff --git a/lib/matplotlib/testing/conftest.py b/lib/matplotlib/testing/conftest.py
@@ -73,5 +73,7 @@ def mpl_image_comparison_parameters(request, extension):
 
     func = request.function
     func.__wrapped__.parameters = (baseline_images, extension)
-    yield
-    delattr(func.__wrapped__, 'parameters')
+    try:
+        yield
+    finally:
+        delattr(func.__wrapped__, 'parameters')
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
@@ -234,6 +234,12 @@ def _mark_xfail_if_format_is_uncomparable(extension):
 
 
 class _ImageComparisonBase(object):
+    """
+    Image comparison base class
+
+    This class provides *just* the comparison-related functionality and avoids
+    any code that would be specific to any testing framework.
+    """
     def __init__(self, tol, remove_text, savefig_kwargs):
         self.func = self.baseline_dir = self.result_dir = None
         self.tol = tol
@@ -282,6 +288,15 @@ def compare(self, idx, baseline, extension):
 
 
 class ImageComparisonTest(CleanupTest, _ImageComparisonBase):
+    """
+    Nose-based image comparison class
+
+    This class generates tests for a nose-based testing framework. Ideally,
+    this class would not be public, and the only publically visible API would
+    be the :func:`image_comparison` decorator. Unfortunately, there are
+    existing downstream users of this class (e.g., pytest-mpl) so it cannot yet
+    be removed.
+    """
     def __init__(self, baseline_images, extensions, tol,
                  freetype_version, remove_text, savefig_kwargs, style):
         _ImageComparisonBase.__init__(self, tol, remove_text, savefig_kwargs)
@@ -339,14 +354,24 @@ def runner_wrapper():
 def _pytest_image_comparison(baseline_images, extensions, tol,
                              freetype_version, remove_text, savefig_kwargs,
                              style):
+    """
+    Decorate function with image comparison for pytest.
+
+    This function creates a decorator that wraps a figure-generating function
+    with image comparison code. Pytest can become confused if we change the
+    signature of the function, so we indirectly pass anything we need via the
+    `mpl_image_comparison_parameters` fixture and extra markers.
+    """
     import pytest
 
     extensions = map(_mark_xfail_if_format_is_uncomparable, extensions)
 
     def decorator(func):
+        # Parameter indirection; see docstring above and comment below.
         @pytest.mark.usefixtures('mpl_image_comparison_parameters')
         @pytest.mark.parametrize('extension', extensions)
         @pytest.mark.baseline_images(baseline_images)
+        # END Parameter indirection.
         @pytest.mark.style(style)
         @_checked_on_freetype_version(freetype_version)
         @functools.wraps(func)
@@ -358,6 +383,7 @@ def wrapper(*args, **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
