import pickle
from asyncio.base_events import BaseEventLoop
from concurrent.futures import Executor, ProcessPoolExecutor
-from enum import Enum
+from enum import Enum, Flag
from functools import partial, wraps
import keyword
import logging
from blib2to3.pgen2.parse import ParseError
-__version__ = "18.5b0"
+__version__ = "18.5b1"
DEFAULT_LINE_LENGTH = 88
CACHE_DIR = Path(user_cache_dir("black", version=__version__))
YES = 2
+class FileMode(Flag):
+ AUTO_DETECT = 0
+ PYTHON36 = 1
+ PYI = 2
+
+
@click.command()
@click.option(
"-l",
write_back = WriteBack.DIFF
else:
write_back = WriteBack.YES
+ mode = FileMode.AUTO_DETECT
+ if py36:
+ mode |= FileMode.PYTHON36
+ if pyi:
+ mode |= FileMode.PYI
report = Report(check=check, quiet=quiet)
if len(sources) == 0:
out("No paths given. Nothing to do 😴")
src=sources[0],
line_length=line_length,
fast=fast,
- pyi=pyi,
- py36=py36,
write_back=write_back,
+ mode=mode,
report=report,
)
else:
sources=sources,
line_length=line_length,
fast=fast,
- pyi=pyi,
- py36=py36,
write_back=write_back,
+ mode=mode,
report=report,
loop=loop,
executor=executor,
src: Path,
line_length: int,
fast: bool,
- pyi: bool,
- py36: bool,
write_back: WriteBack,
+ mode: FileMode,
report: "Report",
) -> None:
"""Reformat a single file under `src` without spawning child processes.
changed = Changed.NO
if not src.is_file() and str(src) == "-":
if format_stdin_to_stdout(
- line_length=line_length,
- fast=fast,
- is_pyi=pyi,
- force_py36=py36,
- write_back=write_back,
+ line_length=line_length, fast=fast, write_back=write_back, mode=mode
):
changed = Changed.YES
else:
cache: Cache = {}
if write_back != WriteBack.DIFF:
- cache = read_cache(line_length, pyi, py36)
+ cache = read_cache(line_length, mode)
src = src.resolve()
if src in cache and cache[src] == get_cache_info(src):
changed = Changed.CACHED
src,
line_length=line_length,
fast=fast,
- force_pyi=pyi,
- force_py36=py36,
write_back=write_back,
+ mode=mode,
):
changed = Changed.YES
if write_back == WriteBack.YES and changed is not Changed.NO:
- write_cache(cache, [src], line_length, pyi, py36)
+ write_cache(cache, [src], line_length, mode)
report.done(src, changed)
except Exception as exc:
report.failed(src, str(exc))
sources: List[Path],
line_length: int,
fast: bool,
- pyi: bool,
- py36: bool,
write_back: WriteBack,
+ mode: FileMode,
report: "Report",
loop: BaseEventLoop,
executor: Executor,
"""
cache: Cache = {}
if write_back != WriteBack.DIFF:
- cache = read_cache(line_length, pyi, py36)
+ cache = read_cache(line_length, mode)
sources, cached = filter_cached(cache, sources)
for src in cached:
report.done(src, Changed.CACHED)
src,
line_length,
fast,
- pyi,
- py36,
write_back,
+ mode,
lock,
): src
for src in sorted(sources)
if cancelled:
await asyncio.gather(*cancelled, loop=loop, return_exceptions=True)
if write_back == WriteBack.YES and formatted:
- write_cache(cache, formatted, line_length, pyi, py36)
+ write_cache(cache, formatted, line_length, mode)
def format_file_in_place(
src: Path,
line_length: int,
fast: bool,
- force_pyi: bool = False,
- force_py36: bool = False,
write_back: WriteBack = WriteBack.NO,
+ mode: FileMode = FileMode.AUTO_DETECT,
lock: Any = None, # multiprocessing.Manager().Lock() is some crazy proxy
) -> bool:
"""Format file under `src` path. Return True if changed.
If `write_back` is True, write reformatted code back to stdout.
`line_length` and `fast` options are passed to :func:`format_file_contents`.
"""
- is_pyi = force_pyi or src.suffix == ".pyi"
-
+ if src.suffix == ".pyi":
+ mode |= FileMode.PYI
with tokenize.open(src) as src_buffer:
src_contents = src_buffer.read()
try:
dst_contents = format_file_contents(
- src_contents,
- line_length=line_length,
- fast=fast,
- is_pyi=is_pyi,
- force_py36=force_py36,
+ src_contents, line_length=line_length, fast=fast, mode=mode
)
except NothingChanged:
return False
def format_stdin_to_stdout(
line_length: int,
fast: bool,
- is_pyi: bool = False,
- force_py36: bool = False,
write_back: WriteBack = WriteBack.NO,
+ mode: FileMode = FileMode.AUTO_DETECT,
) -> bool:
"""Format file on stdin. Return True if changed.
src = sys.stdin.read()
dst = src
try:
- dst = format_file_contents(
- src,
- line_length=line_length,
- fast=fast,
- is_pyi=is_pyi,
- force_py36=force_py36,
- )
+ dst = format_file_contents(src, line_length=line_length, fast=fast, mode=mode)
return True
except NothingChanged:
*,
line_length: int,
fast: bool,
- is_pyi: bool = False,
- force_py36: bool = False,
+ mode: FileMode = FileMode.AUTO_DETECT,
) -> FileContent:
"""Reformat contents a file and return new contents.
if src_contents.strip() == "":
raise NothingChanged
- dst_contents = format_str(
- src_contents, line_length=line_length, is_pyi=is_pyi, force_py36=force_py36
- )
+ dst_contents = format_str(src_contents, line_length=line_length, mode=mode)
if src_contents == dst_contents:
raise NothingChanged
if not fast:
assert_equivalent(src_contents, dst_contents)
- assert_stable(
- src_contents,
- dst_contents,
- line_length=line_length,
- is_pyi=is_pyi,
- force_py36=force_py36,
- )
+ assert_stable(src_contents, dst_contents, line_length=line_length, mode=mode)
return dst_contents
def format_str(
- src_contents: str,
- line_length: int,
- *,
- is_pyi: bool = False,
- force_py36: bool = False,
+ src_contents: str, line_length: int, *, mode: FileMode = FileMode.AUTO_DETECT
) -> FileContent:
"""Reformat a string and return new contents.
src_node = lib2to3_parse(src_contents)
dst_contents = ""
future_imports = get_future_imports(src_node)
- elt = EmptyLineTracker(is_pyi=is_pyi)
- py36 = force_py36 or is_python36(src_node)
+ is_pyi = bool(mode & FileMode.PYI)
+ py36 = bool(mode & FileMode.PYTHON36) or is_python36(src_node)
lines = LineGenerator(
remove_u_prefix=py36 or "unicode_literals" in future_imports, is_pyi=is_pyi
)
+ elt = EmptyLineTracker(is_pyi=is_pyi)
empty_line = Line()
after = 0
for current_line in lines.visit(src_node):
and self.leaves[3].value == ")"
)
+ @property
+ def is_triple_quoted_string(self) -> bool:
+ """Is the line a triple quoted string?"""
+ return (
+ bool(self)
+ and self.leaves[0].type == token.STRING
+ and self.leaves[0].value.startswith(('"""', "'''"))
+ )
+
def contains_standalone_comments(self, depth_limit: int = sys.maxsize) -> bool:
"""If so, needs to be split before emitting."""
for leaf in self.leaves:
the prefix of the first leaf consists of optional newlines. Those newlines
are consumed by `maybe_empty_lines()` and included in the computation.
"""
+
is_pyi: bool = False
previous_line: Optional[Line] = None
previous_after: int = 0
if self.previous_line.is_decorator:
return 0, 0
+ if self.previous_line.depth < current_line.depth and (
+ self.previous_line.is_class or self.previous_line.is_def
+ ):
+ return 0, 0
+
if (
self.previous_line.is_comment
and self.previous_line.depth == current_line.depth
):
return (before or 1), 0
+ if (
+ self.previous_line
+ and self.previous_line.is_class
+ and current_line.is_triple_quoted_string
+ ):
+ return before, 1
+
return before, 0
Note: destroys the tree it's visiting by mutating prefixes of its leaves
in ways that will no longer stringify to valid Python code on the tree.
"""
+
is_pyi: bool = False
current_line: Line = Factory(Line)
remove_u_prefix: bool = False
@dataclass
class Report:
"""Provides a reformatting counter. Can be rendered with `str(report)`."""
+
check: bool = False
quiet: bool = False
change_count: int = 0
def assert_stable(
- src: str, dst: str, line_length: int, is_pyi: bool = False, force_py36: bool = False
+ src: str, dst: str, line_length: int, mode: FileMode = FileMode.AUTO_DETECT
) -> None:
"""Raise AssertionError if `dst` reformats differently the second time."""
- newdst = format_str(
- dst, line_length=line_length, is_pyi=is_pyi, force_py36=force_py36
- )
+ newdst = format_str(dst, line_length=line_length, mode=mode)
if dst != newdst:
log = dump_to_file(
diff(src, dst, "source", "first pass"),
return False
-def get_cache_file(line_length: int, pyi: bool = False, py36: bool = False) -> Path:
+def get_cache_file(line_length: int, mode: FileMode) -> Path:
+ pyi = bool(mode & FileMode.PYI)
+ py36 = bool(mode & FileMode.PYTHON36)
return (
CACHE_DIR
/ f"cache.{line_length}{'.pyi' if pyi else ''}{'.py36' if py36 else ''}.pickle"
)
-def read_cache(line_length: int, pyi: bool = False, py36: bool = False) -> Cache:
+def read_cache(line_length: int, mode: FileMode) -> Cache:
"""Read the cache if it exists and is well formed.
If it is not well formed, the call to write_cache later should resolve the issue.
"""
- cache_file = get_cache_file(line_length, pyi, py36)
+ cache_file = get_cache_file(line_length, mode)
if not cache_file.exists():
return {}
def write_cache(
- cache: Cache,
- sources: List[Path],
- line_length: int,
- pyi: bool = False,
- py36: bool = False,
+ cache: Cache, sources: List[Path], line_length: int, mode: FileMode
) -> None:
"""Update the cache file."""
- cache_file = get_cache_file(line_length, pyi, py36)
+ cache_file = get_cache_file(line_length, mode)
try:
if not CACHE_DIR.exists():
CACHE_DIR.mkdir(parents=True)