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 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
|
"""Adapter for https://github.com/charliermarsh/ruff."""
from __future__ import annotations
import argparse
import concurrent.futures
import dataclasses
import enum
import json
import logging
import os
import subprocess
import sys
import time
from typing import Any, BinaryIO
LINTER_CODE = "RUFF"
SYNTAX_ERROR = "E999"
IS_WINDOWS: bool = os.name == "nt"
def eprint(*args: Any, **kwargs: Any) -> None:
"""Print to stderr."""
print(*args, file=sys.stderr, flush=True, **kwargs)
class LintSeverity(str, enum.Enum):
"""Severity of a lint message."""
ERROR = "error"
WARNING = "warning"
ADVICE = "advice"
DISABLED = "disabled"
@dataclasses.dataclass(frozen=True)
class LintMessage:
"""A lint message defined by https://docs.rs/lintrunner/latest/lintrunner/lint_message/struct.LintMessage.html."""
path: str | None
line: int | None
char: int | None
code: str
severity: LintSeverity
name: str
original: str | None
replacement: str | None
description: str | None
def asdict(self) -> dict[str, Any]:
return dataclasses.asdict(self)
def display(self) -> None:
"""Print to stdout for lintrunner to consume."""
print(json.dumps(self.asdict()), flush=True)
def as_posix(name: str) -> str:
return name.replace("\\", "/") if IS_WINDOWS else name
def _run_command(
args: list[str],
*,
timeout: int | None,
stdin: BinaryIO | None,
input: bytes | None,
check: bool,
cwd: os.PathLike[Any] | None,
) -> subprocess.CompletedProcess[bytes]:
logging.debug("$ %s", " ".join(args))
start_time = time.monotonic()
try:
if input is not None:
return subprocess.run(
args,
capture_output=True,
shell=False,
input=input,
timeout=timeout,
check=check,
cwd=cwd,
)
return subprocess.run(
args,
stdin=stdin,
capture_output=True,
shell=False,
timeout=timeout,
check=check,
cwd=cwd,
)
finally:
end_time = time.monotonic()
logging.debug("took %dms", (end_time - start_time) * 1000)
def run_command(
args: list[str],
*,
retries: int = 0,
timeout: int | None = None,
stdin: BinaryIO | None = None,
input: bytes | None = None,
check: bool = False,
cwd: os.PathLike[Any] | None = None,
) -> subprocess.CompletedProcess[bytes]:
remaining_retries = retries
while True:
try:
return _run_command(
args, timeout=timeout, stdin=stdin, input=input, check=check, cwd=cwd
)
except subprocess.TimeoutExpired as err:
if remaining_retries == 0:
raise err
remaining_retries -= 1
logging.warning(
"(%s/%s) Retrying because command failed with: %r",
retries - remaining_retries,
retries,
err,
)
time.sleep(1)
def add_default_options(parser: argparse.ArgumentParser) -> None:
"""Add default options to a parser.
This should be called the last in the chain of add_argument calls.
"""
parser.add_argument(
"--retries",
type=int,
default=3,
help="number of times to retry if the linter times out.",
)
parser.add_argument(
"--verbose",
action="store_true",
help="verbose logging",
)
parser.add_argument(
"filenames",
nargs="+",
help="paths to lint",
)
def explain_rule(code: str) -> str:
proc = run_command(
["ruff", "rule", "--output-format=json", code],
check=True,
)
rule = json.loads(str(proc.stdout, "utf-8").strip())
return f"\n{rule['linter']}: {rule['summary']}"
def get_issue_severity(code: str) -> LintSeverity:
# "B901": `return x` inside a generator
# "B902": Invalid first argument to a method
# "B903": __slots__ efficiency
# "B950": Line too long
# "C4": Flake8 Comprehensions
# "C9": Cyclomatic complexity
# "E2": PEP8 horizontal whitespace "errors"
# "E3": PEP8 blank line "errors"
# "E5": PEP8 line length "errors"
# "T400": type checking Notes
# "T49": internal type checker errors or unmatched messages
if any(
code.startswith(x)
for x in (
"B9",
"C4",
"C9",
"E2",
"E3",
"E5",
"T400",
"T49",
"PLC",
"PLR",
)
):
return LintSeverity.ADVICE
# "F821": Undefined name
# "E999": syntax error
if any(code.startswith(x) for x in ("F821", SYNTAX_ERROR, "PLE")):
return LintSeverity.ERROR
# "F": PyFlakes Error
# "B": flake8-bugbear Error
# "E": PEP8 "Error"
# "W": PEP8 Warning
# possibly other plugins...
return LintSeverity.WARNING
def format_lint_message(
message: str, code: str, rules: dict[str, str], show_disable: bool
) -> str:
if rules:
message += f".\n{rules.get(code) or ''}"
message += ".\nSee https://beta.ruff.rs/docs/rules/"
if show_disable:
message += f".\n\nTo disable, use ` # noqa: {code}`"
return message
def check_files(
filenames: list[str],
severities: dict[str, LintSeverity],
*,
config: str | None,
retries: int,
timeout: int,
explain: bool,
show_disable: bool,
) -> list[LintMessage]:
try:
proc = run_command(
[
sys.executable,
"-m",
"ruff",
"check",
"--exit-zero",
"--quiet",
"--output-format=json",
*([f"--config={config}"] if config else []),
*filenames,
],
retries=retries,
timeout=timeout,
check=True,
)
except (OSError, subprocess.CalledProcessError) as err:
return [
LintMessage(
path=None,
line=None,
char=None,
code=LINTER_CODE,
severity=LintSeverity.ERROR,
name="command-failed",
original=None,
replacement=None,
description=(
f"Failed due to {err.__class__.__name__}:\n{err}"
if not isinstance(err, subprocess.CalledProcessError)
else (
f"COMMAND (exit code {err.returncode})\n"
f"{' '.join(as_posix(x) for x in err.cmd)}\n\n"
f"STDERR\n{err.stderr.decode('utf-8').strip() or '(empty)'}\n\n"
f"STDOUT\n{err.stdout.decode('utf-8').strip() or '(empty)'}"
)
),
)
]
stdout = str(proc.stdout, "utf-8").strip()
vulnerabilities = json.loads(stdout)
if explain:
all_codes = {v["code"] for v in vulnerabilities}
rules = {code: explain_rule(code) for code in all_codes}
else:
rules = {}
def lint_message(vuln: dict[str, Any]) -> LintMessage:
code = vuln["code"] or SYNTAX_ERROR
return LintMessage(
path=vuln["filename"],
name=code,
description=(
format_lint_message(
vuln["message"],
code,
rules,
show_disable and bool(vuln["code"]),
)
),
line=int(vuln["location"]["row"]),
char=int(vuln["location"]["column"]),
code=LINTER_CODE,
severity=severities.get(code, get_issue_severity(code)),
original=None,
replacement=None,
)
return [lint_message(v) for v in vulnerabilities]
def check_file_for_fixes(
filename: str,
*,
config: str | None,
retries: int,
timeout: int,
) -> list[LintMessage]:
try:
with open(filename, "rb") as f:
original = f.read()
with open(filename, "rb") as f:
proc_fix = run_command(
[
sys.executable,
"-m",
"ruff",
"check",
"--fix-only",
"--exit-zero",
*([f"--config={config}"] if config else []),
"--stdin-filename",
filename,
"-",
],
stdin=f,
retries=retries,
timeout=timeout,
check=True,
)
except (OSError, subprocess.CalledProcessError) as err:
return [
LintMessage(
path=None,
line=None,
char=None,
code=LINTER_CODE,
severity=LintSeverity.ERROR,
name="command-failed",
original=None,
replacement=None,
description=(
f"Failed due to {err.__class__.__name__}:\n{err}"
if not isinstance(err, subprocess.CalledProcessError)
else (
f"COMMAND (exit code {err.returncode})\n"
f"{' '.join(as_posix(x) for x in err.cmd)}\n\n"
f"STDERR\n{err.stderr.decode('utf-8').strip() or '(empty)'}\n\n"
f"STDOUT\n{err.stdout.decode('utf-8').strip() or '(empty)'}"
)
),
)
]
replacement = proc_fix.stdout
if original == replacement:
return []
return [
LintMessage(
path=filename,
name="format",
description="Run `lintrunner -a` to apply this patch.",
line=None,
char=None,
code=LINTER_CODE,
severity=LintSeverity.WARNING,
original=original.decode("utf-8"),
replacement=replacement.decode("utf-8"),
)
]
def main() -> None:
parser = argparse.ArgumentParser(
description=f"Ruff linter. Linter code: {LINTER_CODE}. Use with RUFF-FIX to auto-fix issues.",
fromfile_prefix_chars="@",
)
parser.add_argument(
"--config",
default=None,
help="Path to the `pyproject.toml` or `ruff.toml` file to use for configuration",
)
parser.add_argument(
"--explain",
action="store_true",
help="Explain a rule",
)
parser.add_argument(
"--show-disable",
action="store_true",
help="Show how to disable a lint message",
)
parser.add_argument(
"--timeout",
default=90,
type=int,
help="Seconds to wait for ruff",
)
parser.add_argument(
"--severity",
action="append",
help="map code to severity (e.g. `F401:advice`). This option can be used multiple times.",
)
parser.add_argument(
"--no-fix",
action="store_true",
help="Do not suggest fixes",
)
add_default_options(parser)
args = parser.parse_args()
logging.basicConfig(
format="<%(threadName)s:%(levelname)s> %(message)s",
level=logging.NOTSET
if args.verbose
else logging.DEBUG
if len(args.filenames) < 1000
else logging.INFO,
stream=sys.stderr,
)
severities: dict[str, LintSeverity] = {}
if args.severity:
for severity in args.severity:
parts = severity.split(":", 1)
assert len(parts) == 2, f"invalid severity `{severity}`"
severities[parts[0]] = LintSeverity(parts[1])
lint_messages = check_files(
args.filenames,
severities=severities,
config=args.config,
retries=args.retries,
timeout=args.timeout,
explain=args.explain,
show_disable=args.show_disable,
)
for lint_message in lint_messages:
lint_message.display()
if args.no_fix or not lint_messages:
# If we're not fixing, we can exit early
return
files_with_lints = {lint.path for lint in lint_messages if lint.path is not None}
with concurrent.futures.ThreadPoolExecutor(
max_workers=os.cpu_count(),
thread_name_prefix="Thread",
) as executor:
futures = {
executor.submit(
check_file_for_fixes,
path,
config=args.config,
retries=args.retries,
timeout=args.timeout,
): path
for path in files_with_lints
}
for future in concurrent.futures.as_completed(futures):
try:
for lint_message in future.result():
lint_message.display()
except Exception: # Catch all exceptions for lintrunner
logging.critical('Failed at "%s".', futures[future])
raise
if __name__ == "__main__":
main()
|