Fix the resetting of color cycles

matplotlib · tacaswell · Nov 24, 2015 · Nov 20, 2015 · Nov 20, 2015 · eed693fcbe3ef29bb7f4314782e197c36f10e29d
commit eed693fcbe3ef29bb7f4314782e197c36f10e29d
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1123,7 +1123,13 @@ def set_color_cycle(self, clist):
        """
        cbook.warn_deprecated(
                '1.5', name='set_color_cycle', alternative='set_prop_cycle')
-        self.set_prop_cycle('color', clist)
+        if clist is None:
+            # Calling set_color_cycle() or set_prop_cycle() with None
+            # effectively resets the cycle, but you can't do
+            # set_prop_cycle('color', None). So we are special-casing this.
+            self.set_prop_cycle(None)
+        else:
+            self.set_prop_cycle('color', clist)

    def ishold(self):
        """return the HOLD status of the axes"""

diff --git a/lib/matplotlib/tests/test_cycles.py b/lib/matplotlib/tests/test_cycles.py
@@ -1,3 +1,5 @@
+import warnings
+
 from matplotlib.testing.decorators import image_comparison, cleanup
 import matplotlib.pyplot as plt
 import numpy as np
@@ -147,6 +149,30 @@ def test_valid_input_forms():
    assert True


+@cleanup
+def test_cycle_reset():
+    fig, ax = plt.subplots()
+
+    # Can't really test a reset because only a cycle object is stored
+    # but we can test the first item of the cycle.
+    prop = next(ax._get_lines.prop_cycler)
+    ax.set_prop_cycle(linewidth=[10, 9, 4])
+    assert prop != next(ax._get_lines.prop_cycler)
+    ax.set_prop_cycle(None)
+    got = next(ax._get_lines.prop_cycler)
+    assert prop == got, "expected %s, got %s" % (prop, got)
+
+    fig, ax = plt.subplots()
+    # Need to double-check the old set/get_color_cycle(), too
+    with warnings.catch_warnings():
+        prop = next(ax._get_lines.prop_cycler)
+        ax.set_color_cycle(['c', 'm', 'y', 'k'])
+        assert prop != next(ax._get_lines.prop_cycler)
+        ax.set_color_cycle(None)
+        got = next(ax._get_lines.prop_cycler)
+        assert prop == got, "expected %s, got %s" % (prop, got)
+
+
 @cleanup
 def test_invalid_input_forms():
    fig, ax = plt.subplots()