Getting cycling to work!

WeatherGod · WeatherGod · commit 5fa07f279465 · 2015-08-15T14:45:49.000-04:00
* Sort batch setting of artist properties for consistency
* Improved error notification on bad properties (but still leaves artist in a mixed state...)
* Finer-grained defaults handling in axes._base
* Backwards-compatible fixes to makefill()
* Improved unit test case
* Fixed some situations where color was assumed to be in the cycles.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -900,13 +900,20 @@ def properties(self):
 
     def set(self, **kwargs):
         """
-        A tkstyle set command, pass *kwargs* to set properties
+        A property batch setter. Pass *kwargs* to set properties.
+        Will handle property name collisions (e.g., if both
+        'color' and 'facecolor' are specified, the property
+        with higher priority gets set last).
+
         """
         ret = []
-        for k, v in six.iteritems(kwargs):
+        for k, v in sorted(kwargs.items(), reverse=True):
             k = k.lower()
             funcName = "set_%s" % k
-            func = getattr(self, funcName)
+            func = getattr(self, funcName, None)
+            if func is None:
+               raise TypeError('There is no %s property "%s"' %
+                               (self.__class__.__name__, k))
             ret.extend([func(v)])
         return ret
 
@@ -1406,14 +1413,17 @@ def setp(obj, *args, **kwargs):
     funcvals = []
     for i in range(0, len(args) - 1, 2):
         funcvals.append((args[i], args[i + 1]))
-    funcvals.extend(kwargs.items())
+    funcvals.extend(sorted(kwargs.items(), reverse=True))
 
     ret = []
     for o in objs:
         for s, val in funcvals:
             s = s.lower()
             funcName = "set_%s" % s
-            func = getattr(o, funcName)
+            func = getattr(o, funcName, None)
+            if func is None:
+                raise TypeError('There is no %s property "%s"' %
+                                (o.__class__.__name__, s))
             ret.extend([func(val)])
     return [x for x in cbook.flatten(ret)]
 
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -181,23 +181,16 @@ def __call__(self, *args, **kwargs):
         ret = self._grab_next_args(*args, **kwargs)
         return ret
 
+
     def set_lineprops(self, line, **kwargs):
         assert self.command == 'plot', 'set_lineprops only works with "plot"'
-        for key, val in six.iteritems(kwargs):
-            funcName = "set_%s" % key
-            if not hasattr(line, funcName):
-                raise TypeError('There is no line property "%s"' % key)
-            func = getattr(line, funcName)
-            func(val)
+        line.set(**kwargs)
+
 
     def set_patchprops(self, fill_poly, **kwargs):
         assert self.command == 'fill', 'set_patchprops only works with "fill"'
-        for key, val in six.iteritems(kwargs):
-            funcName = "set_%s" % key
-            if not hasattr(fill_poly, funcName):
-                raise TypeError('There is no patch property "%s"' % key)
-            func = getattr(fill_poly, funcName)
-            func(val)
+        fill_poly.set(**kwargs)
+
 
     def _xy_from_xy(self, x, y):
         if self.axes.xaxis is not None and self.axes.yaxis is not None:
@@ -235,37 +228,79 @@ def _xy_from_xy(self, x, y):
             y = y[:, np.newaxis]
         return x, y
 
-    def _setdefaults(self, kw, kwargs):
-        # Only advance the cycler if the cycler
-        # has information that is not specified
-        # in the supplied kw and kwargs dicts
-        if any([kw.get(k, None) is None and kwargs.get(k, None) is None
-                for k in self._prop_keys]):
+
+    def _getdefaults(self, *kwargs):
+        """
+        Only advance the cycler if the cycler has information that
+        is not specified in any of the supplied tuple of dicts
+
+        Returns a dictionary or None.
+
+        """
+        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)
         else:
             default_dict = None
+        return default_dict
+
+
+    def _setdefaults(self, default_dict, *kwargs):
+        """
+        Given a defaults dictionary (or None), and a other dictionaries,
+        update the other dictionaries with information in defaults if
+        none of the other dictionaries contains that information.
+
+        """
+        if default_dict is None:
+            return
+        for k in default_dict:
+            if all([kw.get(k, None) is None for kw in kwargs]):
+                for kw in kwargs:
+                    kw[k] = default_dict[k]
 
-        for k in self._prop_keys:
-            if (default_dict is not None and
-                    kw.get(k, None) is None and
-                    kwargs.get(k, None) is None):
-                kwargs[k] = kw[k] = default_dict[k]
 
     def _makeline(self, x, y, kw, kwargs):
         kw = kw.copy()  # Don't modify the original kw.
         kwargs = kwargs.copy()
