px template tests galore

Author: nicolaskruchten

packages/python/plotly/plotly/tests/test_core/test_px/test_px.py

@@ -51,3 +51,111 @@ def test_custom_data_scatter():
         fig.data[0].hovertemplate
         == "sepal_width=%{x}<br>sepal_length=%{y}<br>petal_length=%{customdata[2]}<br>petal_width=%{customdata[3]}<br>species_id=%{customdata[0]}"
     )
+
+
+def test_px_templates():
+    import plotly.io as pio
+    import plotly.graph_objects as go
+
+    tips = px.data.tips()
+
+    # use the normal defaults
+    fig = px.scatter()
+    assert fig.layout.template == pio.templates[pio.templates.default]
+
+    # respect changes to defaults
+    pio.templates.default = "seaborn"
+    fig = px.scatter()
+    assert fig.layout.template == pio.templates["seaborn"]
+
+    # special px-level defaults over pio defaults
+    pio.templates.default = "seaborn"
+    px.defaults.template = "ggplot2"
+    fig = px.scatter()
+    assert fig.layout.template == pio.templates["ggplot2"]
+
+    # accept names in args over pio and px defaults
+    fig = px.scatter(template="seaborn")
+    assert fig.layout.template == pio.templates["seaborn"]
+
+    # accept objects in args
+    fig = px.scatter(template={})
+    assert fig.layout.template == go.layout.Template()
+
+    # read colorway from the template
+    fig = px.scatter(
+        tips,
+        x="total_bill",
+        y="tip",
+        color="sex",
+        template=dict(layout_colorway=["red", "blue"]),
+    )
+    assert fig.data[0].marker.color == "red"
+    assert fig.data[1].marker.color == "blue"
+
+    # default colorway fallback
+    fig = px.scatter(tips, x="total_bill", y="tip", color="sex", template=dict())
+    assert fig.data[0].marker.color == px.colors.qualitative.D3[0]
+    assert fig.data[1].marker.color == px.colors.qualitative.D3[1]
+
+    # pio default template colorway fallback
+    pio.templates.default = "seaborn"
+    px.defaults.template = None
+    fig = px.scatter(tips, x="total_bill", y="tip", color="sex")
+    assert fig.data[0].marker.color == pio.templates["seaborn"].layout.colorway[0]
+    assert fig.data[1].marker.color == pio.templates["seaborn"].layout.colorway[1]
+
+    # pio default template colorway fallback
+    pio.templates.default = "seaborn"
+    px.defaults.template = "ggplot2"
+    fig = px.scatter(tips, x="total_bill", y="tip", color="sex")
+    assert fig.data[0].marker.color == pio.templates["ggplot2"].layout.colorway[0]
+    assert fig.data[1].marker.color == pio.templates["ggplot2"].layout.colorway[1]
+
+    # don't overwrite top margin when set in template
+    fig = px.scatter(title="yo")
+    assert fig.layout.margin.t is None
+
+    fig = px.scatter()
+    assert fig.layout.margin.t == 60
+
+    fig = px.scatter(template=dict(layout_margin_t=2))
+    assert fig.layout.margin.t is None
+
+    # don't force histogram gridlines when set in template
+    pio.templates.default = "none"
+    px.defaults.template = None
+    fig = px.scatter(
+        tips, x="total_bill", y="tip", marginal_x="histogram", marginal_y="histogram"
+    )
+    assert fig.layout.xaxis2.showgrid
+    assert fig.layout.xaxis3.showgrid
+    assert fig.layout.yaxis2.showgrid
+    assert fig.layout.yaxis3.showgrid
+
+    fig = px.scatter(
+        tips,
+        x="total_bill",
+        y="tip",
+        marginal_x="histogram",
+        marginal_y="histogram",
+        template=dict(layout_yaxis_showgrid=False),
+    )
+    assert fig.layout.xaxis2.showgrid
+    assert fig.layout.xaxis3.showgrid
+    assert fig.layout.yaxis2.showgrid is None
+    assert fig.layout.yaxis3.showgrid is None
+
+    fig = px.scatter(
+        tips,
+        x="total_bill",
+        y="tip",
+        marginal_x="histogram",
+        marginal_y="histogram",
+        template=dict(layout_xaxis_showgrid=False),
+    )
+    assert fig.layout.xaxis2.showgrid is None
+    assert fig.layout.xaxis3.showgrid is None
+    assert fig.layout.yaxis2.showgrid
+    assert fig.layout.yaxis3.showgrid
+