Switch to ruff like MicroPython

Author: tannewt

.pre-commit-config.yaml

@@ -39,10 +39,19 @@ repos:
     -   id: formatting
         name: Formatting
         entry: python3 tools/codeformat.py
-        types_or: [c, python]
+        types: [c]
         language: system
         exclude: |
           (?x)^(
             lib/tinyusb|
             ports/raspberrypi/sdk
           )
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.9.4
+  hooks:
+    # Run the linter.
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format

pyproject.toml

@@ -4,3 +4,38 @@
 
 [tool.setuptools_scm]
 # can be empty if no extra settings are needed, presence enables setuptools-scm
+
+# Ruff settings copied from MicroPython
+[tool.ruff]
+# Exclude third-party code from linting and formatting
+extend-exclude = ["lib"]
+line-length = 99
+target-version = "py37"
+
+[tool.ruff.lint]
+extend-select = ["C9", "PLC"]
+ignore = [
+  "E401",
+  "E402",
+  "E722",
+  "E731",
+  "E741",
+  "F401",
+  "F403",
+  "F405",
+  "PLC1901",
+]
+
+[tool.ruff.mccabe]
+max-complexity = 40
+
+[tool.ruff.lint.per-file-ignores]
+# Exclude all tests from linting (does not apply to formatting).
+"tests/**/*.py" = ["ALL"]
+
+[tool.ruff.format]
+# Exclude third-party code, and exclude the following tests:
+#   basics: needs careful attention before applying automatic formatting
+#   repl_: not real python files
+#   viper_args: uses f(*)
+exclude = ["tests/basics/*.py", "tests/*/repl_*.py", "tests/micropython/viper_args.py"]

tools/codeformat.py

@@ -39,7 +39,6 @@
 # Relative to top-level repo dir.
 # CIRCUITPY-CHANGE: different directory trees
 PATHS = [
-    # C
     "main.c",
     "devices/**/*.[ch]",
     "extmod/*.[ch]",
@@ -52,26 +51,14 @@
     "shared-bindings/**/*.[ch]",
     "shared-module/**/*.[ch]",
     "supervisor/**/*.[ch]",
-    # Python
-    "extmod/*.py",
-    "ports/**/*.py",
-    "py/**/*.py",
-    "tools/**/*.py",
-    "tests/circuitpython-*/**/*.py",
 ]
 
 # CIRCUITPY-CHANGE: different exclusions
 EXCLUSIONS = [
     # STM32 build includes generated Python code.
     "ports/*/build*",
-    # gitignore in ports/unix ignores *.py, so also do it here.
-    "ports/unix/**/*.py",
-    # not real python files
-    "tests/**/repl_*.py",
     # don't reindent this third-party code we vendored in
     "ports/raspberrypi/lwip_src",
-    # line breaks
-    "tools/mpy-tool.py",
 ]
 
 
@@ -119,12 +106,6 @@ def transform(m):
 TOP = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
 
 UNCRUSTIFY_CFG = os.path.join(TOP, "tools/uncrustify.cfg")
-# CIRCUITPY-CHANGE
-C_EXTS = (
-    ".c",
-    ".h",
-)
-PY_EXTS = (".py",)
 
 
 def check_uncrustify_version():
@@ -217,14 +198,8 @@ def main():
     # Expand the arguments passed on the command line, subject to the PATHS and EXCLUSIONS
     files = list_files(args.files)
 
-    # Extract files matching a specific language.
-    def lang_files(exts):
-        for file in files:
-            if os.path.splitext(file)[1].lower() in exts:
-                yield file
-
     def bindings_files():
-        for file in lang_files(C_EXTS):
+        for file in files:
             if file.startswith("shared-bindings/") or "/bindings/" in file:
                 yield file
 
@@ -248,8 +223,8 @@ def batch(cmd, files, N=200, check=False):
         command = ["uncrustify", "-c", UNCRUSTIFY_CFG, "-lC", "--no-backup"]
         if not args.v:
             command.append("-q")
-        batch(command, lang_files(C_EXTS))
-        for file in lang_files(C_EXTS):
+        batch(command, files)
+        for file in files:
             fixup_c(file)
         # Format bindings with black_bindings
         if format_py:
@@ -258,12 +233,13 @@ def batch(cmd, files, N=200, check=False):
 
     # Format Python files with black.
     if format_py:
-        command = ["black", "--fast", "--line-length=99"]
+        command = ["rust", "format"]
         if args.v:
             command.append("-v")
         else:
             command.append("-q")
-        batch(command, lang_files(PY_EXTS))
+        command.append(".")
+        subprocess.check_call(command, cwd=TOP)
 
 
 if __name__ == "__main__":