import asyncio
from asyncio.base_events import BaseEventLoop
from concurrent.futures import Executor, ProcessPoolExecutor
+from enum import Enum
from functools import partial, wraps
import keyword
+import logging
+from multiprocessing import Manager
import os
from pathlib import Path
+import re
import tokenize
+import signal
import sys
from typing import (
+ Any,
Callable,
Dict,
Generic,
from blib2to3.pgen2 import driver, token
from blib2to3.pgen2.parse import ParseError
-__version__ = "18.3a4"
+__version__ = "18.4a0"
DEFAULT_LINE_LENGTH = 88
# types
syms = pygram.python_symbols
Priority = int
Index = int
LN = Union[Leaf, Node]
-SplitFunc = Callable[['Line', bool], Iterator['Line']]
+SplitFunc = Callable[["Line", bool], Iterator["Line"]]
out = partial(click.secho, bold=True, err=True)
-err = partial(click.secho, fg='red', err=True)
+err = partial(click.secho, fg="red", err=True)
class NothingChanged(UserWarning):
"""Found a comment like `# fmt: off` in the file."""
+class WriteBack(Enum):
+ NO = 0
+ YES = 1
+ DIFF = 2
+
+
@click.command()
@click.option(
- '-l',
- '--line-length',
+ "-l",
+ "--line-length",
type=int,
default=DEFAULT_LINE_LENGTH,
- help='How many character per line to allow.',
+ help="How many character per line to allow.",
show_default=True,
)
@click.option(
- '--check',
+ "--check",
is_flag=True,
help=(
- "Don't write back the files, just return the status. Return code 0 "
+ "Don't write the files back, just return the status. Return code 0 "
"means nothing would change. Return code 1 means some files would be "
"reformatted. Return code 123 means there was an internal error."
),
)
@click.option(
- '--fast/--safe',
+ "--diff",
+ is_flag=True,
+ help="Don't write the files back, just output a diff for each file on stdout.",
+)
+@click.option(
+ "--fast/--safe",
is_flag=True,
- help='If --fast given, skip temporary sanity checks. [default: --safe]',
+ help="If --fast given, skip temporary sanity checks. [default: --safe]",
+)
+@click.option(
+ "-q",
+ "--quiet",
+ is_flag=True,
+ help=(
+ "Don't emit non-error messages to stderr. Errors are still emitted, "
+ "silence those with 2>/dev/null."
+ ),
)
@click.version_option(version=__version__)
@click.argument(
- 'src',
+ "src",
nargs=-1,
type=click.Path(
exists=True, file_okay=True, dir_okay=True, readable=True, allow_dash=True
)
@click.pass_context
def main(
- ctx: click.Context, line_length: int, check: bool, fast: bool, src: List[str]
+ ctx: click.Context,
+ line_length: int,
+ check: bool,
+ diff: bool,
+ fast: bool,
+ quiet: bool,
+ src: List[str],
) -> None:
"""The uncompromising code formatter."""
sources: List[Path] = []
elif p.is_file():
# if a file was explicitly given, we don't care about its extension
sources.append(p)
- elif s == '-':
- sources.append(Path('-'))
+ elif s == "-":
+ sources.append(Path("-"))
else:
- err(f'invalid path: {s}')
+ err(f"invalid path: {s}")
+ if check and diff:
+ exc = click.ClickException("Options --check and --diff are mutually exclusive")
+ exc.exit_code = 2
+ raise exc
+
+ if check:
+ write_back = WriteBack.NO
+ elif diff:
+ write_back = WriteBack.DIFF
+ else:
+ write_back = WriteBack.YES
if len(sources) == 0:
ctx.exit(0)
elif len(sources) == 1:
p = sources[0]
- report = Report(check=check)
+ report = Report(check=check, quiet=quiet)
try:
- if not p.is_file() and str(p) == '-':
+ if not p.is_file() and str(p) == "-":
changed = format_stdin_to_stdout(
- line_length=line_length, fast=fast, write_back=not check
+ line_length=line_length, fast=fast, write_back=write_back
)
else:
changed = format_file_in_place(
- p, line_length=line_length, fast=fast, write_back=not check
+ p, line_length=line_length, fast=fast, write_back=write_back
)
report.done(p, changed)
except Exception as exc:
try:
return_code = loop.run_until_complete(
schedule_formatting(
- sources, line_length, not check, fast, loop, executor
+ sources, line_length, write_back, fast, quiet, loop, executor
)
)
finally:
- loop.close()
+ shutdown(loop)
ctx.exit(return_code)
async def schedule_formatting(
sources: List[Path],
line_length: int,
- write_back: bool,
+ write_back: WriteBack,
fast: bool,
+ quiet: bool,
loop: BaseEventLoop,
executor: Executor,
) -> int:
`line_length`, `write_back`, and `fast` options are passed to
:func:`format_file_in_place`.
"""
+ lock = None
+ if write_back == WriteBack.DIFF:
+ # For diff output, we need locks to ensure we don't interleave output
+ # from different processes.
+ manager = Manager()
+ lock = manager.Lock()
tasks = {
src: loop.run_in_executor(
- executor, format_file_in_place, src, line_length, fast, write_back
+ executor, format_file_in_place, src, line_length, fast, write_back, lock
)
for src in sources
}
+ _task_values = list(tasks.values())
+ loop.add_signal_handler(signal.SIGINT, cancel, _task_values)
+ loop.add_signal_handler(signal.SIGTERM, cancel, _task_values)
await asyncio.wait(tasks.values())
cancelled = []
- report = Report(check=not write_back)
+ report = Report(check=write_back is WriteBack.NO, quiet=quiet)
for src, task in tasks.items():
if not task.done():
- report.failed(src, 'timed out, cancelling')
+ report.failed(src, "timed out, cancelling")
task.cancel()
cancelled.append(task)
+ elif task.cancelled():
+ cancelled.append(task)
elif task.exception():
report.failed(src, str(task.exception()))
else:
report.done(src, task.result())
if cancelled:
- await asyncio.wait(cancelled, timeout=2)
- out('All done! ✨ 🍰 ✨')
- click.echo(str(report))
+ await asyncio.gather(*cancelled, loop=loop, return_exceptions=True)
+ elif not quiet:
+ out("All done! ✨ 🍰 ✨")
+ if not quiet:
+ click.echo(str(report))
return report.return_code
def format_file_in_place(
- src: Path, line_length: int, fast: bool, write_back: bool = False
+ src: Path,
+ line_length: int,
+ fast: bool,
+ write_back: WriteBack = WriteBack.NO,
+ lock: Any = None, # multiprocessing.Manager().Lock() is some crazy proxy
) -> bool:
"""Format file under `src` path. Return True if changed.
with tokenize.open(src) as src_buffer:
src_contents = src_buffer.read()
try:
- contents = format_file_contents(
+ dst_contents = format_file_contents(
src_contents, line_length=line_length, fast=fast
)
except NothingChanged:
return False
- if write_back:
+ if write_back == write_back.YES:
with open(src, "w", encoding=src_buffer.encoding) as f:
- f.write(contents)
+ f.write(dst_contents)
+ elif write_back == write_back.DIFF:
+ src_name = f"{src.name} (original)"
+ dst_name = f"{src.name} (formatted)"
+ diff_contents = diff(src_contents, dst_contents, src_name, dst_name)
+ if lock:
+ lock.acquire()
+ try:
+ sys.stdout.write(diff_contents)
+ finally:
+ if lock:
+ lock.release()
return True
def format_stdin_to_stdout(
- line_length: int, fast: bool, write_back: bool = False
+ line_length: int, fast: bool, write_back: WriteBack = WriteBack.NO
) -> bool:
"""Format file on stdin. Return True if changed.
If `write_back` is True, write reformatted code back to stdout.
`line_length` and `fast` arguments are passed to :func:`format_file_contents`.
"""
- contents = sys.stdin.read()
+ src = sys.stdin.read()
try:
- contents = format_file_contents(contents, line_length=line_length, fast=fast)
+ dst = format_file_contents(src, line_length=line_length, fast=fast)
return True
except NothingChanged:
+ dst = src
return False
finally:
- if write_back:
- sys.stdout.write(contents)
+ if write_back == WriteBack.YES:
+ sys.stdout.write(dst)
+ elif write_back == WriteBack.DIFF:
+ src_name = "<stdin> (original)"
+ dst_name = "<stdin> (formatted)"
+ sys.stdout.write(diff(src, dst, src_name, dst_name))
def format_file_contents(
valid by calling :func:`assert_equivalent` and :func:`assert_stable` on it.
`line_length` is passed to :func:`format_str`.
"""
- if src_contents.strip() == '':
+ if src_contents.strip() == "":
raise NothingChanged
dst_contents = format_str(src_contents, line_length=line_length)
def lib2to3_parse(src_txt: str) -> Node:
"""Given a string with source, return the lib2to3 Node."""
grammar = pygram.python_grammar_no_print_statement
- if src_txt[-1] != '\n':
- nl = '\r\n' if '\r\n' in src_txt[:1024] else '\n'
+ if src_txt[-1] != "\n":
+ nl = "\r\n" if "\r\n" in src_txt[:1024] else "\n"
src_txt += nl
for grammar in GRAMMARS:
drv = driver.Driver(grammar, pytree.convert)
return code
-T = TypeVar('T')
+T = TypeVar("T")
class Visitor(Generic[T]):
name = token.tok_name[node.type]
else:
name = type_repr(node.type)
- yield from getattr(self, f'visit_{name}', self.visit_default)(node)
+ yield from getattr(self, f"visit_{name}", self.visit_default)(node)
def visit_default(self, node: LN) -> Iterator[T]:
"""Default `visit_*()` implementation. Recurses to children of `node`."""
tree_depth: int = 0
def visit_default(self, node: LN) -> Iterator[T]:
- indent = ' ' * (2 * self.tree_depth)
+ indent = " " * (2 * self.tree_depth)
if isinstance(node, Node):
_type = type_repr(node.type)
- out(f'{indent}{_type}', fg='yellow')
+ out(f"{indent}{_type}", fg="yellow")
self.tree_depth += 1
for child in node.children:
yield from self.visit(child)
self.tree_depth -= 1
- out(f'{indent}/{_type}', fg='yellow', bold=False)
+ out(f"{indent}/{_type}", fg="yellow", bold=False)
else:
_type = token.tok_name.get(node.type, str(node.type))
- out(f'{indent}{_type}', fg='blue', nl=False)
+ out(f"{indent}{_type}", fg="blue", nl=False)
if node.prefix:
# We don't have to handle prefixes for `Node` objects since
# that delegates to the first child anyway.
- out(f' {node.prefix!r}', fg='green', bold=False, nl=False)
- out(f' {node.value!r}', fg='blue', bold=False)
+ out(f" {node.prefix!r}", fg="green", bold=False, nl=False)
+ out(f" {node.value!r}", fg="blue", bold=False)
@classmethod
def show(cls, code: str) -> None:
KEYWORDS = set(keyword.kwlist)
WHITESPACE = {token.DEDENT, token.INDENT, token.NEWLINE}
-FLOW_CONTROL = {'return', 'raise', 'break', 'continue'}
+FLOW_CONTROL = {"return", "raise", "break", "continue"}
STATEMENT = {
syms.if_stmt,
syms.while_stmt,
syms.classdef,
}
STANDALONE_COMMENT = 153
-LOGIC_OPERATORS = {'and', 'or'}
+LOGIC_OPERATORS = {"and", "or"}
COMPARATORS = {
token.LESS,
token.GREATER,
token.DOUBLESTAR,
token.DOUBLESLASH,
}
+VARARGS = {token.STAR, token.DOUBLESTAR}
COMPREHENSION_PRIORITY = 20
COMMA_PRIORITY = 10
LOGIC_PRIORITY = 5
leaf.opening_bracket = opening_bracket
leaf.bracket_depth = self.depth
if self.depth == 0:
- delim = is_delimiter(leaf)
- if delim:
- self.delimiters[id(leaf)] = delim
- elif self.previous is not None:
- if leaf.type == token.STRING and self.previous.type == token.STRING:
- self.delimiters[id(self.previous)] = STRING_PRIORITY
- elif (
- leaf.type == token.NAME
- and leaf.value == 'for'
- and leaf.parent
- and leaf.parent.type in {syms.comp_for, syms.old_comp_for}
- ):
- self.delimiters[id(self.previous)] = COMPREHENSION_PRIORITY
- elif (
- leaf.type == token.NAME
- and leaf.value == 'if'
- and leaf.parent
- and leaf.parent.type in {syms.comp_if, syms.old_comp_if}
- ):
- self.delimiters[id(self.previous)] = COMPREHENSION_PRIORITY
- elif (
- leaf.type == token.NAME
- and leaf.value in LOGIC_OPERATORS
- and leaf.parent
- ):
- self.delimiters[id(self.previous)] = LOGIC_PRIORITY
+ delim = is_split_before_delimiter(leaf, self.previous)
+ if delim and self.previous is not None:
+ self.delimiters[id(self.previous)] = delim
+ else:
+ delim = is_split_after_delimiter(leaf, self.previous)
+ if delim:
+ self.delimiters[id(leaf)] = delim
if leaf.type in OPENING_BRACKETS:
self.bracket_match[self.depth, BRACKET[leaf.type]] = leaf
self.depth += 1
return (
bool(self)
and self.leaves[0].type == token.NAME
- and self.leaves[0].value == 'class'
+ and self.leaves[0].value == "class"
)
@property
except IndexError:
second_leaf = None
return (
- (first_leaf.type == token.NAME and first_leaf.value == 'def')
+ (first_leaf.type == token.NAME and first_leaf.value == "def")
or (
first_leaf.type == token.ASYNC
and second_leaf is not None
and second_leaf.type == token.NAME
- and second_leaf.value == 'def'
+ and second_leaf.value == "def"
)
)
return (
bool(self)
and self.leaves[0].type == token.NAME
- and self.leaves[0].value == 'yield'
+ and self.leaves[0].value == "yield"
)
@property
To avoid splitting on the comma in this situation, increase the depth of
tokens between `for` and `in`.
"""
- if leaf.type == token.NAME and leaf.value == 'for':
+ if leaf.type == token.NAME and leaf.value == "for":
self.has_for = True
self.bracket_tracker.depth += 1
self._for_loop_variable = True
def maybe_decrement_after_for_loop_variable(self, leaf: Leaf) -> bool:
"""See `maybe_increment_for_loop_variable` above for explanation."""
- if self._for_loop_variable and leaf.type == token.NAME and leaf.value == 'in':
+ if self._for_loop_variable and leaf.type == token.NAME and leaf.value == "in":
self.bracket_tracker.depth -= 1
self._for_loop_variable = False
return True
comment.type == STANDALONE_COMMENT
and self.bracket_tracker.any_open_brackets()
):
- comment.prefix = ''
+ comment.prefix = ""
return False
if comment.type != token.COMMENT:
after = len(self.leaves) - 1
if after == -1:
comment.type = STANDALONE_COMMENT
- comment.prefix = ''
+ comment.prefix = ""
return False
else:
def __str__(self) -> str:
"""Render the line."""
if not self:
- return '\n'
+ return "\n"
- indent = ' ' * self.depth
+ indent = " " * self.depth
leaves = iter(self.leaves)
first = next(leaves)
- res = f'{first.prefix}{indent}{first.value}'
+ res = f"{first.prefix}{indent}{first.value}"
for leaf in leaves:
res += str(leaf)
for _, comment in self.comments:
res += str(comment)
- return res + '\n'
+ return res + "\n"
def __bool__(self) -> bool:
"""Return True if the line has leaves or comments."""
`depth` is not used for indentation in this case.
"""
if not self:
- return '\n'
+ return "\n"
- res = ''
+ res = ""
for leaf in self.leaves:
res += str(leaf)
return res
if current_line.leaves:
# Consume the first leaf's extra newlines.
first_leaf = current_line.leaves[0]
- before = first_leaf.prefix.count('\n')
+ before = first_leaf.prefix.count("\n")
before = min(before, max_allowed)
- first_leaf.prefix = ''
+ first_leaf.prefix = ""
else:
before = 0
depth = current_line.depth
else:
normalize_prefix(node, inside_brackets=any_open_brackets)
+ if node.type == token.STRING:
+ normalize_string_quotes(node)
if node.type not in WHITESPACE:
self.current_line.append(node)
yield from super().visit_default(node)
yield from self.line()
yield from self.visit(node)
+ if node.type == token.ENDMARKER:
+ # somebody decided not to put a final `# fmt: on`
+ yield from self.line()
+
def __attrs_post_init__(self) -> None:
"""You are in a twisty little maze of passages."""
v = self.visit_stmt
- self.visit_if_stmt = partial(v, keywords={'if', 'else', 'elif'})
- self.visit_while_stmt = partial(v, keywords={'while', 'else'})
- self.visit_for_stmt = partial(v, keywords={'for', 'else'})
- self.visit_try_stmt = partial(v, keywords={'try', 'except', 'else', 'finally'})
- self.visit_except_clause = partial(v, keywords={'except'})
- self.visit_funcdef = partial(v, keywords={'def'})
- self.visit_with_stmt = partial(v, keywords={'with'})
- self.visit_classdef = partial(v, keywords={'class'})
+ self.visit_if_stmt = partial(v, keywords={"if", "else", "elif"})
+ self.visit_while_stmt = partial(v, keywords={"while", "else"})
+ self.visit_for_stmt = partial(v, keywords={"for", "else"})
+ self.visit_try_stmt = partial(v, keywords={"try", "except", "else", "finally"})
+ self.visit_except_clause = partial(v, keywords={"except"})
+ self.visit_funcdef = partial(v, keywords={"def"})
+ self.visit_with_stmt = partial(v, keywords={"with"})
+ self.visit_classdef = partial(v, keywords={"class"})
self.visit_async_funcdef = self.visit_async_stmt
self.visit_decorated = self.visit_decorators
def whitespace(leaf: Leaf) -> str: # noqa C901
"""Return whitespace prefix if needed for the given `leaf`."""
- NO = ''
- SPACE = ' '
- DOUBLESPACE = ' '
+ NO = ""
+ SPACE = " "
+ DOUBLESPACE = " "
t = leaf.type
p = leaf.parent
v = leaf.value
and prevp.parent.type == syms.shift_expr
and prevp.prev_sibling
and prevp.prev_sibling.type == token.NAME
- and prevp.prev_sibling.value == 'print' # type: ignore
+ and prevp.prev_sibling.value == "print" # type: ignore
):
# Python 2 print chevron
return NO
return NO
elif t == token.NAME:
- if v == 'import':
+ if v == "import":
return SPACE
if prev and prev.type == token.DOT:
return None
-def is_delimiter(leaf: Leaf) -> int:
- """Return the priority of the `leaf` delimiter. Return 0 if not delimiter.
+def is_split_after_delimiter(leaf: Leaf, previous: Leaf = None) -> int:
+ """Return the priority of the `leaf` delimiter, given a line break after it.
+
+ The delimiter priorities returned here are from those delimiters that would
+ cause a line break after themselves.
Higher numbers are higher priority.
"""
if leaf.type == token.COMMA:
return COMMA_PRIORITY
- if leaf.type in COMPARATORS:
- return COMPARATOR_PRIORITY
+ return 0
+
+
+def is_split_before_delimiter(leaf: Leaf, previous: Leaf = None) -> int:
+ """Return the priority of the `leaf` delimiter, given a line before after it.
+
+ The delimiter priorities returned here are from those delimiters that would
+ cause a line break before themselves.
+
+ Higher numbers are higher priority.
+ """
+ if (
+ leaf.type in VARARGS
+ and leaf.parent
+ and leaf.parent.type in {syms.argument, syms.typedargslist}
+ ):
+ # * and ** might also be MATH_OPERATORS but in this case they are not.
+ # Don't treat them as a delimiter.
+ return 0
if (
leaf.type in MATH_OPERATORS
):
return MATH_PRIORITY
+ if leaf.type in COMPARATORS:
+ return COMPARATOR_PRIORITY
+
+ if (
+ leaf.type == token.STRING
+ and previous is not None
+ and previous.type == token.STRING
+ ):
+ return STRING_PRIORITY
+
+ if (
+ leaf.type == token.NAME
+ and leaf.value == "for"
+ and leaf.parent
+ and leaf.parent.type in {syms.comp_for, syms.old_comp_for}
+ ):
+ return COMPREHENSION_PRIORITY
+
+ if (
+ leaf.type == token.NAME
+ and leaf.value == "if"
+ and leaf.parent
+ and leaf.parent.type in {syms.comp_if, syms.old_comp_if}
+ ):
+ return COMPREHENSION_PRIORITY
+
+ if leaf.type == token.NAME and leaf.value in LOGIC_OPERATORS and leaf.parent:
+ return LOGIC_PRIORITY
+
return 0
+def is_delimiter(leaf: Leaf, previous: Leaf = None) -> int:
+ """Return the priority of the `leaf` delimiter. Return 0 if not delimiter.
+
+ Higher numbers are higher priority.
+ """
+ return max(
+ is_split_before_delimiter(leaf, previous),
+ is_split_after_delimiter(leaf, previous),
+ )
+
+
def generate_comments(leaf: Leaf) -> Iterator[Leaf]:
"""Clean the prefix of the `leaf` and generate comments from it, if any.
if not p:
return
- if '#' not in p:
+ if "#" not in p:
return
consumed = 0
nlines = 0
- for index, line in enumerate(p.split('\n')):
+ for index, line in enumerate(p.split("\n")):
consumed += len(line) + 1 # adding the length of the split '\n'
line = line.lstrip()
if not line:
nlines += 1
- if not line.startswith('#'):
+ if not line.startswith("#"):
continue
if index == 0 and leaf.type != token.ENDMARKER:
else:
comment_type = STANDALONE_COMMENT
comment = make_comment(line)
- yield Leaf(comment_type, comment, prefix='\n' * nlines)
+ yield Leaf(comment_type, comment, prefix="\n" * nlines)
- if comment in {'# fmt: on', '# yapf: enable'}:
+ if comment in {"# fmt: on", "# yapf: enable"}:
raise FormatOn(consumed)
- if comment in {'# fmt: off', '# yapf: disable'}:
- raise FormatOff(consumed)
+ if comment in {"# fmt: off", "# yapf: disable"}:
+ if comment_type == STANDALONE_COMMENT:
+ raise FormatOff(consumed)
+
+ prev = preceding_leaf(leaf)
+ if not prev or prev.type in WHITESPACE: # standalone comment in disguise
+ raise FormatOff(consumed)
nlines = 0
"""
content = content.rstrip()
if not content:
- return '#'
+ return "#"
- if content[0] == '#':
+ if content[0] == "#":
content = content[1:]
- if content and content[0] not in ' !:#':
- content = ' ' + content
- return '#' + content
+ if content and content[0] not in " !:#":
+ content = " " + content
+ return "#" + content
def split_line(
yield line
return
- line_str = str(line).strip('\n')
+ line_str = str(line).strip("\n")
if (
len(line_str) <= line_length
- and '\n' not in line_str # multiline strings
+ and "\n" not in line_str # multiline strings
and not line.contains_standalone_comments
):
yield line
result: List[Line] = []
try:
for l in split_func(line, py36):
- if str(l).strip('\n') == line_str:
+ if str(l).strip("\n") == line_str:
raise CannotSplit("Split function returned an unchanged result")
result.extend(
current_line = Line(depth=line.depth, inside_brackets=line.inside_brackets)
if current_line:
if (
- delimiter_priority == COMMA_PRIORITY
+ trailing_comma_safe
+ and delimiter_priority == COMMA_PRIORITY
and current_line.leaves[-1].type != token.COMMA
- and trailing_comma_safe
+ and current_line.leaves[-1].type != STANDALONE_COMMENT
):
- current_line.append(Leaf(token.COMMA, ','))
+ current_line.append(Leaf(token.COMMA, ","))
yield current_line
return bool(
t == token.NAME
and (
- (v == 'import' and p and p.type == syms.import_name)
- or (v == 'from' and p and p.type == syms.import_from)
+ (v == "import" and p and p.type == syms.import_name)
+ or (v == "from" and p and p.type == syms.import_from)
)
)
Note: don't use backslashes for formatting or you'll lose your voting rights.
"""
if not inside_brackets:
- spl = leaf.prefix.split('#')
- if '\\' not in spl[0]:
- nl_count = spl[-1].count('\n')
+ spl = leaf.prefix.split("#")
+ if "\\" not in spl[0]:
+ nl_count = spl[-1].count("\n")
if len(spl) > 1:
nl_count -= 1
- leaf.prefix = '\n' * nl_count
+ leaf.prefix = "\n" * nl_count
return
- leaf.prefix = ''
+ leaf.prefix = ""
+
+
+def normalize_string_quotes(leaf: Leaf) -> None:
+ """Prefer double quotes but only if it doesn't cause more escaping.
+
+ Adds or removes backslashes as appropriate. Doesn't parse and fix
+ strings nested in f-strings (yet).
+
+ Note: Mutates its argument.
+ """
+ value = leaf.value.lstrip("furbFURB")
+ if value[:3] == '"""':
+ return
+
+ elif value[:3] == "'''":
+ orig_quote = "'''"
+ new_quote = '"""'
+ elif value[0] == '"':
+ orig_quote = '"'
+ new_quote = "'"
+ else:
+ orig_quote = "'"
+ new_quote = '"'
+ first_quote_pos = leaf.value.find(orig_quote)
+ if first_quote_pos == -1:
+ return # There's an internal error
+
+ prefix = leaf.value[:first_quote_pos]
+ body = leaf.value[first_quote_pos + len(orig_quote):-len(orig_quote)]
+ unescaped_new_quote = re.compile(r"(([^\\]|^)(\\\\)*)" + new_quote)
+ escaped_orig_quote = re.compile(r"\\(\\\\)*" + orig_quote)
+ if "r" in prefix.casefold():
+ if unescaped_new_quote.search(body):
+ # There's at least one unescaped new_quote in this raw string
+ # so converting is impossible
+ return
+
+ # Do not introduce or remove backslashes in raw strings
+ new_body = body
+ else:
+ new_body = escaped_orig_quote.sub(f"\\1{orig_quote}", body)
+ new_body = unescaped_new_quote.sub(f"\\1\\\\{new_quote}", new_body)
+ if new_quote == '"""' and new_body[-1] == '"':
+ # edge case:
+ new_body = new_body[:-1] + '\\"'
+ orig_escape_count = body.count("\\")
+ new_escape_count = new_body.count("\\")
+ if new_escape_count > orig_escape_count:
+ return # Do not introduce more escaping
+
+ if new_escape_count == orig_escape_count and orig_quote == '"':
+ return # Prefer double quotes
+
+ leaf.value = f"{prefix}{new_quote}{new_body}{new_quote}"
def is_python36(node: Node) -> bool:
for n in node.pre_order():
if n.type == token.STRING:
value_head = n.value[:2] # type: ignore
- if value_head in {'f"', 'F"', "f'", "F'", 'rf', 'fr', 'RF', 'FR'}:
+ if value_head in {'f"', 'F"', "f'", "F'", "rf", "fr", "RF", "FR"}:
return True
elif (
return False
-PYTHON_EXTENSIONS = {'.py'}
+PYTHON_EXTENSIONS = {".py"}
BLACKLISTED_DIRECTORIES = {
- 'build', 'buck-out', 'dist', '_build', '.git', '.hg', '.mypy_cache', '.tox', '.venv'
+ "build", "buck-out", "dist", "_build", ".git", ".hg", ".mypy_cache", ".tox", ".venv"
}
class Report:
"""Provides a reformatting counter. Can be rendered with `str(report)`."""
check: bool = False
+ quiet: bool = False
change_count: int = 0
same_count: int = 0
failure_count: int = 0
def done(self, src: Path, changed: bool) -> None:
"""Increment the counter for successful reformatting. Write out a message."""
if changed:
- reformatted = 'would reformat' if self.check else 'reformatted'
- out(f'{reformatted} {src}')
+ reformatted = "would reformat" if self.check else "reformatted"
+ if not self.quiet:
+ out(f"{reformatted} {src}")
self.change_count += 1
else:
- out(f'{src} already well formatted, good job.', bold=False)
+ if not self.quiet:
+ out(f"{src} already well formatted, good job.", bold=False)
self.same_count += 1
def failed(self, src: Path, message: str) -> None:
"""Increment the counter for failed reformatting. Write out a message."""
- err(f'error: cannot format {src}: {message}')
+ err(f"error: cannot format {src}: {message}")
self.failure_count += 1
@property
failed = "failed to reformat"
report = []
if self.change_count:
- s = 's' if self.change_count > 1 else ''
+ s = "s" if self.change_count > 1 else ""
report.append(
- click.style(f'{self.change_count} file{s} {reformatted}', bold=True)
+ click.style(f"{self.change_count} file{s} {reformatted}", bold=True)
)
if self.same_count:
- s = 's' if self.same_count > 1 else ''
- report.append(f'{self.same_count} file{s} {unchanged}')
+ s = "s" if self.same_count > 1 else ""
+ report.append(f"{self.same_count} file{s} {unchanged}")
if self.failure_count:
- s = 's' if self.failure_count > 1 else ''
+ s = "s" if self.failure_count > 1 else ""
report.append(
- click.style(f'{self.failure_count} file{s} {failed}', fg='red')
+ click.style(f"{self.failure_count} file{s} {failed}", fg="red")
)
- return ', '.join(report) + '.'
+ return ", ".join(report) + "."
def assert_equivalent(src: str, dst: str) -> None:
try:
dst_ast = ast.parse(dst)
except Exception as exc:
- log = dump_to_file(''.join(traceback.format_tb(exc.__traceback__)), dst)
+ log = dump_to_file("".join(traceback.format_tb(exc.__traceback__)), dst)
raise AssertionError(
f"INTERNAL ERROR: Black produced invalid code: {exc}. "
f"Please report a bug on https://github.com/ambv/black/issues. "
f"This invalid output might be helpful: {log}"
) from None
- src_ast_str = '\n'.join(_v(src_ast))
- dst_ast_str = '\n'.join(_v(dst_ast))
+ src_ast_str = "\n".join(_v(src_ast))
+ dst_ast_str = "\n".join(_v(dst_ast))
if src_ast_str != dst_ast_str:
- log = dump_to_file(diff(src_ast_str, dst_ast_str, 'src', 'dst'))
+ log = dump_to_file(diff(src_ast_str, dst_ast_str, "src", "dst"))
raise AssertionError(
f"INTERNAL ERROR: Black produced code that is not equivalent to "
f"the source. "
newdst = format_str(dst, line_length=line_length)
if dst != newdst:
log = dump_to_file(
- diff(src, dst, 'source', 'first pass'),
- diff(dst, newdst, 'first pass', 'second pass'),
+ diff(src, dst, "source", "first pass"),
+ diff(dst, newdst, "first pass", "second pass"),
)
raise AssertionError(
f"INTERNAL ERROR: Black produced different code on the second pass "
import tempfile
with tempfile.NamedTemporaryFile(
- mode='w', prefix='blk_', suffix='.log', delete=False
+ mode="w", prefix="blk_", suffix=".log", delete=False
) as f:
for lines in output:
f.write(lines)
- f.write('\n')
+ if lines and lines[-1] != "\n":
+ f.write("\n")
return f.name
"""Return a unified diff string between strings `a` and `b`."""
import difflib
- a_lines = [line + '\n' for line in a.split('\n')]
- b_lines = [line + '\n' for line in b.split('\n')]
- return ''.join(
+ a_lines = [line + "\n" for line in a.split("\n")]
+ b_lines = [line + "\n" for line in b.split("\n")]
+ return "".join(
difflib.unified_diff(a_lines, b_lines, fromfile=a_name, tofile=b_name, n=5)
)
-if __name__ == '__main__':
+def cancel(tasks: List[asyncio.Task]) -> None:
+ """asyncio signal handler that cancels all `tasks` and reports to stderr."""
+ err("Aborted!")
+ for task in tasks:
+ task.cancel()
+
+
+def shutdown(loop: BaseEventLoop) -> None:
+ """Cancel all pending tasks on `loop`, wait for them, and close the loop."""
+ try:
+ # This part is borrowed from asyncio/runners.py in Python 3.7b2.
+ to_cancel = [task for task in asyncio.Task.all_tasks(loop) if not task.done()]
+ if not to_cancel:
+ return
+
+ for task in to_cancel:
+ task.cancel()
+ loop.run_until_complete(
+ asyncio.gather(*to_cancel, loop=loop, return_exceptions=True)
+ )
+ finally:
+ # `concurrent.futures.Future` objects cannot be cancelled once they
+ # are already running. There might be some when the `shutdown()` happened.
+ # Silence their logger's spew about the event loop being closed.
+ cf_logger = logging.getLogger("concurrent.futures")
+ cf_logger.setLevel(logging.CRITICAL)
+ loop.close()
+
+
+if __name__ == "__main__":
main()
projects / etc / vim.git / blobdiff