File: do_format_code.toml

package info (click to toggle)
python-docformatter 1.7.7-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,156 kB
  • sloc: python: 6,180; makefile: 28; sh: 7
file content (315 lines) | stat: -rw-r--r-- 5,698 bytes parent folder | download
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
[one_line]
instring='''def foo():
    """
    Hello foo.
    """'''
outstring='''def foo():
    """Hello foo."""'''

[module_docstring]
instring='''#!/usr/env/bin python
"""This is
a module
docstring.

1. One
2. Two
"""

"""But
this
is
not."""'''
outstring='''#!/usr/env/bin python
"""This is a module docstring.

1. One
2. Two
"""

"""But
this
is
not."""'''

[newline_module_variable]
instring='''
    CONST = 123

    """docstring for CONST."""
'''
outstring='''
    CONST = 123
    """docstring for CONST."""
'''

[class_docstring]
instring='''
    class TestClass:
        """This is a class docstring.
        :cvar test_int: a class attribute.
        ..py.method: big_method()
        """
'''
outstring='''
    class TestClass:
        """This is a class docstring.

        :cvar test_int: a class attribute.
        ..py.method: big_method()
        """
'''

[newline_class_variable]
instring='''
    class TestClass:

        """This is a class docstring."""

        test_var = 0

        """This is a class variable docstring."""

        test_var2 = 1


        """This is a second class variable docstring."""
'''
outstring='''
    class TestClass:
        """This is a class docstring."""

        test_var = 0
        """This is a class variable docstring."""

        test_var2 = 1
        """This is a second class variable docstring."""
'''

[newline_outside_docstring]
instring='''
def new_function():
    """Description of function."""
    found = next(
        (index for index, line in enumerate(split) if line.strip()), 0
    )

    return "\n".join(split[found:])
'''
outstring='''
def new_function():
    """Description of function."""
    found = next(
        (index for index, line in enumerate(split) if line.strip()), 0
    )

    return "\n".join(split[found:])
'''

[preserve_line_ending]
instring='''
def foo():\r
    """\r
    Hello\r
    foo. This is a docstring.\r
    """\r
'''
outstring='''def foo():\r
    """\r
    Hello\r
    foo. This is a docstring.\r
    """\r
'''

[issue_51]
instring='''def my_func():

"""Summary of my function."""
pass'''
outstring='''def my_func():
"""Summary of my function."""
pass'''

[issue_51_2]
instring='''
def crash_rocket(location):    # pragma: no cover
    """This is a docstring following an in-line comment."""
    return location'''
outstring='''
def crash_rocket(location):    # pragma: no cover
    """This is a docstring following an in-line comment."""
    return location'''

[issue_97]
instring='''def pytest_addoption(parser: pytest.Parser) -> "
            None:
    register_toggle.pytest_addoption(parser)
'''
outstring='''def pytest_addoption(parser: pytest.Parser) -> "
            None:
    register_toggle.pytest_addoption(parser)
'''

[issue_97_2]
instring='''def pytest_addoption(parser: pytest.Parser) ->
            None:    # pragma: no cover

            register_toggle.pytest_addoption(parser)
'''
outstring='''def pytest_addoption(parser: pytest.Parser) ->
            None:    # pragma: no cover

            register_toggle.pytest_addoption(parser)
'''

[issue_130]
instring='''
class TestClass:

    """This is a class docstring."""

    def test_method(self):

        """This is a method docstring.

        With a long description followed by two blank lines.
        """


        pass
'''
outstring='''
class TestClass:
    """This is a class docstring."""

    def test_method(self):
        """This is a method docstring.

        With a long description followed by two blank lines.
        """
        pass
'''

[issue_139]
instring='''
class TestClass:

    """This is a class docstring.
    :cvar test_int: a class attribute.
    ..py.method: big_method()
    """
'''
outstring='''
class TestClass:
    """This is a class docstring.

    :cvar test_int: a class attribute.
    ..py.method: big_method()
    """
'''

[issue_139_2]
instring="""
class TestClass:

    variable = 1
"""
outstring="""
class TestClass:

    variable = 1
"""

[issue_156]
instring='''
def test_wps3_process_step_io_data_or_href():
    """Validates that \'data\' literal values and \'href\' file references are both
    handled as input for workflow steps corresponding to a WPS-3 process."""

    def mock_wps_request(method, url, *_, **kwargs):
        nonlocal test_reached_parse_inputs

        method = method.upper()
'''
outstring='''
def test_wps3_process_step_io_data_or_href():
    """Validates that \'data\' literal values and \'href\' file references are
    both handled as input for workflow steps corresponding to a WPS-3
    process."""

    def mock_wps_request(method, url, *_, **kwargs):
        nonlocal test_reached_parse_inputs

        method = method.upper()
'''

[issue_156_173]
instring='''
class Foo:

    @abstractmethod
    def bar(self):

        """This is a description."""

    @abstractmethod
    def baz(self):

        """This is a second description."""

'''
outstring='''
class Foo:

    @abstractmethod
    def bar(self):
        """This is a description."""

    @abstractmethod
    def baz(self):
        """This is a second description."""

'''

[issue_187]
instring='''
#!/usr/bin/env python

"""a.py"""
'''
outstring='''
#!/usr/bin/env python

"""a.py."""
'''

[issue_203]
instring='''
#!/usr/bin/env python

import os
from typing import Iterator

"""Don't remove this comment, it's cool."""
IMPORTANT_CONSTANT = "potato"
'''
outstring='''
#!/usr/bin/env python

import os
from typing import Iterator

"""Don't remove this comment, it's cool."""
IMPORTANT_CONSTANT = "potato"
'''

[issue_243]
instring='''def foo(bar):
    """Return `foo` using `bar`. Description."""
'''
outstring='''def foo(bar):
    """Return `foo` using `bar`.

    Description.
    """
'''