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
|
# 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
"""Check source code is ascii only or has an encoding declaration (PEP 263)."""
from __future__ import annotations
import re
import tokenize
from typing import TYPE_CHECKING
from astroid import nodes
from pylint.checkers import BaseRawFileChecker, BaseTokenChecker
from pylint.typing import ManagedMessage
if TYPE_CHECKING:
from pylint.lint import PyLinter
class ByIdManagedMessagesChecker(BaseRawFileChecker):
"""Checks for messages that are enabled or disabled by id instead of symbol."""
name = "miscellaneous"
msgs = {
"I0023": (
"%s",
"use-symbolic-message-instead",
"Used when a message is enabled or disabled by id.",
)
}
options = ()
def _clear_by_id_managed_msgs(self) -> None:
self.linter._by_id_managed_msgs.clear()
def _get_by_id_managed_msgs(self) -> list[ManagedMessage]:
return self.linter._by_id_managed_msgs
def process_module(self, node: nodes.Module) -> None:
"""Inspect the source file to find messages activated or deactivated by id."""
managed_msgs = self._get_by_id_managed_msgs()
for mod_name, msgid, symbol, lineno, is_disabled in managed_msgs:
if mod_name == node.name:
verb = "disable" if is_disabled else "enable"
txt = f"'{msgid}' is cryptic: use '# pylint: {verb}={symbol}' instead"
self.add_message("use-symbolic-message-instead", line=lineno, args=txt)
self._clear_by_id_managed_msgs()
class EncodingChecker(BaseTokenChecker, BaseRawFileChecker):
"""BaseChecker for encoding issues.
Checks for:
* warning notes in the code like FIXME, XXX
* encoding issues.
"""
# configuration section name
name = "miscellaneous"
msgs = {
"W0511": (
"%s",
"fixme",
"Used when a warning note as FIXME or XXX is detected.",
)
}
options = (
(
"notes",
{
"type": "csv",
"metavar": "<comma separated values>",
"default": ("FIXME", "XXX", "TODO"),
"help": (
"List of note tags to take in consideration, "
"separated by a comma."
),
},
),
(
"notes-rgx",
{
"type": "string",
"metavar": "<regexp>",
"help": "Regular expression of note tags to take in consideration.",
"default": "",
},
),
)
def open(self) -> None:
super().open()
notes = "|".join(re.escape(note) for note in self.linter.config.notes)
if self.linter.config.notes_rgx:
regex_string = rf"#\s*({notes}|{self.linter.config.notes_rgx})(?=(:|\s|\Z))"
else:
regex_string = rf"#\s*({notes})(?=(:|\s|\Z))"
self._fixme_pattern = re.compile(regex_string, re.I)
def _check_encoding(
self, lineno: int, line: bytes, file_encoding: str
) -> str | None:
try:
return line.decode(file_encoding)
except UnicodeDecodeError:
pass
except LookupError:
if (
line.startswith(b"#")
and "coding" in str(line)
and file_encoding in str(line)
):
msg = f"Cannot decode using encoding '{file_encoding}', bad encoding"
self.add_message("syntax-error", line=lineno, args=msg)
return None
def process_module(self, node: nodes.Module) -> None:
"""Inspect the source file to find encoding problem."""
encoding = node.file_encoding if node.file_encoding else "ascii"
with node.stream() as stream:
for lineno, line in enumerate(stream):
self._check_encoding(lineno + 1, line, encoding)
def process_tokens(self, tokens: list[tokenize.TokenInfo]) -> None:
"""Inspect the source to find fixme problems."""
if not self.linter.config.notes:
return
for token_info in tokens:
if token_info.type != tokenize.COMMENT:
continue
comment_text = token_info.string[1:].lstrip() # trim '#' and white-spaces
if self._fixme_pattern.search("#" + comment_text.lower()):
self.add_message(
"fixme",
col_offset=token_info.start[1] + 1,
args=comment_text,
line=token_info.start[0],
)
def register(linter: PyLinter) -> None:
linter.register_checker(EncodingChecker(linter))
linter.register_checker(ByIdManagedMessagesChecker(linter))
|
