All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
1 from dataclasses import replace
2 from typing import Any, Iterator, List
3 from unittest.mock import patch
8 from tests.util import (
17 SIMPLE_CASES: List[str] = [
18 "attribute_access_on_number_literals",
19 "beginning_backslash",
21 "class_blank_parentheses",
22 "class_methods_new_line",
30 "comments_non_breaking_space",
31 "comment_after_escaped_newline",
33 "composition_no_trailing_comma",
50 "function_trailing_comma",
57 "trailing_comma_optional_parens1",
58 "trailing_comma_optional_parens2",
59 "trailing_comma_optional_parens3",
60 "tricky_unicode_symbols",
64 PY310_CASES: List[str] = [
66 "pattern_matching_simple",
67 "pattern_matching_complex",
68 "pattern_matching_extras",
69 "pattern_matching_style",
70 "pattern_matching_generic",
71 "parenthesized_context_managers",
74 PREVIEW_CASES: List[str] = [
80 "long_strings__edge_case",
81 "long_strings__regression",
83 "remove_for_brackets",
84 "one_element_subscript",
87 SOURCES: List[str] = [
88 "src/black/__init__.py",
89 "src/black/__main__.py",
90 "src/black/brackets.py",
92 "src/black/comments.py",
93 "src/black/concurrency.py",
97 "src/black/linegen.py",
100 "src/black/nodes.py",
101 "src/black/numerics.py",
102 "src/black/output.py",
103 "src/black/parsing.py",
104 "src/black/report.py",
105 "src/black/rusty.py",
106 "src/black/strings.py",
107 "src/black/trans.py",
108 "src/blackd/__init__.py",
109 "src/blib2to3/pygram.py",
110 "src/blib2to3/pytree.py",
111 "src/blib2to3/pgen2/conv.py",
112 "src/blib2to3/pgen2/driver.py",
113 "src/blib2to3/pgen2/grammar.py",
114 "src/blib2to3/pgen2/literals.py",
115 "src/blib2to3/pgen2/parse.py",
116 "src/blib2to3/pgen2/pgen.py",
117 "src/blib2to3/pgen2/tokenize.py",
118 "src/blib2to3/pgen2/token.py",
120 "tests/test_black.py",
121 "tests/test_blackd.py",
122 "tests/test_format.py",
129 @pytest.fixture(autouse=True)
130 def patch_dump_to_file(request: Any) -> Iterator[None]:
131 with patch("black.dump_to_file", dump_to_stderr):
135 def check_file(filename: str, mode: black.Mode, *, data: bool = True) -> None:
136 source, expected = read_data(filename, data=data)
137 assert_format(source, expected, mode, fast=False)
140 @pytest.mark.parametrize("filename", SIMPLE_CASES)
141 def test_simple_format(filename: str) -> None:
142 check_file(filename, DEFAULT_MODE)
145 @pytest.mark.parametrize("filename", PREVIEW_CASES)
146 def test_preview_format(filename: str) -> None:
147 check_file(filename, black.Mode(preview=True))
150 @pytest.mark.parametrize("filename", SOURCES)
151 def test_source_is_formatted(filename: str) -> None:
152 path = THIS_DIR.parent / filename
153 check_file(str(path), DEFAULT_MODE, data=False)
161 def test_empty() -> None:
162 source = expected = ""
163 assert_format(source, expected)
166 def test_pep_572() -> None:
167 source, expected = read_data("pep_572")
168 assert_format(source, expected, minimum_version=(3, 8))
171 def test_pep_572_remove_parens() -> None:
172 source, expected = read_data("pep_572_remove_parens")
173 assert_format(source, expected, minimum_version=(3, 8))
176 def test_pep_572_do_not_remove_parens() -> None:
177 source, expected = read_data("pep_572_do_not_remove_parens")
178 # the AST safety checks will fail, but that's expected, just make sure no
179 # parentheses are touched
180 assert_format(source, expected, fast=True)
183 @pytest.mark.parametrize("major, minor", [(3, 9), (3, 10)])
184 def test_pep_572_newer_syntax(major: int, minor: int) -> None:
185 source, expected = read_data(f"pep_572_py{major}{minor}")
186 assert_format(source, expected, minimum_version=(major, minor))
189 def test_pep_570() -> None:
190 source, expected = read_data("pep_570")
191 assert_format(source, expected, minimum_version=(3, 8))
194 @pytest.mark.parametrize("filename", PY310_CASES)
195 def test_python_310(filename: str) -> None:
196 source, expected = read_data(filename)
197 mode = black.Mode(target_versions={black.TargetVersion.PY310})
198 assert_format(source, expected, mode, minimum_version=(3, 10))
201 def test_python_310_without_target_version() -> None:
202 source, expected = read_data("pattern_matching_simple")
204 assert_format(source, expected, mode, minimum_version=(3, 10))
207 def test_patma_invalid() -> None:
208 source, expected = read_data("pattern_matching_invalid")
209 mode = black.Mode(target_versions={black.TargetVersion.PY310})
210 with pytest.raises(black.parsing.InvalidInput) as exc_info:
211 assert_format(source, expected, mode, minimum_version=(3, 10))
213 exc_info.match("Cannot parse: 10:11")
216 def test_python_2_hint() -> None:
217 with pytest.raises(black.parsing.InvalidInput) as exc_info:
218 assert_format("print 'daylily'", "print 'daylily'")
219 exc_info.match(black.parsing.PY2_HINT)
222 def test_docstring_no_string_normalization() -> None:
223 """Like test_docstring but with string normalization off."""
224 source, expected = read_data("docstring_no_string_normalization")
225 mode = replace(DEFAULT_MODE, string_normalization=False)
226 assert_format(source, expected, mode)
229 def test_long_strings_flag_disabled() -> None:
230 """Tests for turning off the string processing logic."""
231 source, expected = read_data("long_strings_flag_disabled")
232 mode = replace(DEFAULT_MODE, experimental_string_processing=False)
233 assert_format(source, expected, mode)
236 def test_numeric_literals() -> None:
237 source, expected = read_data("numeric_literals")
238 mode = replace(DEFAULT_MODE, target_versions=PY36_VERSIONS)
239 assert_format(source, expected, mode)
242 def test_numeric_literals_ignoring_underscores() -> None:
243 source, expected = read_data("numeric_literals_skip_underscores")
244 mode = replace(DEFAULT_MODE, target_versions=PY36_VERSIONS)
245 assert_format(source, expected, mode)
248 def test_stub() -> None:
249 mode = replace(DEFAULT_MODE, is_pyi=True)
250 source, expected = read_data("stub.pyi")
251 assert_format(source, expected, mode)
254 def test_python38() -> None:
255 source, expected = read_data("python38")
256 assert_format(source, expected, minimum_version=(3, 8))
259 def test_python39() -> None:
260 source, expected = read_data("python39")
261 assert_format(source, expected, minimum_version=(3, 9))
264 def test_power_op_newline() -> None:
265 # requires line_length=0
266 source, expected = read_data("power_op_newline")
267 assert_format(source, expected, mode=black.Mode(line_length=0))