feat: switch code (re)formatting to ruff

Author: gvwilson

codegen/__init__.py

@@ -26,10 +26,6 @@
     get_data_validator_instance,
 )
 
-# Target Python version for code formatting with Black.
-# Must be one of the values listed in pyproject.toml.
-BLACK_TARGET_VERSIONS = "py38 py39 py310 py311 py312"
-
 
 # Import notes
 # ------------
@@ -89,6 +85,12 @@ def preprocess_schema(plotly_schema):
         items["colorscale"] = items.pop("concentrationscales")
 
 
+def reformat_code():
+    """Reformat Python code using settings in pyproject.toml."""
+
+    subprocess.call(["ruff", "format", "."])
+
+
 def perform_codegen(noformat=False):
     # Set root codegen output directory
     # ---------------------------------
@@ -344,12 +346,7 @@ def __getattr__(import_name):
     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])
+        reformat_code()
 
 
 if __name__ == "__main__":

commands.py

@@ -1,7 +1,7 @@
 """Utility command runner."""
 
 import argparse
-from distutils import log
+import logging
 import json
 import os
 import platform
@@ -11,9 +11,10 @@
 import sys
 import time
 
-from codegen import perform_codegen
+from codegen import perform_codegen, reformat_code
 
 
+LOGGER = logging.getLogger(__name__)
 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")
@@ -54,19 +55,19 @@ def install_js_deps(local):
 
     skip_npm = os.environ.get("SKIP_NPM", False)
     if skip_npm:
-        log.info("Skipping npm-installation")
+        LOGGER.info("Skipping npm-installation")
         return
 
     if not has_npm:
-        log.error(
+        LOGGER.error(
             "`npm` unavailable.  If you're running this command using sudo, make sure `npm` is available to sudo"
         )
 
     env = os.environ.copy()
     env["PATH"] = NPM_PATH
 
     if has_npm:
-        log.info("Installing build dependencies with npm.  This may take a while...")
+        LOGGER.info("Installing build dependencies with npm.  This may take a while...")
         check_call(
             [npmName, "install"],
             cwd=NODE_ROOT,
@@ -130,9 +131,7 @@ def overwrite_plotlyjs_version_file(plotlyjs_version):
 # DO NOT EDIT
 # This file is generated by the updatebundle commands.py command
 __plotlyjs_version__ = "{plotlyjs_version}"
-""".format(
-                plotlyjs_version=plotlyjs_version
-            )
+""".format(plotlyjs_version=plotlyjs_version)
         )
 
 
@@ -223,7 +222,6 @@ def update_plotlyjs(plotly_js_version):
 
 # Update the plotly.js schema and bundle from master
 def update_schema_bundle_from_master():
-
     if "--devrepo" in sys.argv:
         devrepo = sys.argv[sys.argv.index("--devrepo") + 1]
     else:
@@ -295,9 +293,15 @@ def parse_args():
     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_codegen.add_argument(
+        "--noformat", action="store_true", help="prevent reformatting"
+    )
 
-    p_updateplotlyjsdev = subparsers.add_parser("updateplotlyjsdev", help="update plotly.js for development")
+    p_format = subparsers.add_parser("format", help="reformat code")
+
+    p_updateplotlyjsdev = subparsers.add_parser(
+        "updateplotlyjsdev", help="update plotly.js for development"
+    )
 
     p_updateplotlyjs = subparsers.add_parser("updateplotlyjs", help="update plotly.js")
 
@@ -312,6 +316,9 @@ def main():
     if args.cmd == "codegen":
         perform_codegen(noformat=args.noformat)
 
+    elif args.cmd == "format":
+        reformat_code()
+
     elif args.cmd == "updateplotlyjsdev":
         update_plotlyjs_dev()
 

pyproject.toml

@@ -47,7 +47,11 @@ dependencies = [
 [project.optional-dependencies]
 express = ["numpy"]
 kaleido = ["kaleido==1.0.0rc15"]
-dev = ["black==25.1.0"]
+dev = [
+    "inflect=7.5.0",
+    "requests==2.32.3",
+    "ruff==0.11.12"
+]
 
 [project.scripts]
 plotly_get_chrome = "plotly.io._kaleido:get_chrome"
@@ -65,27 +69,8 @@ plotly = [
     "package_data/datasets/*",
 ]
 
-[tool.black]
-line-length = 88
-target_version = ['py38', 'py39', 'py310', 'py311', 'py312']
-include = '\.pyi?$'
-exclude = '''
-/(
-      \.eggs         # exclude a few common directories in the
-    | \.git          # root of the project
-    | \.hg
-    | \.mypy_cache
-    | \.tox
-    | \.venv
-    | _build
-    | buck-out
-    | build
-    | dist
-    | js
-    | submodules
-    | plotly/matplotlylib/mplexporter
-)/
-'''
+[tool.ruff]
+target-version = "py38"
 
 [tool.jupyter-packaging.builder]
 factory = "jupyter_packaging.npm_builder"