textcolor: included tests for markeredgecolor and markerfacecolor

DanHickstein · DanHickstein · commit 1403335eec2b · 2020-01-08T22:22:40.000-07:00
diff --git a/doc/users/next_whats_new/2019-12-09-legend-textcolor.rst b/doc/users/next_whats_new/2019-12-09-legend-textcolor.rst
@@ -2,9 +2,15 @@ Textcolor for legend labels
 ---------------------------
 
 The text color of legend labels can now be set by passing a parameter 
-``textcolor`` to `~.axes.Axes.legend`. The ``textcolor`` keyword can be 
-either a single color, which adjusts the color of all of labels. Alternatively, 
-it can be a list or tuple, allowing the color of the label texts to be set 
-individually. Finally, it can be set to ``linecolor``, ``markerfacecolor``, or 
-``markeredgecolor`` so that the label text can be set to the colors of the lines
-or markers. 
+``textcolor`` to `~.axes.Axes.legend`. The ``textcolor`` keyword can be:
+ 
+* A single color (either a string or RGBA tuple), which adjusts the color of 
+  all of labels.
+* A list or tuple, allowing the color of each label text to be set 
+  individually. 
+* ``linecolor``, which sets the color of each label to match the corresponding 
+  line color.
+* ``markerfacecolor``, which sets the color of each label to match the 
+  corresponding marker face color 
+* ``markeredgecolor``,  which sets the color of each label to match the 
+  corresponding marker edge color
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -21,9 +21,10 @@
 information.
 """
 
+import itertools
 import logging
 import time
-import itertools
+
 import numpy as np
 
 from matplotlib import rcParams
@@ -178,10 +179,8 @@ def _update_bbox_to_anchor(self, loc_in_canvas):
 textcolor : str or list
     Sets the color of the text in the legend. Can be a valid color string
     (for example, 'red'), or a list of color strings. The textcolor can
-    also be made to match the color of the line or marker using the following:
-    line color ('linecolor'),
-    marker face color ('markerfacecolor' or 'mfc')
-    marker edge color ('markeredgecolor' or 'mec')
+    also be made to match the color of the line or marker using 'linecolor', 
+    'markerfacecolor' (or 'mfc'), or 'markeredgecolor' (or 'mec').
 
 numpoints : int, default: :rc:`legend.numpoints`
     The number of marker points in the legend when creating a legend
@@ -548,11 +547,11 @@ def __init__(self, parent, handles, labels,
         # set the text color
 
         color_getters = {  # getter function depends on line or patch
-            'linecolor':       ['get_color', 'get_facecolor'],
+            'linecolor':       ['get_color',           'get_facecolor'],
             'markerfacecolor': ['get_markerfacecolor', 'get_facecolor'],
             'mfc':             ['get_markerfacecolor', 'get_facecolor'],
             'markeredgecolor': ['get_markeredgecolor', 'get_edgecolor'],
-            'mec':             ['get_markerfacecolor', 'get_facecolor'],
+            'mec':             ['get_markeredgecolor', 'get_edgecolor'],
         }
         if textcolor is None:
             pass
diff --git a/lib/matplotlib/tests/test_legend.py b/lib/matplotlib/tests/test_legend.py
@@ -541,7 +541,7 @@ def test_legend_textcolor_single():
 
     leg = ax.legend(textcolor='red')
     for text in leg.get_texts():
-        assert (text.get_color() == mpl.colors.to_rgba_array('red')).all
+        assert mpl.colors.same_color(text.get_color(), 'red')
 
 
 def test_legend_textcolor_list():
@@ -553,7 +553,7 @@ def test_legend_textcolor_list():
 
     leg = ax.legend(textcolor=['r', 'g', 'b'])
     for text, color in zip(leg.get_texts(), ['r', 'g', 'b']):
-        assert (text.get_color() == mpl.colors.to_rgba_array(color)).all
+        assert mpl.colors.same_color(text.get_color(), color)
 
 
 def test_legend_textcolor_linecolor():
@@ -568,6 +568,30 @@ def test_legend_textcolor_linecolor():
         assert text.get_color() == color
 
 
+def test_legend_textcolor_markeredgecolor():
+    # test the textcolor for textcolor='markeredgecolor'
+    fig, ax = plt.subplots()
+    ax.plot(np.arange(10), np.arange(10)*1, label='#1', markeredgecolor='r')
+    ax.plot(np.arange(10), np.arange(10)*2, label='#2', markeredgecolor='g')
+    ax.plot(np.arange(10), np.arange(10)*3, label='#3', markeredgecolor='b')
+
+    leg = ax.legend(textcolor='markeredgecolor')
+    for text, color in zip(leg.get_texts(), ['r', 'g', 'b']):
+        assert text.get_color() == color
+
+
+def test_legend_textcolor_markerfacecolor():
+    # test the textcolor for textcolor='markerfacecolor'
+    fig, ax = plt.subplots()
+    ax.plot(np.arange(10), np.arange(10)*1, label='#1', markerfacecolor='r')
+    ax.plot(np.arange(10), np.arange(10)*2, label='#2', markerfacecolor='g')
+    ax.plot(np.arange(10), np.arange(10)*3, label='#3', markerfacecolor='b')
+
+    leg = ax.legend(textcolor='markerfacecolor')
+    for text, color in zip(leg.get_texts(), ['r', 'g', 'b']):
+        assert text.get_color() == color
+
+
 def test_get_set_draggable():
     legend = plt.legend()
     assert not legend.get_draggable()
