Merge branch 'v1.5.x' into v2.0.x

mdboom · mdboom · commit 527c85aba502 · 2015-11-12T11:42:19.000-05:00
diff --git a/README.rst b/README.rst
@@ -20,15 +20,17 @@ Testing
 
 After installation, you can launch the test suite::
 
-  python setup.py test
+  python tests.py
 
 Or from the python interpreter::
 
   import matplotlib
   matplotlib.test()
 
 Consider reading http://matplotlib.org/devel/coding_guide.html#testing for
-more information.
+more information. Note that the test suite requires nose and on python 2.7 mock
+which are not installed by default. Please install with pip or your package
+manager of choice.
 
 Contact
 =======
diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst
@@ -13,7 +13,7 @@ A guide for developers who are doing a matplotlib release.
 Testing
 =======
 
-* Run all of the regression tests by running ``python setup.py test`` script
+* Run all of the regression tests by running ``python tests.py``
   at the root of the source tree.
 
 * Run :file:`unit/memleak_hawaii3.py` and make sure there are no
diff --git a/doc/devel/testing.rst b/doc/devel/testing.rst
@@ -52,43 +52,40 @@ matplotlib source directory::
 Running the tests
 -----------------
 
-Running the tests is simple. Make sure you have nose installed and run
-the setup script's ``test`` command::
+Running the tests is simple. Make sure you have nose installed and run::
 
-   python setup.py test
+   python tests.py
 
 in the root directory of the distribution. The script takes a set of
 commands, such as:
 
 ========================  ===========
-``--pep8-only``           pep8 checks
-``--omit-pep8``           Do not perform pep8 checks
-``--nocapture``           do not capture stdout (nosetests)
-``--nose-verbose``        be verbose (nosetests)
-``--processes``           number of processes (nosetests)
-``--process-timeout``     process timeout (nosetests)
-``--with-coverage``       with coverage
-``--detailed-error-msg``  detailed error message (nosetest)
-``--tests``               comma separated selection of tests (nosetest)
+``--pep8``                pep8 checks
+``--no-pep8``             Do not perform pep8 checks
+``--no-network``          Disable tests that require network access
 ========================  ===========
 
-Additionally it is possible to run only coding standard test or disable them:
+Additional arguments are passed on to nosetests. See the nose 
+documentation for supported arguments. Some of the more important ones are given
+here:
 
-===================  ===========
-``--pep8``           run only PEP8 checks
-``--no-pep8``        disable PEP8 checks
-===================  ===========
+=============================  ===========
+``--verbose``                  Be more verbose
+``--processes=NUM``            Run tests in parallel over NUM processes
+``--process-timeout=SECONDS``  Set timeout for results from test runner process
+``--nocapture``                Do not capture stdout
+=============================  ===========
 
 To run a single test from the command line, you can provide a
 dot-separated path to the module followed by the function separated by
 a colon, e.g., (this is assuming the test is installed)::
 
-  python setup.py test --tests=matplotlib.tests.test_simplification:test_clipping
+  python tests.py matplotlib.tests.test_simplification:test_clipping
 
 If you want to run the full test suite, but want to save wall time try
 running the tests in parallel::
 
-  python setup.py test --nocapture --nose-verbose --processes=5 --process-timeout=300
+  python tests.py --nocapture --nose-verbose --processes=5 --process-timeout=300
 
 
 An alternative implementation that does not look at command line
@@ -100,9 +97,10 @@ matplotlib library function :func:`matplotlib.test`::
 
 .. hint::
 
-   You might need to install nose for this::
+   To run the tests you need to install nose and mock if using python 2.7::
 
       pip install nose
+      pip install mock
 
 
 .. _`nosetest arguments`: http://nose.readthedocs.org/en/latest/usage.html
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -22,6 +22,11 @@
 import operator
 import os
 import warnings
+try:
+    import collections.abc as abc
+except ImportError:
+    # python 2
+    import collections as abc
 from matplotlib.fontconfig_pattern import parse_fontconfig_pattern
 from matplotlib.colors import is_color_like
 
@@ -78,15 +83,19 @@ def f(s):
                     return [scalar_validator(v.strip()) for v in s if v.strip()]
                 else:
                     raise
-        elif type(s) in (list, tuple):
+        # We should allow any generic sequence type, including generators,
+        # Numpy ndarrays, and pandas data structures.  However, unordered
+        # sequences, such as sets, should be allowed but discouraged unless the
+        # user desires pseudorandom behavior.
+        elif isinstance(s, abc.Iterable) and not isinstance(s, abc.Mapping):
             # The condition on this list comprehension will preserve the
             # behavior of filtering out any empty strings (behavior was
             # from the original validate_stringlist()), while allowing
             # any non-string/text scalar values such as numbers and arrays.
             return [scalar_validator(v) for v in s
                     if not isinstance(v, six.string_types) or v]
         else:
-            msg = "'s' must be of type [ string | list | tuple ]"
+            msg = "{0!r} must be of type: string or non-dictionary iterable.".format(s)
             raise ValueError(msg)
     f.__doc__ = scalar_validator.__doc__
     return f
