eric: comparison src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/PathLib/PathlibChecker.py

-:fc45672fae42
+:73d80859079c
 #####################################################################################
 ## adapted from: flake8-use-pathlib v0.3.0                                         ##
 ##                                                                                 ##
 ## Original: Copyright (c) 2021 Rodolphe Pelloux-Prayer                            ##
-##                                                                                 ##
-## License:                                                                        ##
-## Permission is hereby granted, free of charge, to any person obtaining a copy    ##
-## of this software and associated documentation files (the "Software"), to deal   ##
-## in the Software without restriction, including without limitation the rights    ##
-## to use, copy, modify, merge, publish, distribute, sublicense, and/or sell       ##
-## copies of the Software, and to permit persons to whom the Software is           ##
-## furnished to do so, subject to the following conditions:                        ##
-##                                                                                 ##
-## The above copyright notice and this permission notice shall be included in all  ##
-## copies or substantial portions of the Software.                                 ##
-##                                                                                 ##
-## THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR      ##
-## IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,        ##
-## FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE     ##
-## AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER          ##
-## LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,   ##
-## OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE   ##
 #####################################################################################
 import ast
 import contextlib
-import copy
+from CodeStyleTopicChecker import CodeStyleTopicChecker
-class PathlibChecker:
+class PathlibChecker(CodeStyleTopicChecker):
 """
 Class implementing a checker for functions that can be replaced by use of
 the pathlib module.
 """
 ## Replacements for some Python standard library functions
 "P-301",
 ## Replacements for py.path.local
 "P-401",
 ]
+Category = "P"
 # map functions to be replaced to error codes
 Function2Code = {
 "os.chmod": "P-101",
 "os.mkdir": "P-102",
 @param expected list of expected codes
 @type list of str
 @param repeat flag indicating to report each occurrence of a code
 @type bool
 """
-self.__select = tuple(selected)
+super().__init__(
-self.__ignore = tuple(ignored)
+PathlibChecker.Category,
-self.__expected = expected[:]
+source,
-self.__repeat = repeat
+filename,
-self.__filename = filename
+tree,
-self.__source = source[:]
+selected,
-self.__tree = copy.deepcopy(tree)
+ignored,
+expected,
-# statistics counters
+repeat,
-self.counters = {}
+[],
-# collection of detected errors
-self.errors = []
-self.__checkCodes = (code for code in self.Codes if not self.__ignoreCode(code))
-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):
+checkersWithCodes = [
-"""
+(
-Private method to record an issue.
+self.__checkPathlibReplacement,
+(
-@param lineNumber line number of the issue
+"P-101",
-@type int
+"P-102",
-@param offset position within line of the issue
+"P-103",
-@type int
+"P-104",
-@param code message code
+"P-105",
-@type str
+"P-106",
-@param args arguments for the message
+"P-107",
-@type list
+"P-108",
-"""
+"P-109",
-if self.__ignoreCode(code):
+"P-110",
-return
+"P-111",
+"P-112",
-if code in self.counters:
+"P-113",
-self.counters[code] += 1
+"P-114",
-else:
+"P-201",
-self.counters[code] = 1
+"P-202",
+"P-203",
-# Don't care about expected codes
+"P-204",
-if code in self.__expected:
+"P-205",
-return
+"P-206",
+"P-207",
-if code and (self.counters[code] == 1 or self.__repeat):
+"P-208",
-# record the issue with one based line number
+"P-209",
-self.errors.append(
+"P-210",
-{
+"P-211",
-"file": self.__filename,
+"P-212",
-"line": lineNumber + 1,
+"P-213",
-"offset": offset,
+"P-301",
-"code": code,
+"P-401",
-"args": args,
+),
-}
+),
-)
+]
+self._initializeCheckers(checkersWithCodes)
-def run(self):
-"""
+def __checkPathlibReplacement(self):
-Public method to check the given source against functions
+"""
-to be replaced by 'pathlib' equivalents.
+Private method to check for pathlib replacements.
 """
-if not self.__filename:
-# don't do anything, if essential data is missing
-return
-if not self.__checkCodes:
-# don't do anything, if no codes were selected
-return
 visitor = PathlibVisitor(self.__checkForReplacement)
-visitor.visit(self.__tree)
+visitor.visit(self.tree)
 def __checkForReplacement(self, node, name):
 """
 Private method to check the given node for the need for a
 replacement.
 @param name resolved name of the node
 @type str
 """
 with contextlib.suppress(KeyError):
 errorCode = self.Function2Code[name]
-self.__error(node.lineno - 1, node.col_offset, errorCode)
+self.addErrorFromNode(node, errorCode)
 class PathlibVisitor(ast.NodeVisitor):
 """
 Class to traverse the AST node tree and check for potential issues.
 nameResolver = NameResolver(self.__importAlias)
 nameResolver.visit(node.func)
 self.__checkCallback(node, nameResolver.name())
+self.generic_visit(node)
 class NameResolver(ast.NodeVisitor):
 """
 Class to resolve a Name or Attribute node.
 """

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/PathLib/PathlibChecker.py

src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/PathLib/PathlibChecker.py