Merge pull request #14259 from timhoffm/deprecate-str-as-colorsequence

efiring · web-flow · commit a2b1482a08cd · 2019-05-20T09:34:04.000-10:00
Deprecate string as color sequence
diff --git a/doc/api/next_api_changes/2019-05-19-TH.rst b/doc/api/next_api_changes/2019-05-19-TH.rst
@@ -0,0 +1,5 @@
+Deprecations
+````````````
+
+Using a string of single-character colors as a color sequence (e.g. "rgb") is
+deprecated. Use an explicit list instead.
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -286,10 +286,25 @@ def to_rgba_array(c, alpha=None):
         return np.array([to_rgba(c, alpha)], float)
     except (ValueError, TypeError):
         pass
+
     # Convert one at a time.
-    result = np.empty((len(c), 4), float)
-    for i, cc in enumerate(c):
-        result[i] = to_rgba(cc, alpha)
+    if isinstance(c, str):
+        # Single string as color sequence.
+        # This is deprecated and will be removed in the future.
+        try:
+            result = np.array([to_rgba(cc, alpha) for cc in c])
+        except ValueError:
+            raise ValueError(
+                "'%s' is neither a valid single color nor a color sequence "
+                "consisting of single character color specifiers such as "
+                "'rgb'. Note also that the latter is deprecated." % c)
+        else:
+            cbook.warn_deprecated("3.2", message="Using a string of single "
+                                  "character colors as a color sequence is "
+                                  "deprecated. Use an explicit list instead.")
+    else:
+        result = np.array([to_rgba(cc, alpha) for cc in c])
+
     return result
 
 
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -1910,9 +1910,6 @@ def test_scatter_different_shapes(self, fig_test, fig_ref):
         # single string:
         ('0.5', None),
         # Single letter-sequences
-        ("rgby", None),
-        ("rgb", "shape"),
-        ("rgbrgb", "shape"),
         (["rgby"], "conversion"),
         # Special cases
         ("red", None),
@@ -3424,7 +3421,6 @@ def test_eventplot_defaults():
     ('0.5',),  # string color with multiple characters: not OK before #8193 fix
     ('tab:orange', 'tab:pink', 'tab:cyan', 'bLacK'),  # case-insensitive
     ('red', (0, 1, 0), None, (1, 0, 1, 0.5)),  # a tricky case mixing types
-    ('rgbk',)  # len('rgbk') == len(data) and each character is a valid color
 ])
 def test_eventplot_colors(colors):
     '''Test the *colors* parameter of eventplot. Inspired by the issue #8193.
diff --git a/lib/matplotlib/tests/test_colors.py b/lib/matplotlib/tests/test_colors.py
@@ -767,13 +767,32 @@ def test_conversions():
         hex_color
 
 
+def test_to_rgba_array_single_str():
+    # single color name is valid
+    assert_array_equal(mcolors.to_rgba_array("red"), [(1, 0, 0, 1)])
+
+    # single char color sequence is deprecated
+    with pytest.warns(cbook.MatplotlibDeprecationWarning,
+                      match="Using a string of single character colors as a "
+                            "color sequence is deprecated"):
+        array = mcolors.to_rgba_array("rgb")
+    assert_array_equal(array, [(1, 0, 0, 1), (0, 0.5, 0, 1), (0, 0, 1, 1)])
+
+    with pytest.raises(ValueError,
+                       match="neither a valid single color nor a color "
+                             "sequence"):
+        mcolors.to_rgba_array("rgbx")
+
+
 def test_failed_conversions():
     with pytest.raises(ValueError):
         mcolors.to_rgba('5')
     with pytest.raises(ValueError):
         mcolors.to_rgba('-1')
     with pytest.raises(ValueError):
         mcolors.to_rgba('nan')
+    with pytest.raises(ValueError):
+        mcolors.to_rgba('unknown_color')
     with pytest.raises(ValueError):
         # Gray must be a string to distinguish 3-4 grays from RGB or RGBA.
         mcolors.to_rgba(0.4)
