Skip to content

Commit

Permalink
Move process_tokens to _MessageStateHandler (pylint-dev#6546)
Browse files Browse the repository at this point in the history 
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
  • Loading branch information
@DanielNoord @Pierre-Sassoulas
DanielNoord and Pierre-Sassoulas committed May 8, 2022
1 parent 8df920b commit 40ddfab
Show file tree
Hide file tree
Showing 2 changed files with 98 additions and 97 deletions.
94 changes: 94 additions & 0 deletions pylint/lint/message_state_handler.py
View file
Expand Up @@ -5,6 +5,7 @@
from __future__ import annotations

import sys
import tokenize
from typing import TYPE_CHECKING

from pylint import exceptions, interfaces
Expand All @@ -17,6 +18,12 @@
)
from pylint.message import MessageDefinition
from pylint.typing import ManagedMessage
from pylint.utils.pragma_parser import (
OPTION_PO,
InvalidPragmaError,
UnRecognizedOptionError,
parse_pragma,
)

if sys.version_info >= (3, 8):
from typing import Literal
Expand All @@ -43,6 +50,7 @@ def __init__(self, linter: PyLinter) -> None:
"disable-msg": self._options_methods["disable"],
"enable-msg": self._options_methods["enable"],
}
self._pragma_lineno: dict[str, int] = {}

