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
|
#!/usr/bin/python
import unittest
import os
import pyment.pyment as pym
import pyment.docstring as ds
current_dir = os.path.dirname(__file__)
absdir = lambda f: os.path.join(current_dir, f)
class IssuesTests(unittest.TestCase):
def testIssue9(self):
# Title: :rtype: is removed from doc comments; :return: loses indentation
issue9 = absdir('issue9.py')
p = pym.PyComment(issue9)
p._parse()
self.assertTrue(p.parsed)
res = p.diff(issue9, "{0}.patch".format(issue9))
self.assertTrue(res[8].strip() == "- :return: smthg")
self.assertTrue(res[9].strip() == "+ :returns: smthg")
self.assertTrue((res[10][1:].rstrip() == " :rtype: ret type")
and (res[10][0] == ' '))
def testIssue10(self):
# Title: created patch-file not correct
try:
f = open(absdir("issue10.py.patch.expected"))
expected = f.read()
f.close()
except Exception as e:
self.fail('Raised exception: "{0}"'.format(e))
p = pym.PyComment(absdir('issue10.py'))
p._parse()
self.assertTrue(p.parsed)
result = ''.join(p.diff())
self.assertTrue(result == expected)
def testIssue11(self):
# Title: doctests incorrectly formatted with reST option
deftxt = "def meaning(subject, answer=False):"
txt = '''"""
>>> meaning('life', answer=True)
42
"""'''
expected = ''' """
:param subject:
:param answer: (Default value = False)
>>> meaning('life', answer=True)
42
"""'''
d = ds.DocString(deftxt, quotes='"""')
d.parse_docs(txt)
self.assertTrue(d.get_raw_docs() == expected)
def testIssue15(self):
# Title: Does not convert existing docstrings
try:
f = open(absdir("issue15.py.patch.expected"))
expected = f.read()
f.close()
except Exception as e:
self.fail('Raised exception: "{0}"'.format(e))
p = pym.PyComment(absdir('issue15.py'))
p._parse()
self.assertTrue(p.parsed)
result = ''.join(p.diff())
self.assertTrue(result == expected)
def testIssue19(self):
# Title: :raises in reST is incorrectly parsed
txt = '''"""
:raises ValueError: on incorrect JSON
:raises requests.exceptions.HTTPError: on response error from server
"""'''
expected = ''' """
:raises ValueError: on incorrect JSON
:raises requests.exceptions.HTTPError: on response error from server
"""'''
docs = ds.DocString('def test():', quotes='"""')
docs.parse_docs(txt)
self.assertTrue(docs.get_raw_docs() == expected)
def testIssue22(self):
# Title: Class __init__() docstrings are not generated
expected = '''--- a/issue22.py
+++ b/issue22.py
@@ -2,4 +2,9 @@
"""Test class for issue 22"""
def __init__(self, param1):
+ """
+
+ :param param1:
+
+ """
pass
'''
p = pym.PyComment(absdir('issue22.py'))
p._parse()
self.assertTrue(p.parsed)
result = ''.join(p.diff())
self.assertTrue(result == expected)
def testIssue30(self):
# if file starting with a function/class definition, patching the file
# will remove the first line!
p = pym.PyComment(absdir('issue30.py'), input_style="numpydoc", output_style="numpydoc")
p._parse()
self.assertTrue(p.parsed)
try:
p.diff()
except Exception as e:
self.fail('Raised exception: "{0}"'.format(e))
def testIssue32(self):
# Title: def statement gets deleted
# if file starting with a function/class definition, patching the file
# will remove the first line!
expected = '''--- a/issue32.py
+++ b/issue32.py
@@ -1,2 +1,8 @@
def hello_world(a=22, b='hello'):
+ """
+
+ :param a: (Default value = 22)
+ :param b: (Default value = 'hello')
+
+ """
return 42'''
p = pym.PyComment(absdir('issue32.py'))
p._parse()
self.assertTrue(p.parsed)
result = ''.join(p.diff())
self.assertTrue(result == expected)
@unittest.expectedFailure
def testIssue34(self):
# Title: Problem with regenerating empty param docstring
# if two consecutive params have empty descriptions, the first will
# be filled with the full second param line
p = pym.PyComment(absdir('issue34.py'))
p._parse()
self.assertTrue(p.parsed)
result = ''.join(p.diff())
self.assertTrue(result == '')
@unittest.expectedFailure
def testIssue46(self):
# Title: list, tuple, dict default param values are not parsed correctly
# if a list/tuple/dict is given as default value for a parameter, the
# commas will be considered as separators for parameters
try:
f = open(absdir("issue46.py.patch.expected"))
expected = f.readlines()
if expected[0].startswith("# Patch"):
expected = expected[2:]
expected = "".join(expected)
f.close()
except Exception as e:
self.fail('Raised exception: "{0}"'.format(e))
p = pym.PyComment(absdir('issue46.py'))
p._parse()
self.assertTrue(p.parsed)
result = ''.join(p.diff())
self.assertTrue(result == expected)
@unittest.expectedFailure
def testIssue47(self):
# Title: Extra blank line for docstring with a muli-line description #47
# If a function has no argument and a multi-line description, Pyment will insert two blank lines
# between the description and the end of the docstring.
p = pym.PyComment(absdir('issue47.py'))
p._parse()
self.assertTrue(p.parsed)
result = ''.join(p.diff())
self.assertTrue(result == '')
def testIssue49(self):
# Title: If already numpydoc format, will remove the Raises section
# If the last section in a numpydoc docstring is a `Raises` section,
# it will be removed if the output format is also set to numpydoc
p = pym.PyComment(absdir('issue49.py'), output_style='numpydoc')
p._parse()
self.assertTrue(p.parsed)
result = ''.join(p.diff())
print(result)
self.assertTrue(result == '')
def testIssue51(self):
# Title: Raise block convertion
p = pym.PyComment(absdir('issue51.py'), output_style='google')
p._parse()
self.assertTrue(p.parsed)
result = ''.join(p.diff())
self.assertTrue(result == '')
def testIssue58(self):
# Title: Comments after def statement not supported
# If a function's def statement is followed by a comment it won't be proceeded.
p = pym.PyComment(absdir('issue58.py'))
expected = '''--- a/issue58.py
+++ b/issue58.py
@@ -1,5 +1,9 @@
def func(param): # some comment
- """some docstring"""
+ """some docstring
+
+ :param param:
+
+ """
pass
'''
p._parse()
self.assertTrue(p.parsed)
result = ''.join(p.diff())
self.assertTrue(result == expected)
def testIssue88(self):
# Title: Not working on async functions
# The async functions are not managed
p = pym.PyComment(absdir('issue88.py'))
p._parse()
f = open(absdir('issue88.py.patch'))
patch = f.read()
f.close()
self.assertEqual(''.join(p.diff()), patch)
def testIssue90(self):
# Title: __doc__ is not well parsed
# If the line after function signature contains triple [double] quotes but is not a docstring
# it will be however considered as if it was and will have side effect.
p = pym.PyComment(absdir('issue90.py'))
p._parse()
f = open(absdir('issue90.py.patch'))
patch = f.read()
f.close()
self.assertEqual(''.join(p.diff()), patch)
def main():
unittest.main()
if __name__ == '__main__':
main()
|
