Tests that make_subplots checks spacing against number of rows and cols

nicholas-esterer · nicholas-esterer · commit 2ef6c04ff0dc · 2020-10-16T10:42:42.000-04:00
The tests are failing for some reason like the regex doesn't match when
it should...
diff --git a/packages/python/plotly/plotly/subplots.py b/packages/python/plotly/plotly/subplots.py
@@ -637,6 +637,21 @@ def _checks(item, defaults):
 
     max_subplot_ids = _get_initial_max_subplot_ids()
 
+    # Check to see that number of rows and columns does not conflict with
+    # requested vertical_spacing and horizontal_spacing
+    def _check_row_col_spacing(n, spacing):
+        if (n > 1) and (spacing > (1 / (n - 1))):
+            return False
+        return True
+
+    if not _check_row_col_spacing(rows, vertical_spacing):
+        raise ValueError(
+            "Vertical spacing must be less than or equal to 1 / (rows - 1)."
+        )
+    if not _check_row_col_spacing(cols, horizontal_spacing):
+        raise ValueError(
+            "Horizontal spacing must be less than or equal to 1 / (cols - 1)."
+        )
     # Loop through specs -- (r, c) <-> (row, col)
     for r, spec_row in enumerate(specs):
         for c, spec in enumerate(spec_row):
@@ -1350,9 +1365,9 @@ def _set_trace_grid_reference(trace, layout, grid_ref, row, col, secondary_y=Fal
             raise ValueError(
                 """\
 Trace type '{typ}' is not compatible with subplot type '{subplot_type}'
-at grid position ({row}, {col}) 
+at grid position ({row}, {col})
 
-See the docstring for the specs argument to plotly.subplots.make_subplots 
+See the docstring for the specs argument to plotly.subplots.make_subplots
 for more information on subplot types""".format(
                     typ=trace.type,
                     subplot_type=subplot_refs[0].subplot_type,
diff --git a/packages/python/plotly/plotly/tests/test_core/test_subplots/test_make_subplots.py b/packages/python/plotly/plotly/tests/test_core/test_subplots/test_make_subplots.py
@@ -114,6 +114,19 @@ def test_row_width_not_list_of_correct_numbers(self):
         with self.assertRaises(Exception):
             tls.make_subplots(rows=2, cols=2, row_heights=[1])
 
+    def test_bad_row_spacing(self):
+        with self.assertRaisesRegex(
+            ValueError, "Vertical spacing must be less than or equal to 1 / (rows - 1)."
+        ):
+            tls.make_subplots(rows=3, vertical_spacing=1 / 2 + 1e-6)
+
+    def test_bad_col_spacing(self):
+        with self.assertRaisesRegex(
+            ValueError,
+            "Horizontal spacing must be less than or equal to 1 / (cols - 1).",
+        ):
+            tls.make_subplots(cols=3, horizontal_spacing=1 / 2 + 1e-6)
+
     def test_single_plot(self):
         expected = Figure(
             data=Data(),
