Run exising polygon selector tests with draw_box=True

Run exising polygon selector tests with draw_box=True

Author: dstansby

lib/matplotlib/tests/test_widgets.py

@@ -1,3 +1,5 @@
+import functools
+
 from matplotlib._api.deprecation import MatplotlibDeprecationWarning
 import matplotlib.colors as mcolors
 import matplotlib.widgets as widgets
@@ -1112,7 +1114,8 @@ def test_range_slider(orientation):
     assert_allclose(slider.val, [0.1, 0.34])
 
 
-def check_polygon_selector(event_sequence, expected_result, selections_count):
+def check_polygon_selector(event_sequence, expected_result, selections_count,
+                           **kwargs):
     """
     Helper function to test Polygon Selector.
 
@@ -1129,6 +1132,8 @@ def check_polygon_selector(event_sequence, expected_result, selections_count):
     selections_count : int
         Wait for the tool to call its `onselect` function `selections_count`
         times, before comparing the result to the `expected_result`
+    kwargs :
+        Keyword arguments are passed to PolygonSelector.
     """
     ax = get_ax()
 
@@ -1138,7 +1143,7 @@ def onselect(vertices):
         ax._selections_count += 1
         ax._current_result = vertices
 
-    tool = widgets.PolygonSelector(ax, onselect)
+    tool = widgets.PolygonSelector(ax, onselect, **kwargs)
 
     for (etype, event_args) in event_sequence:
         do_event(tool, etype, **event_args)
@@ -1159,14 +1164,18 @@ def polygon_remove_vertex(xdata, ydata):
             ('release', dict(xdata=xdata, ydata=ydata, button=3))]
 
 
-def test_polygon_selector():
+@pytest.mark.parametrize('draw_box', [False, True])
+def test_polygon_selector(draw_box):
+    check_selector = functools.partial(
+        check_polygon_selector, draw_box=draw_box)
+
     # Simple polygon
     expected_result = [(50, 50), (150, 50), (50, 150)]
     event_sequence = (polygon_place_vertex(50, 50)
                       + polygon_place_vertex(150, 50)
                       + polygon_place_vertex(50, 150)
                       + polygon_place_vertex(50, 50))
-    check_polygon_selector(event_sequence, expected_result, 1)
+    check_selector(event_sequence, expected_result, 1)
 
     # Move first vertex before completing the polygon.
     expected_result = [(75, 50), (150, 50), (50, 150)]
@@ -1180,7 +1189,7 @@ def test_polygon_selector():
                          ('on_key_release', dict(key='control'))]
                       + polygon_place_vertex(50, 150)
                       + polygon_place_vertex(75, 50))
-    check_polygon_selector(event_sequence, expected_result, 1)
+    check_selector(event_sequence, expected_result, 1)
 
     # Move first two vertices at once before completing the polygon.
     expected_result = [(50, 75), (150, 75), (50, 150)]
@@ -1194,7 +1203,7 @@ def test_polygon_selector():
                          ('on_key_release', dict(key='shift'))]
                       + polygon_place_vertex(50, 150)
                       + polygon_place_vertex(50, 75))
-    check_polygon_selector(event_sequence, expected_result, 1)
+    check_selector(event_sequence, expected_result, 1)
 
     # Move first vertex after completing the polygon.
     expected_result = [(75, 50), (150, 50), (50, 150)]
@@ -1206,7 +1215,7 @@ def test_polygon_selector():
                          ('press', dict(xdata=50, ydata=50)),
                          ('onmove', dict(xdata=75, ydata=50)),
                          ('release', dict(xdata=75, ydata=50))])
-    check_polygon_selector(event_sequence, expected_result, 2)
+    check_selector(event_sequence, expected_result, 2)
 
     # Move all vertices after completing the polygon.
     expected_result = [(75, 75), (175, 75), (75, 175)]
@@ -1220,7 +1229,7 @@ def test_polygon_selector():
                          ('onmove', dict(xdata=125, ydata=125)),
                          ('release', dict(xdata=125, ydata=125)),
                          ('on_key_release', dict(key='shift'))])
