File size: 5,846 Bytes
2569bec | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 | #!/usr/bin/env python3
"""Format repository sources or check that they are already formatted."""
import argparse
import os
import shlex
import subprocess
import sys
from concurrent.futures import ThreadPoolExecutor, as_completed
from dataclasses import dataclass
from pathlib import Path
REPO_ROOT = Path(__file__).resolve().parents[1]
@dataclass(frozen=True)
class Command:
args: tuple[str, ...]
cwd: Path = REPO_ROOT
@dataclass(frozen=True)
class FormatterGroup:
name: str
commands: tuple[Command, ...]
@dataclass(frozen=True)
class FormatterResult:
name: str
output: str
returncode: int
def just_formatter_group(*, check: bool) -> FormatterGroup:
args = ["just", "--unstable", "--fmt"]
if check:
args.append("--check")
return FormatterGroup("Just", (Command(tuple(args)),))
def rust_formatter_group(*, check: bool) -> FormatterGroup:
args = ["cargo", "fmt", "--", "--config", "imports_granularity=Item"]
if check:
args.append("--check")
command = Command(tuple(args), REPO_ROOT / "codex-rs")
return FormatterGroup("Rust", (command,))
def buildifier_formatter_group(*, check: bool) -> FormatterGroup:
repository_files = subprocess.check_output(
["git", "ls-files", "-z", "--cached", "--others", "--exclude-standard"],
cwd=REPO_ROOT,
).split(b"\0")
buildifier_files: list[str] = []
for encoded_path in repository_files:
if not encoded_path:
continue
path = Path(os.fsdecode(encoded_path))
name = path.name
if (
name in {"BUILD", "WORKSPACE", "MODULE.bazel"}
or name.startswith(("BUILD.", "WORKSPACE."))
or name.endswith((".BUILD.bazel", ".MODULE.bazel", ".bzl", ".sky"))
or ".bzl." in name
or ".sky." in name
):
buildifier_files.append(path.as_posix())
buildifier_files.sort()
# Invoke DotSlash explicitly because Windows does not honor shebangs.
buildifier_args = [
"dotslash",
str(REPO_ROOT / "tools" / "buildifier"),
"-mode=check" if check else "-mode=fix",
"-lint=off",
*buildifier_files,
]
return FormatterGroup("Bazel/Starlark", (Command(tuple(buildifier_args)),))
def python_sdk_formatter_group(*, check: bool) -> FormatterGroup:
# Each `--project` retains its local dependency and Ruff configuration context.
uv_run_args = [
"uv",
"run",
"--frozen",
"--project",
"sdk/python",
"--only-group",
"format",
]
format_args = [
*uv_run_args,
"ruff",
"format",
]
if check:
format_args.append("--check")
# `ruff check --diff` reports lint-driven rewrites without changing files.
# It is the check-mode counterpart of `--fix --fix-only`, not a full lint gate.
lint_args = ["ruff", "check", "--diff"]
else:
# Ruff's lint fixer and formatter are separate passes: the first applies
# fixable lint rewrites, while the second formats source layout.
lint_args = ["ruff", "check", "--fix", "--fix-only"]
return FormatterGroup(
"Python SDK",
(
Command((*uv_run_args, *lint_args, "sdk/python")),
Command((*format_args, "sdk/python")),
),
)
def python_scripts_formatter_group(*, check: bool) -> FormatterGroup:
args = ["uv", "run", "--frozen", "--project", "scripts", "ruff", "format"]
if check:
args.append("--check")
args.append(".")
return FormatterGroup("Python scripts", (Command(tuple(args)),))
def formatter_groups(*, check: bool) -> tuple[FormatterGroup, ...]:
return (
just_formatter_group(check=check),
rust_formatter_group(check=check),
buildifier_formatter_group(check=check),
python_sdk_formatter_group(check=check),
python_scripts_formatter_group(check=check),
)
def run_formatter_group(group: FormatterGroup) -> FormatterResult:
"""Run one formatter group sequentially and return its buffered output."""
for command in group.commands:
try:
process = subprocess.run(
command.args,
cwd=command.cwd,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
text=True,
check=False,
)
except OSError as error:
output = f"$ {shlex.join(command.args)}\n{error}\n"
return FormatterResult(group.name, output, 1)
if process.returncode != 0:
output = f"$ {shlex.join(command.args)}\n{process.stdout}"
if process.stdout and not process.stdout.endswith("\n"):
output += "\n"
return FormatterResult(group.name, output, process.returncode)
return FormatterResult(group.name, "", 0)
def main() -> int:
parser = argparse.ArgumentParser()
parser.add_argument(
"--check",
action="store_true",
help="check formatting without modifying files",
)
args = parser.parse_args()
groups = formatter_groups(check=args.check)
failures: list[str] = []
with ThreadPoolExecutor(max_workers=len(groups)) as executor:
futures = [executor.submit(run_formatter_group, group) for group in groups]
for future in as_completed(futures):
result = future.result()
if result.returncode != 0:
failures.append(result.name)
print(f"==> {result.name} formatter failed", file=sys.stderr)
print(result.output, end="", file=sys.stderr)
if failures:
print(f"Formatting failed: {', '.join(failures)}", file=sys.stderr)
return 1
return 0
if __name__ == "__main__":
raise SystemExit(main())
|