Anything truthy passed to exclude_empty_subplots works

That means that truthy values exclude subplots containing absolutely
nothing (but not those containing shapes, but no traces, say) and
anything falsey adds to all subplots.

Author: nicholas-esterer

packages/python/plotly/plotly/basedatatypes.py

@@ -1302,7 +1302,9 @@ def _add_annotation_like(
             # 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_not_empty(xref, yref, selector=exclude_empty_subplots)
+                not self._subplot_not_empty(
+                    xref, yref, selector=bool(exclude_empty_subplots)
+                )
             ):
                 return self
             # in case the user specified they wanted an axis to refer to the
@@ -1994,7 +1996,7 @@ def add_traces(
             data = list(
                 filter(
                     lambda trace: self._subplot_not_empty(
-                        trace["xaxis"], trace["yaxis"], exclude_empty_subplots
+                        trace["xaxis"], trace["yaxis"], bool(exclude_empty_subplots)
                     ),
                     data,
                 )

packages/python/plotly/plotly/tests/test_core/test_figure_messages/test_add_traces.py

@@ -120,7 +120,43 @@ def test_add_trace_no_exclude_empty_subplots():
     fig.add_trace(go.Scatter(x=[1, 2, 3], y=[5, 1, 2]), row=1, col=1)
     fig.add_trace(go.Scatter(x=[1, 2, 3], y=[2, 1, -7]), row=2, col=2)
     # Add traces with exclude_empty_subplots set to true and make sure this
-    # doesn't add to traces that don't already have data
+    # even adds to traces that don't already have data
+    fig.add_trace(go.Scatter(x=[1, 2, 3], y=[0, 1, -1]), row="all", col="all")
+    assert len(fig.data) == 6
+    assert fig.data[2]["xaxis"] == "x" and fig.data[2]["yaxis"] == "y"
+    assert fig.data[3]["xaxis"] == "x2" and fig.data[3]["yaxis"] == "y2"
+    assert fig.data[4]["xaxis"] == "x3" and fig.data[4]["yaxis"] == "y3"
+    assert fig.data[5]["xaxis"] == "x4" and fig.data[5]["yaxis"] == "y4"
+
+
+def test_add_trace_exclude_totally_empty_subplots():
+    # Add traces
+    fig = make_subplots(2, 2)
+    fig.add_trace(go.Scatter(x=[1, 2, 3], y=[5, 1, 2]), row=1, col=1)
+    fig.add_trace(go.Scatter(x=[1, 2, 3], y=[2, 1, -7]), row=2, col=2)
+    fig.add_shape(dict(type="rect", x0=0, x1=1, y0=0, y1=1), row=1, col=2)
+    # Add traces with exclude_empty_subplots set to true and make sure this
+    # doesn't add to traces that don't already have data or layout objects
+    fig.add_trace(
+        go.Scatter(x=[1, 2, 3], y=[0, 1, -1]),
+        row="all",
+        col="all",
+        exclude_empty_subplots=["anything", "truthy"],
+    )
+    assert len(fig.data) == 5
+    assert fig.data[2]["xaxis"] == "x" and fig.data[2]["yaxis"] == "y"
+    assert fig.data[3]["xaxis"] == "x2" and fig.data[3]["yaxis"] == "y2"
+    assert fig.data[4]["xaxis"] == "x4" and fig.data[4]["yaxis"] == "y4"
+
+
+def test_add_trace_no_exclude_totally_empty_subplots():
+    # Add traces
+    fig = make_subplots(2, 2)
+    fig.add_trace(go.Scatter(x=[1, 2, 3], y=[5, 1, 2]), row=1, col=1)
+    fig.add_trace(go.Scatter(x=[1, 2, 3], y=[2, 1, -7]), row=2, col=2)
+    fig.add_shape(dict(type="rect", x0=0, x1=1, y0=0, y1=1), row=1, col=2)
+    # Add traces with exclude_empty_subplots set to true and make sure this
+    # even adds to traces that don't already have data or layout objects
     fig.add_trace(go.Scatter(x=[1, 2, 3], y=[0, 1, -1]), row="all", col="all")
     assert len(fig.data) == 6
     assert fig.data[2]["xaxis"] == "x" and fig.data[2]["yaxis"] == "y"

packages/python/plotly/plotly/tests/test_core/test_update_objects/test_update_annotations.py

@@ -270,51 +270,78 @@ def test_image_attributes(self):
 
 
 def test_exclude_empty_subplots():
-    for k, fun, d in [
+    for k, fun, d, fun2, d2 in [
         (
             "shapes",
             go.Figure.add_shape,
             dict(type="rect", x0=1.5, x1=2.5, y0=3.5, y1=4.5),
+            # add a different type to make the check easier (otherwise we might
+            # mix up the objects added before and after fun was run)
+            go.Figure.add_annotation,
+            dict(x=1, y=2, text="A"),
+        ),
+        (
+            "annotations",
+            go.Figure.add_annotation,
+            dict(x=1, y=2, text="A"),
+            go.Figure.add_layout_image,
+            dict(x=3, y=4, sizex=2, sizey=3, source="test"),
         ),
-        ("annotations", go.Figure.add_annotation, dict(x=1, y=2, text="A")),
         (
             "images",
             go.Figure.add_layout_image,
             dict(x=3, y=4, sizex=2, sizey=3, source="test"),
+            go.Figure.add_shape,
+            dict(type="rect", x0=1.5, x1=2.5, y0=3.5, y1=4.5),
         ),
     ]:
         # make a figure where not all the subplots are populated
         fig = make_subplots(2, 2)
         fig.add_trace(go.Scatter(x=[1, 2, 3], y=[5, 1, 2]), row=1, col=1)
         fig.add_trace(go.Scatter(x=[1, 2, 3], y=[2, 1, -7]), row=2, col=2)
+        fun2(fig, d2, row=1, col=2)
         # add a thing to all subplots but make sure it only goes on the
-        # plots without data
-        fun(fig, d, row="all", col="all", exclude_empty_subplots=True)
-        assert len(fig.layout[k]) == 2
+        # plots without data or layout objects
+        fun(fig, d, row="all", col="all", exclude_empty_subplots="anything_truthy")
+        assert len(fig.layout[k]) == 3
         assert fig.layout[k][0]["xref"] == "x" and fig.layout[k][0]["yref"] == "y"
-        assert fig.layout[k][1]["xref"] == "x4" and fig.layout[k][1]["yref"] == "y4"
+        assert fig.layout[k][1]["xref"] == "x2" and fig.layout[k][1]["yref"] == "y2"
+        assert fig.layout[k][2]["xref"] == "x4" and fig.layout[k][2]["yref"] == "y4"
 
 
 def test_no_exclude_empty_subplots():
-    for k, fun, d in [
+    for k, fun, d, fun2, d2 in [
         (
             "shapes",
             go.Figure.add_shape,
             dict(type="rect", x0=1.5, x1=2.5, y0=3.5, y1=4.5),
+            # add a different type to make the check easier (otherwise we might
+            # mix up the objects added before and after fun was run)
+            go.Figure.add_annotation,
+            dict(x=1, y=2, text="A"),
+        ),
+        (
+            "annotations",
+            go.Figure.add_annotation,
+            dict(x=1, y=2, text="A"),
+            go.Figure.add_layout_image,
+            dict(x=3, y=4, sizex=2, sizey=3, source="test"),
         ),
-        ("annotations", go.Figure.add_annotation, dict(x=1, y=2, text="A")),
         (
             "images",
             go.Figure.add_layout_image,
             dict(x=3, y=4, sizex=2, sizey=3, source="test"),
+            go.Figure.add_shape,
+            dict(type="rect", x0=1.5, x1=2.5, y0=3.5, y1=4.5),
         ),
     ]:
         # make a figure where not all the subplots are populated
         fig = make_subplots(2, 2)
         fig.add_trace(go.Scatter(x=[1, 2, 3], y=[5, 1, 2]), row=1, col=1)
         fig.add_trace(go.Scatter(x=[1, 2, 3], y=[2, 1, -7]), row=2, col=2)
-        # add a thing to all subplots and make sure it even goes on the
-        # plots without data
+        fun2(fig, d2, row=1, col=2)
+        # add a thing to all subplots but make sure it only goes on the
+        # plots without data or layout objects
         fun(fig, d, row="all", col="all", exclude_empty_subplots=False)
         assert len(fig.layout[k]) == 4
         assert fig.layout[k][0]["xref"] == "x" and fig.layout[k][0]["yref"] == "y"