from io import BytesIO, TextIOWrapper
import os
from pathlib import Path
+import re
import sys
from tempfile import TemporaryDirectory
-from typing import Any, List, Tuple, Iterator
+from typing import Any, BinaryIO, Generator, List, Tuple, Iterator
import unittest
from unittest.mock import patch
-import re
from click import unstyle
from click.testing import CliRunner
import black
+
ll = 88
ff = partial(black.format_file_in_place, line_length=ll, fast=True)
fs = partial(black.format_str, line_length=ll)
loop.close()
+class BlackRunner(CliRunner):
+ """Modify CliRunner so that stderr is not merged with stdout.
+
+ This is a hack that can be removed once we depend on Click 7.x"""
+
+ def __init__(self, stderrbuf: BinaryIO) -> None:
+ self.stderrbuf = stderrbuf
+ super().__init__()
+
+ @contextmanager
+ def isolation(self, *args: Any, **kwargs: Any) -> Generator[BinaryIO, None, None]:
+ with super().isolation(*args, **kwargs) as output:
+ try:
+ hold_stderr = sys.stderr
+ sys.stderr = TextIOWrapper(self.stderrbuf, encoding=self.charset)
+ yield output
+ finally:
+ sys.stderr = hold_stderr
+
+
class BlackTestCase(unittest.TestCase):
maxDiff = None
black.err(str(ve))
self.assertEqual(expected, actual)
+ @patch("black.dump_to_file", dump_to_stderr)
+ def test_empty(self) -> None:
+ source = expected = ""
+ actual = fs(source)
+ self.assertFormatEqual(expected, actual)
+ black.assert_equivalent(source, actual)
+ black.assert_stable(source, actual, line_length=ll)
+
+ def test_empty_ff(self) -> None:
+ expected = ""
+ tmp_file = Path(black.dump_to_file())
+ try:
+ self.assertFalse(ff(tmp_file, write_back=black.WriteBack.YES))
+ with open(tmp_file, encoding="utf8") as f:
+ actual = f.read()
+ finally:
+ os.unlink(tmp_file)
+ self.assertFormatEqual(expected, actual)
+
@patch("black.dump_to_file", dump_to_stderr)
def test_self(self) -> None:
source, expected = read_data("test_black")
def test_piping(self) -> None:
source, expected = read_data("../black")
- hold_stdin, hold_stdout = sys.stdin, sys.stdout
- try:
- sys.stdin = TextIOWrapper(BytesIO(source.encode("utf8")), encoding="utf8")
- sys.stdout = TextIOWrapper(BytesIO(), encoding="utf8")
- sys.stdin.buffer.name = "<stdin>" # type: ignore
- black.format_stdin_to_stdout(
- line_length=ll, fast=True, write_back=black.WriteBack.YES
- )
- sys.stdout.seek(0)
- actual = sys.stdout.read()
- finally:
- sys.stdin, sys.stdout = hold_stdin, hold_stdout
- self.assertFormatEqual(expected, actual)
- black.assert_equivalent(source, actual)
- black.assert_stable(source, actual, line_length=ll)
+ stderrbuf = BytesIO()
+ result = BlackRunner(stderrbuf).invoke(
+ black.main, ["-", "--fast", f"--line-length={ll}"], input=source
+ )
+ self.assertEqual(result.exit_code, 0)
+ self.assertFormatEqual(expected, result.output)
+ black.assert_equivalent(source, result.output)
+ black.assert_stable(source, result.output, line_length=ll)
def test_piping_diff(self) -> None:
+ diff_header = re.compile(
+ rf"(STDIN|STDOUT)\t\d\d\d\d-\d\d-\d\d "
+ rf"\d\d:\d\d:\d\d\.\d\d\d\d\d\d \+\d\d\d\d"
+ )
source, _ = read_data("expression.py")
expected, _ = read_data("expression.diff")
- hold_stdin, hold_stdout = sys.stdin, sys.stdout
- try:
- sys.stdin = TextIOWrapper(BytesIO(source.encode("utf8")), encoding="utf8")
- sys.stdout = TextIOWrapper(BytesIO(), encoding="utf8")
- sys.stdin.buffer.name = "<stdin>" # type: ignore
- black.format_stdin_to_stdout(
- line_length=ll, fast=True, write_back=black.WriteBack.DIFF
- )
- sys.stdout.seek(0)
- actual = sys.stdout.read()
- finally:
- sys.stdin, sys.stdout = hold_stdin, hold_stdout
+ stderrbuf = BytesIO()
+ result = BlackRunner(stderrbuf).invoke(
+ black.main, ["-", "--fast", f"--line-length={ll}", "--diff"], input=source
+ )
+ self.assertEqual(result.exit_code, 0)
+ actual = diff_header.sub("[Deterministic header]", result.output)
actual = actual.rstrip() + "\n" # the diff output has a trailing space
self.assertEqual(expected, actual)
source, _ = read_data("expression.py")
expected, _ = read_data("expression.diff")
tmp_file = Path(black.dump_to_file(source))
- hold_stdout = sys.stdout
+ diff_header = re.compile(
+ rf"{re.escape(str(tmp_file))}\t\d\d\d\d-\d\d-\d\d "
+ rf"\d\d:\d\d:\d\d\.\d\d\d\d\d\d \+\d\d\d\d"
+ )
+ stderrbuf = BytesIO()
try:
- sys.stdout = TextIOWrapper(BytesIO(), encoding="utf8")
- self.assertTrue(ff(tmp_file, write_back=black.WriteBack.DIFF))
- sys.stdout.seek(0)
- actual = sys.stdout.read()
- actual = actual.replace(str(tmp_file), "<stdin>")
+ result = BlackRunner(stderrbuf).invoke(
+ black.main, ["--diff", str(tmp_file)]
+ )
+ self.assertEqual(result.exit_code, 0)
finally:
- sys.stdout = hold_stdout
os.unlink(tmp_file)
+ actual = result.output
+ actual = diff_header.sub("[Deterministic header]", actual)
actual = actual.rstrip() + "\n" # the diff output has a trailing space
if expected != actual:
dump = black.dump_to_file(actual)
cached_but_changed.touch()
cache = {cached: black.get_cache_info(cached), cached_but_changed: (0.0, 0)}
todo, done = black.filter_cached(
- cache, [uncached, cached, cached_but_changed]
+ cache, {uncached, cached, cached_but_changed}
)
- self.assertEqual(todo, [uncached, cached_but_changed])
- self.assertEqual(done, [cached])
+ self.assertEqual(todo, {uncached, cached_but_changed})
+ self.assertEqual(done, {cached})
def test_write_cache_creates_directory_if_needed(self) -> None:
mode = black.FileMode.AUTO_DETECT
if nl == "\n":
self.assertNotIn(b"\r\n", updated_contents) # type: ignore
+ def test_assert_equivalent_different_asts(self) -> None:
+ with self.assertRaises(AssertionError):
+ black.assert_equivalent("{}", "None")
+
if __name__ == "__main__":
unittest.main()