Initial implementation of property cycling

WeatherGod · WeatherGod · commit 6b2223d64630 · 2015-08-15T14:45:48.000-04:00
* Changed name from style cycling to property cycling
* Still not working for bar plots, though.
* Need to test errorbars.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1265,9 +1265,9 @@ def plot(self, *args, **kwargs):
 
         Return value is a list of lines that were added.
 
-        By default, each line is assigned a different color specified by a
-        'color cycle'.  To change this behavior, you can edit the
-        axes.color_cycle rcParam.
+        By default, each line is assigned a different style specified by a
+        'style cycle'.  To change this behavior, you can edit the
+        axes.prop_cycle rcParam.
 
         The following format string characters are accepted to control
         the line style or marker:
@@ -2935,8 +2935,8 @@ def xywhere(xs, ys, mask):
             l0, = self.plot(x, y, fmt, **kwargs)
 
         if ecolor is None:
-            if l0 is None:
-                ecolor = six.next(self._get_lines.color_cycle)
+            if l0 is None and 'color' in self._get_lines._prop_keys:
+                ecolor = six.next(self._get_lines.prop_cycle)['color']
             else:
                 ecolor = l0.get_color()
 
@@ -5829,8 +5829,8 @@ def hist(self, x, bins=10, range=None, normed=False, weights=None,
 
         nx = len(x)  # number of datasets
 
-        if color is None:
-            color = [six.next(self._get_lines.color_cycle)
+        if color is None and 'color' in self._get_lines._prop_keys:
+            color = [six.next(self._get_lines.prop_cycle)['color']
                      for i in xrange(nx)]
         else:
             color = mcolors.colorConverter.to_rgba_array(color)
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -9,7 +9,7 @@
 import math
 from operator import itemgetter
 
-from cycler import cycler
+from cycler import cycler, Cycler
 import numpy as np
 from numpy import ma
 
@@ -139,25 +139,25 @@ class _process_plot_var_args(object):
     def __init__(self, axes, command='plot'):
         self.axes = axes
         self.command = command
-        self.set_style_cycle()
+        self.set_prop_cycle()
 
     def __getstate__(self):
         # note: it is not possible to pickle a itertools.cycle instance
         return {'axes': self.axes, 'command': self.command}
 
     def __setstate__(self, state):
         self.__dict__ = state.copy()
-        self.set_style_cycle()
+        self.set_prop_cycle()
 
-    def set_style_cycle(self, style_cycler=None):
-        if style_cycler is None:
-            style_cycler = rcParams['axes.style_cycle']
-            if style_cycler is None and 'axes.color_cycle' in rcParams:
+    def set_prop_cycle(self, prop_cycler=None):
+        if prop_cycler is None:
+            prop_cycler = rcParams['axes.prop_cycle']
+            if prop_cycler is None and 'axes.color_cycle' in rcParams:
                 clist = rcParams['axes.color_cycle']
-                style_cycler = cycler('color', clist)
-        self.style_cycler = itertools.cycle(style_cycler)
+                prop_cycler = cycler('color', clist)
+        self.prop_cycler = itertools.cycle(prop_cycler)
         # Make a copy
-        self._style_keys = list(style_cycler.keys)
+        self._prop_keys = list(prop_cycler.keys)
 
     def __call__(self, *args, **kwargs):
 
@@ -240,12 +240,12 @@ def _setdefaults(self, kw, kwargs):
         # 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._style_keys]):
-            default_dict = six.next(self.style_cycler)
+                for k in self._prop_keys]):
+            default_dict = six.next(self.prop_cycler)
         else:
             default_dict = None
 
-        for k in self._style_keys:
+        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):
@@ -1004,14 +1004,30 @@ def clear(self):
         """clear the axes"""
         self.cla()
 
+    def set_prop_cycle(self, prop_cycle):
+        """
+        Set the prop cycle for any future plot commands on this Axes.
+
+        *prop_cycle* is a :class:Cycler object.
+        Can also be `None` to reset to the cycle defined by the
+        current style.
+        """
+        self._get_lines.set_prop_cycle(prop_cycle)
+        self._get_patches_for_fill.set_prop_cycle(prop_cycle)
+
     def set_color_cycle(self, clist):
         """
         Set the color cycle for any future plot commands on this Axes.
 
         *clist* is a list of mpl color specifiers.
+
+        .. deprecated:: 1.5
         """
-        self._get_lines.set_color_cycle(clist)
-        self._get_patches_for_fill.set_color_cycle(clist)
+        cbook.warn_deprecated(
+                '1.5', name='set_color_cycle', alternative='set_prop_cycle')
+        prop_cycler = cycler('color', clist)
+        self._get_lines.set_prop_cycle(prop_cycler)
+        self._get_patches_for_fill.set_prop_cycle(prop_cycler)
 
     def ishold(self):
         """return the HOLD status of the axes"""
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -302,7 +302,7 @@ def validate_color(s):
     raise ValueError('%s does not look like a color arg%s' % (s, msg))
 
 def deprecate_axes_colorcycle(value):
-    warnings.warn("axes.color_cycle is deprecated.  Use axes.style_cycle "
+    warnings.warn("axes.color_cycle is deprecated.  Use axes.prop_cycle "
                   "instead. Will be removed in 2.1.0")
     return validate_colorlist(value)
 
@@ -780,8 +780,8 @@ def __call__(self, s):
     # This entry can be either a cycler object or a
     # string repr of a cycler-object, which gets eval()'ed
     # to create the object.
-    'axes.style_cycle': [cycler('color', 'bgrcmyk'),
-                         validate_cycler],
+    'axes.prop_cycle': [cycler('color', 'bgrcmyk'),
+                        validate_cycler],
     'axes.xmargin': [0, ValidateInterval(0, 1,
                                          closedmin=True,
                                          closedmax=True)],  # margin added to xaxis