-        self._setdefaults(kw, kwargs)
+        default_dict = self._getdefaults(kw, kwargs)
+        self._setdefaults(default_dict, kw, kwargs)
         seg = mlines.Line2D(x, y, **kw)
         self.set_lineprops(seg, **kwargs)
         return seg
 
+
     def _makefill(self, x, y, kw, kwargs):
         kw = kw.copy()  # Don't modify the original kw.
         kwargs = kwargs.copy()
-        # Might be problematic with fallback names such as
-        # 'facecolor' and such. Possibly fixed by traitlets?
-        self._setdefaults(kw, kwargs)
+
+        # 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)
+        self._setdefaults(default_dict, kw)
+
+        # Looks like we don't want "color" to be interpreted to
+        # mean both facecolor and edgecolor for some reason.
+        # So the "kw" dictionary is thrown out, and only its
+        # 'color' value is kept and translated as a 'facecolor'.
+        # This design should probably be revisited as it increases
+        # complexity.
         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!
+        if default_dict is not None:
+            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)
+
         seg = mpatches.Polygon(np.hstack((x[:, np.newaxis],
                                           y[:, np.newaxis])),
                                facecolor=facecolor,
@@ -274,6 +309,7 @@ def _makefill(self, x, y, kw, kwargs):
         self.set_patchprops(seg, **kwargs)
         return seg
 
+
     def _plot_args(self, tup, kwargs):
         ret = []
         if len(tup) > 1 and is_string_like(tup[-1]):
diff --git a/lib/matplotlib/stackplot.py b/lib/matplotlib/stackplot.py
@@ -102,16 +102,23 @@ def stackplot(axes, x, *args, **kwargs):
         raise ValueError(errstr)
 
     # Color between x = 0 and the first array.
+    if 'color' in axes._get_lines._prop_keys:
+        color = six.next(axes._get_lines.prop_cycler)['color']
+    else:
+        color = None
     r.append(axes.fill_between(x, first_line, stack[0, :],
-                               facecolor=six.next(axes._get_lines.prop_cycler)['color'],
+                               facecolor=color,
                                label= six.next(labels, None),
                                **kwargs))
 
     # Color between array i-1 and array i
     for i in xrange(len(y) - 1):
-        color = six.next(axes._get_lines.prop_cycler)['color']
+        if 'color' in axes._get_lines._prop_keys:
+            color = six.next(axes._get_lines.prop_cycler)['color']
+        else:
+            color = None
         r.append(axes.fill_between(x, stack[i, :], stack[i + 1, :],
-                                   facecolor= color,
+                                   facecolor=color,
                                    label= six.next(labels, None),
                                    **kwargs))
     return r
diff --git a/lib/matplotlib/streamplot.py b/lib/matplotlib/streamplot.py
@@ -82,7 +82,7 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
     if transform is None:
         transform = axes.transData
 
-    if color is None:
+    if color is None and 'color' in axes._get_lines._prop_keys:
         color = six.next(axes._get_lines.prop_cycler)['color']
 
     if linewidth is None:
diff --git a/lib/matplotlib/tests/baseline_images/test_cycles/fill_cycle_basic.png b/lib/matplotlib/tests/baseline_images/test_cycles/fill_cycle_basic.png
diff --git a/lib/matplotlib/tests/test_cycles.py b/lib/matplotlib/tests/test_cycles.py
@@ -45,16 +45,17 @@ def test_fillcycle_basic():
     fig = plt.figure()
     ax = fig.add_subplot(111)
     ax.set_prop_cycle(cycler('color',  ['r', 'g', 'y']) +
-                      cycler('hatch', ['xx', 'O', '|-']))
+                      cycler('hatch', ['xx', 'O', '|-']) +
+                      cycler('linestyle', ['-', '--', ':']))
     xs = np.arange(10)
     ys = 0.25 * xs**.5 + 2
-    ax.fill(xs, ys, label='red, x', facecolor='none')
+    ax.fill(xs, ys, label='red, x')
     ys = 0.45 * xs**.5 + 3
-    ax.fill(xs, ys, label='green, circle', facecolor='none')
+    ax.fill(xs, ys, label='green, circle')
     ys = 0.65 * xs**.5 + 4
-    ax.fill(xs, ys, label='yellow, cross', facecolor='none')
+    ax.fill(xs, ys, label='yellow, cross')
     ys = 0.85 * xs**.5 + 5
-    ax.fill(xs, ys, label='red2, x2', facecolor='none')
+    ax.fill(xs, ys, label='red2, xx')
     ax.legend(loc='upper left')
 
 
