added unit tests, edited legend.py for pep8 compliance

RiazCharania · Mar 9, 2020 · Mar 9, 2020 · Mar 9, 2020 · Mar 9, 2020 · Mar 9, 2020
commit 732b5c434b5268dea0cd950fb77f4068ff5763c5
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -840,7 +840,7 @@ def _auto_legend_data(self):
                 offsets.append(offset)
 
         texts = [text.get_window_extent()
-                    for text in ax.texts]
+                 for text in ax.texts]
 
         return bboxes, lines, offsets, texts
 
@@ -1031,12 +1031,12 @@ def _find_best_position(self, width, height, renderer, consider=None):
             # XXX TODO: If markers are present, it would be good to take them
             # into account when checking vertex overlaps in the next line.
             badness = (sum(legendBox.count_contains(line.vertices)
-                           for line in lines)
-                       + legendBox.count_contains(offsets)
-                       + legendBox.count_overlaps(bboxes)
-                       + legendBox.count_overlaps(texts)
-                       + sum(line.intersects_bbox(legendBox, filled=False)
-                             for line in lines))
+                           for line in lines) +
+                       legendBox.count_contains(offsets) +
+                       legendBox.count_overlaps(bboxes) +
+                       legendBox.count_overlaps(texts) +
+                       sum(line.intersects_bbox(legendBox, filled=False)
+                           for line in lines))
             if badness == 0:
                 return l, b
             # Include the index to favor lower codes in case of a tie.

diff --git a/lib/matplotlib/tests/test_legend.py b/lib/matplotlib/tests/test_legend.py
@@ -570,3 +570,38 @@ def test_no_warn_big_data_when_loc_specified():
         ax.plot(np.arange(5000), label=idx)
     legend = ax.legend('best')
     fig.draw_artist(legend)  # Check that no warning is emitted.
+
+
+def test_overlap_no_texts():
+    # test there is no error without text
+    fig, ax = plt.subplots()
+    fig.canvas.draw()
+    legend = ax.legend()
+    fig.draw_artist(legend)
+
+
+def test_overlap_one_text():
+    # test legend doesn't overlap with one text
+    fig, ax = plt.subplots()
+    fig.canvas.draw()
+    ax.text(1, 0, "Text")
+    legend = ax.legend()
+    fig.draw_artist(legend)
+    texts = [text.get_window_extent()
+             for text in ax.texts]
+
+    assert legend.get_window_extent().count_overlaps(texts) == 0
+
+
+def test_overlap_two_texts():
+    # test legend doesn't overlap with two texts
+    fig, ax = plt.subplots()
+    fig.canvas.draw()
+    ax.text(1, 0, "Text")
+    ax.text(0, 1, "Text")
+    legend = ax.legend()
+    fig.draw_artist(legend)
+    texts = [text.get_window_extent()
+             for text in ax.texts]
+
+    assert legend.get_window_extent().count_overlaps(texts) == 0