_add_annotation_like now accepts exclude_empty_subplots argument

but this has broken all of the tests.

Author: nicholas-esterer

packages/python/plotly/codegen/figure.py

@@ -541,7 +541,7 @@ def add_{method_prefix}{singular_name}(self"""
             buffer,
             node.child_datatypes,
             prepend_extras=["arg"],
-            append_extras=["row", "col", "secondary_y"],
+            append_extras=["row", "col", "secondary_y", "exclude_empty_subplots"],
         )
 
         prepend_extras = [
@@ -561,6 +561,10 @@ def add_{method_prefix}{singular_name}(self"""
                 f"Subplot column for {singular_name}. If 'all', addresses all columns in the specified row(s).",
             ),
             ("secondary_y", f"Whether to add {singular_name} to secondary y-axis"),
+            (
+                "exclude_empty_subplots",
+                f"If True, {singular_name} will not be added to subplots without traces.",
+            ),
         ]
         add_docstring(
             buffer,
@@ -597,6 +601,7 @@ def add_{method_prefix}{singular_name}(self"""
             row=row,
             col=col,
             secondary_y=secondary_y,
+            exclude_empty_subplots=exclude_empty_subplots,
         )"""
         )
 

packages/python/plotly/plotly/basedatatypes.py

@@ -1208,7 +1208,14 @@ def _select_annotations_like(
             yield obj
 
     def _add_annotation_like(
-        self, prop_singular, prop_plural, new_obj, row=None, col=None, secondary_y=None
+        self,
+        prop_singular,
+        prop_plural,
+        new_obj,
+        row=None,
+        col=None,
+        secondary_y=None,
+        exclude_empty_subplots=False,
     ):
         # Make sure we have both row and col or neither
         if row is not None and col is None:
@@ -1234,6 +1241,7 @@ def _add_annotation_like(
                     row=r,
                     col=c,
                     secondary_y=secondary_y,
+                    exclude_empty_subplots=exclude_empty_subplots,
                 )
             return self
 
@@ -1279,6 +1287,12 @@ def _add_annotation_like(
             else:
                 xaxis, yaxis = refs[0].layout_keys
             xref, yref = xaxis.replace("axis", ""), yaxis.replace("axis", "")
+            # if exclude_empty_subplots is True, check to see if subplot is
+            # empty and return if it is
+            if exclude_empty_subplots and (
+                not self._subplot_contains_trace(xref, yref)
+            ):
+                return self
             # in case the user specified they wanted an axis to refer to the
             # domain of that axis and not the data, append ' domain' to the
             # computed axis accordingly
@@ -3628,9 +3642,7 @@ def _index_is(iterable, val):
 
         return index_list[0]
 
-    def _make_axis_spanning_layout_object(
-        self, direction, shape, none_if_no_trace=True
-    ):
+    def _make_axis_spanning_layout_object(self, direction, shape):
         """
         Convert a shape drawn on a plot or a subplot into one whose yref or xref
         ends with " domain" and has coordinates so that the shape will seem to
@@ -3658,23 +3670,6 @@ def _make_axis_spanning_layout_object(
                 "Bad direction: %s. Permissible values are 'vertical' and 'horizontal'."
                 % (direction,)
             )
-        if none_if_no_trace:
-            # iterate through all the traces and check to see if one with the
-            # same xref and yref pair is there, if not, we return None (we don't
-            # want to draw a shape if there is no trace)
-            if not any(
-                t == (shape["xref"], shape["yref"])
-                for t in [
-                    # if a trace exists but has no xaxis or yaxis keys, then it
-                    # is plotted with xaxis 'x' and yaxis 'y'
-                    (
-                        "x" if d["xaxis"] is None else d["xaxis"],
-                        "y" if d["yaxis"] is None else d["yaxis"],
-                    )
-                    for d in self.data
-                ]
-            ):
-                return None
         # set the ref to "<axis_id> domain" so that its size is based on the
         # axis's size
         shape[ref] += " domain"
@@ -3721,9 +3716,19 @@ def _process_multiple_axis_spanning_shapes(
         augmented_annotation = shapeannotation.axis_spanning_shape_annotation(
             annotation, shape_type, shape_args, annotation_kwargs
         )
-        self.add_shape(row=row, col=col, **_combine_dicts([shape_args, shape_kwargs]))
+        self.add_shape(
+            row=row,
+            col=col,
+            **_combine_dicts([shape_args, shape_kwargs]),
+            exclude_empty_subplots=exclude_empty_subplots
+        )
         if augmented_annotation is not None:
-            self.add_annotation(augmented_annotation, row=row, col=col)
+            self.add_annotation(
+                augmented_annotation,
+                row=row,
+                col=col,
+                exclude_empty_subplots=exclude_empty_subplots,
+            )
         # update xref and yref for the new shapes and annotations
         for layout_obj, n_layout_objs_before in zip(
             ["shapes", "annotations"], [n_shapes_before, n_annotations_before]
@@ -3825,6 +3830,20 @@ def _has_subplots(self):
         single plot and so this returns False. """
         return self._grid_ref is not None
 
+    def _subplot_contains_trace(self, xref, yref):
+        return any(
+            t == (xref, yref)
+            for t in [
+                # if a trace exists but has no xaxis or yaxis keys, then it
+                # is plotted with xaxis 'x' and yaxis 'y'
+                (
+                    "x" if d["xaxis"] is None else d["xaxis"],
+                    "y" if d["yaxis"] is None else d["yaxis"],
+                )
+                for d in self.data
+            ]
+        )
+
 
 class BasePlotlyType(object):
     """