-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathpython-insert-docstring-tests.el
270 lines (232 loc) · 13 KB
/
python-insert-docstring-tests.el
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
;;; python-insert-docstring-tests.el --- Tests for the Python Google docstring inserter -*- lexical-binding: t; -*-
;; Copyright (c) 2021 Marco Vocialta
;; Author: Marco Vocialta <[email protected]>
;; Package-Requires: ((emacs "24.1"))
;; URL: https://github.com/macurovc/insert-docstring
;; Version: 1.1
;; This file is not part of GNU Emacs.
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; This file contains tests for the functions in python-insert-docstring.el that
;; don't require user inputs and don't modify a buffer.
;;; Code:
(defconst python-insert-docstring--fill-column 79)
(ert-deftest python-python-function-name-test ()
"Match the name of a simple function."
(let ((string "def something()"))
(should (equal (string-match python-insert-docstring-function-name-regex string) 0))
(should (equal (match-string 1 string) "something"))))
(ert-deftest python-function-name-with-indent-test ()
"Match the name of a function with some indentation."
(let ((string "\n \t def something ("))
(should (equal (string-match python-insert-docstring-function-name-regex string) 6))
(should (equal (match-string 1 string) "something"))))
(ert-deftest python-function-name-with-underscores-test ()
"Match the name of a function with underscores."
(let ((string "\n \t def _something_else ("))
(should (equal (string-match python-insert-docstring-function-name-regex string) 6))
(should (equal (match-string 1 string) "_something_else"))))
(ert-deftest python-end-of-function-test ()
"Match the end of a function definition."
(should (equal (string-match python-insert-docstring-function-end-regex "):") 0))
(should (equal (string-match python-insert-docstring-function-end-regex ") -> None : ") 0)))
(ert-deftest python-end-of-function-with-newline-test ()
"Match the end of a function definition with a None return type and newlines."
(let ((string ") \n ->\n \n\nNone:\n"))
(should (equal (string-match python-insert-docstring-function-end-regex string) 0))))
(ert-deftest python-end-of-function-with-type-test ()
"Match the end of a function definition with an elaborate return type."
(let ((string " ) \n ->\n \n\nMap[int, int]:\n"))
(should (equal (string-match python-insert-docstring-function-end-regex string) 2))))
(ert-deftest python-argument-string-regex-test ()
"Match the arguments string."
(let ((string "def toto_blabla(hey1):"))
(should (equal (string-match python-insert-docstring-function-arguments-regex string) 15))
(should (equal (match-string 1 string) "hey1"))))
(ert-deftest python-argument-string-regex-test ()
"Match the arguments string."
(let ((string "\ndef\n\ntoto( bubu : List[str] , lala ) -> \n\nNone : "))
(should (equal (string-match python-insert-docstring-function-arguments-regex string) 10))
(should (equal (match-string 1 string) " bubu : List[str] , lala "))))
(ert-deftest python-argument-string-regex-with-newlines-test ()
"Match the arguments string."
(let ((string "\ndef\n\ntoto( bubu : List[str] ,\n lala ) -> \n\nNone : "))
(should (equal (string-match python-insert-docstring-function-arguments-regex string) 10))
(should (equal (match-string 1 string) " bubu : List[str] ,\n lala "))))
(ert-deftest python-function-indentation-test ()
"Match the arguments string."
(let ((string "\ndef\n\ntoto() -> \n\nNone : "))
(should (equal (string-match python-insert-docstring-function-indentation-regex string) 1))
(should (equal (match-string 1 string) ""))))
(ert-deftest python-function-indentation-with-tabs-and-spaces-test ()
"Match the arguments string."
(let ((string "\n \t def\n\ntoto() -> \n\nNone : "))
(should (equal (string-match python-insert-docstring-function-indentation-regex string) 1))
(should (equal (match-string 1 string) " \t "))))
(ert-deftest python-parse-argument-list-test ()
"Test the arguments list parser function."
(progn
(should (equal (python-insert-docstring--get-arguments-names-from-string "") nil))
(should (equal (python-insert-docstring--get-arguments-names-from-string
"one") '("one")))
(should (equal (python-insert-docstring--get-arguments-names-from-string
" first, second, third ") '("first" "second" "third")))
(should (equal (python-insert-docstring--get-arguments-names-from-string
" first: Type, second: Map[some, other], third : Dict[str, List[str]] ")
'("first" "second" "third")))
(should (equal (python-insert-docstring--get-arguments-names-from-string
" first: Type\n,\n second:\n Map[some, other]") '("first" "second")))
(should (equal (python-insert-docstring--get-arguments-names-from-string
" first: Type = 1,\n second: Map[some, other] = 2") '("first" "second")))
(should (equal (python-insert-docstring--get-arguments-names-from-string
" first = 1,\n second = 2") '("first" "second")))
(should (equal (python-insert-docstring--get-arguments-names-from-string
" cls ,\n second = 2") '("second")))
(should (equal (python-insert-docstring--get-arguments-names-from-string
" self ,\n second = 2") '("second")))))
(ert-deftest prefix-lines-test ()
"Test the function to prefix lines with blanks."
(should (equal (python-insert-docstring--prefix-lines '("some" "lines") " ") '(" some" " lines")))
(should (equal (python-insert-docstring--prefix-lines '("some" "") " ") '(" some" ""))))
(ert-deftest python-google-docstring-arguments-test ()
"Test the generation of the argument list in the docstring."
(should (equal (python-insert-docstring--google-docstring-arguments () "") nil))
(let ((arguments (list (make-python-insert-docstring--argument-data :name "one" :description "this one")
(make-python-insert-docstring--argument-data :name "two" :description "this two"))))
(should (equal (python-insert-docstring--google-docstring-arguments arguments "pre")
'("" "preArgs:" "pre one: this one" "pre two: this two")))))
(ert-deftest python-google-docstring-returns-test ()
"Test the generation of the return statement in the docstring."
(should (equal (python-insert-docstring--google-docstring-returns nil "") nil))
(should (equal (python-insert-docstring--google-docstring-returns "something" "")
'("" "Returns:" " something")))
(should (equal (python-insert-docstring--google-docstring-returns "something" " ")
'("" " Returns:" " something"))))
(ert-deftest python-google-docstring-title-only ()
"Test the generation of the entire docstring."
(should (equal
(python-insert-docstring--google-docstring
(make-python-insert-docstring--function-data
:indentation-string ""
:short-description "title"
:long-description nil
:arguments nil
:return nil))
'(" \"\"\"title"
" \"\"\""))))
(ert-deftest python-google-docstring-title-and-return ()
"Test the generation of the entire docstring."
(should (equal
(python-insert-docstring--google-docstring
(make-python-insert-docstring--function-data
:indentation-string ""
:short-description "title"
:long-description nil
:arguments nil
:return "something"))
'(" \"\"\"title"
""
" Returns:"
" something"
" \"\"\""))))
(ert-deftest python-google-docstring-title-args-and-return ()
"Test the generation of the entire docstring."
(should (equal
(python-insert-docstring--google-docstring
(make-python-insert-docstring--function-data
:indentation-string ""
:short-description "title"
:long-description nil
:arguments (list (make-python-insert-docstring--argument-data :name "one" :description "this one")
(make-python-insert-docstring--argument-data :name "two" :description "this two"))
:return "something"))
'(" \"\"\"title"
""
" Args:"
" one: this one"
" two: this two"
""
" Returns:"
" something"
" \"\"\""))))
(ert-deftest python-google-docstring-title-and-args ()
"Test the generation of the entire docstring."
(should (equal
(python-insert-docstring--google-docstring
(make-python-insert-docstring--function-data
:indentation-string ""
:short-description "title"
:long-description nil
:arguments (list (make-python-insert-docstring--argument-data :name "one" :description "this one")
(make-python-insert-docstring--argument-data :name "two" :description "this two"))
:return nil))
'(" \"\"\"title"
""
" Args:"
" one: this one"
" two: this two"
" \"\"\""))))
(ert-deftest python-google-docstring-all-fields ()
"Test the generation of the entire docstring."
(should (equal
(python-insert-docstring--google-docstring
(make-python-insert-docstring--function-data
:indentation-string " "
:short-description "this is a very very very very very very very very very very very very long title"
:long-description "this is a very very very very very very very very very very very very long description"
:arguments (list (make-python-insert-docstring--argument-data
:name "one"
:description "this one is very very very very very very very very very very long")
(make-python-insert-docstring--argument-data :name "two" :description "this two"))
:return "what a very very very very very very very very very very very very long return"))
'(" \"\"\"this is a very very very very very very very very very very very"
" very long title"
""
" this is a very very very very very very very very very very very very"
" long description"
""
" Args:"
" one: this one is very very very very very very very very very very"
" long"
" two: this two"
""
" Returns:"
" what a very very very very very very very very very very very very"
" long return"
" \"\"\""))))
(ert-deftest indentation-length ()
"Test the computation of the indentation length."
(should (equal (python-insert-docstring--indentation-length "") 0))
(should (equal (python-insert-docstring--indentation-length " ") 1))
(should (equal (python-insert-docstring--indentation-length " ") 3))
(should (equal (python-insert-docstring--indentation-length " \t " 2) 5))
(should (equal (python-insert-docstring--indentation-length " \t \t " 3) 11)))
(ert-deftest append-words-to-paragraph ()
"Test the function to append words to a paragraph."
(should (equal (python-insert-docstring--append-words-to-paragraph () 5 '("one" "two" "three"))
'("one" "two" "three")))
(should (equal (python-insert-docstring--append-words-to-paragraph () 7 '("one" "two" "three"))
'("one two" "three")))
(should (equal (python-insert-docstring--append-words-to-paragraph () 13 '("one" "two" "three"))
'("one two three")))
(should (equal (python-insert-docstring--append-words-to-paragraph '("one") 7 '("two" "three"))
'("one two" "three")))
(should (equal (python-insert-docstring--append-words-to-paragraph '("one") 7 '("two" "three") " ")
'("one two" " three")))
(should (equal (python-insert-docstring--append-words-to-paragraph () 7 '("two" "three") " ")
'("two" " three"))))
(ert-deftest line-to-indented-paragraph ()
"Test splitting a line into a paragraph."
(should (equal (python-insert-docstring--line-to-indented-paragraph "this is a line" " " " " 9)
'(" this is" " a line"))))
;; End:
;;; python-insert-docstring-tests.el ends here