Merge branch 'master' into merge-doc-prod-to-master

Author: LiamConnors

.circleci/config.yml

@@ -249,14 +249,6 @@ jobs:
       - test_optional:
           py: "312_no_numpy"
 
-  # Orca
-  python_38_orca:
-    docker:
-      - image: cimg/python:3.8-browsers
-    steps:
-      - test_orca:
-          py: "38"
-
   # Percy
   python_39_percy:
     docker:
@@ -613,7 +605,6 @@ workflows:
       - python_311_optional
       - python_312_optional
       - python_39_pandas_2_optional
-      - python_38_orca
       - python_39_percy
       - python_312_no_numpy
       - build-doc

CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### Updated
+
+- Updated plotly.py to use base64 encoding of arrays in plotly JSON to improve performance. 
+
 ## [5.24.1] - 2024-09-12
 
 ### Updated
@@ -21,6 +25,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - Fixed a bug in integer validation of arrays that threw an error when an array contained a mix of strings and integers.
 
+- Fixed a bug in JupyterLab >= 4 and Jupyter Notebook >= 7 that caused latex to not render in plotly charts. 
+
+- Use modern [native ES6 import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) to load plotly.js bundle instead of requirejs which is [no longer under active development](https://github.com/requirejs/r.js/compare/2.3.6...2.3.7)
+
 ## [5.23.0] - 2024-07-23
 
 ### Updated

LICENSE.txt

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2016-2018 Plotly, Inc
+Copyright (c) 2016-2024 Plotly Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

contributing.md

@@ -57,9 +57,7 @@ There are many ways to contribute to plotly.py. To contribute effectively, it is
 
 - tests are found in `packages/python/plotly/plotly/tests`. Different
   directories correspond to different test jobs (with different dependency sets)
-  run in continuous integration. These jobs are configured in
-  `packages/python/plotly/tox.ini`, which itself is used in the Circle CI
-  configuration file `.circleci/config.yml`. More is explained about tests
+  run in continuous integration. More is explained about tests
   in the following "Technical aspects" section.
 
 - the **documentation** is part of this repository. Its structure and some
@@ -231,10 +229,10 @@ For dev branches, it is also possible to use `updateplotlyjsdev` in two configur
 
 ### CircleCI Release
 
-If your devbranch is part of the official plotly.js repository, you can use 
+If your devbranch is part of the official plotly.js repository, you can use
 ```bash
 python setup.py updateplotlyjsdev --devrepo reponame --devbranch branchname
-``` 
+```
 to update to development versions of `plotly.js`. This will fetch the `plotly.js` in the CircleCI artifact of the branch `branchname` of the repo `reponame`. If `--devrepo` or `--devbranch` are omitted, `updateplotlyjsdev` defaults using `plotly/plotly.js` and `master` respectively.
 
 ### Local Repository

doc/python/renderers.md

@@ -164,7 +164,7 @@ The `plotly_mimetype` renderer creates a specification of the figure (called a M
 These are aliases for `plotly_mimetype` since this renderer is a good choice when working in JupyterLab, nteract, and the Visual Studio Code notebook interface. Note that in VSCode Notebooks, the version of Plotly.js that is used to render is provided by the [vscode-python extension](https://code.visualstudio.com/docs/languages/python) and often trails the latest version by several weeks, so the latest features of `plotly` may not be available in VSCode right away. The situation is similar for Nteract.
 
 ##### Static Image Renderers
-A set of renderers is provided for displaying figures as static images.  These renderers all rely on the [orca](https://github.com/plotly/orca) static image export utility. See the [Static Image Export](https://plot.ly/python/static-image-export/) page for more information on getting set up with [orca].
+A set of renderers is provided for displaying figures as static images. See the [Static Image Export](https://plot.ly/python/static-image-export/) page for more information on getting set up.
 
 ###### `png`, `jpeg`, and `svg`
 These renderers display figures as static `.png`, `.jpeg`, and `.svg` files, respectively.  These renderers are useful for user interfaces that do not support inline HTML output, but do support inline static images.  Examples include the [QtConsole](https://qtconsole.readthedocs.io/en/stable/), [Spyder](https://www.spyder-ide.org/), and the PyCharm [notebook interface](https://www.jetbrains.com/help/pycharm/jupyter-notebook-support.html).

doc/requirements.txt

@@ -1,5 +1,5 @@
 plotly==5.24.1
-jupytext==1.1.1
+jupytext==1.16.4
 ipywidgets==7.7.2
 jupyter-client<7
 jupyter

packages/python/chart-studio/chart_studio/tools.py

@@ -287,7 +287,7 @@ def _get_embed_url(file_owner_or_url, file_id=None):
             "The 'file_id' argument must be a non-negative number."
         )
 
-    if share_key is "":
+    if share_key == "":
         return "{plotly_rest_url}/~{file_owner}/{file_id}.embed".format(
             plotly_rest_url=plotly_rest_url, file_owner=file_owner, file_id=file_id
         )

packages/python/plotly/_plotly_utils/utils.py

@@ -1,11 +1,115 @@
+import base64
 import decimal
 import json as _json
 import sys
 import re
 from functools import reduce
 
 from _plotly_utils.optional_imports import get_module
-from _plotly_utils.basevalidators import ImageUriValidator
+from _plotly_utils.basevalidators import (
+    ImageUriValidator,
+    copy_to_readonly_numpy_array,
+    is_homogeneous_array,
+)
+
+
+int8min = -128
+int8max = 127
+int16min = -32768
+int16max = 32767
+int32min = -2147483648
+int32max = 2147483647
+
+uint8max = 255
+uint16max = 65535
+uint32max = 4294967295
+
+plotlyjsShortTypes = {
+    "int8": "i1",
+    "uint8": "u1",
+    "int16": "i2",
+    "uint16": "u2",
+    "int32": "i4",
+    "uint32": "u4",
+    "float32": "f4",
+    "float64": "f8",
+}
+
+
+def to_typed_array_spec(v):
+    """
+    Convert numpy array to plotly.js typed array spec
+    If not possible return the original value
+    """
+    v = copy_to_readonly_numpy_array(v)
+
+    np = get_module("numpy", should_load=False)
+    if not np or not isinstance(v, np.ndarray):
+        return v
+
+    dtype = str(v.dtype)
+
+    # convert default Big Ints until we could support them in plotly.js
+    if dtype == "int64":
+        max = v.max()
+        min = v.min()
+        if max <= int8max and min >= int8min:
+            v = v.astype("int8")
+        elif max <= int16max and min >= int16min:
+            v = v.astype("int16")
+        elif max <= int32max and min >= int32min:
+            v = v.astype("int32")
+        else:
+            return v
+
+    elif dtype == "uint64":
+        max = v.max()
+        min = v.min()
+        if max <= uint8max and min >= 0:
+            v = v.astype("uint8")
+        elif max <= uint16max and min >= 0:
+            v = v.astype("uint16")
+        elif max <= uint32max and min >= 0:
+            v = v.astype("uint32")
+        else:
+            return v
+
+    dtype = str(v.dtype)
+
+    if dtype in plotlyjsShortTypes:
+        arrObj = {
+            "dtype": plotlyjsShortTypes[dtype],
+            "bdata": base64.b64encode(v).decode("ascii"),
+        }
+
+        if v.ndim > 1:
+            arrObj["shape"] = str(v.shape)[1:-1]
+
+        return arrObj
+
+    return v
+
+
+def is_skipped_key(key):
+    """
+    Return whether the key is skipped for conversion to the typed array spec
+    """
+    skipped_keys = ["geojson", "layer", "layers", "range"]
+    return any(skipped_key == key for skipped_key in skipped_keys)
+
+
+def convert_to_base64(obj):
+    if isinstance(obj, dict):
+        for key, value in obj.items():
+            if is_skipped_key(key):
+                continue
+            elif is_homogeneous_array(value):
+                obj[key] = to_typed_array_spec(value)
+            else:
+                convert_to_base64(value)
+    elif isinstance(obj, list) or isinstance(obj, tuple):
+        for value in obj:
+            convert_to_base64(value)
 
 
 def cumsum(x):

packages/python/plotly/plotly/basedatatypes.py

@@ -15,6 +15,7 @@
     display_string_positions,
     chomp_empty_strings,
     find_closest_string,
+    convert_to_base64,
 )
 from _plotly_utils.exceptions import PlotlyKeyError
 from .optional_imports import get_module
@@ -3310,6 +3311,9 @@ def to_dict(self):
         if frames:
             res["frames"] = frames
 
+        # Add base64 conversion before sending to the front-end
+        convert_to_base64(res)
+
         return res
 
     def to_plotly_json(self):
@@ -3534,12 +3538,6 @@ def to_html(self, *args, **kwargs):
             plotly.min.js bundle that is assumed to reside in the same
             directory as the HTML file.
 
-            If 'require', Plotly.js is loaded using require.js.  This option
-            assumes that require.js is globally available and that it has been
-            globally configured to know how to find Plotly.js as 'plotly'.
-            This option is not advised when full_html=True as it will result
-            in a non-functional html file.
-
             If a string that ends in '.js', a script tag is included that
             references the specified path. This approach can be used to point
             the resulting HTML file to an alternative CDN or local bundle.
@@ -3643,12 +3641,6 @@ def write_html(self, *args, **kwargs):
             directory because the plotly.js source code will be included only
             once per output directory, rather than once per output file.
 
-            If 'require', Plotly.js is loaded using require.js.  This option
-            assumes that require.js is globally available and that it has been
-            globally configured to know how to find Plotly.js as 'plotly'.
-            This option is not advised when full_html=True as it will result
-            in a non-functional html file.
-
             If a string that ends in '.js', a script tag is included that
             references the specified path. This approach can be used to point
             the resulting HTML file to an alternative CDN or local bundle.

packages/python/plotly/plotly/express/_chart_types.py

@@ -258,7 +258,7 @@ def line(
     height=None,
 ) -> go.Figure:
     """
-    In a 2D line plot, each row of `data_frame` is represented as vertex of
+    In a 2D line plot, each row of `data_frame` is represented as a vertex of
     a polyline mark in 2D space.
     """
     return make_figure(args=locals(), constructor=go.Scatter)
@@ -309,8 +309,8 @@ def area(
 ) -> go.Figure:
     """
     In a stacked area plot, each row of `data_frame` is represented as
-    vertex of a polyline mark in 2D space. The area between successive
-    polylines is filled.
+    a vertex of a polyline mark in 2D space. The area between
+    successive polylines is filled.
     """
     return make_figure(
         args=locals(),
@@ -821,7 +821,7 @@ def line_3d(
     height=None,
 ) -> go.Figure:
     """
-    In a 3D line plot, each row of `data_frame` is represented as vertex of
+    In a 3D line plot, each row of `data_frame` is represented as a vertex of
     a polyline mark in 3D space.
     """
     return make_figure(args=locals(), constructor=go.Scatter3d)
@@ -902,7 +902,7 @@ def line_ternary(
 ) -> go.Figure:
     """
     In a ternary line plot, each row of `data_frame` is represented as
-    vertex of a polyline mark in ternary coordinates.
+    a vertex of a polyline mark in ternary coordinates.
     """
     return make_figure(args=locals(), constructor=go.Scatterternary)
 
@@ -992,8 +992,8 @@ def line_polar(
     height=None,
 ) -> go.Figure:
     """
-    In a polar line plot, each row of `data_frame` is represented as vertex
-    of a polyline mark in polar coordinates.
+    In a polar line plot, each row of `data_frame` is represented as a
+    vertex of a polyline mark in polar coordinates.
     """
     return make_figure(args=locals(), constructor=go.Scatterpolar)
 
@@ -1199,7 +1199,7 @@ def line_geo(
 ) -> go.Figure:
     """
     In a geographic line plot, each row of `data_frame` is represented as
-    vertex of a polyline mark on a map.
+    a vertex of a polyline mark on a map.
     """
     return make_figure(
         args=locals(),
@@ -1314,7 +1314,7 @@ def density_map(
 ) -> go.Figure:
     """
     In a density map, each row of `data_frame` contributes to the intensity of
-    the color of the region around the corresponding point on the map
+    the color of the region around the corresponding point on the map.
     """
     return make_figure(
         args=locals(), constructor=go.Densitymap, trace_patch=dict(radius=radius)
@@ -1350,7 +1350,7 @@ def line_map(
 ) -> go.Figure:
     """
     In a line map, each row of `data_frame` is represented as
-    vertex of a polyline mark on the map.
+    a vertex of a polyline mark on the map.
     """
     return make_figure(args=locals(), constructor=go.Scattermap)
 
@@ -1497,7 +1497,7 @@ def line_mapbox(
 ) -> go.Figure:
     """
     In a Mapbox line plot, each row of `data_frame` is represented as
-    vertex of a polyline mark on a Mapbox map.
+    a vertex of a polyline mark on a Mapbox map.
     """
     return make_figure(args=locals(), constructor=go.Scattermapbox)