Pass boxplots labels param to legend & update test

saranti · saranti · commit b20b1d817db4 · 2024-01-06T19:14:42.000+11:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -4007,6 +4007,9 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
             if 'color' in boxprops:
                 boxprops['edgecolor'] = boxprops.pop('color')
 
+        if labels:
+            boxprops['label'] = labels
+
         # if non-default sym value, put it into the flier dictionary
         # the logic for providing the default symbol ('b+') now lives
         # in bxp in the initial value of flierkw
diff --git a/lib/matplotlib/tests/test_legend.py b/lib/matplotlib/tests/test_legend.py
@@ -1393,15 +1393,33 @@ def test_legend_nolabels_draw():
     assert plt.gca().get_legend() is not None
 
 
-def test_legend_key_patch():
-    """Test that legend key entries are patches"""
+def test_boxplot_legend():
+    # Test that boxplot legends handles are patches
+    # and labels are generated from boxplot's labels parameter.
     fig, axs = plt.subplots()
     A = 5*np.random.rand(100, 1)
     B = 10*np.random.rand(100, 1) - 5
     C = 7*np.random.rand(100, 1) - 5
-    bp0 = axs.boxplot(A, positions=[0], patch_artist=True)
-    bp1 = axs.boxplot(B, positions=[1], patch_artist=True)
-    bp2 = axs.boxplot(C, positions=[2], patch_artist=True)
-    legend = axs.legend(['A', 'B', 'C'])
+    labels = ['a', 'b', 'c']
+
+    bp0 = axs.boxplot(A, positions=[0], patch_artist=True, labels=labels[0])
+    bp1 = axs.boxplot(B, positions=[1], patch_artist=True, labels=labels[1])
+    bp2 = axs.boxplot(C, positions=[2], patch_artist=True, labels=labels[2])
+    # red, blue, green
+    colors = [(1.0, 0.0, 0.0, 1), (0.0, 0.0, 1.0, 1), (0.0, 0.5, 0.0, 1)]
+    box_list = [bp0, bp1, bp2]
+    # Set colors to the boxes
+    lbl_index = 0
+    for b_plot, color in zip(box_list, colors):
+        for patch in b_plot['boxes']:
+            patch.set_color(color)
+            lbl_index += 1
+
+    legend = axs.legend()
+    index = 0
     for i in legend.legend_handles:
         assert isinstance(i, mpl.patches.Rectangle)
+        assert i.get_facecolor() == colors[index]
+        assert i.get_edgecolor() == colors[index]
+        assert i.get_label() == labels[index]
+        index += 1
