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
|
# pylint: skip-file
# type: ignore
#
# tests.test_format_lists.py is part of the docformatter project
#
# Copyright (C) 2012-2023 Steven Myint
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Module for testing the Formatter class."""
# Standard Library Imports
import contextlib
import sys
with contextlib.suppress(ImportError):
if sys.version_info >= (3, 11):
# Standard Library Imports
import tomllib
else:
# Third Party Imports
import tomli as tomllib
# Third Party Imports
import pytest
# docformatter Package Imports
from docformatter import Formatter
INDENTATION = " "
class TestFormatLists:
"""Class for testing format_docstring() with lists in the docstring."""
with open("tests/_data/string_files/format_lists.toml", "rb") as f:
TEST_STRINGS = tomllib.load(f)
@pytest.mark.unit
@pytest.mark.parametrize("args", [["--wrap-descriptions", "72", ""]])
def test_format_docstring_should_ignore_numbered_lists(self, test_args, args):
"""Ignore lists beginning with numbers."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["numbered"]["instring"]
outstring = self.TEST_STRINGS["numbered"]["outstring"]
assert outstring == uut._do_format_docstring(
INDENTATION,
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [["--wrap-descriptions", "72", ""]])
def test_format_docstring_should_ignore_parameter_lists(self, test_args, args):
"""Ignore lists beginning with <word> -."""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["parameter"]["dash"]["instring"]
outstring = self.TEST_STRINGS["parameter"]["dash"]["outstring"]
assert outstring == uut._do_format_docstring(
INDENTATION,
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize(
"args", [["--wrap-descriptions", "72", "--style", "numpy", ""]]
)
def test_format_docstring_should_ignore_colon_parameter_lists(
self, test_args, args
):
"""Ignore lists beginning with <word>:"""
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["parameter"]["colon"]["instring"]
outstring = self.TEST_STRINGS["parameter"]["colon"]["outstring"]
assert outstring == uut._do_format_docstring(
INDENTATION,
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_docstring_should_leave_list_alone(self, test_args, args):
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["many"]["short"]["columns"]["instring"]
outstring = self.TEST_STRINGS["many"]["short"]["columns"]["outstring"]
assert outstring == uut._do_format_docstring(
INDENTATION,
instring,
)
@pytest.mark.unit
@pytest.mark.parametrize("args", [[""]])
def test_format_docstring_should_leave_list_alone_with_rest(self, test_args, args):
uut = Formatter(
test_args,
sys.stderr,
sys.stdin,
sys.stdout,
)
instring = self.TEST_STRINGS["issue_239"]["instring"]
outstring = self.TEST_STRINGS["issue_239"]["outstring"]
assert outstring == uut._do_format_docstring(
INDENTATION,
instring,
)
|
