mirror of
https://github.com/neondatabase/neon.git
synced 2025-12-23 06:09:59 +00:00
7de829e475
## Problem `black` is slow sometimes, we can replace it with `ruff format` (a new feature in 0.1.2 [0]), which produces pretty similar to black style [1]. On my local machine (MacBook M1 Pro 16GB): ``` # `black` on main $ hyperfine "BLACK_CACHE_DIR=/dev/null poetry run black ." Benchmark 1: BLACK_CACHE_DIR=/dev/null poetry run black . Time (mean ± σ): 3.131 s ± 0.090 s [User: 5.194 s, System: 0.859 s] Range (min … max): 3.047 s … 3.354 s 10 runs ``` ``` # `ruff format` on the current PR $ hyperfine "RUFF_NO_CACHE=true poetry run ruff format" Benchmark 1: RUFF_NO_CACHE=true poetry run ruff format Time (mean ± σ): 300.7 ms ± 50.2 ms [User: 259.5 ms, System: 76.1 ms] Range (min … max): 267.5 ms … 420.2 ms 10 runs ``` ## Summary of changes - Replace `black` with `ruff format` everywhere - [0] https://docs.astral.sh/ruff/formatter/ - [1] https://docs.astral.sh/ruff/formatter/#black-compatibility
132 lines
3.5 KiB
Python
Executable File
132 lines
3.5 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
|
|
import argparse
|
|
import enum
|
|
import subprocess
|
|
import sys
|
|
from typing import List
|
|
|
|
|
|
@enum.unique
|
|
class Color(enum.Enum):
|
|
RED = "\033[0;31m"
|
|
GREEN = "\033[0;33m"
|
|
CYAN = "\033[0;36m"
|
|
|
|
|
|
NC = "\033[0m" # No Color
|
|
|
|
|
|
def colorify(
|
|
s: str,
|
|
color: Color,
|
|
no_color: bool = False,
|
|
):
|
|
if no_color:
|
|
return s
|
|
return f"{color.value}{s}{NC}"
|
|
|
|
|
|
def rustfmt(fix_inplace: bool = False, no_color: bool = False) -> str:
|
|
cmd = "rustfmt --edition=2021"
|
|
if not fix_inplace:
|
|
cmd += " --check"
|
|
if no_color:
|
|
cmd += " --color=never"
|
|
return cmd
|
|
|
|
|
|
def ruff_check(fix_inplace: bool) -> str:
|
|
cmd = "poetry run ruff check"
|
|
if fix_inplace:
|
|
cmd += " --fix"
|
|
return cmd
|
|
|
|
|
|
def ruff_format(fix_inplace: bool) -> str:
|
|
cmd = "poetry run ruff format"
|
|
if not fix_inplace:
|
|
cmd += " --diff --check"
|
|
return cmd
|
|
|
|
|
|
def mypy() -> str:
|
|
return "poetry run mypy"
|
|
|
|
|
|
def get_commit_files() -> List[str]:
|
|
files = subprocess.check_output("git diff --cached --name-only --diff-filter=ACM".split())
|
|
return files.decode().splitlines()
|
|
|
|
|
|
def check(name: str, suffix: str, cmd: str, changed_files: List[str], no_color: bool = False):
|
|
print(f"Checking: {name} ", end="")
|
|
applicable_files = list(filter(lambda fname: fname.strip().endswith(suffix), changed_files))
|
|
if not applicable_files:
|
|
print(colorify("[NOT APPLICABLE]", Color.CYAN, no_color))
|
|
return
|
|
|
|
cmd = f'{cmd} {" ".join(applicable_files)}'
|
|
res = subprocess.run(cmd.split(), capture_output=True)
|
|
if res.returncode != 0:
|
|
print(colorify("[FAILED]", Color.RED, no_color))
|
|
if name == "mypy":
|
|
print("Please inspect the output below and fix type mismatches.")
|
|
else:
|
|
print("Please inspect the output below and run make fmt to fix automatically.")
|
|
if suffix == ".py":
|
|
print(
|
|
"If the output is empty, ensure that you've installed Python tooling by\n"
|
|
"running './scripts/pysync' in the current directory (no root needed)"
|
|
)
|
|
print()
|
|
print(res.stdout.decode())
|
|
sys.exit(1)
|
|
|
|
print(colorify("[OK]", Color.GREEN, no_color))
|
|
|
|
|
|
if __name__ == "__main__":
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument("--fix-inplace", action="store_true", help="apply fixes inplace")
|
|
parser.add_argument(
|
|
"--no-color",
|
|
action="store_true",
|
|
help="disable colored output",
|
|
default=not sys.stdout.isatty(),
|
|
)
|
|
args = parser.parse_args()
|
|
|
|
files = get_commit_files()
|
|
# we use rustfmt here because cargo fmt does not accept list of files
|
|
# it internally gathers project files and feeds them to rustfmt
|
|
# so because we want to check only files included in the commit we use rustfmt directly
|
|
check(
|
|
name="rustfmt",
|
|
suffix=".rs",
|
|
cmd=rustfmt(fix_inplace=args.fix_inplace, no_color=args.no_color),
|
|
changed_files=files,
|
|
no_color=args.no_color,
|
|
)
|
|
check(
|
|
name="ruff check",
|
|
suffix=".py",
|
|
cmd=ruff_check(fix_inplace=args.fix_inplace),
|
|
changed_files=files,
|
|
no_color=args.no_color,
|
|
)
|
|
check(
|
|
name="ruff format",
|
|
suffix=".py",
|
|
cmd=ruff_format(fix_inplace=args.fix_inplace),
|
|
changed_files=files,
|
|
no_color=args.no_color,
|
|
)
|
|
check(
|
|
name="mypy",
|
|
suffix=".py",
|
|
cmd=mypy(),
|
|
changed_files=files,
|
|
no_color=args.no_color,
|
|
)
|