Document each configuration option in more detail (#2839)

[etc/vim.git] / tests / test_format.py

diff --git a/tests/test_format.py b/tests/test_format.py
index 005a5771c2b644c9feb9bb881adfefbaa5be7547..5a7b3bb67627c5f1f8f043174f8abe48e8cd1988 100644 (file)
--- a/tests/test_format.py
+++ b/tests/test_format.py
@@ -1,5 +1,6 @@
+import re

 from dataclasses import replace
 from dataclasses import replace

-from typing import Any, Iterator, List
+from typing import Any, Iterator

 from unittest.mock import patch
 
 import pytest
 from unittest.mock import patch
 
 import pytest


@@ -8,53 +9,12 @@ import black
 from tests.util import (
     DEFAULT_MODE,
     PY36_VERSIONS,
 from tests.util import (
     DEFAULT_MODE,
     PY36_VERSIONS,

+    all_data_cases,

     assert_format,
     dump_to_stderr,
     read_data,
     assert_format,
     dump_to_stderr,
     read_data,

-    all_data_cases,

 )
 
 )
 

-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]:
 
 @pytest.fixture(autouse=True)
 def patch_dump_to_file(request: Any) -> Iterator[None]:


@@ -69,9 +29,13 @@ def check_file(
     assert_format(source, expected, mode, fast=False)
 
 
     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:
 @pytest.mark.parametrize("filename", all_data_cases("simple_cases"))
 def test_simple_format(filename: str) -> None:

-    check_file("simple_cases", filename, DEFAULT_MODE)
+    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"))
 
 
 @pytest.mark.parametrize("filename", all_data_cases("preview"))


@@ -79,16 +43,27 @@ def test_preview_format(filename: str) -> None:
     check_file("preview", filename, black.Mode(preview=True))
 
 
     check_file("preview", filename, black.Mode(preview=True))
 
 

-@pytest.mark.parametrize("filename", all_data_cases("preview_39"))
-def test_preview_minimum_python_39_format(filename: str) -> None:
-    source, expected = read_data("preview_39", filename)
-    mode = 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))
 
 
     assert_format(source, expected, mode, minimum_version=(3, 9))
 
 

-@pytest.mark.parametrize("filename", SOURCES)
-def test_source_is_formatted(filename: str) -> None:
-    check_file("", filename, DEFAULT_MODE, data=False)
+@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))))

 
 
 # =============== #
 
 
 # =============== #


@@ -171,6 +146,7 @@ def test_python_2_hint() -> None:
     exc_info.match(black.parsing.PY2_HINT)
 
 
     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")
 def test_docstring_no_string_normalization() -> None:
     """Like test_docstring but with string normalization off."""
     source, expected = read_data("miscellaneous", "docstring_no_string_normalization")


@@ -178,6 +154,25 @@ def test_docstring_no_string_normalization() -> None:
     assert_format(source, expected, mode)
 
 
     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")
 def test_long_strings_flag_disabled() -> None:
     """Tests for turning off the string processing logic."""
     source, expected = read_data("miscellaneous", "long_strings_flag_disabled")


@@ -191,7 +186,20 @@ def test_stub() -> None:
     assert_format(source, expected, mode)
 
 
     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_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)