-
Notifications
You must be signed in to change notification settings - Fork 914
/
format@docstring_code_examples.py.snap
15060 lines (11111 loc) · 290 KB
/
format@docstring_code_examples.py.snap
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
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
source: crates/ruff_python_formatter/tests/fixtures.rs
input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/docstring_code_examples.py
---
## Input
```python
###############################################################################
# DOCTEST CODE EXAMPLES
#
# This section shows examples of docstrings that contain code snippets in
# Python's "doctest" format.
#
# See: https://docs.python.org/3/library/doctest.html
###############################################################################
# The simplest doctest to ensure basic formatting works.
def doctest_simple():
"""
Do cool stuff.
>>> cool_stuff( 1 )
2
"""
pass
# Another simple test, but one where the Python code
# extends over multiple lines.
def doctest_simple_continued():
"""
Do cool stuff.
>>> def cool_stuff( x ):
... print( f"hi {x}" );
hi 2
"""
pass
# Test that we support multiple directly adjacent
# doctests.
def doctest_adjacent():
"""
Do cool stuff.
>>> cool_stuff( x )
>>> cool_stuff( y )
2
"""
pass
# Test that a doctest on the last non-whitespace line of a docstring
# reformats correctly.
def doctest_last_line():
"""
Do cool stuff.
>>> cool_stuff( x )
"""
pass
# Test that a doctest that continues to the last non-whitespace line of
# a docstring reformats correctly.
def doctest_last_line_continued():
"""
Do cool stuff.
>>> def cool_stuff( x ):
... print( f"hi {x}" );
"""
pass
# Test that a doctest on the real last line of a docstring reformats
# correctly.
def doctest_really_last_line():
"""
Do cool stuff.
>>> cool_stuff( x )"""
pass
# Test that a continued doctest on the real last line of a docstring reformats
# correctly.
def doctest_really_last_line_continued():
"""
Do cool stuff.
>>> cool_stuff( x )
... more( y )"""
pass
# Test that a doctest is correctly identified and formatted with a blank
# continuation line.
def doctest_blank_continued():
"""
Do cool stuff.
>>> def cool_stuff ( x ):
... print( x )
...
... print( x )
"""
pass
# Tests that a blank PS2 line at the end of a doctest can get dropped.
# It is treated as part of the Python snippet which will trim the
# trailing whitespace.
def doctest_blank_end():
"""
Do cool stuff.
>>> def cool_stuff ( x ):
... print( x )
... print( x )
...
"""
pass
# Tests that a blank PS2 line at the end of a doctest can get dropped
# even when there is text following it.
def doctest_blank_end_then_some_text():
"""
Do cool stuff.
>>> def cool_stuff ( x ):
... print( x )
... print( x )
...
And say something else.
"""
pass
# Test that a doctest containing a triple quoted string gets formatted
# correctly and doesn't result in invalid syntax.
def doctest_with_triple_single():
"""
Do cool stuff.
>>> x = '''tricksy'''
"""
pass
# Test that a doctest containing a triple quoted f-string gets
# formatted correctly and doesn't result in invalid syntax.
def doctest_with_triple_single():
"""
Do cool stuff.
>>> x = f'''tricksy'''
"""
pass
# Another nested multi-line string case, but with triple escaped double
# quotes inside a triple single quoted string.
def doctest_with_triple_escaped_double():
"""
Do cool stuff.
>>> x = '''\"\"\"'''
"""
pass
# Tests that inverting the triple quoting works as expected.
def doctest_with_triple_inverted():
'''
Do cool stuff.
>>> x = """tricksy"""
'''
pass
# Tests that inverting the triple quoting with an f-string works as
# expected.
def doctest_with_triple_inverted_fstring():
'''
Do cool stuff.
>>> x = f"""tricksy"""
'''
pass
# Tests nested doctests are ignored. That is, we don't format doctests
# recursively. We only recognize "top level" doctests.
#
# This restriction primarily exists to avoid needing to deal with
# nesting quotes. It also seems like a generally sensible restriction,
# although it could be lifted if necessary I believe.
def doctest_nested_doctest_not_formatted():
'''
Do cool stuff.
>>> def nested( x ):
... """
... Do nested cool stuff.
... >>> func_call( 5 )
... """
... pass
'''
pass
# Tests that the starting column does not matter.
def doctest_varying_start_column():
'''
Do cool stuff.
>>> assert ("Easy!")
>>> import math
>>> math.floor( 1.9 )
1
'''
pass
# Tests that long lines get wrapped... appropriately.
#
# The docstring code formatter uses the same line width settings as for
# formatting other code. This means that a line in the docstring can
# actually extend past the configured line limit.
#
# It's not quite clear whether this is desirable or not. We could in
# theory compute the intendation length of a code snippet and then
# adjust the line-width setting on a recursive call to the formatter.
# But there are assuredly pathological cases to consider. Another path
# would be to expose another formatter option for controlling the
# line-width of code snippets independently.
def doctest_long_lines():
'''
Do cool stuff.
This won't get wrapped even though it exceeds our configured
line width because it doesn't exceed the line width within this
docstring. e.g, the `f` in `foo` is treated as the first column.
>>> foo, bar, quux = this_is_a_long_line(lion, giraffe, hippo, zeba, lemur, penguin, monkey)
But this one is long enough to get wrapped.
>>> foo, bar, quux = this_is_a_long_line(lion, giraffe, hippo, zeba, lemur, penguin, monkey, spider, bear, leopard)
'''
# This demostrates a normal line that will get wrapped but won't
# get wrapped in the docstring above because of how the line-width
# setting gets reset at the first column in each code snippet.
foo, bar, quux = this_is_a_long_line(lion, giraffe, hippo, zeba, lemur, penguin, monkey)
# Checks that a simple but invalid doctest gets skipped.
def doctest_skipped_simple():
"""
Do cool stuff.
>>> cool-stuff( x ):
2
"""
pass
# Checks that a simple doctest that is continued over multiple lines,
# but is invalid, gets skipped.
def doctest_skipped_simple_continued():
"""
Do cool stuff.
>>> def cool-stuff( x ):
... print( f"hi {x}" );
2
"""
pass
# Checks that a doctest with improper indentation gets skipped.
def doctest_skipped_inconsistent_indent():
"""
Do cool stuff.
>>> def cool_stuff( x ):
... print( f"hi {x}" );
hi 2
"""
pass
# Checks that a doctest with some proper indentation and some improper
# indentation is "partially" formatted. That is, the part that appears
# before the inconsistent indentation is formatted. This requires that
# the part before it is valid Python.
def doctest_skipped_partial_inconsistent_indent():
"""
Do cool stuff.
>>> def cool_stuff( x ):
... print( x )
... print( f"hi {x}" );
hi 2
"""
pass
# Checks that a doctest with improper triple single quoted string gets
# skipped. That is, the code snippet is itself invalid Python, so it is
# left as is.
def doctest_skipped_triple_incorrect():
"""
Do cool stuff.
>>> foo( x )
... '''tri'''cksy'''
"""
pass
# Tests that a doctest on a single line is skipped.
def doctest_skipped_one_line():
">>> foo( x )"
pass
# f-strings are not considered docstrings[1], so any doctests
# inside of them should not be formatted.
#
# [1]: https://docs.python.org/3/reference/lexical_analysis.html#formatted-string-literals
def doctest_skipped_fstring():
f"""
Do cool stuff.
>>> cool_stuff( 1 )
2
"""
pass
# Test that a doctest containing a triple quoted string at least
# does not result in invalid Python code. Ideally this would format
# correctly, but at time of writing it does not.
def doctest_invalid_skipped_with_triple_double_in_single_quote_string():
"""
Do cool stuff.
>>> x = '\"\"\"'
"""
pass
###############################################################################
# reStructuredText CODE EXAMPLES
#
# This section shows examples of docstrings that contain code snippets in
# reStructuredText formatted code blocks.
#
# See: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks
# See: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block
# See: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#literal-blocks
# See: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#toc-entry-30
# See: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#toc-entry-38
###############################################################################
def rst_literal_simple():
"""
Do cool stuff::
cool_stuff( 1 )
Done.
"""
pass
def rst_literal_simple_continued():
"""
Do cool stuff::
def cool_stuff( x ):
print( f"hi {x}" );
Done.
"""
pass
# Tests that we can end the literal block on the second
# to last line of the docstring.
def rst_literal_second_to_last():
"""
Do cool stuff::
cool_stuff( 1 )
"""
pass
# Tests that we can end the literal block on the actual
# last line of the docstring.
def rst_literal_actually_last():
"""
Do cool stuff::
cool_stuff( 1 )"""
pass
def rst_literal_with_blank_lines():
"""
Do cool stuff::
def cool_stuff( x ):
print( f"hi {x}" );
def other_stuff( y ):
print( y )
Done.
"""
pass
# Extra blanks should be preserved.
def rst_literal_extra_blanks():
"""
Do cool stuff::
cool_stuff( 1 )
Done.
"""
pass
# If a literal block is never properly ended (via a non-empty unindented line),
# then the end of the block should be the last non-empty line. And subsequent
# empty lines should be preserved as-is.
def rst_literal_extra_blanks_at_end():
"""
Do cool stuff::
cool_stuff( 1 )
"""
pass
# A literal block can contain many empty lines and it should not end the block
# if it continues.
def rst_literal_extra_blanks_in_snippet():
"""
Do cool stuff::
cool_stuff( 1 )
cool_stuff( 2 )
Done.
"""
pass
# This tests that a unindented line appearing after an indented line (but where
# the indent is still beyond the minimum) gets formatted properly.
def rst_literal_subsequent_line_not_indented():
"""
Do cool stuff::
if True:
cool_stuff( '''
hiya''' )
Done.
"""
pass
# This checks that if the first line in a code snippet has been indented with
# tabs, then so long as its "indentation length" is considered bigger than the
# line with `::`, it is reformatted as code.
#
# (If your tabwidth is set to 4, then it looks like the code snippet
# isn't indented at all, which is perhaps counter-intuitive. Indeed, reST
# itself also seems to recognize this as a code block, although it appears
# under-specified.)
def rst_literal_first_line_indent_uses_tabs_4spaces():
"""
Do cool stuff::
cool_stuff( 1 )
Done.
"""
pass
# Like the test above, but with multiple lines.
def rst_literal_first_line_indent_uses_tabs_4spaces_multiple():
"""
Do cool stuff::
cool_stuff( 1 )
cool_stuff( 2 )
Done.
"""
pass
# Another test with tabs, except in this case, if your tabwidth is less than
# 8, than the code snippet actually looks like its indent is *less* than the
# opening line with a `::`. One might presume this means that the code snippet
# is not treated as a literal block and thus not reformatted, but since we
# assume all tabs have tabwidth=8 when computing indentation length, the code
# snippet is actually seen as being more indented than the opening `::` line.
# As with the above example, reST seems to behave the same way here.
def rst_literal_first_line_indent_uses_tabs_8spaces():
"""
Do cool stuff::
cool_stuff( 1 )
Done.
"""
pass
# Like the test above, but with multiple lines.
def rst_literal_first_line_indent_uses_tabs_8spaces_multiple():
"""
Do cool stuff::
cool_stuff( 1 )
cool_stuff( 2 )
Done.
"""
pass
# Tests that if two lines in a literal block are indented to the same level
# but by different means (tabs versus spaces), then we correctly recognize the
# block and format it.
def rst_literal_first_line_tab_second_line_spaces():
"""
Do cool stuff::
cool_stuff( 1 )
cool_stuff( 2 )
Done.
"""
pass
# Tests that when two lines in a code snippet have weird and inconsistent
# indentation, the code still gets formatted so long as the indent is greater
# than the indent of the `::` line.
#
# In this case, the minimum indent is 5 spaces (from the second line) where as
# the first line has an indent of 8 spaces via a tab (by assuming tabwidth=8).
# The minimum indent is stripped from each code line. Since tabs aren't
# divisible, the entire tab is stripped, which means the first and second lines
# wind up with the same level of indentation.
#
# An alternative behavior here would be that the tab is replaced with 3 spaces
# instead of being stripped entirely. The code snippet itself would then have
# inconsistent indentation to the point of being invalid Python, and thus code
# formatting would be skipped.
#
# I decided on the former behavior because it seems a bit easier to implement,
# but we might want to switch to the alternative if cases like this show up in
# the real world. ---AG
def rst_literal_odd_indentation():
"""
Do cool stuff::
cool_stuff( 1 )
cool_stuff( 2 )
Done.
"""
pass
# Tests that having a line with a lone `::` works as an introduction of a
# literal block.
def rst_literal_lone_colon():
"""
Do cool stuff.
::
cool_stuff( 1 )
Done.
"""
pass
def rst_directive_simple():
"""
.. code-block:: python
cool_stuff( 1 )
Done.
"""
pass
def rst_directive_case_insensitive():
"""
.. cOdE-bLoCk:: python
cool_stuff( 1 )
Done.
"""
pass
def rst_directive_sourcecode():
"""
.. sourcecode:: python
cool_stuff( 1 )
Done.
"""
pass
def rst_directive_options():
"""
.. code-block:: python
:linenos:
:emphasize-lines: 2,3
:name: blah blah
cool_stuff( 1 )
cool_stuff( 2 )
cool_stuff( 3 )
cool_stuff( 4 )
Done.
"""
pass
# In this case, since `pycon` isn't recognized as a Python code snippet, the
# docstring reformatter ignores it. But it then picks up the doctest and
# reformats it.
def rst_directive_doctest():
"""
.. code-block:: pycon
>>> cool_stuff( 1 )
Done.
"""
pass
# This checks that if the first non-empty line after the start of a literal
# block is not indented more than the line containing the `::`, then it is not
# treated as a code snippet.
def rst_literal_skipped_first_line_not_indented():
"""
Do cool stuff::
cool_stuff( 1 )
Done.
"""
pass
# Like the test above, but inserts an indented line after the un-indented one.
# This should not cause the literal block to be resumed.
def rst_literal_skipped_first_line_not_indented_then_indented():
"""
Do cool stuff::
cool_stuff( 1 )
cool_stuff( 2 )
Done.
"""
pass
# This also checks that a code snippet is not reformatted when the indentation
# of the first line is not more than the line with `::`, but this uses tabs to
# make it a little more confounding. It relies on the fact that indentation
# length is computed by assuming a tabwidth equal to 8. reST also rejects this
# and doesn't treat it as a literal block.
def rst_literal_skipped_first_line_not_indented_tab():
"""
Do cool stuff::
cool_stuff( 1 )
Done.
"""
pass
# Like the previous test, but adds a second line.
def rst_literal_skipped_first_line_not_indented_tab_multiple():
"""
Do cool stuff::
cool_stuff( 1 )
cool_stuff( 2 )
Done.
"""
pass
# Tests that a code block with a second line that is not properly indented gets
# skipped. A valid code block needs to have an empty line separating these.
#
# One trick here is that we need to make sure the Python code in the snippet is
# valid, otherwise it would be skipped because of invalid Python.
def rst_literal_skipped_subsequent_line_not_indented():
"""
Do cool stuff::
if True:
cool_stuff( '''
hiya''' )
Done.
"""
pass
# In this test, we write what looks like a code-block, but it should be treated
# as invalid due to the missing `language` argument.
#
# It does still look like it could be a literal block according to the literal
# rules, but we currently consider the `.. ` prefix to indicate that it is not
# a literal block.
def rst_literal_skipped_not_directive():
"""
.. code-block::
cool_stuff( 1 )
Done.
"""
pass
# In this test, we start a line with `.. `, which makes it look like it might
# be a directive. But instead continue it as if it was just some periods from
# the previous line, and then try to end it by starting a literal block.
#
# But because of the `.. ` in the beginning, we wind up not treating this as a
# code snippet. The reST render I was using to test things does actually treat
# this as a code block, so we may be out of conformance here.
def rst_literal_skipped_possible_false_negative():
"""
This is a test.
.. This is a test::
cool_stuff( 1 )
Done.
"""
pass
# This tests that a doctest inside of a reST literal block doesn't get
# reformatted. It's plausible this isn't the right behavior, but it also seems
# like it might be the right behavior since it is a literal block. (The doctest
# makes the Python code invalid.)
def rst_literal_skipped_doctest():
"""
Do cool stuff::
>>> cool_stuff( 1 )
Done.
"""
pass
def rst_literal_skipped_markdown():
"""
Do cool stuff::
```py
cool_stuff( 1 )
```
Done.
"""
pass
def rst_directive_skipped_not_indented():
"""
.. code-block:: python
cool_stuff( 1 )
Done.
"""
pass
def rst_directive_skipped_wrong_language():
"""
.. code-block:: rust
cool_stuff( 1 )
Done.
"""
pass
# This gets skipped for the same reason that the doctest in a literal block
# gets skipped.
def rst_directive_skipped_doctest():
"""
.. code-block:: python
>>> cool_stuff( 1 )
Done.
"""
pass
###############################################################################
# Markdown CODE EXAMPLES
#
# This section shows examples of docstrings that contain code snippets in
# Markdown fenced code blocks.
#
# See: https://spec.commonmark.org/0.30/#fenced-code-blocks
###############################################################################
def markdown_simple():
"""
Do cool stuff.
```py
cool_stuff( 1 )
```
Done.
"""
pass
def markdown_simple_continued():
"""
Do cool stuff.
```python
def cool_stuff( x ):
print( f"hi {x}" );
```
Done.
"""
pass
# Tests that unlabeled Markdown fenced code blocks are assumed to be Python.
def markdown_unlabeled():
"""
Do cool stuff.
```
cool_stuff( 1 )
```
Done.
"""
pass
# Tests that fenced code blocks using tildes work.
def markdown_tildes():
"""
Do cool stuff.
~~~py
cool_stuff( 1 )
~~~
Done.
"""
pass
# Tests that a longer closing fence is just fine and dandy.
def markdown_longer_closing_fence():
"""
Do cool stuff.
```py
cool_stuff( 1 )
``````
Done.
"""
pass
# Tests that an invalid closing fence is treated as invalid.
#
# We embed it into a docstring so that the surrounding Python
# remains valid.
def markdown_longer_closing_fence():
"""
Do cool stuff.
```py
cool_stuff( 1 )
'''
```invalid
'''
cool_stuff( 2 )
```
Done.
"""
pass
# Tests that one can nest fenced code blocks by using different numbers of
# backticks.
def markdown_nested_fences():
"""
Do cool stuff.
``````
do_something( '''
```
did i trick you?
```
''' )
``````
Done.
"""
pass
# Tests that an unclosed block gobbles up everything remaining in the
# docstring. When it's only empty lines, those are passed into the formatter
# and thus stripped.
def markdown_unclosed_empty_lines():
"""
Do cool stuff.
```py
cool_stuff( 1 )
"""
pass
# Tests that we can end the block on the second to last line of the
# docstring.
def markdown_second_to_last():
"""
Do cool stuff.
```py
cool_stuff( 1 )
```
"""
pass
# Tests that an unclosed block with one extra line at the end is treated