-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_old_style.py
443 lines (339 loc) · 11.9 KB
/
test_old_style.py
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
# -*- coding: utf-8 -*-
from refactordoc.styles.old_style import refactor_class, refactor_function
from refactordoc.tests._compat import unittest
class TestOldStyleClass(unittest.TestCase):
def setUp(self):
self.maxDiff = None
def test_refactor_attributes(self):
docstring =\
"""Base abstract docstring refactoring class.
The class' main purpose is to parse the dosctring and find the
sections that need to be refactored. It also provides a number of
methods to help with the refactoring. Subclasses should provide
the methods responsible for refactoring the sections.
Attributes
----------
docstring : list
A list of strings (lines) that holds docstrings
index : int
The current zero-based line number of the docstring that is
proccessed.
"""
rst = \
"""Base abstract docstring refactoring class.
The class' main purpose is to parse the dosctring and find the
sections that need to be refactored. It also provides a number of
methods to help with the refactoring. Subclasses should provide
the methods responsible for refactoring the sections.
.. attribute:: docstring
:annotation: = list
A list of strings (lines) that holds docstrings
.. attribute:: index
:annotation: = int
The current zero-based line number of the docstring that is
proccessed.
"""
docstring_lines = docstring.splitlines()
class_doc = refactor_class(docstring_lines)
class_doc.parse()
output = '\n'.join(docstring_lines)
self.assertMultiLineEqual(rst, output)
def test_refactor_methods(self):
docstring = \
""" This is a sample class docstring
Methods
-------
extract_fields(indent='', field_check=None)
Extract the fields from the docstring
get_field()
Get the field description.
get_next_paragraph()
Get the next paragraph designated by an empty line.
"""
rst = \
""" This is a sample class docstring
==================================================================== ===================================================
Method Description
==================================================================== ===================================================
:meth:`extract_fields(indent='', field_check=None) <extract_fields>` Extract the fields from the docstring
:meth:`get_field() <get_field>` Get the field description.
:meth:`get_next_paragraph() <get_next_paragraph>` Get the next paragraph designated by an empty line.
==================================================================== ===================================================
"""
docstring_lines = docstring.splitlines()
class_doc = refactor_class(docstring_lines)
class_doc.parse()
output = '\n'.join(docstring_lines)
self.assertMultiLineEqual(rst, output)
def test_refactor_notes(self):
docstring1 =\
""" This is a sample class docstring
Notes
-----
This is the test.
Wait we have not finished.
This is not a note.
"""
docstring2 =\
""" This is a sample class docstring
Notes
-----
This is the test.
Wait we have not finished.
This is not a note.
"""
rst = \
""" This is a sample class docstring
.. note::
This is the test.
Wait we have not finished.
This is not a note.
"""
docstring_lines = docstring1.splitlines()
class_doc = refactor_class(docstring_lines)
class_doc.parse()
output = '\n'.join(docstring_lines) + '\n'
self.assertMultiLineEqual(rst, output)
docstring_lines = docstring2.splitlines()
class_doc = refactor_class(docstring_lines)
class_doc.parse()
output = '\n'.join(docstring_lines) + '\n'
self.assertMultiLineEqual(rst, output)
class TestOldStyleFunction(unittest.TestCase):
def setUp(self):
self.maxDiff = None
def test_refactor_returns(self):
docstring = \
""" This is a sample function docstring.
Returns
-------
myvalue : list
A list of important values.
But we need to say more things about it.
"""
rst = \
""" This is a sample function docstring.
:returns:
**myvalue** (*list*) --
A list of important values.
But we need to say more things about it.
"""
docstring_lines = docstring.splitlines()
function_doc = refactor_function(docstring_lines)
function_doc.parse()
output = '\n'.join(docstring_lines)
self.assertMultiLineEqual(rst, output)
def test_refactor_raises(self):
docstring = \
""" This is a sample function docstring.
Raises
------
TypeError :
This is the first paragraph of the description.
More description.
ValueError :
Description of another case where errors are raised.
"""
rst = \
""" This is a sample function docstring.
:raises:
- **TypeError** --
This is the first paragraph of the description.
More description.
- **ValueError** --
Description of another case where errors are raised.
"""
docstring_lines = docstring.splitlines()
function_doc = refactor_function(docstring_lines)
function_doc.parse()
output = '\n'.join(docstring_lines)
self.assertMultiLineEqual(rst, output)
def test_refactor_arguments(self):
docstring =\
""" This is a sample function docstring
Arguments
---------
inputa : str
The first argument holds the first input!.
This is the second paragraph.
inputb : float
The second argument is a float.
the default value is 0.
.. note:: this is an optional value.
"""
rst = \
""" This is a sample function docstring
:param inputa:
The first argument holds the first input!.
This is the second paragraph.
:type inputa: str
:param inputb:
The second argument is a float.
the default value is 0.
.. note:: this is an optional value.
:type inputb: float
"""
docstring_lines = docstring.splitlines()
function_doc = refactor_function(docstring_lines)
function_doc.parse()
output = '\n'.join(docstring_lines) + '\n'
self.assertMultiLineEqual(rst, output)
def test_refactor_strange_arguments(self):
docstring = \
""" This is a sample function docstring
Parameters
----------
*args :
Positional arguments with which this constructor was called
from the enaml source code.
**kwards :
Keyword arguments with which this constructor was called
from the enaml source code.
from_ :
Arguments with trailing underscore.
"""
rst = \
""" This is a sample function docstring
:param \*args:
Positional arguments with which this constructor was called
from the enaml source code.
:param \*\*kwards:
Keyword arguments with which this constructor was called
from the enaml source code.
:param from\_:
Arguments with trailing underscore.
"""
docstring_lines = docstring.splitlines()
function_doc = refactor_function(docstring_lines)
function_doc.parse()
output = '\n'.join(docstring_lines) + '\n'
self.assertMultiLineEqual(rst, output)
def test_refactor_notes(self):
docstring = \
""" This is a sample function docstring.
Notes
-----
This is the test.
Wait we have not finished.
This should not be included.
"""
rst = \
""" This is a sample function docstring.
.. note::
This is the test.
Wait we have not finished.
This should not be included.
"""
docstring_lines = docstring.splitlines()
function_doc = refactor_function(docstring_lines)
function_doc.parse()
output = '\n'.join(docstring_lines) + '\n'
self.assertMultiLineEqual(rst, output)
def test_docstring_cases_1(self):
docstring1 = \
""" Sets the selection to the bounds of start and end.
If the indices are invalid, no selection will be made,
and any current selection will be cleared.
Arguments
---------
start : Int
The start selection index, zero based.
end : Int
The end selection index, zero based.
Returns
-------
result : None
"""
docstring2 = \
""" Sets the selection to the bounds of start and end.
If the indices are invalid, no selection will be made,
and any current selection will be cleared.
Arguments
---------
start : Int
The start selection index, zero based.
end : Int
The end selection index, zero based.
Returns
-------
result : None
"""
rst = \
""" Sets the selection to the bounds of start and end.
If the indices are invalid, no selection will be made,
and any current selection will be cleared.
:param start:
The start selection index, zero based.
:type start: Int
:param end:
The end selection index, zero based.
:type end: Int
:returns:
**result** (*None*)
"""
docstring_lines = docstring1.splitlines()
function_doc = refactor_function(docstring_lines)
function_doc.parse()
output = '\n'.join(docstring_lines)
self.assertMultiLineEqual(rst, output)
docstring_lines = docstring2.splitlines()
function_doc = refactor_function(docstring_lines)
function_doc.parse()
output = '\n'.join(docstring_lines)
self.assertMultiLineEqual(rst, output)
def test_docstring_cases_2(self):
docstring = \
""" Verify that the requested attribute is properly set
The method compares the attribute value in the Enaml object and
check if it is synchronized with the toolkit widget. The component
attribute is retrieved directly while the widget value is retrieved
through a call to a method function in the test case.
Arguments
---------
component : enaml.widgets.component.Component
The Enaml component to check.
attribute_name : str
The string name of the Enaml attribute to check.
value :
The expected value.
.. note:: It is expected that the user has defined an appropriate
method get_<attribute_name>(widget) or the extentded version
get_<attribute_name>(component, widget) in the current test
case. The extended signature is commonly used because additional
information on the component's attributes is required to return
a sensible result (e.g. the component uses Converters to set
and retrieve the value of the attribute). The assert method
The get methods can raise assertion errors when it is not
possible to retrieve a sensible value for the attribute.
"""
rst = \
""" Verify that the requested attribute is properly set
The method compares the attribute value in the Enaml object and
check if it is synchronized with the toolkit widget. The component
attribute is retrieved directly while the widget value is retrieved
through a call to a method function in the test case.
:param component:
The Enaml component to check.
:type component: enaml.widgets.component.Component
:param attribute_name:
The string name of the Enaml attribute to check.
:type attribute_name: str
:param value:
The expected value.
.. note:: It is expected that the user has defined an appropriate
method get_<attribute_name>(widget) or the extentded version
get_<attribute_name>(component, widget) in the current test
case. The extended signature is commonly used because additional
information on the component's attributes is required to return
a sensible result (e.g. the component uses Converters to set
and retrieve the value of the attribute). The assert method
The get methods can raise assertion errors when it is not
possible to retrieve a sensible value for the attribute.
"""
docstring_lines = docstring.splitlines()
function_doc = refactor_function(docstring_lines)
function_doc.parse()
output = '\n'.join(docstring_lines) + '\n'
self.assertMultiLineEqual(rst, output)
if __name__ == '__main__':
unittest.main()