Merge pull request #17580 from timhoffm/same-color-none

jklymak · web-flow · commit 7f66d471bcbc · 2020-06-08T12:20:11.000-07:00
Fix same_color() for 'none' color
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -138,8 +138,22 @@ def is_color_like(c):
 
 
 def same_color(c1, c2):
-    """Return whether the colors *c1* and *c2* are the same."""
-    return (to_rgba_array(c1) == to_rgba_array(c2)).all()
+    """
+    Return whether the colors *c1* and *c2* are the same.
+
+    *c1*, *c2* can be single colors or lists/arrays of colors.
+    """
+    c1 = to_rgba_array(c1)
+    c2 = to_rgba_array(c2)
+    n1 = max(c1.shape[0], 1)  # 'none' results in shape (0, 4), but is 1-elem
+    n2 = max(c2.shape[0], 1)  # 'none' results in shape (0, 4), but is 1-elem
+
+    if n1 != n2:
+        raise ValueError('Different number of elements passed.')
+    # The following shape test is needed to correctly handle comparisons with
+    # 'none', which results in a shape (0, 4) array and thus cannot be tested
+    # via value comparison.
+    return c1.shape == c2.shape and (c1 == c2).all()
 
 
 def to_rgba(c, alpha=None):
diff --git a/lib/matplotlib/tests/test_colors.py b/lib/matplotlib/tests/test_colors.py
@@ -1118,6 +1118,13 @@ def __add__(self, other):
 def test_same_color():
     assert mcolors.same_color('k', (0, 0, 0))
     assert not mcolors.same_color('w', (1, 1, 0))
+    assert mcolors.same_color(['red', 'blue'], ['r', 'b'])
+    assert mcolors.same_color('none', 'none')
+    assert not mcolors.same_color('none', 'red')
+    with pytest.raises(ValueError):
+        mcolors.same_color(['r', 'g', 'b'], ['r'])
+    with pytest.raises(ValueError):
+        mcolors.same_color(['red', 'green'], 'none')
 
 
 def test_hex_shorthand_notation():
