Merge branch 'master' into 3984-facets-empty-dataset

alexcjohnson · web-flow · commit 649d275a97e7 · 2023-06-03T21:30:35.000-04:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -371,7 +371,7 @@ jobs:
           name: Create conda environment
           command: |
             conda create -n env --yes python=3.9 conda-build conda-verify
-            conda install -n env -c conda-forge jupyterlab nodejs=16
+            conda install -n env -c conda-forge jupyterlab=3 nodejs=16
             conda init bash
             mkdir output
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,8 +6,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
   - Fixed another compatibility issue with Pandas 2.0, just affecting `px.*(line_close=True)` [[#4190](https://github.com/plotly/plotly.py/pull/4190)]
-  - Added some rounding to the `make_subplots` function to handle situations where the user-input specs cause the domain to exceed 1 by small amounts https://github.com/plotly/plotly.py/pull/4153
   - Empty pandas dataframe with facet row/column set no longer fails [[#4038](https://github.com/plotly/plotly.py/pull/4038)]
+  - Added some rounding to the `make_subplots` function to handle situations where the user-input specs cause the domain to exceed 1 by small amounts [[#4153](https://github.com/plotly/plotly.py/pull/4153)]
+  - Sanitize JSON output to prevent an XSS vector when graphs are inserted directly into HTML [[#4196](https://github.com/plotly/plotly.py/pull/4196)]
+  - Fixed issue with shapes and annotations plotting on the wrong y axis when supplied with a specific axis in the `yref` parameter [[#4177](https://github.com/plotly/plotly.py/pull/4177)]
+  - Remove `use_2to3` setuptools arg, which is invalid in the latest Python and setuptools versions [[#4206](https://github.com/plotly/plotly.py/pull/4206)]
+  - Fix [#4066](https://github.com/plotly/plotly.py/issues/4066) JupyterLab v4 giving tiny default graph height [[#4227](https://github.com/plotly/plotly.py/pull/4227)]
 
 ## [5.14.1] - 2023-04-05
 
diff --git a/packages/javascript/jupyterlab-plotly/src/Figure.ts b/packages/javascript/jupyterlab-plotly/src/Figure.ts
@@ -849,6 +849,9 @@ export class FigureView extends DOMWidgetView {
     // the model is not directly mutated by the Plotly.js library.
     var initialTraces = _.cloneDeep(this.model.get("_data"));
     var initialLayout = _.cloneDeep(this.model.get("_layout"));
+    if (!initialLayout.height) {
+      initialLayout.height = 360;
+    }
     var config = this.model.get("_config");
     config.editSelection = false;
 
diff --git a/packages/javascript/jupyterlab-plotly/src/plotly-renderer.ts b/packages/javascript/jupyterlab-plotly/src/plotly-renderer.ts
@@ -126,12 +126,16 @@ export class RenderedPlotly extends Widget implements IRenderMime.IRenderer {
       | any
       | IPlotlySpec;
 
+    if (!layout.height) {
+      layout.height = 360;
+    }
+
     // Load plotly asynchronously
     const loadPlotly = async (): Promise<void> => {
       if (RenderedPlotly.Plotly === null) {
         RenderedPlotly.Plotly = await import("plotly.js/dist/plotly");
         RenderedPlotly._resolveLoadingPlotly();
-      } 
+      }
       return RenderedPlotly.loadingPlotly;
     };
 
diff --git a/packages/javascript/jupyterlab-plotly/style/index.css b/packages/javascript/jupyterlab-plotly/style/index.css
@@ -21,12 +21,7 @@
   overflow: hidden;
 }
 
-/* Output styles */
-.jp-OutputArea .jp-RenderedPlotly {
-  min-height: 360px;
-}
-
 /* Document icon */
 .jp-PlotlyIcon {
   background-image: var(--jp-icon-plotly);
-}
+}
diff --git a/packages/python/plotly/_plotly_utils/tests/validators/test_integer_validator.py b/packages/python/plotly/_plotly_utils/tests/validators/test_integer_validator.py
@@ -74,7 +74,7 @@ def test_acceptance_min(val, validator_min):
     assert validator_min.validate_coerce(val) == approx(val)
 
 
-@pytest.mark.parametrize("val", [-2, -123, np.iinfo(np.int).min])
+@pytest.mark.parametrize("val", [-2, -123, np.iinfo(int).min])
 def test_rejection_min(val, validator_min):
     with pytest.raises(ValueError) as validation_failure:
         validator_min.validate_coerce(val)
diff --git a/packages/python/plotly/plotly/basedatatypes.py b/packages/python/plotly/plotly/basedatatypes.py
@@ -1559,17 +1559,31 @@ def _add_annotation_like(
                         subplot_type=refs[0].subplot_type,
                     )
                 )
-            if len(refs) == 1 and secondary_y:
-                raise ValueError(
-                    """
-Cannot add {prop_singular} to secondary y-axis of subplot at position ({r}, {c})
-because subplot does not have a secondary y-axis"""
-                )
-            if secondary_y:
-                xaxis, yaxis = refs[1].layout_keys
+
+            # If the new_object was created with a yref specified that did not include paper or domain, the specified yref should be used otherwise assign the xref and yref from the layout_keys
+            if (
+                new_obj.yref is None
+                or new_obj.yref == "y"
+                or "paper" in new_obj.yref
+                or "domain" in new_obj.yref
+            ):
+                if len(refs) == 1 and secondary_y:
+                    raise ValueError(
+                        """
+    Cannot add {prop_singular} to secondary y-axis of subplot at position ({r}, {c})
+    because subplot does not have a secondary y-axis""".format(
+                            prop_singular=prop_singular, r=row, c=col
+                        )
+                    )
+                if secondary_y:
+                    xaxis, yaxis = refs[1].layout_keys
+                else:
+                    xaxis, yaxis = refs[0].layout_keys
+                xref, yref = xaxis.replace("axis", ""), yaxis.replace("axis", "")
             else:
-                xaxis, yaxis = refs[0].layout_keys
-            xref, yref = xaxis.replace("axis", ""), yaxis.replace("axis", "")
+                yref = new_obj.yref
+                xaxis = refs[0].layout_keys[0]
+                xref = xaxis.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 (
@@ -1591,6 +1605,11 @@ def _add_domain(ax_letter, new_axref):
             new_obj.update(xref=xref, yref=yref)
 
         self.layout[prop_plural] += (new_obj,)
+        # The 'new_obj.xref' and 'new_obj.yref' parameters need to be reset otherwise it
+        # will appear as if user supplied yref params when looping through subplots and
+        # will force annotation to be on the axis of the last drawn annotation
+        # i.e. they all end up on the same axis.
+        new_obj.update(xref=None, yref=None)
 
         return self
 
@@ -4034,6 +4053,7 @@ def _process_multiple_axis_spanning_shapes(
                 row=row,
                 col=col,
                 exclude_empty_subplots=exclude_empty_subplots,
+                yref=shape_kwargs.get("yref", "y"),
             )
         # update xref and yref for the new shapes and annotations
         for layout_obj, n_layout_objs_before in zip(
@@ -4045,10 +4065,13 @@ def _process_multiple_axis_spanning_shapes(
             ):
                 # this was called intending to add to a single plot (and
                 # self.add_{layout_obj} succeeded)
-                # however, in the case of a single plot, xref and yref are not
-                # specified, so we specify them here so the following routines can work
-                # (they need to append " domain" to xref or yref)
-                self.layout[layout_obj][-1].update(xref="x", yref="y")
+                # however, in the case of a single plot, xref and yref MAY not be
+                # specified, IF they are not specified we specify them here so the following routines can work
+                # (they need to append " domain" to xref or yref). If they are specified, we leave them alone.
+                if self.layout[layout_obj][-1].xref is None:
+                    self.layout[layout_obj][-1].update(xref="x")
+                if self.layout[layout_obj][-1].yref is None:
+                    self.layout[layout_obj][-1].update(yref="y")
             new_layout_objs = tuple(
                 filter(
                     lambda x: x is not None,
diff --git a/packages/python/plotly/plotly/io/_json.py b/packages/python/plotly/plotly/io/_json.py
@@ -57,6 +57,25 @@ def coerce_to_strict(const):
         return const
 
 
+_swap_json = (
+    ("<", "\\u003c"),
+    (">", "\\u003e"),
+    ("/", "\\u002f"),
+)
+_swap_orjson = _swap_json + (
+    ("\u2028", "\\u2028"),
+    ("\u2029", "\\u2029"),
+)
+
+
+def _safe(json_str, _swap):
+    out = json_str
+    for unsafe_char, safe_char in _swap:
+        if unsafe_char in out:
+            out = out.replace(unsafe_char, safe_char)
+    return out
+
+
 def to_json_plotly(plotly_object, pretty=False, engine=None):
     """
     Convert a plotly/Dash object to a JSON string representation
@@ -120,7 +139,9 @@ def to_json_plotly(plotly_object, pretty=False, engine=None):
 
         from _plotly_utils.utils import PlotlyJSONEncoder
 
-        return json.dumps(plotly_object, cls=PlotlyJSONEncoder, **opts)
+        return _safe(
+            json.dumps(plotly_object, cls=PlotlyJSONEncoder, **opts), _swap_json
+        )
     elif engine == "orjson":
         JsonConfig.validate_orjson()
         opts = orjson.OPT_NON_STR_KEYS | orjson.OPT_SERIALIZE_NUMPY
@@ -136,7 +157,9 @@ def to_json_plotly(plotly_object, pretty=False, engine=None):
 
         # Try without cleaning
         try:
-            return orjson.dumps(plotly_object, option=opts).decode("utf8")
+            return _safe(
+                orjson.dumps(plotly_object, option=opts).decode("utf8"), _swap_orjson
+            )
         except TypeError:
             pass
 
@@ -146,7 +169,7 @@ def to_json_plotly(plotly_object, pretty=False, engine=None):
             datetime_allowed=True,
             modules=modules,
         )
-        return orjson.dumps(cleaned, option=opts).decode("utf8")
+        return _safe(orjson.dumps(cleaned, option=opts).decode("utf8"), _swap_orjson)
 
 
 def to_json(fig, validate=True, pretty=False, remove_uids=True, engine=None):
diff --git a/packages/python/plotly/plotly/io/_renderers.py b/packages/python/plotly/plotly/io/_renderers.py
@@ -525,13 +525,15 @@ def show(fig, renderer=None, validate=True, **kwargs):
 else:
     # If ipython isn't available, try to display figures in the default
     # browser
-    import webbrowser
-
     try:
+        import webbrowser
+
         webbrowser.get()
         default_renderer = "browser"
-    except webbrowser.Error:
-        # Default browser could not be loaded
+    except Exception:
+        # Many things could have gone wrong
+        # There could not be a webbrowser Python module,
+        # or the module may be a dumb placeholder
         pass
 
 renderers.render_on_display = True
diff --git a/packages/python/plotly/plotly/tests/test_core/test_update_objects/test_update_annotations.py b/packages/python/plotly/plotly/tests/test_core/test_update_objects/test_update_annotations.py
@@ -5,6 +5,7 @@
 
 import plotly.graph_objs as go
 from plotly.subplots import make_subplots
+
 import pytest
 
 
@@ -351,6 +352,64 @@ def test_no_exclude_empty_subplots():
         assert fig.layout[k][3]["xref"] == "x4" and fig.layout[k][3]["yref"] == "y4"
 
 
+def test_supplied_yref_on_single_plot_subplot():
+    ### test a (1,1) subplot figure object
+    fig = make_subplots(1, 1)
+    fig.add_trace(go.Scatter(x=[1, 2, 3, 4], y=[1, 2, 2, 1]))
+    fig.add_trace(go.Scatter(x=[1, 2, 3, 4], y=[4, 3, 2, 1], yaxis="y2"))
+    fig.update_layout(
+        yaxis=dict(title="yaxis1 title"),
+        yaxis2=dict(title="yaxis2 title", overlaying="y", side="right"),
+    )
+    # add horizontal line on y2. Secondary_y can be True or False when yref is supplied
+    fig.add_hline(y=3, yref="y2", secondary_y=True)
+    assert fig.layout["shapes"][0]["yref"] == "y2"
+
+
+def test_supplied_yref_on_non_subplot_figure_object():
+    ### test a non-subplot figure object from go.Figure
+    trace1 = go.Scatter(x=[1, 2, 3, 4], y=[1, 2, 2, 1])
+    trace2 = go.Scatter(x=[1, 2, 3, 4], y=[4, 3, 2, 1], yaxis="y2")
+    data = [trace1, trace2]
+    layout = go.Layout(
+        yaxis=dict(title="yaxis1 title"),
+        yaxis2=dict(title="yaxis2 title", overlaying="y", side="right"),
+    )
+    fig = go.Figure(data=data, layout=layout)
+    # add horizontal line on y2. Secondary_y can be True or False when yref is supplied
+    fig.add_hline(y=3, yref="y2", secondary_y=False)
+    assert fig.layout["shapes"][0]["yref"] == "y2"
+
+
+def test_supplied_yref_on_multi_plot_subplot():
+    ### test multiple subploted figure object with subplots.make_subplots
+    fig = make_subplots(
+        rows=1,
+        cols=2,
+        shared_yaxes=False,
+        specs=[[{"secondary_y": True}, {"secondary_y": True}]],
+    )
+    ### Add traces to the first subplot
+    fig.add_trace(go.Scatter(x=[1, 2, 3], y=[1, 2, 3]), row=1, col=1)
+    fig.add_trace(
+        go.Scatter(x=[1, 2, 3], y=[3, 2, 1], yaxis="y2"), row=1, col=1, secondary_y=True
+    )
+    ### Add traces to the second subplot
+    fig.add_trace(go.Scatter(x=[1, 2, 3], y=[1, 2, 3], yaxis="y"), row=1, col=2)
+    fig.add_trace(
+        go.Scatter(x=[1, 2, 3], y=[1, 1, 2], yaxis="y2"), row=1, col=2, secondary_y=True
+    )
+    # add a horizontal line on both subplots on their respective secondary y.
+    # When using the subplots.make_subplots() method yref parameter should NOT be supplied per docstring instructions.
+    # Instead secondary_y specs and secondary_y parameter MUST be True to plot on secondary y
+    fig.add_hline(y=2, row=1, col=1, secondary_y=True)
+    fig.add_hline(y=1, row=1, col=2, secondary_y=True)
+    assert fig.layout["shapes"][0]["yref"] == "y2"
+    assert fig.layout["shapes"][0]["xref"] == "x domain"
+    assert fig.layout["shapes"][1]["yref"] == "y4"
+    assert fig.layout["shapes"][1]["xref"] == "x2 domain"
+
+
 @pytest.fixture
 def select_annotations_integer():
     fig = make_subplots(2, 3)
diff --git a/packages/python/plotly/plotly/tests/test_io/test_renderers.py b/packages/python/plotly/plotly/tests/test_io/test_renderers.py
@@ -126,6 +126,7 @@ def test_plotly_mimetype_renderer_show(fig1, renderer):
 # ------------
 # See plotly/tests/test_orca/test_image_renderers.py
 
+
 # HTML
 # ----
 def assert_full_html(html):
@@ -381,3 +382,45 @@ def test_repr_mimebundle_mixed_renderer(fig1):
     assert set(fig1._repr_mimebundle_().keys()) == set(
         {"application/vnd.plotly.v1+json", "text/html"}
     )
+
+
+def test_missing_webbrowser_module(fig1):
+    """
+    Assert that no errors occur if the webbrowser module is absent
+    """
+    try:
+        import builtins
+    except ImportError:
+        import __builtin__ as builtins
+    realimport = builtins.__import__
+
+    def webbrowser_absent_import(name, globals, locals, fromlist, level):
+        """
+        Mimick an absent webbrowser module
+        """
+        if name == "webbrowser":
+            raise ImportError
+        return realimport(name, globals, locals, fromlist, level)
+
+    with mock.patch("builtins.__import__", webbrowser_absent_import):
+        # 1: check whether importing webbrowser actually results in an ImportError
+        with pytest.raises(ImportError):
+            import webbrowser
+
+        # 2: check whether the _repr_html_ can handle it regardless
+        fig1._repr_html_()
+
+
+def test_missing_webbrowser_methods(fig1):
+    """
+    Assert that no errors occur if the webbrowser module does not contain some methods
+    """
+    import webbrowser
+
+    removed_webbrowser_get_method = webbrowser.get
+    try:
+        del webbrowser.get
+        fig1._repr_html_()
+    finally:
+        # restore everything after this test
+        webbrowser.get = removed_webbrowser_get_method
diff --git a/packages/python/plotly/plotly/tests/test_io/test_to_from_plotly_json.py b/packages/python/plotly/plotly/tests/test_io/test_to_from_plotly_json.py
diff --git a/packages/python/plotly/setup.cfg b/packages/python/plotly/setup.cfg
diff --git a/packages/python/plotly/setup.py b/packages/python/plotly/setup.py
diff --git a/packages/python/plotly/test_requirements/requirements_37_optional.txt b/packages/python/plotly/test_requirements/requirements_37_optional.txt
diff --git a/packages/python/plotly/test_requirements/requirements_39_optional.txt b/packages/python/plotly/test_requirements/requirements_39_optional.txt