diff --git a/lib/matplotlib/tests/test_cycles.py b/lib/matplotlib/tests/test_cycles.py
@@ -1,6 +1,7 @@
-from matplotlib.testing.decorators import image_comparison
+from matplotlib.testing.decorators import image_comparison, cleanup
 import matplotlib.pyplot as plt
 import numpy as np
+from nose.tools import assert_raises
 
 from cycler import cycler
 
@@ -42,6 +43,27 @@ def test_marker_cycle():
     ax.legend(loc='upper left')
 
 
+# Reuse the image from test_marker_cycle()
+@image_comparison(baseline_images=['marker_cycle'], remove_text=True,
+                  extensions=['png'])
+def test_marker_cycle_keywords():
+    fig = plt.figure()
+    ax = fig.add_subplot(111)
+    # Test keyword arguments, numpy arrays, and generic iterators
+    ax.set_prop_cycle(color=np.array(['r', 'g', 'y']),
+                      marker=iter(['.', '*', 'x']))
+    xs = np.arange(10)
+    ys = 0.25 * xs + 2
+    ax.plot(xs, ys, label='red dot', lw=4, ms=16)
+    ys = 0.45 * xs + 3
+    ax.plot(xs, ys, label='green star', lw=4, ms=16)
+    ys = 0.65 * xs + 4
+    ax.plot(xs, ys, label='yellow x', lw=4, ms=16)
+    ys = 0.85 * xs + 5
+    ax.plot(xs, ys, label='red2 dot', lw=4, ms=16)
+    ax.legend(loc='upper left')
+
+
 @image_comparison(baseline_images=['lineprop_cycle_basic'], remove_text=True,
                   extensions=['png'])
 def test_linestylecycle_basic():
@@ -104,6 +126,40 @@ def test_fillcycle_ignore():
     ax.legend(loc='upper left')
 
 
+@cleanup
+def test_valid_input_forms():
+    fig, ax = plt.subplots()
+    # These should not raise an error.
+    ax.set_prop_cycle(None)
+    ax.set_prop_cycle(cycler('linewidth', [1, 2]))
+    ax.set_prop_cycle('color', 'rgywkbcm')
+    ax.set_prop_cycle('linewidth', (1, 2))
+    ax.set_prop_cycle('linewidth', [1, 2])
+    ax.set_prop_cycle('linewidth', iter([1, 2]))
+    ax.set_prop_cycle('linewidth', np.array([1, 2]))
+    ax.set_prop_cycle('color', np.array([[1, 0, 0],
+                                         [0, 1, 0],
+                                         [0, 0, 1]]))
+    ax.set_prop_cycle(lw=[1, 2], color=['k', 'w'], ls=['-', '--'])
+    ax.set_prop_cycle(lw=np.array([1, 2]),
+                      color=np.array(['k', 'w']),
+                      ls=np.array(['-', '--']))
+    assert True
+
+
+@cleanup
+def test_invalid_input_forms():
+    fig, ax = plt.subplots()
+    assert_raises((TypeError, ValueError), ax.set_prop_cycle, 1)
+    assert_raises((TypeError, ValueError), ax.set_prop_cycle, [1, 2])
+    assert_raises((TypeError, ValueError), ax.set_prop_cycle, 'color', 'fish')
+    assert_raises((TypeError, ValueError), ax.set_prop_cycle, 'linewidth', 1)
+    assert_raises((TypeError, ValueError), ax.set_prop_cycle,
+            'linewidth', {'1': 1, '2': 2})
+    assert_raises((TypeError, ValueError), ax.set_prop_cycle,
+            linewidth=1, color='r')
+
+
 if __name__ == '__main__':
     import nose
     nose.runmodule(argv=['-s', '--with-doctest'], exit=False)
diff --git a/lib/matplotlib/tests/test_rcparams.py b/lib/matplotlib/tests/test_rcparams.py
@@ -280,10 +280,15 @@ def test_validators():
                      ('aardvark, ,', ['aardvark']),
                      (['a', 'b'], ['a', 'b']),
                      (('a', 'b'), ['a', 'b']),
-                     ((1, 2), ['1', '2'])),
-            'fail': ((dict(), ValueError),
-                     (1, ValueError),)
-            },
+                     (iter(['a', 'b']), ['a', 'b']),
+                     (np.array(['a', 'b']), ['a', 'b']),
+                     ((1, 2), ['1', '2']),
+                     (np.array([1, 2]), ['1', '2']),
+                    ),
+         'fail': ((dict(), ValueError),
+                  (1, ValueError),
+                 )
+        },
         {'validator': validate_nseq_int(2),
          'success': ((_, [1, 2])
                      for _ in ('1, 2', [1.5, 2.5], [1, 2],
@@ -353,6 +358,8 @@ def test_validators():
                      (['', 'g', 'blue'], ['g', 'blue']),
                      ([np.array([1, 0, 0]), np.array([0, 1, 0])],
                          np.array([[1, 0, 0], [0, 1, 0]])),
+                     (np.array([[1, 0, 0], [0, 1, 0]]),
+                         np.array([[1, 0, 0], [0, 1, 0]])),
                     ),
          'fail': (('fish', ValueError),
                  ),
