Merge pull request #300 from PyO3/xtask

Add xtask Python script to automate recurring development tasks.

Author: adamreichold

.github/workflows/ci.yml

@@ -24,9 +24,7 @@ jobs:
           default: true
       - uses: Swatinem/rust-cache@v1
         continue-on-error: true
-      - run: |
-          cargo fmt --all -- --check
-          cargo clippy --workspace --tests -- --deny warnings
+      - run: ./x.py check
 
   test:
     name: python${{ matrix.python-version }}-${{ matrix.platform.python-architecture }} ${{ matrix.platform.os }}

x.py

@@ -0,0 +1,138 @@
+#!/usr/bin/env python3
+
+import argparse
+import os
+import subprocess
+import sys
+from pathlib import Path
+
+
+def run(*args):
+    subprocess.run([*args], check=True)
+
+
+def can_run(*args):
+    try:
+        subprocess.run([*args], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        return True
+    except OSError:
+        return False
+
+
+def nightly():
+    proc = subprocess.run(["rustc", "--version"], capture_output=True)
+    return b"-nightly " in proc.stdout
+
+
+def default(args):
+    run("cargo", "fmt")
+
+    if nightly():
+        run("cargo", "clippy", "--workspace", "--tests", "--benches")
+    else:
+        run("cargo", "clippy", "--workspace", "--tests")
+
+    run("cargo", "test", "--lib", "--tests")
+
+
+def check(args):
+    run("cargo", "fmt", "--", "--check")
+
+    run("cargo", "clippy", "--workspace", "--tests", "--", "--deny", "warnings")
+
+
+def doc(args):
+    run("cargo", "doc")
+
+    if args.name is None:
+        run("cargo", "test", "--doc")
+    else:
+        run("cargo", "test", "--doc", args.name)
+
+
+def test(args):
+    if args.name is None:
+        run("cargo", "test", "--tests")
+    else:
+        run("cargo", "test", "--test", args.name)
+
+
+def bench(args):
+    if not nightly():
+        sys.exit("Benchmarks require a nightly build of the Rust compiler.")
+
+    if args.name is None:
+        run("cargo", "bench", "--benches")
+    else:
+        run("cargo", "bench", "--bench", args.name)
+
+
+def examples(args):
+    if not can_run("nox", "--version"):
+        sys.exit("Examples require the Nox tool (https://nox.thea.codes)")
+
+    if args.name is None:
+        dirs = [
+            dir_.name
+            for dir_ in Path("examples").iterdir()
+            if (dir_ / "noxfile.py").exists()
+        ]
+    else:
+        dirs = [args.name]
+
+    for dir in dirs:
+        run("nox", "--noxfile", f"examples/{dir}/noxfile.py")
+
+
+def format_(args):
+    if not can_run("black", "--version"):
+        sys.exit(
+            "Formatting requires the Black formatter (https://github.com/psf/black)"
+        )
+
+    run("cargo", "fmt")
+    run("black", ".")
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    subparsers = parser.add_subparsers(
+        help="Default action is Rustfmt, Clippy and tests"
+    )
+    parser.set_defaults(func=default)
+
+    check_parser = subparsers.add_parser(
+        "check", aliases=["c"], help="Rustfmt and Clippy (as in the CI)"
+    )
+    check_parser.set_defaults(func=check)
+
+    doc_parser = subparsers.add_parser(
+        "doc", aliases=["d"], help="Rustdoc and doctests"
+    )
+    doc_parser.set_defaults(func=doc)
+    doc_parser.add_argument("name", nargs="?", help="Test case name")
+
+    test_parser = subparsers.add_parser("test", aliases=["t"], help="Integration tests")
+    test_parser.set_defaults(func=test)
+    test_parser.add_argument("name", nargs="?", help="Test target name")
+
+    bench_parser = subparsers.add_parser(
+        "bench", aliases=["b"], help="Benchmarks (requires nightly)"
+    )
+    bench_parser.set_defaults(func=bench)
+    bench_parser.add_argument("name", nargs="?", help="Benchmark target name")
+
+    examples_parser = subparsers.add_parser(
+        "examples", aliases=["e"], help="Examples (requires Nox)"
+    )
+    examples_parser.set_defaults(func=examples)
+    examples_parser.add_argument("name", nargs="?", help="Example directory name")
+
+    format_parser = subparsers.add_parser(
+        "format", aliases=["f"], help="Format Rust and Python code (requires Black)"
+    )
+    format_parser.set_defaults(func=format_)
+
+    args = parser.parse_args()
+    os.chdir(Path(__file__).parent)
+    args.func(args)