forked from psf/black
/
test_format.py
212 lines (153 loc) · 7.57 KB
/
test_format.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
import re
from dataclasses import replace
from typing import Any, Iterator
from unittest.mock import patch
import pytest
import black
from tests.util import (
DEFAULT_MODE,
PY36_VERSIONS,
all_data_cases,
assert_format,
dump_to_stderr,
read_data,
)
@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("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("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)