+import re
+from dataclasses import replace
+from typing import Any, Iterator
from unittest.mock import patch
-import black
import pytest
-from parameterized import parameterized
+import black
from tests.util import (
- BlackBaseTestCase,
- fs,
- ff,
DEFAULT_MODE,
+ PY36_VERSIONS,
+ all_data_cases,
+ assert_format,
dump_to_stderr,
read_data,
- THIS_DIR,
)
-SIMPLE_CASES = [
- "beginning_backslash",
- "bracketmatch",
- "class_blank_parentheses",
- "class_methods_new_line",
- "collections",
- "comments",
- "comments2",
- "comments3",
- "comments4",
- "comments5",
- "comments6",
- "comments_non_breaking_space",
- "comment_after_escaped_newline",
- "composition",
- "composition_no_trailing_comma",
- "docstring",
- "empty_lines",
- "expression",
- "fmtonoff",
- "fmtonoff2",
- "fmtonoff3",
- "fmtonoff4",
- "fmtskip",
- "fmtskip2",
- "fmtskip3",
- "fmtskip4",
- "fmtskip5",
- "fstring",
- "function",
- "function2",
- "function_trailing_comma",
- "import_spacing",
- "remove_parens",
- "slices",
- "string_prefixes",
- "tricky_unicode_symbols",
- "tupleassign",
-]
-
-SIMPLE_CASES_PY2 = [
- "numeric_literals_py2",
- "python2",
- "python2_unicode_literals",
-]
-
-EXPERIMENTAL_STRING_PROCESSING_CASES = [
- "cantfit",
- "comments7",
- "long_strings",
- "long_strings__edge_case",
- "long_strings__regression",
- "percent_precedence",
-]
-
-
-SOURCES = [
- "src/black/__init__.py",
- "src/black/__main__.py",
- "src/black/brackets.py",
- "src/black/cache.py",
- "src/black/comments.py",
- "src/black/concurrency.py",
- "src/black/const.py",
- "src/black/debug.py",
- "src/black/files.py",
- "src/black/linegen.py",
- "src/black/lines.py",
- "src/black/mode.py",
- "src/black/nodes.py",
- "src/black/numerics.py",
- "src/black/output.py",
- "src/black/parsing.py",
- "src/black/report.py",
- "src/black/rusty.py",
- "src/black/strings.py",
- "src/black/trans.py",
- "src/blackd/__init__.py",
- "src/blib2to3/pygram.py",
- "src/blib2to3/pytree.py",
- "src/blib2to3/pgen2/conv.py",
- "src/blib2to3/pgen2/driver.py",
- "src/blib2to3/pgen2/grammar.py",
- "src/blib2to3/pgen2/literals.py",
- "src/blib2to3/pgen2/parse.py",
- "src/blib2to3/pgen2/pgen.py",
- "src/blib2to3/pgen2/tokenize.py",
- "src/blib2to3/pgen2/token.py",
- "setup.py",
- "tests/test_black.py",
- "tests/test_blackd.py",
- "tests/test_format.py",
- "tests/test_primer.py",
- "tests/optional.py",
- "tests/util.py",
- "tests/conftest.py",
-]
-
-
-class TestSimpleFormat(BlackBaseTestCase):
- @parameterized.expand(SIMPLE_CASES_PY2)
- @pytest.mark.python2
- @patch("black.dump_to_file", dump_to_stderr)
- def test_simple_format_py2(self, filename: str) -> None:
- self.check_file(filename, DEFAULT_MODE)
-
- @parameterized.expand(SIMPLE_CASES)
- @patch("black.dump_to_file", dump_to_stderr)
- def test_simple_format(self, filename: str) -> None:
- self.check_file(filename, DEFAULT_MODE)
-
- @parameterized.expand(EXPERIMENTAL_STRING_PROCESSING_CASES)
- @patch("black.dump_to_file", dump_to_stderr)
- def test_experimental_format(self, filename: str) -> None:
- self.check_file(filename, black.Mode(experimental_string_processing=True))
-
- @parameterized.expand(SOURCES)
- @patch("black.dump_to_file", dump_to_stderr)
- def test_source_is_formatted(self, filename: str) -> None:
- path = THIS_DIR.parent / filename
- self.check_file(str(path), DEFAULT_MODE, data=False)
- self.assertFalse(ff(path))
-
- def check_file(self, filename: str, mode: black.Mode, *, data: bool = True) -> None:
- source, expected = read_data(filename, data=data)
- actual = fs(source, mode=mode)
- self.assertFormatEqual(expected, actual)
- black.assert_equivalent(source, actual)
- black.assert_stable(source, actual, mode)
+
+@pytest.fixture(autouse=True)
+def patch_dump_to_file(request: Any) -> Iterator[None]:
+ with patch("black.dump_to_file", dump_to_stderr):
+ yield
+
+
+def check_file(
+ subdir: str, filename: str, mode: black.Mode, *, data: bool = True
+) -> None:
+ source, expected = read_data(subdir, filename, data=data)
+ assert_format(source, expected, mode, fast=False)
+
+
+@pytest.mark.filterwarnings("ignore:invalid escape sequence.*:DeprecationWarning")
+@pytest.mark.parametrize("filename", all_data_cases("simple_cases"))
+def test_simple_format(filename: str) -> None:
+ magic_trailing_comma = filename != "skip_magic_trailing_comma"
+ check_file(
+ "simple_cases", filename, black.Mode(magic_trailing_comma=magic_trailing_comma)
+ )
+
+
+@pytest.mark.parametrize("filename", all_data_cases("preview"))
+def test_preview_format(filename: str) -> None:
+ check_file("preview", filename, black.Mode(preview=True))
+
+
+def test_preview_context_managers_targeting_py38() -> None:
+ source, expected = read_data("preview_context_managers", "targeting_py38.py")
+ mode = black.Mode(preview=True, target_versions={black.TargetVersion.PY38})
+ assert_format(source, expected, mode, minimum_version=(3, 8))
+
+
+def test_preview_context_managers_targeting_py39() -> None:
+ source, expected = read_data("preview_context_managers", "targeting_py39.py")
+ mode = black.Mode(preview=True, target_versions={black.TargetVersion.PY39})
+ assert_format(source, expected, mode, minimum_version=(3, 9))
+
+
+@pytest.mark.parametrize(
+ "filename", all_data_cases("preview_context_managers/auto_detect")
+)
+def test_preview_context_managers_auto_detect(filename: str) -> None:
+ match = re.match(r"features_3_(\d+)", filename)
+ assert match is not None, "Unexpected filename format: %s" % filename
+ source, expected = read_data("preview_context_managers/auto_detect", filename)
+ mode = black.Mode(preview=True)
+ assert_format(source, expected, mode, minimum_version=(3, int(match.group(1))))
+
+
+# =============== #
+# Complex cases
+# ============= #
+
+
+def test_empty() -> None:
+ source = expected = ""
+ assert_format(source, expected)
+
+
+@pytest.mark.parametrize("filename", all_data_cases("py_36"))
+def test_python_36(filename: str) -> None:
+ source, expected = read_data("py_36", filename)
+ mode = black.Mode(target_versions=PY36_VERSIONS)
+ assert_format(source, expected, mode, minimum_version=(3, 6))
+
+
+@pytest.mark.parametrize("filename", all_data_cases("py_37"))
+def test_python_37(filename: str) -> None:
+ source, expected = read_data("py_37", filename)
+ mode = black.Mode(target_versions={black.TargetVersion.PY37})
+ assert_format(source, expected, mode, minimum_version=(3, 7))
+
+
+@pytest.mark.parametrize("filename", all_data_cases("py_38"))
+def test_python_38(filename: str) -> None:
+ source, expected = read_data("py_38", filename)
+ mode = black.Mode(target_versions={black.TargetVersion.PY38})
+ assert_format(source, expected, mode, minimum_version=(3, 8))
+
+
+@pytest.mark.parametrize("filename", all_data_cases("py_39"))
+def test_python_39(filename: str) -> None:
+ source, expected = read_data("py_39", filename)
+ mode = black.Mode(target_versions={black.TargetVersion.PY39})
+ assert_format(source, expected, mode, minimum_version=(3, 9))
+
+
+@pytest.mark.parametrize("filename", all_data_cases("py_310"))
+def test_python_310(filename: str) -> None:
+ source, expected = read_data("py_310", filename)
+ mode = black.Mode(target_versions={black.TargetVersion.PY310})
+ assert_format(source, expected, mode, minimum_version=(3, 10))
+
+
+@pytest.mark.parametrize("filename", all_data_cases("py_310"))
+def test_python_310_without_target_version(filename: str) -> None:
+ source, expected = read_data("py_310", filename)
+ mode = black.Mode()
+ assert_format(source, expected, mode, minimum_version=(3, 10))
+
+
+def test_patma_invalid() -> None:
+ source, expected = read_data("miscellaneous", "pattern_matching_invalid")
+ mode = black.Mode(target_versions={black.TargetVersion.PY310})
+ with pytest.raises(black.parsing.InvalidInput) as exc_info:
+ assert_format(source, expected, mode, minimum_version=(3, 10))
+
+ exc_info.match("Cannot parse: 10:11")
+
+
+@pytest.mark.parametrize("filename", all_data_cases("py_311"))
+def test_python_311(filename: str) -> None:
+ source, expected = read_data("py_311", filename)
+ mode = black.Mode(target_versions={black.TargetVersion.PY311})
+ assert_format(source, expected, mode, minimum_version=(3, 11))
+
+
+@pytest.mark.parametrize("filename", all_data_cases("fast"))
+def test_fast_cases(filename: str) -> None:
+ source, expected = read_data("fast", filename)
+ assert_format(source, expected, fast=True)
+
+
+def test_python_2_hint() -> None:
+ with pytest.raises(black.parsing.InvalidInput) as exc_info:
+ assert_format("print 'daylily'", "print 'daylily'")
+ exc_info.match(black.parsing.PY2_HINT)
+
+
+@pytest.mark.filterwarnings("ignore:invalid escape sequence.*:DeprecationWarning")
+def test_docstring_no_string_normalization() -> None:
+ """Like test_docstring but with string normalization off."""
+ source, expected = read_data("miscellaneous", "docstring_no_string_normalization")
+ mode = replace(DEFAULT_MODE, string_normalization=False)
+ assert_format(source, expected, mode)
+
+
+def test_docstring_line_length_6() -> None:
+ """Like test_docstring but with line length set to 6."""
+ source, expected = read_data("miscellaneous", "linelength6")
+ mode = black.Mode(line_length=6)
+ assert_format(source, expected, mode)
+
+
+def test_preview_docstring_no_string_normalization() -> None:
+ """
+ Like test_docstring but with string normalization off *and* the preview style
+ enabled.
+ """
+ source, expected = read_data(
+ "miscellaneous", "docstring_preview_no_string_normalization"
+ )
+ mode = replace(DEFAULT_MODE, string_normalization=False, preview=True)
+ assert_format(source, expected, mode)
+
+
+def test_long_strings_flag_disabled() -> None:
+ """Tests for turning off the string processing logic."""
+ source, expected = read_data("miscellaneous", "long_strings_flag_disabled")
+ mode = replace(DEFAULT_MODE, experimental_string_processing=False)
+ assert_format(source, expected, mode)
+
+
+def test_stub() -> None:
+ mode = replace(DEFAULT_MODE, is_pyi=True)
+ source, expected = read_data("miscellaneous", "stub.pyi")
+ assert_format(source, expected, mode)
+
+
+def test_nested_class_stub() -> None:
+ mode = replace(DEFAULT_MODE, is_pyi=True, preview=True)
+ source, expected = read_data("miscellaneous", "nested_class_stub.pyi")
+ assert_format(source, expected, mode)
+
+
+def test_power_op_newline() -> None:
+ # requires line_length=0
+ source, expected = read_data("miscellaneous", "power_op_newline")
+ assert_format(source, expected, mode=black.Mode(line_length=0))
+
+
+def test_type_comment_syntax_error() -> None:
+ """Test that black is able to format python code with type comment syntax errors."""
+ source, expected = read_data("type_comments", "type_comment_syntax_error")
+ assert_format(source, expected)
+ black.assert_equivalent(source, expected)
projects / etc / vim.git / blobdiff