def _set_one_msg_status(
self, scope: str, msg: MessageDefinition, line: int | None, enable: bool
Expand Down Expand Up @@ -316,3 +324,89 @@ def is_message_enabled(
# for now.
msgids = [msg_descr]
return any(self._is_one_message_enabled(msgid, line) for msgid in msgids)

def process_tokens(self, tokens: list[tokenize.TokenInfo]) -> None:
"""Process tokens from the current module to search for module/block level
options.
See func_block_disable_msg.py test case for expected behaviour.
"""
control_pragmas = {"disable", "disable-next", "enable"}
prev_line = None
saw_newline = True
seen_newline = True
for (tok_type, content, start, _, _) in tokens:
if prev_line and prev_line != start[0]:
saw_newline = seen_newline
seen_newline = False

prev_line = start[0]
if tok_type in (tokenize.NL, tokenize.NEWLINE):
seen_newline = True

if tok_type != tokenize.COMMENT:
continue
match = OPTION_PO.search(content)
if match is None:
continue
try:
for pragma_repr in parse_pragma(match.group(2)):
if pragma_repr.action in {"disable-all", "skip-file"}:
if pragma_repr.action == "disable-all":
self.linter.add_message(
"deprecated-pragma",
line=start[0],
args=("disable-all", "skip-file"),
)
self.linter.add_message("file-ignored", line=start[0])
self._ignore_file = True
return
try:
meth = self._options_methods[pragma_repr.action]
except KeyError:
meth = self._bw_options_methods[pragma_repr.action]
# found a "(dis|en)able-msg" pragma deprecated suppression
self.linter.add_message(
"deprecated-pragma",
line=start[0],
args=(
pragma_repr.action,
pragma_repr.action.replace("-msg", ""),
),
)
for msgid in pragma_repr.messages:
# Add the line where a control pragma was encountered.
if pragma_repr.action in control_pragmas:
self._pragma_lineno[msgid] = start[0]

if (pragma_repr.action, msgid) == ("disable", "all"):
self.linter.add_message(
"deprecated-pragma",
line=start[0],
args=("disable=all", "skip-file"),
)
self.linter.add_message("file-ignored", line=start[0])
self._ignore_file = True
return
# If we did not see a newline between the previous line and now,
# we saw a backslash so treat the two lines as one.
l_start = start[0]
if not saw_newline:
l_start -= 1
try:
meth(msgid, "module", l_start)
except exceptions.UnknownMessageError:
msg = f"{pragma_repr.action}. Don't recognize message {msgid}."
self.linter.add_message(
"bad-option-value", args=msg, line=start[0]
)
except UnRecognizedOptionError as err:
self.linter.add_message(
"unrecognized-inline-option", args=err.token, line=start[0]
)
continue
except InvalidPragmaError as err:
self.linter.add_message(
"bad-inline-option", args=err.token, line=start[0]
)
continue
101 changes: 4 additions & 97 deletions pylint/lint/pylinter.py
View file
Expand Up @@ -57,12 +57,6 @@
Options,
)
from pylint.utils import ASTWalker, FileState, LinterStats, utils
from pylint.utils.pragma_parser import (
OPTION_PO,
InvalidPragmaError,
UnRecognizedOptionError,
parse_pragma,
)

if sys.version_info >= (3, 8):
from typing import Protocol
Expand Down Expand Up @@ -226,7 +220,7 @@ class PyLinter(
_ArgumentsManager,
_MessageStateHandler,
reporters.ReportsHandlerMixIn,
checkers.BaseTokenChecker,
checkers.BaseChecker,
):
"""Lint Python modules using external checkers.
Expand Down Expand Up @@ -290,7 +284,6 @@ def __init__(
self.current_name: str | None = None
self.current_file: str | None = None
self._ignore_file = False
self._pragma_lineno: dict[str, int] = {}

# Attributes related to stats
self.stats = LinterStats()
Expand All @@ -307,13 +300,13 @@ def __init__(
"""List of message symbols on which pylint should fail, set by --fail-on."""
self._error_mode = False

# Attributes related to messages (states) and their handling
# Attributes related to registering messages and their handling
self.msgs_store = MessageDefinitionStore()
self.msg_status = 0
self._by_id_managed_msgs: list[ManagedMessage] = []

reporters.ReportsHandlerMixIn.__init__(self)
checkers.BaseTokenChecker.__init__(self, self)
checkers.BaseChecker.__init__(self, self)
# provided reports
self.reports = (
("RP0001", "Messages by category", report_total_messages_stats),
Expand Down Expand Up @@ -508,91 +501,6 @@ def _parse_error_mode(self) -> None:
self.set_option("persistent", False)
self.set_option("score", False)

# block level option handling #############################################
# see func_block_disable_msg.py test case for expected behaviour

def process_tokens(self, tokens: list[tokenize.TokenInfo]) -> None:
"""Process tokens from the current module to search for module/block level
options.
"""
control_pragmas = {"disable", "disable-next", "enable"}
prev_line = None
saw_newline = True
seen_newline = True
for (tok_type, content, start, _, _) in tokens:
if prev_line and prev_line != start[0]:
saw_newline = seen_newline
seen_newline = False

prev_line = start[0]
if tok_type in (tokenize.NL, tokenize.NEWLINE):
seen_newline = True

if tok_type != tokenize.COMMENT:
continue
match = OPTION_PO.search(content)
if match is None:
continue
try:
for pragma_repr in parse_pragma(match.group(2)):
if pragma_repr.action in {"disable-all", "skip-file"}:
if pragma_repr.action == "disable-all":
self.add_message(
"deprecated-pragma",
line=start[0],
args=("disable-all", "skip-file"),
)
self.add_message("file-ignored", line=start[0])
self._ignore_file = True
return
try:
meth = self._options_methods[pragma_repr.action]
except KeyError:
meth = self._bw_options_methods[pragma_repr.action]
# found a "(dis|en)able-msg" pragma deprecated suppression
self.add_message(
"deprecated-pragma",
line=start[0],
args=(
pragma_repr.action,
pragma_repr.action.replace("-msg", ""),
),
)
for msgid in pragma_repr.messages:
# Add the line where a control pragma was encountered.
if pragma_repr.action in control_pragmas:
self._pragma_lineno[msgid] = start[0]

if (pragma_repr.action, msgid) == ("disable", "all"):
self.add_message(
"deprecated-pragma",
line=start[0],
args=("disable=all", "skip-file"),
)
self.add_message("file-ignored", line=start[0])
self._ignore_file = True
return
# If we did not see a newline between the previous line and now,
# we saw a backslash so treat the two lines as one.
l_start = start[0]
if not saw_newline:
l_start -= 1
try:
meth(msgid, "module", l_start)
except exceptions.UnknownMessageError:
msg = f"{pragma_repr.action}. Don't recognize message {msgid}."
self.add_message(
"bad-option-value", args=msg, line=start[0]
)
except UnRecognizedOptionError as err:
self.add_message(
"unrecognized-inline-option", args=err.token, line=start[0]
)
continue
except InvalidPragmaError as err:
self.add_message("bad-inline-option", args=err.token, line=start[0])
continue

# code checking methods ###################################################

def get_checkers(self) -> list[BaseChecker]:
Expand Down Expand Up @@ -1025,8 +933,7 @@ def _check_astroid_module(
self.add_message("raw-checker-failed", args=node.name)
else:
# assert astroid.file.endswith('.py')
# invoke ITokenChecker interface on self to fetch module/block
# level options
# Parse module/block level option pragma's
self.process_tokens(tokens)
if self._ignore_file:
return False
Expand Down

0 comments on commit 40ddfab

Please sign in to comment.