feat: allow --schema path option to code generation

Example usage: `uv run bin/generate_code.py --codedir /tmp/gen --schema /tmp/plot-schema.json`

Author: gvwilson

bin/codegen/__init__.py

@@ -1,5 +1,6 @@
 import json
 import os
+from pathlib import Path
 import shutil
 import sys
 
@@ -27,6 +28,11 @@
 )
 
 
+PROJECT_ROOT = Path(__file__).parent.parent.parent
+PLOT_SCHEMA_RELATIVE = Path("resources") / "plot-schema.json"
+PLOT_SCHEMA = PROJECT_ROOT / PLOT_SCHEMA_RELATIVE
+
+
 # Import notes
 # ------------
 # Nothing from the plotly/ package should be imported during code
@@ -94,7 +100,7 @@ def make_paths(codedir):
     return validators_dir, graph_objects_dir, graph_objs_path
 
 
-def perform_codegen(codedir, noformat=False):
+def perform_codegen(codedir, noformat=False, schema=PLOT_SCHEMA):
     """Generate code."""
 
     # Get paths
@@ -108,8 +114,7 @@ def perform_codegen(codedir, noformat=False):
 
     # Load plotly schema
     project_root = codedir.parent
-    plot_schema_path = project_root / "resources" / "plot-schema.json"
-    with open(plot_schema_path, "r") as f:
+    with open(schema, "r") as f:
         plotly_schema = json.load(f)
 
     # Preprocess Schema
@@ -284,7 +289,9 @@ def __getattr__(import_name):
             init_extra = optional_figure_widget_import
         else:
             init_extra = ""
-        write_init_py(graph_objects_pkg, path_parts, rel_modules, rel_classes, init_extra)
+        write_init_py(
+            graph_objects_pkg, path_parts, rel_modules, rel_classes, init_extra
+        )
 
     # Output graph_objs.py alias
     graph_objs_rel_classes = [
@@ -303,7 +310,7 @@ def __getattr__(import_name):
     )
     graph_objs_path = codedir / "graph_objs"
     graph_objs_path.mkdir(parents=True, exist_ok=True)
-    graph_objs_path /=  "__init__.py"
+    graph_objs_path /= "__init__.py"
     with open(graph_objs_path, "wt") as f:
         f.write("# ruff: noqa: F401\n")
         f.write(graph_objs_init_source)

bin/generate_code.py

@@ -11,15 +11,21 @@ def main():
 
     args = parse_args()
     codedir = utils.select_code_directory(args)
-    utils.perform_codegen(codedir, noformat=args.noformat)
+    utils.perform_codegen(codedir, noformat=args.noformat, schema=args.schema)
 
 
 def parse_args():
     """Parse command-line arguments."""
 
     parser = argparse.ArgumentParser()
-    parser.add_argument("--noformat", action="store_true", help="prevent reformatting")
     parser.add_argument("--codedir", type=Path, help="code directory")
+    parser.add_argument("--noformat", action="store_true", help="prevent reformatting")
+    parser.add_argument(
+        "--schema",
+        type=Path,
+        default=utils.PLOT_SCHEMA,
+        help=f"schema file (default {utils.PLOT_SCHEMA})",
+    )
     return parser.parse_args()
 
 

bin/utils.py

@@ -3,22 +3,22 @@
 import logging
 import json
 import os
-from pathlib import Path
 import platform
 import requests
 import shutil
 from subprocess import check_call
 import sys
 import time
 
-from codegen import perform_codegen
-
+from codegen import (
+    perform_codegen,
+    PROJECT_ROOT,
+    PLOT_SCHEMA,
+)
 
 LOGGER = logging.getLogger(__name__)
-PROJECT_ROOT = Path(__file__).parent.parent
 NODE_ROOT = PROJECT_ROOT / "js"
 NODE_MODULES = NODE_ROOT / "node_modules"
-PLOT_SCHEMA = PROJECT_ROOT / "resources" / "plot-schema.json"
 WIDGET_TARGETS = [PROJECT_ROOT / "plotly" / "package_data" / "widgetbundle.js"]
 NPM_PATH = os.pathsep.join(
     [