--- a/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/Logging/LoggingChecker.py Thu Feb 27 09:22:15 2025 +0100
+++ b/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/Logging/LoggingChecker.py Thu Feb 27 14:42:39 2025 +0100
@@ -7,10 +7,10 @@
Module implementing a checker for logging related issues.
"""
-import copy
+from CodeStyleTopicChecker import CodeStyleTopicChecker
-class LoggingChecker:
+class LoggingChecker(CodeStyleTopicChecker):
"""
Class implementing a checker for logging related issues.
"""
@@ -33,6 +33,7 @@
"L-114",
"L-115",
]
+ Category = "L"
def __init__(self, source, filename, tree, select, ignore, expected, repeat, args):
"""
@@ -55,20 +56,17 @@
@param args dictionary of arguments for the various checks
@type dict
"""
- self.__select = tuple(select)
- self.__ignore = tuple(ignore)
- self.__expected = expected[:]
- self.__repeat = repeat
- self.__filename = filename
- self.__source = source[:]
- self.__tree = copy.deepcopy(tree)
- self.__args = args
-
- # statistics counters
- self.counters = {}
-
- # collection of detected errors
- self.errors = []
+ super().__init__(
+ LoggingChecker.Category,
+ source,
+ filename,
+ tree,
+ select,
+ ignore,
+ expected,
+ repeat,
+ args,
+ )
checkersWithCodes = [
(
@@ -92,77 +90,7 @@
),
),
]
-
- self.__checkers = []
- for checker, codes in checkersWithCodes:
- if any(not (code and self.__ignoreCode(code)) for code in codes):
- self.__checkers.append(checker)
-
- def __ignoreCode(self, code):
- """
- Private method to check if the message code should be ignored.
-
- @param code message code to check for
- @type str
- @return flag indicating to ignore the given code
- @rtype bool
- """
- return code in self.__ignore or (
- code.startswith(self.__ignore) and not code.startswith(self.__select)
- )
-
- def __error(self, lineNumber, offset, code, *args):
- """
- Private method to record an issue.
-
- @param lineNumber line number of the issue
- @type int
- @param offset position within line of the issue
- @type int
- @param code message code
- @type str
- @param args arguments for the message
- @type list
- """
- if self.__ignoreCode(code):
- return
-
- if code in self.counters:
- self.counters[code] += 1
- else:
- self.counters[code] = 1
-
- # Don't care about expected codes
- if code in self.__expected:
- return
-
- if code and (self.counters[code] == 1 or self.__repeat):
- # record the issue with one based line number
- self.errors.append(
- {
- "file": self.__filename,
- "line": lineNumber + 1,
- "offset": offset,
- "code": code,
- "args": args,
- }
- )
-
- def run(self):
- """
- Public method to check the given source against miscellaneous
- conditions.
- """
- if not self.__filename:
- # don't do anything, if essential data is missing
- return
-
- if not self.__checkers:
- # don't do anything, if no codes were selected
- return
-
- for check in self.__checkers:
- check()
+ self._initializeCheckers(checkersWithCodes)
def __checkLogging(self):
"""
@@ -170,5 +98,5 @@
"""
from .LoggingVisitor import LoggingVisitor
- visitor = LoggingVisitor(errorCallback=self.__error)
- visitor.visit(self.__tree)
+ visitor = LoggingVisitor(errorCallback=self.addErrorFromNode)
+ visitor.visit(self.tree)
