+import re
from dataclasses import replace
-from typing import Any, Iterator, List
+from typing import Any, Iterator
from unittest.mock import patch
import pytest
from tests.util import (
DEFAULT_MODE,
PY36_VERSIONS,
- THIS_DIR,
+ all_data_cases,
assert_format,
dump_to_stderr,
read_data,
)
-SIMPLE_CASES: List[str] = [
- "attribute_access_on_number_literals",
- "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",
- "fmtskip6",
- "fmtskip7",
- "fstring",
- "function",
- "function2",
- "function_trailing_comma",
- "import_spacing",
- "power_op_spacing",
- "remove_parens",
- "slices",
- "string_prefixes",
- "torture",
- "trailing_comma_optional_parens1",
- "trailing_comma_optional_parens2",
- "trailing_comma_optional_parens3",
- "tricky_unicode_symbols",
- "tupleassign",
-]
-
-PY310_CASES: List[str] = [
- "starred_for_target",
- "pattern_matching_simple",
- "pattern_matching_complex",
- "pattern_matching_extras",
- "pattern_matching_style",
- "pattern_matching_generic",
- "parenthesized_context_managers",
-]
-
-PY311_CASES: List[str] = [
- "pep_654",
- "pep_654_style",
-]
-
-PREVIEW_CASES: List[str] = [
- # string processing
- "cantfit",
- "comments7",
- "comments8",
- "long_strings",
- "long_strings__edge_case",
- "long_strings__regression",
- "percent_precedence",
- "remove_except_parens",
- "remove_for_brackets",
- "one_element_subscript",
- "remove_await_parens",
- "return_annotation_brackets",
- "docstring_preview",
-]
-
-SOURCES: List[str] = [
- "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/optional.py",
- "tests/util.py",
- "tests/conftest.py",
-]
-
@pytest.fixture(autouse=True)
def patch_dump_to_file(request: Any) -> Iterator[None]:
yield
-def check_file(filename: str, mode: black.Mode, *, data: bool = True) -> None:
- source, expected = read_data(filename, data=data)
+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.parametrize("filename", SIMPLE_CASES)
+@pytest.mark.filterwarnings("ignore:invalid escape sequence.*:DeprecationWarning")
+@pytest.mark.parametrize("filename", all_data_cases("simple_cases"))
def test_simple_format(filename: str) -> None:
- check_file(filename, DEFAULT_MODE)
+ magic_trailing_comma = filename != "skip_magic_trailing_comma"
+ mode = black.Mode(
+ magic_trailing_comma=magic_trailing_comma, is_pyi=filename.endswith("_pyi")
+ )
+ check_file("simple_cases", filename, mode)
-@pytest.mark.parametrize("filename", PREVIEW_CASES)
+@pytest.mark.parametrize("filename", all_data_cases("preview"))
def test_preview_format(filename: str) -> None:
- check_file(filename, black.Mode(preview=True))
+ 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", SOURCES)
-def test_source_is_formatted(filename: str) -> None:
- path = THIS_DIR.parent / filename
- check_file(str(path), DEFAULT_MODE, data=False)
+
+@pytest.mark.parametrize("filename", all_data_cases("preview_py_310"))
+def test_preview_python_310(filename: str) -> None:
+ source, expected = read_data("preview_py_310", filename)
+ mode = black.Mode(target_versions={black.TargetVersion.PY310}, preview=True)
+ assert_format(source, expected, mode, minimum_version=(3, 10))
+
+
+@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))))
# =============== #
assert_format(source, expected)
-def test_pep_572() -> None:
- source, expected = read_data("pep_572")
- assert_format(source, expected, minimum_version=(3, 8))
-
-
-def test_pep_572_remove_parens() -> None:
- source, expected = read_data("pep_572_remove_parens")
- assert_format(source, expected, minimum_version=(3, 8))
-
-
-def test_pep_572_do_not_remove_parens() -> None:
- source, expected = read_data("pep_572_do_not_remove_parens")
- # the AST safety checks will fail, but that's expected, just make sure no
- # parentheses are touched
- assert_format(source, expected, fast=True)
+@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("major, minor", [(3, 9), (3, 10)])
-def test_pep_572_newer_syntax(major: int, minor: int) -> None:
- source, expected = read_data(f"pep_572_py{major}{minor}")
- assert_format(source, expected, minimum_version=(major, minor))
+@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))
-def test_pep_570() -> None:
- source, expected = read_data("pep_570")
- assert_format(source, expected, minimum_version=(3, 8))
+@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))
-def test_remove_with_brackets() -> None:
- source, expected = read_data("remove_with_brackets")
- assert_format(
- source,
- expected,
- black.Mode(preview=True),
- minimum_version=(3, 9),
- )
+@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", PY310_CASES)
+@pytest.mark.parametrize("filename", all_data_cases("py_310"))
def test_python_310(filename: str) -> None:
- source, expected = read_data(filename)
+ source, expected = read_data("py_310", filename)
mode = black.Mode(target_versions={black.TargetVersion.PY310})
assert_format(source, expected, mode, minimum_version=(3, 10))
-def test_python_310_without_target_version() -> None:
- source, expected = read_data("pattern_matching_simple")
+@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("pattern_matching_invalid")
+ 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", PY311_CASES)
+@pytest.mark.parametrize("filename", all_data_cases("py_311"))
def test_python_311(filename: str) -> None:
- source, expected = read_data(filename)
+ 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("py_312"))
+def test_python_312(filename: str) -> None:
+ source, expected = read_data("py_312", filename)
+ mode = black.Mode(target_versions={black.TargetVersion.PY312})
+ assert_format(source, expected, mode, minimum_version=(3, 12))
+
+
+@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("docstring_no_string_normalization")
+ source, expected = read_data("miscellaneous", "docstring_no_string_normalization")
mode = replace(DEFAULT_MODE, string_normalization=False)
assert_format(source, expected, mode)
-def test_long_strings_flag_disabled() -> None:
- """Tests for turning off the string processing logic."""
- source, expected = read_data("long_strings_flag_disabled")
- mode = replace(DEFAULT_MODE, experimental_string_processing=False)
+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_numeric_literals() -> None:
- source, expected = read_data("numeric_literals")
- mode = replace(DEFAULT_MODE, target_versions=PY36_VERSIONS)
+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_numeric_literals_ignoring_underscores() -> None:
- source, expected = read_data("numeric_literals_skip_underscores")
- mode = replace(DEFAULT_MODE, target_versions=PY36_VERSIONS)
+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("stub.pyi")
+ source, expected = read_data("miscellaneous", "stub.pyi")
assert_format(source, expected, mode)
-def test_python38() -> None:
- source, expected = read_data("python38")
- assert_format(source, expected, minimum_version=(3, 8))
-
-
-def test_python39() -> None:
- source, expected = read_data("python39")
- assert_format(source, expected, minimum_version=(3, 9))
+def test_nested_stub() -> None:
+ mode = replace(DEFAULT_MODE, is_pyi=True, preview=True)
+ source, expected = read_data("miscellaneous", "nested_stub.pyi")
+ assert_format(source, expected, mode)
def test_power_op_newline() -> None:
# requires line_length=0
- source, expected = read_data("power_op_newline")
+ 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)