feat: make div_id configurable

implements #3487 (comment)

Author: Skn0tt

packages/python/plotly/plotly/io/_html.py

@@ -38,6 +38,7 @@ def to_html(
     default_width="100%",
     default_height="100%",
     validate=True,
+    div_id=None,
 ):
     """
     Convert a figure to an HTML string representation.
@@ -135,7 +136,7 @@ def to_html(
     fig_dict = validate_coerce_fig_to_dict(fig, validate)
 
     # ## Generate div id ##
-    plotdivid = "plotly-root"
+    plotdivid = div_id or str(uuid.uuid4())
 
     # ## Serialize figure ##
     jdata = to_json_plotly(fig_dict.get("data", []))
@@ -391,6 +392,7 @@ def write_html(
     default_width="100%",
     default_height="100%",
     auto_open=False,
+    div_id=None,
 ):
     """
     Write a figure to an HTML file representation
@@ -512,6 +514,7 @@ def write_html(
         default_width=default_width,
         default_height=default_height,
         validate=validate,
+        div_id=div_id,
     )
 
     # Check if file is a string

packages/python/plotly/plotly/tests/test_io/test_html.py

@@ -41,6 +41,7 @@ def test_versioned_cdn_included(fig1):
 
 
 def test_html_deterministic(fig1):
-    assert pio.to_html(fig1, include_plotlyjs="cdn") == pio.to_html(
-        fig1, include_plotlyjs="cdn"
+    div_id = "plotly-root"
+    assert pio.to_html(fig1, include_plotlyjs="cdn", div_id=div_id) == pio.to_html(
+        fig1, include_plotlyjs="cdn", div_id=div_id
     )