Subclass BaseRawFileChecker and BaseTokenChecker

Author: DanielNoord

examples/custom_raw.py

@@ -2,20 +2,17 @@
 
 from astroid import nodes
 
-from pylint.checkers import BaseChecker
-from pylint.interfaces import IRawChecker
+from pylint.checkers import BaseRawFileChecker
 
 if TYPE_CHECKING:
     from pylint.lint import PyLinter
 
 
-class MyRawChecker(BaseChecker):
+class MyRawChecker(BaseRawFileChecker):
     """Check for line continuations with '\' instead of using triple
     quoted string or parenthesis
     """
 
-    __implements__ = IRawChecker
-
     name = "custom_raw"
     msgs = {
         "W9901": (

pylint/checkers/format.py

@@ -19,15 +19,15 @@
 
 from astroid import nodes
 
-from pylint.checkers import BaseTokenChecker
+from pylint.checkers import BaseRawFileChecker, BaseTokenChecker
 from pylint.checkers.utils import (
     check_messages,
     is_overload_stub,
     is_protocol_class,
     node_frame_class,
 )
 from pylint.constants import WarningScope
-from pylint.interfaces import IAstroidChecker, IRawChecker, ITokenChecker
+from pylint.interfaces import IAstroidChecker
 from pylint.utils.pragma_parser import OPTION_PO, PragmaParserError, parse_pragma
 
 if TYPE_CHECKING:
@@ -195,7 +195,7 @@ def line(self, idx):
         return self._tokens[idx][4]
 
 
-class FormatChecker(BaseTokenChecker):
+class FormatChecker(BaseTokenChecker, BaseRawFileChecker):
     """Formatting checker.
 
     Checks for :
@@ -204,7 +204,7 @@ class FormatChecker(BaseTokenChecker):
     * line length
     """
 
-    __implements__ = (ITokenChecker, IAstroidChecker, IRawChecker)
+    __implements__ = IAstroidChecker
 
     # configuration section name
     name = "format"
@@ -319,7 +319,7 @@ def new_line(self, tokens, line_end, line_start):
             self._lines[line_num] = line.split("\n")[0]
         self.check_lines(line, line_num)
 
-    def process_module(self, _node: nodes.Module) -> None:
+    def process_module(self, node: nodes.Module) -> None:
         pass
 
     # pylint: disable-next=too-many-return-statements

pylint/checkers/misc.py

@@ -12,20 +12,18 @@
 
 from astroid import nodes
 
-from pylint.checkers import BaseChecker
-from pylint.interfaces import IRawChecker, ITokenChecker
+from pylint.checkers import BaseRawFileChecker, BaseTokenChecker
 from pylint.typing import ManagedMessage
 from pylint.utils.pragma_parser import OPTION_PO, PragmaParserError, parse_pragma
 
 if TYPE_CHECKING:
     from pylint.lint import PyLinter
 
 
-class ByIdManagedMessagesChecker(BaseChecker):
+class ByIdManagedMessagesChecker(BaseRawFileChecker):
 
     """Checks for messages that are enabled or disabled by id instead of symbol."""
 
-    __implements__ = IRawChecker
     name = "miscellaneous"
     msgs = {
         "I0023": (
@@ -53,7 +51,7 @@ def process_module(self, node: nodes.Module) -> None:
         self._clear_by_id_managed_msgs()
 
 
-class EncodingChecker(BaseChecker):
+class EncodingChecker(BaseTokenChecker, BaseRawFileChecker):
 
     """BaseChecker for encoding issues.
 
@@ -62,8 +60,6 @@ class EncodingChecker(BaseChecker):
     * encoding issues.
     """
 
-    __implements__ = (IRawChecker, ITokenChecker)
-
     # configuration section name
     name = "miscellaneous"
     msgs = {

pylint/checkers/raw_metrics.py

@@ -9,7 +9,6 @@
 from typing import TYPE_CHECKING, Any, cast
 
 from pylint.checkers import BaseTokenChecker
-from pylint.interfaces import ITokenChecker
 from pylint.reporters.ureports.nodes import Table
 from pylint.utils import LinterStats, diff_string
 
@@ -58,8 +57,6 @@ class RawMetricsChecker(BaseTokenChecker):
     * total number of empty lines
     """
 
-    __implements__ = (ITokenChecker,)
-
     # configuration section name
     name = "metrics"
     # configuration options

pylint/checkers/refactoring/refactoring_checker.py

@@ -196,7 +196,7 @@ class RefactoringChecker(checkers.BaseTokenChecker):
     is a true "else if" node, or an "elif" node.
     """
 
-    __implements__ = (interfaces.ITokenChecker, interfaces.IAstroidChecker)
+    __implements__ = interfaces.IAstroidChecker
 
     name = "refactoring"
 

pylint/checkers/similar.py

@@ -47,8 +47,7 @@
 import astroid
 from astroid import nodes
 
-from pylint.checkers import BaseChecker, table_lines_from_stats
-from pylint.interfaces import IRawChecker
+from pylint.checkers import BaseChecker, BaseRawFileChecker, table_lines_from_stats
 from pylint.reporters.ureports.nodes import Table
 from pylint.typing import Options
 from pylint.utils import LinterStats, decoding_stream
@@ -736,14 +735,13 @@ def report_similarities(
 
 
 # wrapper to get a pylint checker from the similar class
-class SimilarChecker(BaseChecker, Similar):
+class SimilarChecker(BaseRawFileChecker, Similar):
     """Checks for similarities and duplicated code.
 
     This computation may be memory / CPU intensive, so you
     should disable it if you experiment some problems.
     """
 
-    __implements__ = (IRawChecker,)
     # configuration section name
     name = "similarities"
     # messages
@@ -801,7 +799,7 @@ class SimilarChecker(BaseChecker, Similar):
     reports = (("RP0801", "Duplication", report_similarities),)
 
     def __init__(self, linter: PyLinter) -> None:
-        BaseChecker.__init__(self, linter)
+        BaseRawFileChecker.__init__(self, linter)
         Similar.__init__(
             self,
             min_lines=self.linter.config.min_similarity_lines,

pylint/checkers/spelling.py

@@ -16,7 +16,7 @@
 
 from pylint.checkers import BaseTokenChecker
 from pylint.checkers.utils import check_messages
-from pylint.interfaces import IAstroidChecker, ITokenChecker
+from pylint.interfaces import IAstroidChecker
 
 if TYPE_CHECKING:
     from pylint.lint import PyLinter
@@ -183,7 +183,7 @@ def replace_code_but_leave_surrounding_characters(match_obj) -> str:
 class SpellingChecker(BaseTokenChecker):
     """Check spelling in comments and docstrings."""
 
-    __implements__ = (ITokenChecker, IAstroidChecker)
+    __implements__ = IAstroidChecker
     name = "spelling"
     msgs = {
         "C0401": (

pylint/checkers/unicode.py

@@ -25,9 +25,9 @@
 
 from astroid import nodes
 
-import pylint.checkers
 import pylint.interfaces
 import pylint.lint
+from pylint import checkers
 
 _StrLike = TypeVar("_StrLike", str, bytes)
 
@@ -298,7 +298,7 @@ def extract_codec_from_bom(first_line: bytes) -> str:
     raise ValueError("No BOM found. Could not detect Unicode codec.")
 
 
-class UnicodeChecker(pylint.checkers.BaseChecker):
+class UnicodeChecker(checkers.BaseRawFileChecker):
     """Check characters that could be used to hide bad code to humans.
 
     This includes:
@@ -318,8 +318,6 @@ class UnicodeChecker(pylint.checkers.BaseChecker):
     for background.
     """
 
-    __implements__ = pylint.interfaces.IRawChecker
-
     name = "unicode_checker"
 
     msgs = {

pylint/extensions/check_elif.py

@@ -11,7 +11,7 @@
 
 from pylint.checkers import BaseTokenChecker
 from pylint.checkers.utils import check_messages
-from pylint.interfaces import HIGH, IAstroidChecker, ITokenChecker
+from pylint.interfaces import HIGH, IAstroidChecker
 
 if TYPE_CHECKING:
     from pylint.lint import PyLinter
@@ -20,7 +20,7 @@
 class ElseifUsedChecker(BaseTokenChecker):
     """Checks for use of "else if" when an "elif" could be used."""
 
-    __implements__ = (ITokenChecker, IAstroidChecker)
+    __implements__ = IAstroidChecker
     name = "else_if_used"
     msgs = {
         "R5501": (

pylint/extensions/empty_comment.py

@@ -8,8 +8,7 @@
 
 from astroid import nodes
 
-from pylint.checkers import BaseChecker
-from pylint.interfaces import IRawChecker
+from pylint.checkers import BaseRawFileChecker
 
 if TYPE_CHECKING:
     from pylint.lint import PyLinter
@@ -40,8 +39,7 @@ def comment_part_of_string(line, comment_idx):
     return False
 
 
-class CommentChecker(BaseChecker):
-    __implements__ = IRawChecker
+class CommentChecker(BaseRawFileChecker):
 
     name = "refactoring"
     msgs = {

pylint/lint/pylinter.py

@@ -209,8 +209,6 @@ class PyLinter(
     is reporter member; see check_parallel function for more details.
     """
 
-    __implements__ = (interfaces.ITokenChecker,)
-
     name = MAIN_CHECKER_NAME
     msgs = MSGS
     # Will be used like this : datetime.now().strftime(crash_file_path)

tests/benchmark/test_baseline_benchmarks.py

@@ -14,8 +14,7 @@
 import pytest
 from astroid import nodes
 
-import pylint.interfaces
-from pylint.checkers.base_checker import BaseChecker
+from pylint.checkers import BaseRawFileChecker
 from pylint.lint import PyLinter, Run, check_parallel
 from pylint.testutils import GenericTestReporter as Reporter
 from pylint.typing import FileItem
@@ -30,15 +29,13 @@ def _empty_filepath():
     )
 
 
-class SleepingChecker(BaseChecker):
+class SleepingChecker(BaseRawFileChecker):
     """A checker that sleeps, the wall-clock time should reduce as we add workers.
 
     As we apply a roughly constant amount of "work" in this checker any variance is
     likely to be caused by the pylint system.
     """
 
-    __implements__ = (pylint.interfaces.IRawChecker,)
-
     name = "sleeper"
     msgs = {
         "R9999": (
@@ -49,23 +46,21 @@ class SleepingChecker(BaseChecker):
     }
     sleep_duration = 0.5  # the time to pretend we're doing work for
 
-    def process_module(self, _node: nodes.Module) -> None:
+    def process_module(self, node: nodes.Module) -> None:
         """Sleeps for `sleep_duration` on each call.
 
         This effectively means each file costs ~`sleep_duration`+framework overhead
         """
         time.sleep(self.sleep_duration)
 
 
-class SleepingCheckerLong(BaseChecker):
+class SleepingCheckerLong(BaseRawFileChecker):
     """A checker that sleeps, the wall-clock time should reduce as we add workers.
 
     As we apply a roughly constant amount of "work" in this checker any variance is
     likely to be caused by the pylint system.
     """
 
-    __implements__ = (pylint.interfaces.IRawChecker,)
-
     name = "long-sleeper"
     msgs = {
         "R9999": (
@@ -76,19 +71,17 @@ class SleepingCheckerLong(BaseChecker):
     }
     sleep_duration = 0.5  # the time to pretend we're doing work for
 
-    def process_module(self, _node: nodes.Module) -> None:
+    def process_module(self, node: nodes.Module) -> None:
         """Sleeps for `sleep_duration` on each call.
 
         This effectively means each file costs ~`sleep_duration`+framework overhead
         """
         time.sleep(self.sleep_duration)
 
 
-class NoWorkChecker(BaseChecker):
+class NoWorkChecker(BaseRawFileChecker):
     """A checker that sleeps, the wall-clock time should change as we add threads."""
 
-    __implements__ = (pylint.interfaces.IRawChecker,)
-
     name = "sleeper"
     msgs = {
         "R9999": (
@@ -98,7 +91,7 @@ class NoWorkChecker(BaseChecker):
         )
     }
 
-    def process_module(self, _node: nodes.Module) -> None:
+    def process_module(self, node: nodes.Module) -> None:
         pass