GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — black/tests/test_blackd.py at main · psf/black

Expand file tree

/

test_blackd.py

Copy path
More file actions
More file actions

Latest commit

 

History

History
History
553 lines (469 loc) · 21.2 KB
/

test_blackd.py

Copy path

File metadata and controls

553 lines (469 loc) · 21.2 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
import asyncio
import gc
import re
from concurrent.futures import ThreadPoolExecutor
from datetime import datetime, timezone
from threading import Event
from unittest.mock import patch
import pytest
from click.testing import CliRunner
from tests.util import DETERMINISTIC_HEADER, read_data
try:
from aiohttp import web
from aiohttp.test_utils import AioHTTPTestCase
import blackd
import blackd.client
except ImportError as e:
raise RuntimeError("Please install Black with the 'd' extra") from e
import black
@pytest.mark.blackd
class BlackDTestCase(AioHTTPTestCase):
def tearDown(self) -> None:
# Work around https://github.com/python/cpython/issues/124706
gc.collect()
super().tearDown()
def test_blackd_main(self) -> None:
with patch("blackd.web.run_app"):
result = CliRunner().invoke(blackd.main, [])
if result.exception is not None:
raise result.exception
self.assertEqual(result.exit_code, 0)
async def get_application(self) -> web.Application:
return blackd.make_app()
async def test_blackd_request_needs_formatting(self) -> None:
response = await self.client.post("/", data=b"print('hello world')")
self.assertEqual(response.status, 200)
self.assertEqual(response.charset, "utf8")
self.assertEqual(await response.read(), b'print("hello world")\n')
async def test_blackd_request_no_change(self) -> None:
response = await self.client.post("/", data=b'print("hello world")\n')
self.assertEqual(response.status, 204)
self.assertEqual(await response.read(), b"")
async def test_blackd_request_syntax_error(self) -> None:
response = await self.client.post("/", data=b"what even ( is")
self.assertEqual(response.status, 400)
content = await response.text()
self.assertTrue(
content.startswith("cannot parse"),
msg=f"Expected error to start with 'cannot parse', got {repr(content)}",
)
async def test_blackd_request_invalid_encoding(self) -> None:
response = await self.client.post("/", data=b"name = '\xff'")
self.assertEqual(response.status, 400)
self.assertIn("decode", await response.text())
self.assertEqual(
response.headers.get(blackd.BLACK_VERSION_HEADER), black.__version__
)
async def test_blackd_request_unknown_charset(self) -> None:
response = await self.client.post(
"/",
data=b"x=1",
headers={"Content-Type": "text/plain; charset=unknown-charset"},
)
self.assertEqual(response.status, 400)
self.assertIn("unknown encoding", await response.text())
async def test_blackd_request_undecodable_charset(self) -> None:
response = await self.client.post(
"/",
data=b"x=1",
headers={"Content-Type": "text/plain; charset=undefined"},
)
self.assertEqual(response.status, 400)
self.assertIn("undefined", await response.text())
async def test_blackd_request_non_utf8_charset(self) -> None:
response = await self.client.post(
"/",
data=b"name = '\xe9'",
headers={"Content-Type": "text/plain; charset=iso-8859-1"},
)
self.assertEqual(response.status, 200)
self.assertEqual(await response.read(), b'name = "\xe9"\n')
async def test_blackd_unsupported_version(self) -> None:
response = await self.client.post(
"/", data=b"what", headers={blackd.PROTOCOL_VERSION_HEADER: "2"}
)
self.assertEqual(response.status, 501)
async def test_blackd_supported_version(self) -> None:
response = await self.client.post(
"/", data=b"what", headers={blackd.PROTOCOL_VERSION_HEADER: "1"}
)
self.assertEqual(response.status, 200)
async def test_blackd_invalid_python_variant(self) -> None:
async def check(header_value: str, expected_status: int = 400) -> None:
response = await self.client.post(
"/",
data=b"what",
headers={blackd.PYTHON_VARIANT_HEADER: header_value},
)
self.assertEqual(response.status, expected_status)
await check("lol")
await check("ruby3.5")
await check("pyi3.6")
await check("py1.5")
await check("2")
await check("2.7")
await check("py2.7")
await check("2.8")
await check("py2.8")
await check("3.0")
await check("pypy3.0")
await check("jython3.4")
await check("")
await check(" ")
await check("py")
await check("3.6,")
await check("3.6, ,3.7")
await check("py3.6,,py3.7")
async def test_blackd_pyi(self) -> None:
source, expected = read_data("cases", "stub.py")
response = await self.client.post(
"/", data=source, headers={blackd.PYTHON_VARIANT_HEADER: "pyi"}
)
self.assertEqual(response.status, 200)
self.assertEqual(await response.text(), expected)
response = await self.client.post(
"/", data=source, headers={blackd.PYTHON_VARIANT_HEADER: " pyi "}
)
self.assertEqual(response.status, 200)
self.assertEqual(await response.text(), expected)
async def test_blackd_diff(self) -> None:
diff_header = re.compile(
r"(In|Out)\t\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d\.\d\d\d\d\d\d\+\d\d:\d\d"
)
source, _ = read_data("miscellaneous", "blackd_diff")
expected, _ = read_data("miscellaneous", "blackd_diff.diff")
response = await self.client.post(
"/", data=source, headers={blackd.DIFF_HEADER: "true"}
)
self.assertEqual(response.status, 200)
actual = await response.text()
actual = diff_header.sub(DETERMINISTIC_HEADER, actual)
self.assertEqual(actual, expected)
async def test_blackd_python_variant(self) -> None:
code = (
"def f(\n"
" and_has_a_bunch_of,\n"
" very_long_arguments_too,\n"
" and_lots_of_them_as_well_lol,\n"
" **and_very_long_keyword_arguments\n"
"):\n"
" pass\n"
)
async def check(header_value: str, expected_status: int) -> None:
response = await self.client.post(
"/", data=code, headers={blackd.PYTHON_VARIANT_HEADER: header_value}
)
self.assertEqual(
response.status, expected_status, msg=await response.text()
)
await check("3.6", 200)
await check("py3.6", 200)
await check("3.6,3.7", 200)
await check("3.6, 3.7", 200)
await check("3.6,py3.7", 200)
await check("3.6, py3.7", 200)
await check("py3.6, py3.7", 200)
await check(" py3.6 , py3.7 ", 200)
await check("py36,py37", 200)
await check("py36, py37", 200)
await check("36", 200)
await check("3.6.4", 200)
await check("3.4", 204)
await check("py3.4", 204)
await check("py34,py36", 204)
await check("py34, py36", 204)
await check("34", 204)
async def test_blackd_line_length(self) -> None:
response = await self.client.post(
"/", data=b'print("hello")\n', headers={blackd.LINE_LENGTH_HEADER: "7"}
)
self.assertEqual(response.status, 200)
async def test_blackd_invalid_line_length(self) -> None:
response = await self.client.post(
"/",
data=b'print("hello")\n',
headers={blackd.LINE_LENGTH_HEADER: "NaN"},
)
self.assertEqual(response.status, 400)
async def test_blackd_skip_first_source_line(self) -> None:
invalid_first_line = b"Header will be skipped\r\ni = [1,2,3]\nj = [1,2,3]\n"
expected_result = b"Header will be skipped\r\ni = [1, 2, 3]\nj = [1, 2, 3]\n"
response = await self.client.post("/", data=invalid_first_line)
self.assertEqual(response.status, 400)
response = await self.client.post(
"/",
data=invalid_first_line,
headers={blackd.SKIP_SOURCE_FIRST_LINE: "true"},
)
self.assertEqual(response.status, 200)
self.assertEqual(await response.read(), expected_result)
async def test_blackd_skip_first_source_line_with_diff(self) -> None:
source = b"#!/usr/bin/env python\ni = [1,2,3]\n"
response = await self.client.post(
"/",
data=source,
headers={
blackd.SKIP_SOURCE_FIRST_LINE: "true",
blackd.DIFF_HEADER: "true",
},
)
self.assertEqual(response.status, 200)
diff_header = re.compile(
r"(In|Out)\t\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d\.\d\d\d\d\d\d\+\d\d:\d\d"
)
actual = diff_header.sub(DETERMINISTIC_HEADER, await response.text())
# The skipped line must stay inside the patch as context, so that the body is
# a diff of the whole source rather than a raw source line in front of it.
self.assertEqual(
actual,
"--- [Deterministic header]\n"
"+++ [Deterministic header]\n"
"@@ -1,2 +1,2 @@\n"
" #!/usr/bin/env python\n"
"-i = [1,2,3]\n"
"+i = [1, 2, 3]\n",
)
async def test_blackd_preview(self) -> None:
response = await self.client.post(
"/", data=b'print("hello")\n', headers={blackd.PREVIEW: "true"}
)
self.assertEqual(response.status, 204)
async def test_blackd_response_black_version_header(self) -> None:
response = await self.client.post("/")
self.assertIsNotNone(response.headers.get(blackd.BLACK_VERSION_HEADER))
async def test_cors_preflight(self) -> None:
response = await self.client.options(
"/",
headers={
"Access-Control-Request-Method": "POST",
"Origin": "https://example.com",
"Access-Control-Request-Headers": "Content-Type",
},
)
self.assertEqual(response.status, 403)
self.assertIsNone(response.headers.get("Access-Control-Allow-Origin"))
self.assertIsNone(response.headers.get("Access-Control-Allow-Headers"))
self.assertIsNone(response.headers.get("Access-Control-Allow-Methods"))
async def test_cors_requests_rejected_by_default(self) -> None:
response = await self.client.post(
"/", headers={"Origin": "https://example.com"}
)
self.assertEqual(response.status, 403)
self.assertIsNone(response.headers.get("Access-Control-Allow-Origin"))
self.assertIsNone(response.headers.get("Access-Control-Expose-Headers"))
async def test_blackd_format_code_limits_executor_queue(self) -> None:
started = Event()
release = Event()
calls: list[str] = []
executor = ThreadPoolExecutor(max_workers=2)
executor_semaphore = asyncio.BoundedSemaphore(1)
def slow_format(src: str, *, fast: bool, mode: black.Mode) -> str:
calls.append(src)
started.set()
release.wait(timeout=1)
return src
try:
with patch("blackd.black.format_file_contents", side_effect=slow_format):
task1 = asyncio.create_task(
blackd.format_code(
req_str="print(1)\n",
fast=False,
mode=black.Mode(),
then=datetime.now(timezone.utc),
only_diff=False,
executor=executor,
executor_semaphore=executor_semaphore,
)
)
for _ in range(20):
if started.is_set():
break
await asyncio.sleep(0.01)
self.assertTrue(started.is_set())
task2 = asyncio.create_task(
blackd.format_code(
req_str="print(2)\n",
fast=False,
mode=black.Mode(),
then=datetime.now(timezone.utc),
only_diff=False,
executor=executor,
executor_semaphore=executor_semaphore,
)
)
await asyncio.sleep(0.05)
self.assertEqual(len(calls), 1)
release.set()
self.assertEqual(await task1, "print(1)\n")
self.assertEqual(await task2, "print(2)\n")
self.assertEqual(len(calls), 2)
finally:
executor.shutdown(wait=True)
async def test_preserves_line_endings(self) -> None:
for data in (b"c\r\nc\r\n", b"l\nl\n"):
# test preserved newlines when reformatted
response = await self.client.post("/", data=data + b" ")
self.assertEqual(await response.text(), data.decode())
# test 204 when no change
response = await self.client.post("/", data=data)
self.assertEqual(response.status, 204)
async def test_normalizes_line_endings(self) -> None:
for data, expected in ((b"c\r\nc\n", "c\r\nc\r\n"), (b"l\nl\r\n", "l\nl\n")):
response = await self.client.post("/", data=data)
self.assertEqual(await response.text(), expected)
self.assertEqual(response.status, 200)
async def test_single_character(self) -> None:
response = await self.client.post("/", data="1")
self.assertEqual(await response.text(), "1\n")
self.assertEqual(response.status, 200)
@pytest.mark.blackd
class BlackDConfiguredCorsTestCase(AioHTTPTestCase):
def tearDown(self) -> None:
gc.collect()
super().tearDown()
async def get_application(self) -> web.Application:
return blackd.make_app(cors_allow_origins=("https://example.com",))
async def test_cors_preflight(self) -> None:
response = await self.client.options(
"/",
headers={
"Access-Control-Request-Method": "POST",
"Origin": "https://example.com",
"Access-Control-Request-Headers": "Content-Type",
},
)
self.assertEqual(response.status, 200)
self.assertEqual(
response.headers.get("Access-Control-Allow-Origin"),
"https://example.com",
)
self.assertIsNotNone(response.headers.get("Access-Control-Allow-Headers"))
self.assertIsNotNone(response.headers.get("Access-Control-Allow-Methods"))
async def test_cors_headers_present(self) -> None:
response = await self.client.post(
"/", headers={"Origin": "https://example.com"}
)
self.assertEqual(
response.headers.get("Access-Control-Allow-Origin"),
"https://example.com",
)
self.assertIn(
blackd.BLACK_VERSION_HEADER,
response.headers.get("Access-Control-Expose-Headers", ""),
)
@pytest.mark.blackd
class BlackDSmallBodyLimitTestCase(AioHTTPTestCase):
def tearDown(self) -> None:
gc.collect()
super().tearDown()
async def get_application(self) -> web.Application:
return blackd.make_app(max_body_size=16)
async def test_blackd_rejects_large_request_body(self) -> None:
response = await self.client.post("/", data=b"x" * 17)
self.assertEqual(response.status, 413)
@pytest.mark.blackd
class BlackDClientTestCase(AioHTTPTestCase):
def tearDown(self) -> None:
# Work around https://github.com/python/cpython/issues/124706
gc.collect()
super().tearDown()
async def get_application(self) -> web.Application:
return blackd.make_app()
async def test_unformatted_code(self) -> None:
client = blackd.client.BlackDClient(self.client.make_url("/"))
unformatted_code = "def hello(): print('Hello, World!')"
expected = 'def hello():\n print("Hello, World!")\n'
formatted_code = await client.format_code(unformatted_code)
self.assertEqual(formatted_code, expected)
async def test_formatted_code(self) -> None:
client = blackd.client.BlackDClient(self.client.make_url("/"))
initial_code = 'def hello():\n print("Hello, World!")\n'
expected = 'def hello():\n print("Hello, World!")\n'
formatted_code = await client.format_code(initial_code)
self.assertEqual(formatted_code, expected)
async def test_line_length(self) -> None:
client = blackd.client.BlackDClient(self.client.make_url("/"), line_length=10)
unformatted_code = "def hello(): print('Hello, World!')"
expected = 'def hello():\n print(\n "Hello, World!"\n )\n'
formatted_code = await client.format_code(unformatted_code)
self.assertEqual(formatted_code, expected)
async def test_custom_content_type_charset(self) -> None:
for header_name in ("Content-Type", "content-type", "CoNtEnT-TyPe"):
for content_type in (
"text/plain",
"text/plain; charset=utf-8",
"text/plain; charset=iso-8859-1",
"text/plain; charset=windows-1252",
"text/plain; charset=utf-16",
):
for source in ("message='café'", 'message = "café"\n'):
with self.subTest(
header_name=header_name,
content_type=content_type,
source=source,
):
client = blackd.client.BlackDClient(
self.client.make_url("/"),
headers={header_name: content_type},
)
formatted_code = await client.format_code(source)
self.assertEqual(formatted_code, 'message = "café"\n')
async def test_skip_source_first_line(self) -> None:
client = blackd.client.BlackDClient(
self.client.make_url("/"), skip_source_first_line=True
)
invalid_first_line = "Header will be skipped\r\ni = [1,2,3]\nj = [1,2,3]\n"
expected_result = "Header will be skipped\r\ni = [1, 2, 3]\nj = [1, 2, 3]\n"
formatted_code = await client.format_code(invalid_first_line)
self.assertEqual(formatted_code, expected_result)
async def test_skip_string_normalization(self) -> None:
client = blackd.client.BlackDClient(
self.client.make_url("/"), skip_string_normalization=True
)
unformatted_code = "def hello(): print('Hello, World!')"
expected = "def hello():\n print('Hello, World!')\n"
formatted_code = await client.format_code(unformatted_code)
self.assertEqual(formatted_code, expected)
async def test_skip_magic_trailing_comma(self) -> None:
client = blackd.client.BlackDClient(
self.client.make_url("/"), skip_magic_trailing_comma=True
)
unformatted_code = "def hello(): print('Hello, World!')"
expected = 'def hello():\n print("Hello, World!")\n'
formatted_code = await client.format_code(unformatted_code)
self.assertEqual(formatted_code, expected)
async def test_preview(self) -> None:
client = blackd.client.BlackDClient(self.client.make_url("/"), preview=True)
unformatted_code = "def hello(): print('Hello, World!')"
expected = 'def hello():\n print("Hello, World!")\n'
formatted_code = await client.format_code(unformatted_code)
self.assertEqual(formatted_code, expected)
async def test_fast(self) -> None:
client = blackd.client.BlackDClient(self.client.make_url("/"), fast=True)
unformatted_code = "def hello(): print('Hello, World!')"
expected = 'def hello():\n print("Hello, World!")\n'
formatted_code = await client.format_code(unformatted_code)
self.assertEqual(formatted_code, expected)
async def test_python_variant(self) -> None:
client = blackd.client.BlackDClient(
self.client.make_url("/"), python_variant="3.6"
)
unformatted_code = "def hello(): print('Hello, World!')"
expected = 'def hello():\n print("Hello, World!")\n'
formatted_code = await client.format_code(unformatted_code)
self.assertEqual(formatted_code, expected)
async def test_diff(self) -> None:
diff_header = re.compile(
r"(In|Out)\t\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d\.\d\d\d\d\d\d\+\d\d:\d\d"
)
client = blackd.client.BlackDClient(self.client.make_url("/"), diff=True)
source, _ = read_data("miscellaneous", "blackd_diff")
expected, _ = read_data("miscellaneous", "blackd_diff.diff")
diff = await client.format_code(source)
diff = diff_header.sub(DETERMINISTIC_HEADER, diff)
self.assertEqual(diff, expected)
async def test_syntax_error(self) -> None:
client = blackd.client.BlackDClient(self.client.make_url("/"))
with_syntax_error = "def hello(): a 'Hello, World!'"
with self.assertRaises(black.InvalidInput):
_ = await client.format_code(with_syntax_error)
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.