Improvements to property cycler. Closes #5875

WeatherGod · WeatherGod · commit 494531e57aed · 2016-04-06T15:45:31.000-04:00
* Allow key normalization to Cycler objects
* Validation is performed at more entry points
* Requires Cycler v0.9+
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -704,15 +704,7 @@ def cycler(*args, **kwargs):
         if not isinstance(args[0], Cycler):
             raise TypeError("If only one positional argument given, it must "
                             " be a Cycler instance.")
-
-        c = args[0]
-        unknowns = c.keys - (set(_prop_validators.keys()) |
-                             set(_prop_aliases.keys()))
-        if unknowns:
-            # This is about as much validation I can do
-            raise TypeError("Unknown artist properties: %s" % unknowns)
-        else:
-            return Cycler(c)
+        return validate_cycler(args[0])
     elif len(args) == 2:
         pairs = [(args[0], args[1])]
     elif len(args) > 2:
@@ -767,6 +759,17 @@ def validate_cycler(s):
     else:
         raise ValueError("object was not a string or Cycler instance: %s" % s)
 
+    unknowns = cycler_inst.keys - (set(_prop_validators.keys()) |
+                                   set(_prop_aliases.keys()))
+    if unknowns:
+        raise ValueError("Unknown artist properties: %s" % unknowns)
+
+    # Not a full validation, but it'll at least normalize property names
+    # A fuller validation would require v0.10 of cycler.
+    for prop in cycler_inst.keys:
+        norm_prop = _prop_aliases.get(prop, prop)
+        cycler_inst.change_key(prop, norm_prop)
+
     return cycler_inst
 
 
diff --git a/lib/matplotlib/tests/test_cycles.py b/lib/matplotlib/tests/test_cycles.py
@@ -31,7 +31,7 @@ def test_colorcycle_basic():
 def test_marker_cycle():
     fig = plt.figure()
     ax = fig.add_subplot(111)
-    ax.set_prop_cycle(cycler('color', ['r', 'g', 'y']) +
+    ax.set_prop_cycle(cycler('c', ['r', 'g', 'y']) +
                       cycler('marker', ['.', '*', 'x']))
     xs = np.arange(10)
     ys = 0.25 * xs + 2
@@ -47,7 +47,7 @@ def test_marker_cycle():
     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']),
+    ax.set_prop_cycle(c=np.array(['r', 'g', 'y']),
                       marker=iter(['.', '*', 'x']))
     xs = np.arange(10)
     ys = 0.25 * xs + 2
@@ -66,7 +66,7 @@ def test_marker_cycle():
 def test_linestylecycle_basic():
     fig = plt.figure()
     ax = fig.add_subplot(111)
-    ax.set_prop_cycle(cycler('linestyle', ['-', '--', ':']))
+    ax.set_prop_cycle(cycler('ls', ['-', '--', ':']))
     xs = np.arange(10)
     ys = 0.25 * xs + 2
     ax.plot(xs, ys, label='solid', lw=4)
@@ -84,7 +84,7 @@ def test_linestylecycle_basic():
 def test_fillcycle_basic():
     fig = plt.figure()
     ax = fig.add_subplot(111)
-    ax.set_prop_cycle(cycler('color',  ['r', 'g', 'y']) +
+    ax.set_prop_cycle(cycler('c',  ['r', 'g', 'y']) +
                       cycler('hatch', ['xx', 'O', '|-']) +
                       cycler('linestyle', ['-', '--', ':']))
     xs = np.arange(10)
@@ -130,7 +130,7 @@ def test_valid_input_forms():
     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('lw', (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]))
@@ -179,6 +179,11 @@ def test_invalid_input_forms():
             'linewidth', {'1': 1, '2': 2})
     assert_raises((TypeError, ValueError), ax.set_prop_cycle,
             linewidth=1, color='r')
+    assert_raises((TypeError, ValueError), ax.set_prop_cycle, 'foobar', [1, 2])
+    assert_raises((TypeError, ValueError), ax.set_prop_cycle,
+            foobar=[1, 2])
+    assert_raises((TypeError, ValueError), ax.set_prop_cycle,
+            cycler(foobar=[1, 2]))
 
 
 if __name__ == '__main__':
diff --git a/lib/matplotlib/tests/test_rcparams.py b/lib/matplotlib/tests/test_rcparams.py
@@ -321,6 +321,10 @@ def test_validators():
                      ("cycler('c', 'rgb') * cycler('linestyle', ['-', '--'])",
                       (cycler('color', 'rgb') *
                           cycler('linestyle', ['-', '--']))),
+                     (cycler('ls', ['-', '--']),
+                      cycler('linestyle', ['-', '--'])),
+                     (cycler(mew=[2, 5]),
+                      cycler('markeredgewidth', [2, 5])),
                     ),
          # This is *so* incredibly important: validate_cycler() eval's
          # an arbitrary string! I think I have it locked down enough,
@@ -342,6 +346,7 @@ def test_validators():
                   ('cycler("waka", [1, 2, 3])', ValueError),  # not a property
                   ('cycler(c=[1, 2, 3])', ValueError),  # invalid values
                   ("cycler(lw=['a', 'b', 'c'])", ValueError),  # invalid values
+                  (cycler('waka', [1, 3, 5]), ValueError),  # not a property
                  )
         },
         {'validator': validate_hatch,
diff --git a/setupext.py b/setupext.py
@@ -1186,7 +1186,7 @@ def check(self):
         return "using cycler version %s" % cycler.__version__
 
     def get_install_requires(self):
-        return ['cycler']
+        return ['cycler>=0.9']
 
 
 class Dateutil(SetupPackage):
