top: Pin black version.

This replaces the codeformat.py script with just running black directly,
both from GitHub CI and from pre-commit, same as how we do `ruff`.

This allows us to avoid needing to use the system black version for
pre-commit, and lets us pin the same version for both.

pyproject.toml is now used for configuration.

The old codeformat.py is still kept (but now just runs black directly).

This work was funded through GitHub Sponsors.

Signed-off-by: Jim Mussared <[email protected]>

.github/workflows/code_formatting.yml

@@ -1,16 +1,10 @@
-name: Check code formatting
-
+# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+name: Python code formatting with black
 on: [push, pull_request]
-
 jobs:
-  build:
+  black:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: actions/setup-python@v4
-    - name: Install packages
-      run: source tools/ci.sh && ci_code_formatting_setup
-    - name: Run code formatting
-      run: source tools/ci.sh && ci_code_formatting_run
-    - name: Check code formatting
-      run: git diff --exit-code
+    - run: pip install --user black==23.7.0
+    - run: black .

.pre-commit-config.yaml

@@ -1,11 +1,9 @@
 repos:
-  - repo: local
+  - repo: https://github.com/psf/black
+    rev: 23.7.0
     hooks:
-      - id: codeformat
-        name: MicroPython codeformat.py for changed files
-        entry: tools/codeformat.py -v -f
-        language: python
+      - id: black
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.280
+    rev: v0.1.0
     hooks:
       - id: ruff

pyproject.toml

@@ -97,3 +97,7 @@ max-statements = 166
 
 # ble multitests are evaluated with some names pre-defined
 "micropython/bluetooth/aioble/multitests/*" = ["F821"]
+
+[tool.black]
+line-length = 99
+fast = 1

tools/ci.sh

@@ -1,20 +1,5 @@
 #!/bin/bash
 
-########################################################################################
-# code formatting
-
-function ci_code_formatting_setup {
-    sudo apt-add-repository --yes --update ppa:pybricks/ppa
-    sudo apt-get install uncrustify
-    pip3 install black
-    uncrustify --version
-    black --version
-}
-
-function ci_code_formatting_run {
-    tools/codeformat.py -v
-}
-
 ########################################################################################
 # build packages
 

tools/codeformat.py

@@ -25,87 +25,19 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-# This is based on tools/codeformat.py from the main micropython/micropython
-# repository but without support for .c/.h files.
+# This is just a wrapper around running black, so that code formatting can be
+# invoked in the same way as in the main repo.
 
-import argparse
-import glob
-import itertools
 import os
-import re
 import subprocess
 
-# Relative to top-level repo dir.
-PATHS = [
-    "**/*.py",
-]
-
-EXCLUSIONS = []
-
 # Path to repo top-level dir.
 TOP = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
 
-PY_EXTS = (".py",)
-
-
-def list_files(paths, exclusions=None, prefix=""):
-    files = set()
-    for pattern in paths:
-        files.update(glob.glob(os.path.join(prefix, pattern), recursive=True))
-    for pattern in exclusions or []:
-        files.difference_update(glob.fnmatch.filter(files, os.path.join(prefix, pattern)))
-    return sorted(files)
-
 
 def main():
-    cmd_parser = argparse.ArgumentParser(description="Auto-format Python files.")
-    cmd_parser.add_argument("-v", action="store_true", help="Enable verbose output")
-    cmd_parser.add_argument(
-        "-f",
-        action="store_true",
-        help="Filter files provided on the command line against the default list of files to check.",
-    )
-    cmd_parser.add_argument("files", nargs="*", help="Run on specific globs")
-    args = cmd_parser.parse_args()
-
-    # Expand the globs passed on the command line, or use the default globs above.
-    files = []
-    if args.files:
-        files = list_files(args.files)
-        if args.f:
-            # Filter against the default list of files. This is a little fiddly
-            # because we need to apply both the inclusion globs given in PATHS
-            # as well as the EXCLUSIONS, and use absolute paths
-            files = {os.path.abspath(f) for f in files}
-            all_files = set(list_files(PATHS, EXCLUSIONS, TOP))
-            if args.v:  # In verbose mode, log any files we're skipping
-                for f in files - all_files:
-                    print("Not checking: {}".format(f))
-            files = list(files & all_files)
-    else:
-        files = list_files(PATHS, EXCLUSIONS, TOP)
-
-    # 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
-
-    # Run tool on N files at a time (to avoid making the command line too long).
-    def batch(cmd, files, N=200):
-        while True:
-            file_args = list(itertools.islice(files, N))
-            if not file_args:
-                break
-            subprocess.check_call(cmd + file_args)
-
-    # Format Python files with black.
-    command = ["black", "--fast", "--line-length=99"]
-    if args.v:
-        command.append("-v")
-    else:
-        command.append("-q")
-    batch(command, lang_files(PY_EXTS))
+    command = ["black", "."]
+    subprocess.check_call(command, cwd=TOP)
 
 
 if __name__ == "__main__":