feat: merging code generator work with latest changes on master

1.  Modify `commands.py` to run code generation.
1.  Remove comments from generated code.
1.  Replaced named arguments in constructors with positional arguments.
1.  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).

fix

Author: gvwilson

codegen/datatypes.py

@@ -69,11 +69,10 @@ def build_datatype_py(node):
     """
 
     # Validate inputs
-    # ---------------
     assert node.is_compound
 
     # Handle template traces
-    # ----------------------
+    #
     # We want template trace/layout classes like
     # plotly.graph_objs.layout.template.data.Scatter to map to the
     # corresponding trace/layout class (e.g. plotly.graph_objs.Scatter).
@@ -85,17 +84,14 @@ def build_datatype_py(node):
         return "from plotly.graph_objs import Layout"
 
     # Extract node properties
-    # -----------------------
     undercase = node.name_undercase
     datatype_class = node.name_datatype_class
     literal_nodes = [n for n in node.child_literals if n.plotly_name in ["type"]]
 
     # Initialze source code buffer
-    # ----------------------------
     buffer = StringIO()
 
     # Imports
-    # -------
     buffer.write(
         f"from plotly.basedatatypes "
         f"import {node.name_base_datatype} as _{node.name_base_datatype}\n"
@@ -106,7 +102,6 @@ def build_datatype_py(node):
         buffer.write(f"from warnings import warn\n")
 
     # Write class definition
-    # ----------------------
     buffer.write(
         f"""
 
@@ -168,10 +163,9 @@ def _subplot_re_match(self, prop):
     valid_props_list = sorted(
         [node.name_property for node in subtype_nodes + literal_nodes]
     )
+    # class properties
     buffer.write(
         f"""
-    # class properties
-    # --------------------
     _parent_path_str = '{node.parent_path_str}'
     _path_str = '{node.path_str}'
     _valid_props = {{"{'", "'.join(valid_props_list)}"}}
@@ -268,8 +262,6 @@ def {literal_node.name_property}(self):
     valid_props = {node.name_property for node in subtype_nodes}
     buffer.write(
         f"""
-    # Self properties description
-    # ---------------------------
     @property
     def _prop_descriptions(self):
         return \"\"\"\\"""
@@ -331,18 +323,17 @@ def __init__(self"""
     )
 
     if datatype_class == "Layout":
-        buffer.write(
-            f"""
         # Override _valid_props for instance so that instance can mutate set
         # to support subplot properties (e.g. xaxis2)
+        buffer.write(
+            f"""
         self._valid_props = {{"{'", "'.join(valid_props_list)}"}}
 """
         )
 
+    # Validate arg
     buffer.write(
         f"""
-        # Validate arg
-        # ------------
         if arg is None:
             arg = {{}}
         elif isinstance(arg, self.__class__):
@@ -355,19 +346,12 @@ def __init__(self"""
 constructor must be a dict or
 an instance of :class:`{class_name}`\"\"\")
 
-        # Handle skip_invalid
-        # -------------------
         self._skip_invalid = kwargs.pop('skip_invalid', False)
         self._validate = kwargs.pop('_validate', True)
         """
     )
 
-    buffer.write(
-        f"""
-
-        # Populate data dict with properties
-        # ----------------------------------"""
-    )
+    buffer.write("\n\n")
     for subtype_node in subtype_nodes:
         name_prop = subtype_node.name_property
         buffer.write(
@@ -377,13 +361,7 @@ def __init__(self"""
 
     # ### Literals ###
     if literal_nodes:
-        buffer.write(
-            f"""
-
-        # Read-only literals
-        # ------------------
-"""
-        )
+        buffer.write("\n\n")
         for literal_node in literal_nodes:
             lit_name = literal_node.name_property
             lit_val = repr(literal_node.node_data)
@@ -395,13 +373,7 @@ def __init__(self"""
 
     buffer.write(
         f"""
-
-        # Process unknown kwargs
-        # ----------------------
         self._process_kwargs(**dict(arg, **kwargs))
-
-        # Reset skip_invalid
-        # ------------------
         self._skip_invalid = False
 """
     )
@@ -420,7 +392,6 @@ def __init__(self"""
         )
 
     # Return source string
-    # --------------------
     return buffer.getvalue()
 
 
@@ -527,11 +498,9 @@ def add_docstring(
 
     """
     # Validate inputs
-    # ---------------
     assert node.is_compound
 
     # Build wrapped description
-    # -------------------------
     node_description = node.description
     if node_description:
         description_lines = textwrap.wrap(
@@ -544,7 +513,6 @@ def add_docstring(
         node_description = "\n".join(description_lines) + "\n\n"
 
     # Write header and description
-    # ----------------------------
     buffer.write(
         f"""
         \"\"\"
@@ -555,7 +523,7 @@ def add_docstring(
     )
 
     # Write parameter descriptions
-    # ----------------------------
+
     # Write any prepend extras
     for p, v in prepend_extras:
         v_wrapped = "\n".join(
@@ -594,7 +562,6 @@ def add_docstring(
         )
 
     # Write return block and close docstring
-    # --------------------------------------
     buffer.write(
         f"""
 
@@ -623,16 +590,13 @@ def write_datatype_py(outdir, node):
     """
 
     # Build file path
-    # ---------------
     # filepath = opath.join(outdir, "graph_objs", *node.parent_path_parts, "__init__.py")
     filepath = opath.join(
         outdir, "graph_objs", *node.parent_path_parts, "_" + node.name_undercase + ".py"
     )
 
     # Generate source code
-    # --------------------
     datatype_source = build_datatype_py(node)
 
     # Write file
-    # ----------
     write_source_py(datatype_source, filepath, leading_newlines=2)

codegen/validators.py

@@ -54,8 +54,7 @@ def __init__(self, plotly_name={params['plotly_name']},
     # ### Write constructor ###
     buffer.write(
         f"""
-        super().__init__(plotly_name=plotly_name,
-                         parent_name=parent_name"""
+        super().__init__(plotly_name, parent_name"""
     )
 
     # Write out remaining constructor parameters
@@ -198,10 +197,7 @@ def __init__(self, plotly_name={params['plotly_name']},
                        parent_name={params['parent_name']},
                        **kwargs):
 
-        super().__init__(class_strs_map={params['class_strs_map']},
-                         plotly_name=plotly_name,
-                         parent_name=parent_name,
-                         **kwargs)"""
+        super().__init__({params['class_strs_map']}, plotly_name, parent_name, **kwargs)"""
     )
 
     return buffer.getvalue()

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()