mirror of
https://github.com/pchuan98/codex.git
synced 2026-07-01 00:31:56 +08:00
[codex] Add comprehensive root formatting check (#25683)
## Why The root formatting entrypoints could drift: `just fmt` did not format the Justfile itself, and the CI-facing check recipe only checked Python scripts instead of matching everything formatted by `just fmt`. ## What changed - Add a shared cross-platform Python formatter driver used by both `just fmt` and `just fmt-check`. - Run Justfile, Rust, Python SDK, and internal-script formatter groups concurrently while buffering each formatter group's output until it finishes. - Log formatter starts immediately, then print each formatter group's labeled output when it completes. - Keep the SDK lint-fix and Ruff formatting passes ordered, with source comments explaining their distinct roles and the check-mode equivalents. - Run Ruff through shared `uv run --no-sync --with ruff` overlays so formatting works on clean glibc Linux checkouts without installing the platform-specific SDK runtime wheel. - Show `fmt-check` help text in `just -l` and simplify CI to call the shared driver through `just fmt-check`. - Pin the general CI workflow to `just@1.51.0` so its formatter agrees with the checked-in Justfile. - Add regression coverage for the thin Just recipes and the driver's formatter graph. ## Validation - `just fmt` - `just fmt-check` - `python3 -m pytest sdk/python/tests/test_artifact_workflow_and_binaries.py -k 'root_fmt or root_format' -q` - `pnpm run format` - `git diff --check` - `just -l | rg -n '^ fmt|fmt-check'` - `uvx --from uv==0.7.22 uv run --frozen --project sdk/python --no-sync --with ruff ruff check --diff sdk/python`
This commit is contained in:
Adam Perry @ OpenAI
committed by
GitHub
Unverified
GitHub
parent
0002316687
commit
747f1003dd
@@ -0,0 +1,177 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Format repository sources or check that they are already formatted."""
|
||||
|
||||
import argparse
|
||||
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]
|
||||
CODEX_RS_ROOT = REPO_ROOT / "codex-rs"
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class Command:
|
||||
args: tuple[str, ...]
|
||||
cwd: Path = REPO_ROOT
|
||||
discard_stderr: bool = False
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class FormatterGroup:
|
||||
name: str
|
||||
commands: tuple[Command, ...]
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class FormatterResult:
|
||||
name: str
|
||||
output: str
|
||||
returncode: int
|
||||
|
||||
|
||||
def formatter_groups(*, check: bool) -> tuple[FormatterGroup, ...]:
|
||||
just_args = ["just", "--unstable", "--fmt"]
|
||||
cargo_args = ["cargo", "fmt", "--", "--config", "imports_granularity=Item"]
|
||||
# Use an unpinned overlay so Ruff is available without syncing project
|
||||
# dependencies. Each `--project` still retains its local configuration context.
|
||||
sdk_uv_run_args = [
|
||||
"uv",
|
||||
"run",
|
||||
"--frozen",
|
||||
"--project",
|
||||
"sdk/python",
|
||||
"--no-sync",
|
||||
"--with",
|
||||
"ruff",
|
||||
]
|
||||
scripts_uv_run_args = [
|
||||
"uv",
|
||||
"run",
|
||||
"--frozen",
|
||||
"--project",
|
||||
"scripts",
|
||||
"--no-sync",
|
||||
"--with",
|
||||
"ruff",
|
||||
]
|
||||
sdk_format_args = [
|
||||
*sdk_uv_run_args,
|
||||
"ruff",
|
||||
"format",
|
||||
]
|
||||
scripts_format_args = [
|
||||
*scripts_uv_run_args,
|
||||
"ruff",
|
||||
"format",
|
||||
]
|
||||
|
||||
if check:
|
||||
just_args.append("--check")
|
||||
cargo_args.append("--check")
|
||||
sdk_format_args.append("--check")
|
||||
scripts_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.
|
||||
sdk_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.
|
||||
sdk_lint_args = ["ruff", "check", "--fix", "--fix-only"]
|
||||
|
||||
return (
|
||||
FormatterGroup("Just", (Command(tuple(just_args)),)),
|
||||
FormatterGroup(
|
||||
"Rust",
|
||||
# Stable rustfmt repeats a nightly-only `imports_granularity` warning
|
||||
# for each crate, so suppress that expected stderr noise.
|
||||
(Command(tuple(cargo_args), CODEX_RS_ROOT, discard_stderr=True),),
|
||||
),
|
||||
FormatterGroup(
|
||||
"Python SDK",
|
||||
(
|
||||
Command(
|
||||
(
|
||||
*sdk_uv_run_args,
|
||||
*sdk_lint_args,
|
||||
"sdk/python",
|
||||
)
|
||||
),
|
||||
Command((*sdk_format_args, "sdk/python")),
|
||||
),
|
||||
),
|
||||
FormatterGroup(
|
||||
"Python scripts",
|
||||
(
|
||||
# The SDK and internal scripts intentionally use separate project
|
||||
# roots so uv and Ruff retain each project's configuration context.
|
||||
Command((*scripts_format_args, "scripts")),
|
||||
),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
def run_formatter_group(group: FormatterGroup) -> FormatterResult:
|
||||
"""Run one formatter group sequentially and return its buffered output."""
|
||||
output: list[str] = []
|
||||
for command in group.commands:
|
||||
output.append(f"$ {shlex.join(command.args)}\n")
|
||||
try:
|
||||
process = subprocess.run(
|
||||
command.args,
|
||||
cwd=command.cwd,
|
||||
stdout=subprocess.PIPE,
|
||||
stderr=subprocess.DEVNULL
|
||||
if command.discard_stderr
|
||||
else subprocess.STDOUT,
|
||||
text=True,
|
||||
check=False,
|
||||
)
|
||||
except OSError as error:
|
||||
output.append(f"{error}\n")
|
||||
return FormatterResult(group.name, "".join(output), 1)
|
||||
|
||||
output.append(process.stdout)
|
||||
if process.stdout and not process.stdout.endswith("\n"):
|
||||
output.append("\n")
|
||||
if process.returncode != 0:
|
||||
return FormatterResult(group.name, "".join(output), process.returncode)
|
||||
|
||||
return FormatterResult(group.name, "".join(output), 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 = {}
|
||||
for group in groups:
|
||||
print(f"Starting {group.name} formatter...", flush=True)
|
||||
futures[executor.submit(run_formatter_group, group)] = group.name
|
||||
for future in as_completed(futures):
|
||||
result = future.result()
|
||||
print(f"==> {result.name} formatter finished")
|
||||
print(result.output, end="")
|
||||
if result.returncode != 0:
|
||||
failures.append(result.name)
|
||||
|
||||
if failures:
|
||||
print(f"Formatting failed: {', '.join(failures)}", file=sys.stderr)
|
||||
return 1
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
Reference in New Issue
Block a user