2023-12-22 05:45:53 -05:00
|
|
|
# fork of https://github.com/asottile/blacken-docs adapted for ruff
|
2023-11-06 08:19:00 -08:00
|
|
|
from __future__ import annotations
|
|
|
|
|
|
|
|
|
|
import re
|
2023-12-22 05:45:53 -05:00
|
|
|
import sys
|
2023-11-06 08:19:00 -08:00
|
|
|
import argparse
|
|
|
|
|
import textwrap
|
|
|
|
|
import contextlib
|
2023-12-22 05:45:53 -05:00
|
|
|
import subprocess
|
2023-11-06 08:19:00 -08:00
|
|
|
from typing import Match, Optional, Sequence, Generator, NamedTuple, cast
|
|
|
|
|
|
|
|
|
|
MD_RE = re.compile(
|
|
|
|
|
r"(?P<before>^(?P<indent> *)```\s*python\n)" r"(?P<code>.*?)" r"(?P<after>^(?P=indent)```\s*$)",
|
|
|
|
|
re.DOTALL | re.MULTILINE,
|
|
|
|
|
)
|
|
|
|
|
MD_PYCON_RE = re.compile(
|
|
|
|
|
r"(?P<before>^(?P<indent> *)```\s*pycon\n)" r"(?P<code>.*?)" r"(?P<after>^(?P=indent)```.*$)",
|
|
|
|
|
re.DOTALL | re.MULTILINE,
|
|
|
|
|
)
|
|
|
|
|
PYCON_PREFIX = ">>> "
|
|
|
|
|
PYCON_CONTINUATION_PREFIX = "..."
|
|
|
|
|
PYCON_CONTINUATION_RE = re.compile(
|
|
|
|
|
rf"^{re.escape(PYCON_CONTINUATION_PREFIX)}( |$)",
|
|
|
|
|
)
|
2023-12-22 05:45:53 -05:00
|
|
|
DEFAULT_LINE_LENGTH = 100
|
2023-11-06 08:19:00 -08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
class CodeBlockError(NamedTuple):
|
|
|
|
|
offset: int
|
|
|
|
|
exc: Exception
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def format_str(
|
|
|
|
|
src: str,
|
|
|
|
|
) -> tuple[str, Sequence[CodeBlockError]]:
|
|
|
|
|
errors: list[CodeBlockError] = []
|
|
|
|
|
|
|
|
|
|
@contextlib.contextmanager
|
|
|
|
|
def _collect_error(match: Match[str]) -> Generator[None, None, None]:
|
|
|
|
|
try:
|
|
|
|
|
yield
|
|
|
|
|
except Exception as e:
|
|
|
|
|
errors.append(CodeBlockError(match.start(), e))
|
|
|
|
|
|
|
|
|
|
def _md_match(match: Match[str]) -> str:
|
|
|
|
|
code = textwrap.dedent(match["code"])
|
|
|
|
|
with _collect_error(match):
|
2023-12-22 05:45:53 -05:00
|
|
|
code = format_code_block(code)
|
2023-11-06 08:19:00 -08:00
|
|
|
code = textwrap.indent(code, match["indent"])
|
2025-02-03 15:25:21 +00:00
|
|
|
return f"{match['before']}{code}{match['after']}"
|
2023-11-06 08:19:00 -08:00
|
|
|
|
|
|
|
|
def _pycon_match(match: Match[str]) -> str:
|
|
|
|
|
code = ""
|
|
|
|
|
fragment = cast(Optional[str], None)
|
|
|
|
|
|
|
|
|
|
def finish_fragment() -> None:
|
|
|
|
|
nonlocal code
|
|
|
|
|
nonlocal fragment
|
|
|
|
|
|
|
|
|
|
if fragment is not None:
|
|
|
|
|
with _collect_error(match):
|
2023-12-22 05:45:53 -05:00
|
|
|
fragment = format_code_block(fragment)
|
2023-11-06 08:19:00 -08:00
|
|
|
fragment_lines = fragment.splitlines()
|
|
|
|
|
code += f"{PYCON_PREFIX}{fragment_lines[0]}\n"
|
|
|
|
|
for line in fragment_lines[1:]:
|
|
|
|
|
# Skip blank lines to handle Black adding a blank above
|
|
|
|
|
# functions within blocks. A blank line would end the REPL
|
|
|
|
|
# continuation prompt.
|
|
|
|
|
#
|
|
|
|
|
# >>> if True:
|
|
|
|
|
# ... def f():
|
|
|
|
|
# ... pass
|
|
|
|
|
# ...
|
|
|
|
|
if line:
|
|
|
|
|
code += f"{PYCON_CONTINUATION_PREFIX} {line}\n"
|
|
|
|
|
if fragment_lines[-1].startswith(" "):
|
|
|
|
|
code += f"{PYCON_CONTINUATION_PREFIX}\n"
|
|
|
|
|
fragment = None
|
|
|
|
|
|
|
|
|
|
indentation = None
|
|
|
|
|
for line in match["code"].splitlines():
|
|
|
|
|
orig_line, line = line, line.lstrip()
|
|
|
|
|
if indentation is None and line:
|
|
|
|
|
indentation = len(orig_line) - len(line)
|
|
|
|
|
continuation_match = PYCON_CONTINUATION_RE.match(line)
|
|
|
|
|
if continuation_match and fragment is not None:
|
|
|
|
|
fragment += line[continuation_match.end() :] + "\n"
|
|
|
|
|
else:
|
|
|
|
|
finish_fragment()
|
|
|
|
|
if line.startswith(PYCON_PREFIX):
|
|
|
|
|
fragment = line[len(PYCON_PREFIX) :] + "\n"
|
|
|
|
|
else:
|
|
|
|
|
code += orig_line[indentation:] + "\n"
|
|
|
|
|
finish_fragment()
|
|
|
|
|
return code
|
|
|
|
|
|
|
|
|
|
def _md_pycon_match(match: Match[str]) -> str:
|
|
|
|
|
code = _pycon_match(match)
|
|
|
|
|
code = textwrap.indent(code, match["indent"])
|
2025-02-03 15:25:21 +00:00
|
|
|
return f"{match['before']}{code}{match['after']}"
|
2023-11-06 08:19:00 -08:00
|
|
|
|
|
|
|
|
src = MD_RE.sub(_md_match, src)
|
|
|
|
|
src = MD_PYCON_RE.sub(_md_pycon_match, src)
|
|
|
|
|
return src, errors
|
|
|
|
|
|
|
|
|
|
|
2023-12-22 05:45:53 -05:00
|
|
|
def format_code_block(code: str) -> str:
|
|
|
|
|
return subprocess.check_output(
|
|
|
|
|
[
|
|
|
|
|
sys.executable,
|
|
|
|
|
"-m",
|
|
|
|
|
"ruff",
|
|
|
|
|
"format",
|
|
|
|
|
"--stdin-filename=script.py",
|
|
|
|
|
f"--line-length={DEFAULT_LINE_LENGTH}",
|
|
|
|
|
],
|
|
|
|
|
encoding="utf-8",
|
|
|
|
|
input=code,
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
2023-11-06 08:19:00 -08:00
|
|
|
def format_file(
|
|
|
|
|
filename: str,
|
|
|
|
|
skip_errors: bool,
|
|
|
|
|
) -> int:
|
|
|
|
|
with open(filename, encoding="UTF-8") as f:
|
|
|
|
|
contents = f.read()
|
2023-12-22 05:45:53 -05:00
|
|
|
new_contents, errors = format_str(contents)
|
2023-11-06 08:19:00 -08:00
|
|
|
for error in errors:
|
|
|
|
|
lineno = contents[: error.offset].count("\n") + 1
|
|
|
|
|
print(f"{filename}:{lineno}: code block parse error {error.exc}")
|
|
|
|
|
if errors and not skip_errors:
|
|
|
|
|
return 1
|
|
|
|
|
if contents != new_contents:
|
|
|
|
|
print(f"{filename}: Rewriting...")
|
|
|
|
|
with open(filename, "w", encoding="UTF-8") as f:
|
|
|
|
|
f.write(new_contents)
|
|
|
|
|
return 0
|
|
|
|
|
else:
|
|
|
|
|
return 0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def main(argv: Sequence[str] | None = None) -> int:
|
|
|
|
|
parser = argparse.ArgumentParser()
|
|
|
|
|
parser.add_argument(
|
|
|
|
|
"-l",
|
|
|
|
|
"--line-length",
|
|
|
|
|
type=int,
|
|
|
|
|
default=DEFAULT_LINE_LENGTH,
|
|
|
|
|
)
|
|
|
|
|
parser.add_argument(
|
|
|
|
|
"-S",
|
|
|
|
|
"--skip-string-normalization",
|
|
|
|
|
action="store_true",
|
|
|
|
|
)
|
|
|
|
|
parser.add_argument("-E", "--skip-errors", action="store_true")
|
|
|
|
|
parser.add_argument("filenames", nargs="*")
|
|
|
|
|
args = parser.parse_args(argv)
|
|
|
|
|
|
|
|
|
|
retv = 0
|
|
|
|
|
for filename in args.filenames:
|
2023-12-22 05:45:53 -05:00
|
|
|
retv |= format_file(filename, skip_errors=args.skip_errors)
|
2023-11-06 08:19:00 -08:00
|
|
|
return retv
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
|
raise SystemExit(main())
|