-    check_polygon_selector(event_sequence, expected_result, 2)
+    check_selector(event_sequence, expected_result, 2)
 
     # Try to move a vertex and move all before placing any vertices.
     expected_result = [(50, 50), (150, 50), (50, 150)]
@@ -1240,7 +1249,7 @@ def test_polygon_selector():
                       + polygon_place_vertex(150, 50)
                       + polygon_place_vertex(50, 150)
                       + polygon_place_vertex(50, 50))
-    check_polygon_selector(event_sequence, expected_result, 1)
+    check_selector(event_sequence, expected_result, 1)
 
     # Try to place vertex out-of-bounds, then reset, and start a new polygon.
     expected_result = [(50, 50), (150, 50), (50, 150)]
@@ -1252,10 +1261,11 @@ def test_polygon_selector():
                       + polygon_place_vertex(150, 50)
                       + polygon_place_vertex(50, 150)
                       + polygon_place_vertex(50, 50))
-    check_polygon_selector(event_sequence, expected_result, 1)
+    check_selector(event_sequence, expected_result, 1)
 
 
-def test_polygon_selector_set_props_handle_props():
+@pytest.mark.parametrize('draw_box', [False, True])
+def test_polygon_selector_set_props_handle_props(draw_box):
     ax = get_ax()
 
     ax._selections_count = 0
@@ -1266,7 +1276,8 @@ def onselect(vertices):
 
     tool = widgets.PolygonSelector(ax, onselect,
                                    props=dict(color='b', alpha=0.2),
-                                   handle_props=dict(alpha=0.5))
+                                   handle_props=dict(alpha=0.5),
+                                   draw_box=draw_box)
 
     event_sequence = (polygon_place_vertex(50, 50)
                       + polygon_place_vertex(150, 50)
@@ -1308,7 +1319,8 @@ def onselect(verts):
 
 # Change the order that the extra point is inserted in
 @pytest.mark.parametrize('idx', [1, 2, 3])
-def test_polygon_selector_remove(idx):
+@pytest.mark.parametrize('draw_box', [False, True])
+def test_polygon_selector_remove(idx, draw_box):
     verts = [(50, 50), (150, 50), (50, 150)]
     event_sequence = [polygon_place_vertex(*verts[0]),
                       polygon_place_vertex(*verts[1]),
@@ -1321,20 +1333,22 @@ def test_polygon_selector_remove(idx):
     event_sequence.append(polygon_remove_vertex(200, 200))
     # Flatten list of lists
     event_sequence = sum(event_sequence, [])
-    check_polygon_selector(event_sequence, verts, 2)
+    check_polygon_selector(event_sequence, verts, 2, draw_box=draw_box)
 
 
-def test_polygon_selector_remove_first_point():
+@pytest.mark.parametrize('draw_box', [False, True])
+def test_polygon_selector_remove_first_point(draw_box):
     verts = [(50, 50), (150, 50), (50, 150)]
     event_sequence = (polygon_place_vertex(*verts[0]) +
                       polygon_place_vertex(*verts[1]) +
                       polygon_place_vertex(*verts[2]) +
                       polygon_place_vertex(*verts[0]) +
                       polygon_remove_vertex(*verts[0]))
-    check_polygon_selector(event_sequence, verts[1:], 2)
+    check_polygon_selector(event_sequence, verts[1:], 2, draw_box=draw_box)
 
 
-def test_polygon_selector_redraw():
+@pytest.mark.parametrize('draw_box', [False, True])
+def test_polygon_selector_redraw(draw_box):
     verts = [(50, 50), (150, 50), (50, 150)]
     event_sequence = (polygon_place_vertex(*verts[0]) +
                       polygon_place_vertex(*verts[1]) +
@@ -1352,7 +1366,7 @@ def test_polygon_selector_redraw():
     def onselect(vertices):
         pass
 
-    tool = widgets.PolygonSelector(ax, onselect)
+    tool = widgets.PolygonSelector(ax, onselect, draw_box=draw_box)
     for (etype, event_args) in event_sequence:
         do_event(tool, etype, **event_args)
     # After removing two verts, only one remains, and the