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
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
|
# pylint: skip-file
# type: ignore
#
# tests.test_format_code.py is part of the docformatter project
#
# Copyright (C) 2012-2023 Steven Myint
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Module for testing the Formattor._format_code() method."""
# Standard Library Imports
import contextlib
import sys
with contextlib.suppress(ImportError):
if sys.version_info >= (3, 11):
# Standard Library Imports
import tomllib
else:
# Third Party Imports
import tomli as tomllib
# Third Party Imports
import pytest
# docformatter Package Imports
from docformatter import Formatter
class TestFormatCode:
"""Class for testing _format_code() with no arguments."""
with open("tests/_data/string_files/format_code.toml", "rb") as f:
TEST_STRINGS = tomllib.load(f)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_should_ignore_non_docstring(self, test_args, args):
"""Should ignore triple quoted strings that are assigned values."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["non_docstring"]["instring"]
outstring = self.TEST_STRINGS["non_docstring"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_empty_string(self, test_args, args):
"""Should do nothing with an empty string."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
assert not uut._format_code("")
assert not uut._format_code("")
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_tabs(self, test_args, args):
"""Should retain tabbed indentation."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["tabbed_indentation"]["instring"]
outstring = self.TEST_STRINGS["tabbed_indentation"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_mixed_tabs(self, test_args, args):
"""Should retain mixed tabbed and spaced indentation."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["mixed_indentation"]["instring"]
outstring = self.TEST_STRINGS["mixed_indentation"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_escaped_newlines(self, test_args, args):
"""Should leave escaped newlines in code untouched."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["escaped_newlines"]["instring"]
outstring = self.TEST_STRINGS["escaped_newlines"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_comments(self, test_args, args):
"""Should leave comments as is."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["code_comments"]["instring"]
outstring = self.TEST_STRINGS["code_comments"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_escaped_newline_in_inline_comment(self, test_args, args):
"""Should leave code with inline comment as is."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["inline_comment"]["instring"]
outstring = self.TEST_STRINGS["inline_comment"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_raw_docstring_double_quotes(self, test_args, args):
"""Should format raw docstrings with triple double quotes.
See requirement PEP_257_2. See issue #54 for request to handle raw docstrings.
"""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["raw_lowercase"]["instring"]
outstring = self.TEST_STRINGS["raw_lowercase"]["outstring"]
assert outstring == uut._format_code(
instring,
)
instring = self.TEST_STRINGS["raw_uppercase"]["instring"]
outstring = self.TEST_STRINGS["raw_uppercase"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_raw_docstring_single_quotes(self, test_args, args):
"""Should format raw docstrings with triple single quotes.
See requirement PEP_257_2. See issue #54 for request to handle raw docstrings.
"""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["raw_lowercase_single"]["instring"]
outstring = self.TEST_STRINGS["raw_lowercase_single"]["outstring"]
assert outstring == uut._format_code(
instring,
)
instring = self.TEST_STRINGS["raw_uppercase_single"]["instring"]
outstring = self.TEST_STRINGS["raw_uppercase_single"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_unicode_docstring_double_quotes(self, test_args, args):
"""Should format unicode docstrings with triple double quotes.
See requirement PEP_257_3.
"""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["unicode_lowercase"]["instring"]
outstring = self.TEST_STRINGS["unicode_lowercase"]["outstring"]
assert outstring == uut._format_code(
instring,
)
instring = self.TEST_STRINGS["unicode_uppercase"]["instring"]
outstring = self.TEST_STRINGS["unicode_uppercase"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_unicode_docstring_single_quotes(self, test_args, args):
"""Should format unicode docstrings with triple single quotes.
See requirement PEP_257_3.
"""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["unicode_lowercase_single"]["instring"]
outstring = self.TEST_STRINGS["unicode_lowercase_single"]["outstring"]
assert outstring == uut._format_code(
instring,
)
instring = self.TEST_STRINGS["unicode_uppercase_single"]["instring"]
outstring = self.TEST_STRINGS["unicode_uppercase_single"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_skip_nested(self, test_args, args):
"""Should ignore nested triple quotes."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["nested_triple"]["instring"]
outstring = self.TEST_STRINGS["nested_triple"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_multiple_sentences(self, test_args, args):
"""Should create multi-line docstring from multiple sentences."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["multiple_sentences"]["instring"]
outstring = self.TEST_STRINGS["multiple_sentences"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_multiple_sentences_same_line(self, test_args, args):
"""Should create multi-line docstring from multiple sentences."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["multiple_sentences_same_line"]["instring"]
outstring = self.TEST_STRINGS["multiple_sentences_same_line"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_multiple_sentences_multi_line_summary(
self, test_args, args
):
"""Should put summary line on a single line."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["multiline_summary"]["instring"]
outstring = self.TEST_STRINGS["multiline_summary"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_empty_lines(self, test_args, args):
"""Summary line on one line when wrapped, followed by empty line."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["empty_lines"]["instring"]
outstring = self.TEST_STRINGS["empty_lines"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_empty_lines_class_docstring(self, test_args, args):
"""No blank lines before a class's docstring."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["class_empty_lines"]["instring"]
outstring = self.TEST_STRINGS["class_empty_lines"]["outstring"]
assert outstring == uut._format_code(
instring,
)
instring = self.TEST_STRINGS["class_empty_lines"]["instring_2"]
outstring = self.TEST_STRINGS["class_empty_lines"]["outstring_2"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_empty_lines_method_docstring(self, test_args, args):
"""No blank lines before a method's docstring."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["method_empty_lines"]["instring"]
outstring = self.TEST_STRINGS["method_empty_lines"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_trailing_whitespace(self, test_args, args):
"""Should strip trailing whitespace."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["trailing_whitespace"]["instring"]
outstring = self.TEST_STRINGS["trailing_whitespace"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_parameters_list(self, test_args, args):
"""Should treat parameters list as elaborate description."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["parameter_list"]["instring"]
outstring = self.TEST_STRINGS["parameter_list"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_ignore_code_with_single_quote(self, test_args, args):
"""Single single quote on first line of code should remain untouched.
See requirement PEP_257_1. See issue #66 for example of docformatter breaking
code when encountering single quote.
"""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["single_quote"]["instring"]
outstring = self.TEST_STRINGS["single_quote"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_ignore_code_with_double_quote(self, test_args, args):
"""Single double quotes on first line of code should remain untouched.
See requirement PEP_257_1. See issue #66 for example of docformatter breaking
code when encountering single quote.
"""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["double_quote"]["instring"]
outstring = self.TEST_STRINGS["double_quote"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_should_skip_nested_triple_quotes(self, test_args, args):
"""Should ignore triple quotes nested in a string."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["nested_triple_quote"]["instring"]
outstring = self.TEST_STRINGS["nested_triple_quote"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_assignment_on_first_line(self, test_args, args):
"""Should ignore triple quotes in variable assignment."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["first_line_assignment"]["instring"]
outstring = self.TEST_STRINGS["first_line_assignment"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_regular_strings_too(self, test_args, args):
"""Should ignore triple quoted strings after the docstring."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["regular_strings"]["instring"]
outstring = self.TEST_STRINGS["regular_strings"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_syntax_error(self, test_args, args):
"""Should ignore single set of triple quotes followed by newline."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["syntax_error"]["instring"]
outstring = self.TEST_STRINGS["syntax_error"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_syntax_error_case_slash_r(self, test_args, args):
"""Should ignore single set of triple quotes followed by return."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["slash_r"]["instring"]
outstring = self.TEST_STRINGS["slash_r"]["outstring"]
assert outstring == uut._format_code(
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_code_with_syntax_error_case_slash_r_slash_n(self, test_args, args):
"""Should ignore single triple quote followed by return, newline."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["slash_r_slash_n"]["instring"]
outstring = self.TEST_STRINGS["slash_r_slash_n"]["outstring"]
assert outstring == uut._format_code(
instring,
)
|
