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
|
"""Tests for the BaseFormatter object."""
import argparse
from unittest import mock
import pytest
from flake8 import style_guide
from flake8.formatting import base
def options(**kwargs):
"""Create an argparse.Namespace instance."""
kwargs.setdefault("output_file", None)
kwargs.setdefault("tee", False)
return argparse.Namespace(**kwargs)
@pytest.mark.parametrize("filename", [None, "out.txt"])
def test_start(filename):
"""Verify we open a new file in the start method."""
mock_open = mock.mock_open()
formatter = base.BaseFormatter(options(output_file=filename))
with mock.patch("flake8.formatting.base.open", mock_open):
formatter.start()
if filename is None:
assert mock_open.called is False
else:
mock_open.assert_called_once_with(filename, "a")
def test_stop():
"""Verify we close open file objects."""
filemock = mock.Mock()
formatter = base.BaseFormatter(options())
formatter.output_fd = filemock
formatter.stop()
filemock.close.assert_called_once_with()
assert formatter.output_fd is None
def test_format_needs_to_be_implemented():
"""Ensure BaseFormatter#format raises a NotImplementedError."""
formatter = base.BaseFormatter(options())
with pytest.raises(NotImplementedError):
formatter.format(
style_guide.Violation("A000", "file.py", 1, 1, "error text", None)
)
def test_show_source_returns_nothing_when_not_showing_source():
"""Ensure we return nothing when users want nothing."""
formatter = base.BaseFormatter(options(show_source=False))
assert (
formatter.show_source(
style_guide.Violation(
"A000", "file.py", 1, 1, "error text", "line"
)
)
== ""
)
def test_show_source_returns_nothing_when_there_is_source():
"""Ensure we return nothing when there is no line."""
formatter = base.BaseFormatter(options(show_source=True))
assert (
formatter.show_source(
style_guide.Violation("A000", "file.py", 1, 1, "error text", None)
)
== ""
)
@pytest.mark.parametrize(
("line1", "line2", "column"),
[
(
"x=1\n",
" ^",
2,
),
(
" x=(1\n +2)\n",
" ^",
5,
),
(
"\tx\t=\ty\n",
"\t \t \t^",
6,
),
],
)
def test_show_source_updates_physical_line_appropriately(line1, line2, column):
"""Ensure the error column is appropriately indicated."""
formatter = base.BaseFormatter(options(show_source=True))
error = style_guide.Violation("A000", "file.py", 1, column, "error", line1)
output = formatter.show_source(error)
assert output == line1 + line2
@pytest.mark.parametrize("tee", [False, True])
def test_write_uses_an_output_file(tee, capsys):
"""Verify that we use the output file when it's present."""
line = "Something to write"
source = "source"
filemock = mock.Mock()
formatter = base.BaseFormatter(options(tee=tee))
formatter.output_fd = filemock
formatter.write(line, source)
if tee:
assert capsys.readouterr().out == f"{line}\n{source}\n"
else:
assert capsys.readouterr().out == ""
assert filemock.write.called is True
assert filemock.write.call_count == 2
assert filemock.write.mock_calls == [
mock.call(line + formatter.newline),
mock.call(source + formatter.newline),
]
def test_write_uses_print(capsys):
"""Verify that we use the print function without an output file."""
line = "Something to write"
source = "source"
formatter = base.BaseFormatter(options())
formatter.write(line, source)
assert capsys.readouterr().out == f"{line}\n{source}\n"
class AfterInitFormatter(base.BaseFormatter):
"""Subclass for testing after_init."""
def after_init(self):
"""Define method to verify operation."""
self.post_initialized = True
def test_after_init_is_always_called():
"""Verify after_init is called."""
formatter = AfterInitFormatter(options())
assert formatter.post_initialized is True
class FormatFormatter(base.BaseFormatter):
"""Subclass for testing format."""
def format(self, error):
"""Define method to verify operation."""
return repr(error)
def test_handle_formats_the_error():
"""Verify that a formatter will call format from handle."""
formatter = FormatFormatter(options(show_source=False))
filemock = formatter.output_fd = mock.Mock()
error = style_guide.Violation(
code="A001",
filename="example.py",
line_number=1,
column_number=1,
text="Fake error",
physical_line="a = 1",
)
formatter.handle(error)
filemock.write.assert_called_once_with(repr(error) + "\n")
|
