* Fix cycler advance bug (and added test)

WeatherGod · WeatherGod · commit f3e8394851f9 · 2015-08-17T14:31:30.000-04:00
* Normalize aliases
* defaults cycling will ignore properties that are
  not relevant to the particular artist.
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -225,21 +225,32 @@ def _xy_from_xy(self, x, y):
             y = y[:, np.newaxis]
         return x, y
 
-    def _getdefaults(self, *kwargs):
+    def _getdefaults(self, ignore, *kwargs):
         """
         Only advance the cycler if the cycler has information that
-        is not specified in any of the supplied tuple of dicts
+        is not specified in any of the supplied tuple of dicts.
+        Ignore any keys specified in the `ignore` set.
 
-        Returns a dictionary of defaults if there are any
+        Returns a copy of defaults dictionary if there are any
         keys that are not found in any of the supplied dictionaries.
         If the supplied dictionaries have non-None values for
         everything the property cycler has, then just return
-        an empty dictionary.
-
-        """
-        if any([all([kw.get(k, None) is None for kw in kwargs])
-               for k in self._prop_keys]):
-            default_dict = six.next(self.prop_cycler)
+        an empty dictionary. Ignored keys are excluded from the
+        returned dictionary.
+
+        """
+        prop_keys = self._prop_keys
+        if ignore is None:
+            ignore = set([])
+        prop_keys = prop_keys - ignore
+
+        if any(all(kw.get(k, None) is None for kw in kwargs)
+               for k in prop_keys):
+            # Need to copy this dictionary or else the next time around
+            # in the cycle, the dictionary could be missing entries.
+            default_dict = six.next(self.prop_cycler).copy()
+            for p in ignore:
+                default_dict.pop(p, None)
         else:
             default_dict = {}
         return default_dict
@@ -252,14 +263,14 @@ def _setdefaults(self, defaults, *kwargs):
 
         """
         for k in defaults:
-            if all([kw.get(k, None) is None for kw in kwargs]):
+            if all(kw.get(k, None) is None for kw in kwargs):
                 for kw in kwargs:
                     kw[k] = defaults[k]
 
     def _makeline(self, x, y, kw, kwargs):
         kw = kw.copy()  # Don't modify the original kw.
         kwargs = kwargs.copy()
-        default_dict = self._getdefaults(kw, kwargs)
+        default_dict = self._getdefaults(None, kw, kwargs)
         self._setdefaults(default_dict, kw, kwargs)
         seg = mlines.Line2D(x, y, **kw)
         self.set_lineprops(seg, **kwargs)
@@ -269,11 +280,26 @@ def _makefill(self, x, y, kw, kwargs):
         kw = kw.copy()  # Don't modify the original kw.
         kwargs = kwargs.copy()
 
+        # Ignore 'marker'-related properties as they aren't Polygon
+        # properties, but they are Line2D properties, and so they are
+        # likely to appear in the default cycler construction. 
+        # This is done here to the defaults dictionary as opposed to the
+        # other two dictionaries because we do want to capture when a
+        # *user* explicitly specifies a marker which should be an error.
+        # We also want to prevent advancing the cycler if there are no
+        # defaults needed after ignoring the given properties.
+        ignores = set(['marker', 'markersize', 'markeredgecolor',
+                       'markerfacecolor', 'markeredgewidth'])
+        # Also ignore anything provided by *kwargs*.
+        for k, v in six.iteritems(kwargs):
+            if v is not None:
+                ignores.add(k)
+
         # Only using the first dictionary to use as basis
         # for getting defaults for back-compat reasons.
         # Doing it with both seems to mess things up in
         # various places (probably due to logic bugs elsewhere).
-        default_dict = self._getdefaults(kw)
+        default_dict = self._getdefaults(ignores, kw)
         self._setdefaults(default_dict, kw)
 
         # Looks like we don't want "color" to be interpreted to
@@ -285,12 +311,9 @@ def _makefill(self, x, y, kw, kwargs):
         facecolor = kw.get('color', None)
 
         # Throw out 'color' as it is now handled as a facecolor
-        # Need to copy this dictionary or else the next time around
-        # in the cycle, the dictionary will be missing this entry
-        # completely!
-        default_dict = default_dict.copy()
         default_dict.pop('color', None)
 
+
         # To get other properties set from the cycler
         # modify the kwargs dictionary.
         self._setdefaults(default_dict, kwargs)
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -593,8 +593,6 @@ def __call__(self, s):
         'markeredgewidth': validate_floatlist,
         'markeredgecolor': validate_colorlist,
         'alpha': validate_floatlist,
-        # No, this isn't a "property", but how long do you think it
-        # will be before someone requests support for cycling markers?
         'marker': validate_stringlist,
     }
 _prop_aliases = {
@@ -621,7 +619,9 @@ def _cycler_wrap(prop, vals):
     if validator is None:
         raise TypeError("Unknown artist property: %s" % prop)
     vals = validator(vals)
-    return cycler(prop, vals)
+    # We will normalize the property names as well to reduce
+    # the amount of alias handling code elsewhere.
+    return cycler(norm_prop, vals)
 
 def validate_cycler(s):
     'return a cycler object from a string repr or the object itself'
diff --git a/lib/matplotlib/tests/baseline_images/test_cycles/fill_cycle_ignore.png b/lib/matplotlib/tests/baseline_images/test_cycles/fill_cycle_ignore.png
diff --git a/lib/matplotlib/tests/test_cycles.py b/lib/matplotlib/tests/test_cycles.py
@@ -80,6 +80,30 @@ def test_fillcycle_basic():
     ax.legend(loc='upper left')
 
 
+@image_comparison(baseline_images=['fill_cycle_ignore'], remove_text=True,
+                  extensions=['png'])
+def test_fillcycle_ignore():
+    fig = plt.figure()
+    ax = fig.add_subplot(111)
+    ax.set_prop_cycle(cycler('color',  ['r', 'g', 'y']) +
+                      cycler('hatch', ['xx', 'O', '|-']) +
+                      cycler('marker', ['.', '*', 'D']))
+    xs = np.arange(10)
+    ys = 0.25 * xs**.5 + 2
+    # Should not advance the cycler, even though there is an
+    # unspecified property in the cycler "marker".
+    # "marker" is not a Polygon property, and should be ignored.
+    ax.fill(xs, ys, 'r', hatch='xx', label='red, xx')
+    ys = 0.45 * xs**.5 + 3
+    # Allow the cycler to advance, but specify some properties
+    ax.fill(xs, ys, hatch='O', label='red, circle')
+    ys = 0.65 * xs**.5 + 4
+    ax.fill(xs, ys, label='green, circle')
+    ys = 0.85 * xs**.5 + 5
+    ax.fill(xs, ys, label='yellow, cross')
+    ax.legend(loc='upper left')
+
+
 if __name__ == '__main__':
     import nose
     nose.runmodule(argv=['-s', '--with-doctest'], exit=False)
