feat: switch to argparse and clean up imports in commands.py

Author: gvwilson

codegen/__init__.py

@@ -89,7 +89,7 @@ def preprocess_schema(plotly_schema):
         items["colorscale"] = items.pop("concentrationscales")
 
 
-def perform_codegen(reformat=True):
+def perform_codegen(noformat=False):
     # Set root codegen output directory
     # ---------------------------------
     # (relative to project root)
@@ -341,15 +341,15 @@ def __getattr__(import_name):
         f.write(graph_objects_init_source)
 
     # ### Run black code formatter on output directories ###
-    if reformat:
+    if noformat:
+        print("skipping reformatting")
+    else:
         target_version = [
             f"--target-version={v}" for v in BLACK_TARGET_VERSIONS.split()
         ]
         subprocess.call(["black", *target_version, validators_pkgdir])
         subprocess.call(["black", *target_version, graph_objs_pkgdir])
         subprocess.call(["black", *target_version, graph_objects_path])
-    else:
-        print("skipping reformatting")
 
 
 if __name__ == "__main__":

commands.py

@@ -1,13 +1,19 @@
+"""Utility command runner."""
+
+import argparse
 from distutils import log
 import json
 import os
 import platform
+import requests
 import shutil
 from subprocess import check_call
 import sys
 import time
 
-USAGE = "usage: python commands.py [updateplotlyjsdev | updateplotlyjs | codegen]"
+from codegen import perform_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")
@@ -89,24 +95,12 @@ def install_js_deps(local):
             raise ValueError(msg)
 
 
-# Generate class hierarchy from Plotly JSON schema
-def run_codegen():
-    if sys.version_info < (3, 8):
-        raise ImportError("Code generation must be executed with Python >= 3.8")
-
-    from codegen import perform_codegen
-
-    perform_codegen()
-
-
 def overwrite_schema_local(uri):
     path = os.path.join(PROJECT_ROOT, "codegen", "resources", "plot-schema.json")
     shutil.copyfile(uri, path)
 
 
 def overwrite_schema(url):
-    import requests
-
     req = requests.get(url)
     assert req.status_code == 200
     path = os.path.join(PROJECT_ROOT, "codegen", "resources", "plot-schema.json")
@@ -120,8 +114,6 @@ def overwrite_bundle_local(uri):
 
 
 def overwrite_bundle(url):
-    import requests
-
     req = requests.get(url)
     print("url:", url)
     assert req.status_code == 200
@@ -145,8 +137,6 @@ def overwrite_plotlyjs_version_file(plotlyjs_version):
 
 
 def request_json(url):
-    import requests
-
     req = requests.get(url)
     return json.loads(req.content.decode("utf-8"))
 
@@ -228,7 +218,7 @@ def update_bundle(plotly_js_version):
 def update_plotlyjs(plotly_js_version):
     update_bundle(plotly_js_version)
     update_schema(plotly_js_version)
-    run_codegen()
+    perform_codegen()
 
 
 # Update the plotly.js schema and bundle from master
@@ -296,20 +286,43 @@ def update_schema_bundle_from_master():
 # Update project to a new development version of plotly.js
 def update_plotlyjs_dev():
     update_schema_bundle_from_master()
-    run_codegen()
+    perform_codegen()
+
+
+def parse_args():
+    """Parse command-line arguments."""
+    parser = argparse.ArgumentParser()
+    subparsers = parser.add_subparsers(dest="cmd", help="Available subcommands")
+
+    p_codegen = subparsers.add_parser("codegen", help="generate code")
+    p_codegen.add_argument("--noformat", action="store_true", help="prevent reformatting")
+
+    p_updateplotlyjsdev = subparsers.add_parser("updateplotlyjsdev", help="update plotly.js for development")
+
+    p_updateplotlyjs = subparsers.add_parser("updateplotlyjs", help="update plotly.js")
+
+    return parser.parse_args()
 
 
 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":
+    """Main driver."""
+
+    args = parse_args()
+
+    if args.cmd == "codegen":
+        perform_codegen(noformat=args.noformat)
+
+    elif args.cmd == "updateplotlyjsdev":
         update_plotlyjs_dev()
-    elif sys.argv[1] == "updateplotlyjs":
-        print(plotly_js_version())
-        update_plotlyjs(plotly_js_version())
+
+    elif args.cmd == "updateplotlyjs":
+        version = plotly_js_version()
+        print(version)
+        update_plotlyjs(version)
+
+    else:
+        print(f"unknown command {args.cmd}", file=sys.stderr)
+        sys.exit(1)
 
 
 if __name__ == "__main__":