feat: merging code generator work with latest changes on master

1.  Modify `commands.py` to run code generation.
2.  Regenerate all code.

Notes:

The generated code is reformatted once again: this slightly increases
size but makes it more readable.

There is one flaky test:

`tests/test_plotly_utils/validators/test_colorscale_validator.py::test_acceptance_named[Inferno_r]`

It fails when the entire test suite is run but does *not* fail when
only `test_colorscale_validator.py` is run (using Python 3.11.9).

Author: gvwilson

commands.py

@@ -1,31 +1,30 @@
+from distutils import log
+import json
 import os
-import sys
-import time
 import platform
-import json
 import shutil
-
 from subprocess import check_call
-from distutils import log
+import sys
+import time
 
-project_root = os.path.dirname(os.path.abspath(__file__))
-node_root = os.path.join(project_root, "js")
-is_repo = os.path.exists(os.path.join(project_root, ".git"))
-node_modules = os.path.join(node_root, "node_modules")
-targets = [
-    os.path.join(project_root, "plotly", "package_data", "widgetbundle.js"),
+USAGE = "usage: python commands.py [updateplotlyjsdev | updateplotlyjs | codegen]"
+PROJECT_ROOT = os.path.dirname(os.path.abspath(__file__))
+NODE_ROOT = os.path.join(PROJECT_ROOT, "js")
+NODE_MODULES = os.path.join(NODE_ROOT, "node_modules")
+TARGETS = [
+    os.path.join(PROJECT_ROOT, "plotly", "package_data", "widgetbundle.js"),
 ]
 
-npm_path = os.pathsep.join(
+NPM_PATH = os.pathsep.join(
     [
-        os.path.join(node_root, "node_modules", ".bin"),
+        os.path.join(NODE_ROOT, "node_modules", ".bin"),
         os.environ.get("PATH", os.defpath),
     ]
 )
 
 # Load plotly.js version from js/package.json
 def plotly_js_version():
-    path = os.path.join(project_root, "js", "package.json")
+    path = os.path.join(PROJECT_ROOT, "js", "package.json")
     with open(path, "rt") as f:
         package_json = json.load(f)
         version = package_json["dependencies"]["plotly.js"]
@@ -57,33 +56,33 @@ def install_js_deps(local):
         )
 
     env = os.environ.copy()
-    env["PATH"] = npm_path
+    env["PATH"] = NPM_PATH
 
     if has_npm:
         log.info("Installing build dependencies with npm.  This may take a while...")
         check_call(
             [npmName, "install"],
-            cwd=node_root,
+            cwd=NODE_ROOT,
             stdout=sys.stdout,
             stderr=sys.stderr,
         )
         if local is not None:
             plotly_archive = os.path.join(local, "plotly.js.tgz")
             check_call(
                 [npmName, "install", plotly_archive],
-                cwd=node_root,
+                cwd=NODE_ROOT,
                 stdout=sys.stdout,
                 stderr=sys.stderr,
             )
         check_call(
             [npmName, "run", "build"],
-            cwd=node_root,
+            cwd=NODE_ROOT,
             stdout=sys.stdout,
             stderr=sys.stderr,
         )
-        os.utime(node_modules, None)
+        os.utime(NODE_MODULES, None)
 
-    for t in targets:
+    for t in TARGETS:
         if not os.path.exists(t):
             msg = "Missing file: %s" % t
             raise ValueError(msg)
@@ -100,7 +99,7 @@ def run_codegen():
 
 
 def overwrite_schema_local(uri):
-    path = os.path.join(project_root, "codegen", "resources", "plot-schema.json")
+    path = os.path.join(PROJECT_ROOT, "codegen", "resources", "plot-schema.json")
     shutil.copyfile(uri, path)
 
 
@@ -109,13 +108,13 @@ def overwrite_schema(url):
 
     req = requests.get(url)
     assert req.status_code == 200
-    path = os.path.join(project_root, "codegen", "resources", "plot-schema.json")
+    path = os.path.join(PROJECT_ROOT, "codegen", "resources", "plot-schema.json")
     with open(path, "wb") as f:
         f.write(req.content)
 
 
 def overwrite_bundle_local(uri):
-    path = os.path.join(project_root, "plotly", "package_data", "plotly.min.js")
+    path = os.path.join(PROJECT_ROOT, "plotly", "package_data", "plotly.min.js")
     shutil.copyfile(uri, path)
 
 
@@ -125,13 +124,13 @@ def overwrite_bundle(url):
     req = requests.get(url)
     print("url:", url)
     assert req.status_code == 200
-    path = os.path.join(project_root, "plotly", "package_data", "plotly.min.js")
+    path = os.path.join(PROJECT_ROOT, "plotly", "package_data", "plotly.min.js")
     with open(path, "wb") as f:
         f.write(req.content)
 
 
 def overwrite_plotlyjs_version_file(plotlyjs_version):
-    path = os.path.join(project_root, "plotly", "offline", "_plotlyjs_version.py")
+    path = os.path.join(PROJECT_ROOT, "plotly", "offline", "_plotlyjs_version.py")
     with open(path, "w") as f:
         f.write(
             """\
@@ -274,7 +273,7 @@ def update_schema_bundle_from_master():
         overwrite_schema_local(schema_uri)
 
     # Update plotly.js url in package.json
-    package_json_path = os.path.join(node_root, "package.json")
+    package_json_path = os.path.join(NODE_ROOT, "package.json")
     with open(package_json_path, "r") as f:
         package_json = json.load(f)
 
@@ -299,9 +298,18 @@ def update_plotlyjs_dev():
     run_codegen()
 
 
-if __name__ == "__main__":
-    if "updateplotlyjsdev" in sys.argv:
+def main():
+    if len(sys.argv) != 2:
+        print(USAGE, file=sys.stderr)
+        sys.exit(1)
+    elif sys.argv[1] == "codegen":
+        run_codegen()
+    elif sys.argv[1] == "updateplotlyjsdev":
         update_plotlyjs_dev()
-    elif "updateplotlyjs" in sys.argv:
+    elif sys.argv[1] == "updateplotlyjs":
         print(plotly_js_version())
         update_plotlyjs(plotly_js_version())
+
+
+if __name__ == "__main__":
+    main()

plotly/graph_objects/__init__.py

@@ -1,14 +1,146 @@
 import sys
 from _plotly_utils.importers import relative_import
+
 __all__, __getattr__, __dir__ = relative_import(
     __name__,
-    ['..graph_objs.waterfall', '..graph_objs.volume', '..graph_objs.violin', '..graph_objs.treemap', '..graph_objs.table', '..graph_objs.surface', '..graph_objs.sunburst', '..graph_objs.streamtube', '..graph_objs.splom', '..graph_objs.scatterternary', '..graph_objs.scattersmith', '..graph_objs.scatterpolargl', '..graph_objs.scatterpolar', '..graph_objs.scattermapbox', '..graph_objs.scattermap', '..graph_objs.scattergl', '..graph_objs.scattergeo', '..graph_objs.scattercarpet', '..graph_objs.scatter3d', '..graph_objs.scatter', '..graph_objs.sankey', '..graph_objs.pie', '..graph_objs.parcoords', '..graph_objs.parcats', '..graph_objs.ohlc', '..graph_objs.mesh3d', '..graph_objs.isosurface', '..graph_objs.indicator', '..graph_objs.image', '..graph_objs.icicle', '..graph_objs.histogram2dcontour', '..graph_objs.histogram2d', '..graph_objs.histogram', '..graph_objs.heatmap', '..graph_objs.funnelarea', '..graph_objs.funnel', '..graph_objs.densitymapbox', '..graph_objs.densitymap', '..graph_objs.contourcarpet', '..graph_objs.contour', '..graph_objs.cone', '..graph_objs.choroplethmapbox', '..graph_objs.choroplethmap', '..graph_objs.choropleth', '..graph_objs.carpet', '..graph_objs.candlestick', '..graph_objs.box', '..graph_objs.barpolar', '..graph_objs.bar', '..graph_objs.layout'],
-    ['..graph_objs.Waterfall', '..graph_objs.Volume', '..graph_objs.Violin', '..graph_objs.Treemap', '..graph_objs.Table', '..graph_objs.Surface', '..graph_objs.Sunburst', '..graph_objs.Streamtube', '..graph_objs.Splom', '..graph_objs.Scatterternary', '..graph_objs.Scattersmith', '..graph_objs.Scatterpolargl', '..graph_objs.Scatterpolar', '..graph_objs.Scattermapbox', '..graph_objs.Scattermap', '..graph_objs.Scattergl', '..graph_objs.Scattergeo', '..graph_objs.Scattercarpet', '..graph_objs.Scatter3d', '..graph_objs.Scatter', '..graph_objs.Sankey', '..graph_objs.Pie', '..graph_objs.Parcoords', '..graph_objs.Parcats', '..graph_objs.Ohlc', '..graph_objs.Mesh3d', '..graph_objs.Isosurface', '..graph_objs.Indicator', '..graph_objs.Image', '..graph_objs.Icicle', '..graph_objs.Histogram2dContour', '..graph_objs.Histogram2d', '..graph_objs.Histogram', '..graph_objs.Heatmap', '..graph_objs.Funnelarea', '..graph_objs.Funnel', '..graph_objs.Densitymapbox', '..graph_objs.Densitymap', '..graph_objs.Contourcarpet', '..graph_objs.Contour', '..graph_objs.Cone', '..graph_objs.Choroplethmapbox', '..graph_objs.Choroplethmap', '..graph_objs.Choropleth', '..graph_objs.Carpet', '..graph_objs.Candlestick', '..graph_objs.Box', '..graph_objs.Barpolar', '..graph_objs.Bar', '..graph_objs.Layout', '..graph_objs.Frame', '..graph_objs.Figure', '..graph_objs.Data', '..graph_objs.Annotations', '..graph_objs.Frames', '..graph_objs.AngularAxis', '..graph_objs.Annotation', '..graph_objs.ColorBar', '..graph_objs.Contours', '..graph_objs.ErrorX', '..graph_objs.ErrorY', '..graph_objs.ErrorZ', '..graph_objs.Font', '..graph_objs.Legend', '..graph_objs.Line', '..graph_objs.Margin', '..graph_objs.Marker', '..graph_objs.RadialAxis', '..graph_objs.Scene', '..graph_objs.Stream', '..graph_objs.XAxis', '..graph_objs.YAxis', '..graph_objs.ZAxis', '..graph_objs.XBins', '..graph_objs.YBins', '..graph_objs.Trace', '..graph_objs.Histogram2dcontour']
+    [
+        "..graph_objs.waterfall",
+        "..graph_objs.volume",
+        "..graph_objs.violin",
+        "..graph_objs.treemap",
+        "..graph_objs.table",
+        "..graph_objs.surface",
+        "..graph_objs.sunburst",
+        "..graph_objs.streamtube",
+        "..graph_objs.splom",
+        "..graph_objs.scatterternary",
+        "..graph_objs.scattersmith",
+        "..graph_objs.scatterpolargl",
+        "..graph_objs.scatterpolar",
+        "..graph_objs.scattermapbox",
+        "..graph_objs.scattermap",
+        "..graph_objs.scattergl",
+        "..graph_objs.scattergeo",
+        "..graph_objs.scattercarpet",
+        "..graph_objs.scatter3d",
+        "..graph_objs.scatter",
+        "..graph_objs.sankey",
+        "..graph_objs.pie",
+        "..graph_objs.parcoords",
+        "..graph_objs.parcats",
+        "..graph_objs.ohlc",
+        "..graph_objs.mesh3d",
+        "..graph_objs.isosurface",
+        "..graph_objs.indicator",
+        "..graph_objs.image",
+        "..graph_objs.icicle",
+        "..graph_objs.histogram2dcontour",
+        "..graph_objs.histogram2d",
+        "..graph_objs.histogram",
+        "..graph_objs.heatmap",
+        "..graph_objs.funnelarea",
+        "..graph_objs.funnel",
+        "..graph_objs.densitymapbox",
+        "..graph_objs.densitymap",
+        "..graph_objs.contourcarpet",
+        "..graph_objs.contour",
+        "..graph_objs.cone",
+        "..graph_objs.choroplethmapbox",
+        "..graph_objs.choroplethmap",
+        "..graph_objs.choropleth",
+        "..graph_objs.carpet",
+        "..graph_objs.candlestick",
+        "..graph_objs.box",
+        "..graph_objs.barpolar",
+        "..graph_objs.bar",
+        "..graph_objs.layout",
+    ],
+    [
+        "..graph_objs.Waterfall",
+        "..graph_objs.Volume",
+        "..graph_objs.Violin",
+        "..graph_objs.Treemap",
+        "..graph_objs.Table",
+        "..graph_objs.Surface",
+        "..graph_objs.Sunburst",
+        "..graph_objs.Streamtube",
+        "..graph_objs.Splom",
+        "..graph_objs.Scatterternary",
+        "..graph_objs.Scattersmith",
+        "..graph_objs.Scatterpolargl",
+        "..graph_objs.Scatterpolar",
+        "..graph_objs.Scattermapbox",
+        "..graph_objs.Scattermap",
+        "..graph_objs.Scattergl",
+        "..graph_objs.Scattergeo",
+        "..graph_objs.Scattercarpet",
+        "..graph_objs.Scatter3d",
+        "..graph_objs.Scatter",
+        "..graph_objs.Sankey",
+        "..graph_objs.Pie",
+        "..graph_objs.Parcoords",
+        "..graph_objs.Parcats",
+        "..graph_objs.Ohlc",
+        "..graph_objs.Mesh3d",
+        "..graph_objs.Isosurface",
+        "..graph_objs.Indicator",
+        "..graph_objs.Image",
+        "..graph_objs.Icicle",
+        "..graph_objs.Histogram2dContour",
+        "..graph_objs.Histogram2d",
+        "..graph_objs.Histogram",
+        "..graph_objs.Heatmap",
+        "..graph_objs.Funnelarea",
+        "..graph_objs.Funnel",
+        "..graph_objs.Densitymapbox",
+        "..graph_objs.Densitymap",
+        "..graph_objs.Contourcarpet",
+        "..graph_objs.Contour",
+        "..graph_objs.Cone",
+        "..graph_objs.Choroplethmapbox",
+        "..graph_objs.Choroplethmap",
+        "..graph_objs.Choropleth",
+        "..graph_objs.Carpet",
+        "..graph_objs.Candlestick",
+        "..graph_objs.Box",
+        "..graph_objs.Barpolar",
+        "..graph_objs.Bar",
+        "..graph_objs.Layout",
+        "..graph_objs.Frame",
+        "..graph_objs.Figure",
+        "..graph_objs.Data",
+        "..graph_objs.Annotations",
+        "..graph_objs.Frames",
+        "..graph_objs.AngularAxis",
+        "..graph_objs.Annotation",
+        "..graph_objs.ColorBar",
+        "..graph_objs.Contours",
+        "..graph_objs.ErrorX",
+        "..graph_objs.ErrorY",
+        "..graph_objs.ErrorZ",
+        "..graph_objs.Font",
+        "..graph_objs.Legend",
+        "..graph_objs.Line",
+        "..graph_objs.Margin",
+        "..graph_objs.Marker",
+        "..graph_objs.RadialAxis",
+        "..graph_objs.Scene",
+        "..graph_objs.Stream",
+        "..graph_objs.XAxis",
+        "..graph_objs.YAxis",
+        "..graph_objs.ZAxis",
+        "..graph_objs.XBins",
+        "..graph_objs.YBins",
+        "..graph_objs.Trace",
+        "..graph_objs.Histogram2dcontour",
+    ],
 )
 
 
 __all__.append("FigureWidget")
 orig_getattr = __getattr__
+
+
 def __getattr__(import_name):
     if import_name == "FigureWidget":
         try:
@@ -17,12 +149,13 @@ def __getattr__(import_name):
 
             if Version(ipywidgets.__version__) >= Version("7.0.0"):
                 from ..graph_objs._figurewidget import FigureWidget
+
                 return FigureWidget
             else:
                 raise ImportError()
         except Exception:
             from ..missing_anywidget import FigureWidget
+
             return FigureWidget
 
     return orig_getattr(import_name)
-