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
|
# Copyright (c) Meta Platforms, Inc. and affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.
from textwrap import dedent
from typing import Optional
import libcst as cst
from libcst.helpers import ensure_type
from libcst.testing.utils import data_provider, UnitTest
class DocstringTest(UnitTest):
@data_provider(
(
("", None),
('""', ""),
("# comment is not docstring", None),
(
'''
# comment
"""docstring in triple quotes."""
''',
"docstring in triple quotes.",
),
(
'''"docstring in single quotes."''',
"docstring in single quotes.",
),
(
'''
# comment
"""docstring in """ "concatenated strings."
''',
"docstring in concatenated strings.",
),
)
)
def test_module_docstring(self, code: str, docstring: Optional[str]) -> None:
self.assertEqual(cst.parse_module(dedent(code)).get_docstring(), docstring)
@data_provider(
(
(
"""
def f(): # comment"
pass
""",
None,
),
('def f():"docstring"', "docstring"),
(
'''
def f():
"""
This function has no input
and always returns None.
"""
''',
"This function has no input\nand always returns None.",
),
(
"""
def fn(): # comment 1
# comment 2
"docstring"
""",
"docstring",
),
(
"""
def fn():
("docstring")
""",
"docstring",
),
)
)
def test_function_docstring(self, code: str, docstring: Optional[str]) -> None:
self.assertEqual(
ensure_type(
cst.parse_statement(dedent(code)), cst.FunctionDef
).get_docstring(),
docstring,
)
@data_provider(
(
(
"""
class C: # comment"
pass
""",
None,
),
('class C(Base):"docstring"', "docstring"),
(
'''
class C(Base):
# a comment
"""
This class has a multi-
line docstring.
"""
''',
"This class has a multi-\nline docstring.",
),
(
"""
class C(A, B): # comment 1
# comment 2
"docstring"
""",
"docstring",
),
)
)
def test_class_docstring(self, code: str, docstring: Optional[str]) -> None:
self.assertEqual(
ensure_type(
cst.parse_statement(dedent(code)), cst.ClassDef
).get_docstring(),
docstring,
)
def test_clean_docstring(self) -> None:
code = '''
""" A docstring with indentation one first line
and the second line.
"""
'''
self.assertEqual(
cst.parse_module(dedent(code)).get_docstring(),
"A docstring with indentation one first line\nand the second line.",
)
self.assertEqual(
cst.parse_module(dedent(code)).get_docstring(clean=False),
" A docstring with indentation one first line\n and the second line.\n",
)
|
