Feature implementation for Issue 2841

jasonliw93 · jasonliw93 · commit e112aefc2b26 · 2015-03-29T17:42:00.000-04:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -2876,7 +2876,7 @@ def xywhere(xs, ys, mask):
 
         if ecolor is None:
             if l0 is None:
-                ecolor = six.next(self._get_lines.color_cycle)
+                ecolor = self._get_lines.cycle.get_next_color()
             else:
                 ecolor = l0.get_color()
 
@@ -5677,7 +5677,7 @@ 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)
+            color = [self._get_lines.cycle.get_next_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
@@ -29,6 +29,8 @@
 import matplotlib.font_manager as font_manager
 import matplotlib.text as mtext
 import matplotlib.image as mimage
+import matplotlib.cycle as mcycle
+
 from matplotlib.artist import allow_rasterization
 from matplotlib.cbook import iterable
 
@@ -137,20 +139,15 @@ class _process_plot_var_args(object):
     def __init__(self, axes, command='plot'):
         self.axes = axes
         self.command = command
-        self.set_color_cycle()
+        self.cycle = mcycle.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_color_cycle()
-
-    def set_color_cycle(self, clist=None):
-        if clist is None:
-            clist = rcParams['axes.color_cycle']
-        self.color_cycle = itertools.cycle(clist)
+        self.cycle.set_color_cycle()
 
     def __call__(self, *args, **kwargs):
 
@@ -229,12 +226,10 @@ def _xy_from_xy(self, x, y):
         return x, y
 
     def _makeline(self, x, y, kw, kwargs):
-        kw = kw.copy()  # Don't modify the original kw.
+        args = self.cycle.next()
+        args.update(kw)
+        kw = args.copy()  # Don't modify the original kw.
         kwargs = kwargs.copy()
-        if kw.get('color', None) is None and kwargs.get('color', None) is None:
-            kwargs['color'] = kw['color'] = six.next(self.color_cycle)
-            # (can't use setdefault because it always evaluates
-            # its second argument)
         seg = mlines.Line2D(x, y,
                             **kw
                             )
@@ -245,7 +240,7 @@ def _makefill(self, x, y, kw, kwargs):
         try:
             facecolor = kw['color']
         except KeyError:
-            facecolor = six.next(self.color_cycle)
+            facecolor = self.cycle.get_next_color()
         seg = mpatches.Polygon(np.hstack((x[:, np.newaxis],
                                           y[:, np.newaxis])),
                                facecolor=facecolor,
@@ -971,14 +966,47 @@ def clear(self):
         """clear the axes"""
         self.cla()
 
+    def set_cycle(self, style, slist):
+        """
+        Set the cycle for a line attribute for any future plot commands
+        on this Axes
+        
+        *style* is a key to a dictionary for cycles in the cycle class
+        *slist* is a list of mpl style specifiers
+        """
+        self._get_lines.cycle.set_cycle(style, slist)
+        
+    def clear_all_cycle(self):
+        """
+        Clear all the current line attribute cycles
+        """
+        self._get_lines.cycle.clear_all_cycle()
+    
+    def clear_cycle(self, style):
+        """
+        Clear a cycle for a line attribute specified by style
+        
+        *style* is a key to a dictionary for cycles in the cycle class
+        """
+        self._get_lines.cycle.clear_cycle(style)
+
     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.
         """
-        self._get_lines.set_color_cycle(clist)
-        self._get_patches_for_fill.set_color_cycle(clist)
+        self._get_lines.cycle.set_color_cycle(clist)
+        self._get_patches_for_fill.cycle.set_color_cycle(clist)
+
+    def set_line_cycle(self, llist):
+        """
+        Set the line style cycle for any future plot commands on this
+        Axes.
+        
+        *llist* is a list of mpl line style specifiers.
+        """
+        self._get_lines.cycle.set_line_cycle(llist)
 
     def ishold(self):
         """return the HOLD status of the axes"""
diff --git a/lib/matplotlib/cycle.py b/lib/matplotlib/cycle.py
@@ -0,0 +1,108 @@
+import itertools
+import six
+from matplotlib import rcParams
+
+
+class Cycle:
+
+    def __init__(self):
+        """
+        Set the initial cycle of styles to be used by the lines of the graph
+        """
+        self._styles = {'color': None,
+                        'linestyle': None,
+                        'linewidth': None,
+                        'marker': None,
+                        'markersize': None,
+                        'markeredgewidth': None,
+                        'markeredgecolor': None,
+                        'markerfacecolor': None,
+                        'antialiased': None,
+                        'dash_capstyle': None,
+                        'solid_capstyle': None,
+                        'dash_joinstyle': None,
+                        'solid_joinstyle': None,
+                        }
+        self.set_color_cycle()
+        self.set_line_cycle()
+
+    def next(self):
+        """
+        Returns the next set of line attributes for a line on the graph to use
+        """
+        args = {}
+        for i in self._styles.keys():
+            if self._styles[i] != None:
+                args[i] = six.next(self._styles[i])
+        return args
+
+    def set_cycle(self, style, slist):
+        """
+        Set a cycle for a line attribute specified by style, the cycle to be
+        used to is specified by slist
+        
+        *style* is a key to the _style dictionary
+        *slist* is a list of mpl style specifiers
+        """
+        if self.validate(style, slist):
+            self._styles[style] = itertools.cycle(slist)
+
+    def validate(self, style, plist):
+        """
+        Ensures that the style given is a valid attribute to by cycled over
+        If the style is a valid cycle, ensure that the list of specifiers
+        given are valid specifiers for that style
+        
+        *style* is a key to the _style dictionary
+        *plist* is a list of mpl style specifiers
+        """
+        if style not in self._styles.keys():
+            raise ValueError(
+                "Set cycle value error, %s is not a valid style" % style)
+        param = 'lines.' + style
+        for val in set(plist):
+            try:
+                rcParams.validate[param](val)
+            except ValueError:
+                raise ValueError(
+                    "Set cycle value error, Style %s: %s" % (style, str(val)))
+        return True
+
+    def clear_cycle(self, style):
+        """
+        Clears(resets) a cycle for a line attribute specified by style
+        
+        *style* is a key to the _style dictionary
+        """
+        self._styles[style] = None
+
+    def clear_all_cycle(self):
+        """
+        Clears (resets) all cycles for the lines on a plot
+        """
+        for style in self._styles.keys():
+            self._styles[style] = None
+
+    def get_next_color(self):
+        """
+        Return the next color to be used by a line
+        """
+        return six.next(self._styles['color'])
+
+    def set_color_cycle(self, clist=None):
+        """
+        Sets a color cycle to be used for the lines on the graph, if none are
+        specified the default color cycle will be used
+        """
+        if clist is None:
+            clist = rcParams['axes.color_cycle']
+        self._styles['color'] = itertools.cycle(clist)
+
+    def set_line_cycle(self, llist=None):
+        """
+        Sets a line style cycle to be used for the lines on the graph, if none are
+        specified the default line style cycle will be used
+        """
+        if llist is None:
+            llist = rcParams['axes.line_cycle']
+        self._styles['linestyle'] = itertools.cycle(llist)
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -234,6 +234,24 @@ def __call__(self, s):
         except ValueError:
             raise ValueError('Could not convert all entries to ints')
 
+def validate_line(s):
+    'return a valid  arg'
+    if s in (None, 'none', 'None', ' ', ''):
+        return 'None'
+        
+    if s in ('-', '--', '-.', ':'):
+        return s
+    
+    raise ValueError("line given not valid")
+
+
+def validate_markercolor(s):
+    'return a valid marker color arg'
+    if s == 'auto':
+        return s
+    else:
+        return validate_color(s)
+
 
 def validate_color(s):
     'return a valid color arg'
@@ -278,6 +296,14 @@ def validate_colorlist(s):
         msg = "'s' must be of type [ string | list | tuple ]"
         raise ValueError(msg)
 
+def validate_linelist(s):
+    'return a list of colorspecs'
+    if isinstance(s, six.string_types):
+        return [validate_line(l.strip()) for l in s.split(',')]
+    else:
+        assert type(s) in [list, tuple]
+        return [validate_line(l) for l in s]
+
 def validate_stringlist(s):
     'return a list'
     if isinstance(s, six.string_types):
@@ -529,6 +555,8 @@ def __call__(self, s):
     'lines.marker':          ['None', six.text_type],     # black
     'lines.markeredgewidth': [0.5, validate_float],
     'lines.markersize':      [6, validate_float],    # markersize, in points
+    'lines.markeredgecolor' : ['auto', validate_markercolor],
+    'lines.markerfacecolor' : ['auto', validate_markercolor],
     'lines.antialiased':     [True, validate_bool],  # antialised (no jaggies)
     'lines.dash_joinstyle':  ['round', validate_joinstyle],
     'lines.solid_joinstyle': ['round', validate_joinstyle],
@@ -637,6 +665,7 @@ def __call__(self, s):
     'axes.color_cycle': [['b', 'g', 'r', 'c', 'm', 'y', 'k'],
                          validate_colorlist],  # cycle of plot
                                                # line colors
+    'axes.line_cycle':[['-'],validate_linelist],
     'axes.xmargin': [0, ValidateInterval(0, 1,
                                          closedmin=True,
                                          closedmax=True)],  # margin added to xaxis
diff --git a/lib/matplotlib/stackplot.py b/lib/matplotlib/stackplot.py
@@ -103,13 +103,13 @@ def stackplot(axes, x, *args, **kwargs):
 
     # Color between x = 0 and the first array.
     r.append(axes.fill_between(x, first_line, stack[0, :],
-                               facecolor=six.next(axes._get_lines.color_cycle),
+                               facecolor=axes._get_lines.cycle.get_next_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.color_cycle)
+        color = axes._get_lines.cycle.get_next_color()
         r.append(axes.fill_between(x, stack[i, :], stack[i + 1, :],
                                    facecolor= color,
                                    label= six.next(labels, None),
diff --git a/lib/matplotlib/streamplot.py b/lib/matplotlib/streamplot.py
@@ -80,7 +80,7 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
         transform = axes.transData
 
     if color is None:
-        color = six.next(axes._get_lines.color_cycle)
+        color = axes._get_lines.get_next_color()
 
     if linewidth is None:
         linewidth = matplotlib.rcParams['lines.linewidth']
