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
|
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
from __future__ import annotations
import collections
import sys
import warnings
from collections import defaultdict
from collections.abc import Iterator
from typing import TYPE_CHECKING, Dict
from astroid import nodes
from pylint.constants import (
INCOMPATIBLE_WITH_USELESS_SUPPRESSION,
MSG_STATE_SCOPE_MODULE,
WarningScope,
)
if sys.version_info >= (3, 8):
from typing import Literal
else:
from typing_extensions import Literal
if TYPE_CHECKING:
from pylint.message import MessageDefinition, MessageDefinitionStore
MessageStateDict = Dict[str, Dict[int, bool]]
class FileState:
"""Hold internal state specific to the currently analyzed file."""
def __init__(
self,
modname: str | None = None,
msg_store: MessageDefinitionStore | None = None,
node: nodes.Module | None = None,
*,
is_base_filestate: bool = False,
) -> None:
if modname is None:
warnings.warn(
"FileState needs a string as modname argument. "
"This argument will be required in pylint 3.0",
DeprecationWarning,
stacklevel=2,
)
if msg_store is None:
warnings.warn(
"FileState needs a 'MessageDefinitionStore' as msg_store argument. "
"This argument will be required in pylint 3.0",
DeprecationWarning,
stacklevel=2,
)
self.base_name = modname
self._module_msgs_state: MessageStateDict = {}
self._raw_module_msgs_state: MessageStateDict = {}
self._ignored_msgs: defaultdict[
tuple[str, int], set[int]
] = collections.defaultdict(set)
self._suppression_mapping: dict[tuple[str, int], int] = {}
self._module = node
if node:
self._effective_max_line_number = node.tolineno
else:
self._effective_max_line_number = None
self._msgs_store = msg_store
self._is_base_filestate = is_base_filestate
"""If this FileState is the base state made during initialization of
PyLinter.
"""
def collect_block_lines(
self, msgs_store: MessageDefinitionStore, module_node: nodes.Module
) -> None:
"""Walk the AST to collect block level options line numbers."""
warnings.warn(
"'collect_block_lines' has been deprecated and will be removed in pylint 3.0.",
DeprecationWarning,
stacklevel=2,
)
for msg, lines in self._module_msgs_state.items():
self._raw_module_msgs_state[msg] = lines.copy()
orig_state = self._module_msgs_state.copy()
self._module_msgs_state = {}
self._suppression_mapping = {}
self._effective_max_line_number = module_node.tolineno
for msgid, lines in orig_state.items():
for msgdef in msgs_store.get_message_definitions(msgid):
self._set_state_on_block_lines(msgs_store, module_node, msgdef, lines)
def _set_state_on_block_lines(
self,
msgs_store: MessageDefinitionStore,
node: nodes.NodeNG,
msg: MessageDefinition,
msg_state: dict[int, bool],
) -> None:
"""Recursively walk (depth first) AST to collect block level options
line numbers and set the state correctly.
"""
for child in node.get_children():
self._set_state_on_block_lines(msgs_store, child, msg, msg_state)
# first child line number used to distinguish between disable
# which are the first child of scoped node with those defined later.
# For instance in the code below:
#
# 1. def meth8(self):
# 2. """test late disabling"""
# 3. pylint: disable=not-callable, useless-suppression
# 4. print(self.blip)
# 5. pylint: disable=no-member, useless-suppression
# 6. print(self.bla)
#
# E1102 should be disabled from line 1 to 6 while E1101 from line 5 to 6
#
# this is necessary to disable locally messages applying to class /
# function using their fromlineno
if (
isinstance(node, (nodes.Module, nodes.ClassDef, nodes.FunctionDef))
and node.body
):
firstchildlineno = node.body[0].fromlineno
else:
firstchildlineno = node.tolineno
self._set_message_state_in_block(msg, msg_state, node, firstchildlineno)
def _set_message_state_in_block(
self,
msg: MessageDefinition,
lines: dict[int, bool],
node: nodes.NodeNG,
firstchildlineno: int,
) -> None:
"""Set the state of a message in a block of lines."""
first = node.fromlineno
last = node.tolineno
for lineno, state in list(lines.items()):
original_lineno = lineno
if first > lineno or last < lineno:
continue
# Set state for all lines for this block, if the
# warning is applied to nodes.
if msg.scope == WarningScope.NODE:
if lineno > firstchildlineno:
state = True
first_, last_ = node.block_range(lineno)
# pylint: disable=useless-suppression
# For block nodes first_ is their definition line. For example, we
# set the state of line zero for a module to allow disabling
# invalid-name for the module. For example:
# 1. # pylint: disable=invalid-name
# 2. ...
# OR
# 1. """Module docstring"""
# 2. # pylint: disable=invalid-name
# 3. ...
#
# But if we already visited line 0 we don't need to set its state again
# 1. # pylint: disable=invalid-name
# 2. # pylint: enable=invalid-name
# 3. ...
# The state should come from line 1, not from line 2
# Therefore, if the 'fromlineno' is already in the states we just start
# with the lineno we were originally visiting.
# pylint: enable=useless-suppression
if (
first_ == node.fromlineno
and first_ >= firstchildlineno
and node.fromlineno in self._module_msgs_state.get(msg.msgid, ())
):
first_ = lineno
else:
first_ = lineno
last_ = last
for line in range(first_, last_ + 1):
# Do not override existing entries. This is especially important
# when parsing the states for a scoped node where some line-disables
# have already been parsed.
if (
(
isinstance(node, nodes.Module)
and node.fromlineno <= line < lineno
)
or (
not isinstance(node, nodes.Module)
and node.fromlineno < line < lineno
)
) and line in self._module_msgs_state.get(msg.msgid, ()):
continue
if line in lines: # state change in the same block
state = lines[line]
original_lineno = line
self._set_message_state_on_line(msg, line, state, original_lineno)
del lines[lineno]
def _set_message_state_on_line(
self,
msg: MessageDefinition,
line: int,
state: bool,
original_lineno: int,
) -> None:
"""Set the state of a message on a line."""
# Update suppression mapping
if not state:
self._suppression_mapping[(msg.msgid, line)] = original_lineno
else:
self._suppression_mapping.pop((msg.msgid, line), None)
# Update message state for respective line
try:
self._module_msgs_state[msg.msgid][line] = state
except KeyError:
self._module_msgs_state[msg.msgid] = {line: state}
def set_msg_status(
self,
msg: MessageDefinition,
line: int,
status: bool,
scope: str = "package",
) -> None:
"""Set status (enabled/disable) for a given message at a given line."""
assert line > 0
assert self._module
# TODO: 3.0: Remove unnecessary assertion
assert self._msgs_store
if scope != "line":
# Expand the status to cover all relevant block lines
self._set_state_on_block_lines(
self._msgs_store, self._module, msg, {line: status}
)
else:
self._set_message_state_on_line(msg, line, status, line)
# Store the raw value
try:
self._raw_module_msgs_state[msg.msgid][line] = status
except KeyError:
self._raw_module_msgs_state[msg.msgid] = {line: status}
def handle_ignored_message(
self, state_scope: Literal[0, 1, 2] | None, msgid: str, line: int | None
) -> None:
"""Report an ignored message.
state_scope is either MSG_STATE_SCOPE_MODULE or MSG_STATE_SCOPE_CONFIG,
depending on whether the message was disabled locally in the module,
or globally.
"""
if state_scope == MSG_STATE_SCOPE_MODULE:
assert isinstance(line, int) # should always be int inside module scope
try:
orig_line = self._suppression_mapping[(msgid, line)]
self._ignored_msgs[(msgid, orig_line)].add(line)
except KeyError:
pass
def iter_spurious_suppression_messages(
self,
msgs_store: MessageDefinitionStore,
) -> Iterator[
tuple[
Literal["useless-suppression", "suppressed-message"],
int,
tuple[str] | tuple[str, int],
]
]:
for warning, lines in self._raw_module_msgs_state.items():
for line, enable in lines.items():
if (
not enable
and (warning, line) not in self._ignored_msgs
and warning not in INCOMPATIBLE_WITH_USELESS_SUPPRESSION
):
yield "useless-suppression", line, (
msgs_store.get_msg_display_string(warning),
)
# don't use iteritems here, _ignored_msgs may be modified by add_message
for (warning, from_), ignored_lines in list(self._ignored_msgs.items()):
for line in ignored_lines:
yield "suppressed-message", line, (
msgs_store.get_msg_display_string(warning),
from_,
)
def get_effective_max_line_number(self) -> int | None:
return self._effective_max_line_number # type: ignore[no-any-return]
|