eric: comparison src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/Naming/NamingStyleChecker.py

-:f6881d10e995
+:2f70ca07f0af
 def __init__(self, tree, filename, options):
 """
 Constructor (according to 'extended' pycodestyle.py API)
 @param tree AST tree of the source file
-@param filename name of the source file (string)
+@type ast.AST
+@param filename name of the source file
+@type str
 @param options options as parsed by pycodestyle.StyleGuide
+@type optparse.Option
 """
 self.__parents = collections.deque()
 self.__tree = tree
 self.__filename = filename
 """
 Public method run by the pycodestyle.py checker.
 @return tuple giving line number, offset within line, code and
 checker function
+@rtype tuple of (int, int, str, function)
 """
 if self.__tree and self.__checkers:
 return self.__visitTree(self.__tree)
 else:
 return ()
 def __visitTree(self, node):
 """
 Private method to scan the given AST tree.
 @param node AST tree node to scan
+@type ast.AST
 @yield tuple giving line number, offset within line and error code
 @ytype tuple of (int, int, str)
 """
 yield from self.__visitNode(node)
 self.__parents.append(node)
 def __visitNode(self, node):
 """
 Private method to inspect the given AST node.
 @param node AST tree node to inspect
+@type ast.AST
 @yield tuple giving line number, offset within line and error code
 @ytype tuple of (int, int, str)
 """
 if isinstance(node, ast.ClassDef):
 self.__tagClassFunctions(node)
 """
 Private method to tag functions if they are methods, class methods or
 static methods.
 @param classNode AST tree node to tag
+@type ast.ClassDef
 """
 # try to find all 'old style decorators'
 # like m = staticmethod(m)
 lateDecoration = {}
 for node in ast.iter_child_nodes(classNode):
 def __findGlobalDefs(self, functionNode):
 """
 Private method amend a node with global definitions information.
 @param functionNode AST tree node to amend
+@type ast.FunctionDef or ast.AsyncFunctionDef
 """
 globalNames = set()
 nodesToCheck = collections.deque(ast.iter_child_nodes(functionNode))
 while nodesToCheck:
 node = nodesToCheck.pop()
 def __getArgNames(self, node):
 """
 Private method to get the argument names of a function node.
 @param node AST node to extract arguments names from
-@return list of argument names (list of string)
+@type ast.FunctionDef or ast.AsyncFunctionDef
+@return list of argument names
+@rtype list of str
 """
 posArgs = [arg.arg for arg in node.args.args]
 kwOnly = [arg.arg for arg in node.args.kwonlyargs]
 return posArgs + kwOnly
 def __error(self, node, code):
 """
 Private method to build the error information.
 @param node AST node to report an error for
-@param code error code to report (string)
+@type ast.AST
+@param code error code to report
+@type str
 @return tuple giving line number, offset within line and error code
-(integer, integer, string)
+@rtype tuple of (int, int, str)
 """
 if isinstance(node, ast.Module):
 lineno = 0
 offset = 0
 else:
 def __isNameToBeAvoided(self, name):
 """
 Private method to check, if the given name should be avoided.
-@param name name to be checked (string)
+@param name name to be checked
-@return flag indicating to avoid it (boolen)
+@type str
+@return flag indicating to avoid it
+@rtype bool
 """
 return name in ("l", "O", "I")
 def __checkNameToBeAvoided(self, node, parents):  # noqa: U100
 """
 Private class to check the given node for a name to be avoided (N831).
 @param node AST note to check
-@param parents list of parent nodes
+@type ast.Ast
+@param parents list of parent nodes
+@type list of ast.AST
 @yield tuple giving line number, offset within line and error code
 @ytype tuple of (int, int, str)
 """
 if isinstance(node, (ast.ClassDef, ast.FunctionDef, ast.AsyncFunctionDef)):
 name = node.name
 Private method to extract the class definition.
 @param name name of the class
 @type str
 @param parents list of parent nodes
-@type ast.AST
+@type list of ast.AST
 @return node containing the class definition
 @rtype ast.ClassDef
 """
 for parent in parents:
 for node in parent.body:
 Private method to extract the names of all super classes.
 @param name name of the class
 @type str
 @param parents list of parent nodes
-@type ast.AST
+@type list of ast.AST
 @param names set of collected class names (defaults to None)
 @type set of str (optional)
 @return set of class names
 @rtype set of str
 """
 Almost without exception, class names use the CapWords convention.
 Classes for internal use have a leading underscore in addition.
 @param node AST note to check
-@param parents list of parent nodes
+@type ast.ClassDef
+@param parents list of parent nodes
+@type list of ast.AST
 @yield tuple giving line number, offset within line and error code
 @ytype tuple of (int, int, str)
 """
 name = node.name
 strippedName = name.strip("_")
 methods '__' in front and back are not allowed. Mixed case is allowed
 only in contexts where that's already the prevailing style
 (e.g. threading.py), to retain backwards compatibility.
 @param node AST note to check
-@param parents list of parent nodes
+@type ast.FunctionDef or ast.AsynFunctionDef
+@param parents list of parent nodes
+@type list of ast.AST
 @yield tuple giving line number, offset within line and error code
 @ytype tuple of (int, int, str)
 """
 functionType = getattr(node, "function_type", "function")
 name = node.name
 The argument names of a function should be lowercase, with words
 separated by underscores. A class method should have 'cls' as the
 first argument. A method should have 'self' as the first argument.
 @param node AST note to check
-@param parents list of parent nodes
+@type ast.FunctionDef or ast.AsynFunctionDef
+@param parents list of parent nodes
+@type list of ast.AST
 @yield tuple giving line number, offset within line and error code
 @ytype tuple of (int, int, str)
 """
 if node.args.kwarg is not None:
 kwarg = node.args.kwarg.arg
 (N821, N822, N823).
 Local variables in functions should be lowercase.
 @param node AST note to check
-@param parents list of parent nodes
+@type ast.AST
+@param parents list of parent nodes
+@type list of ast.AST
 @yield tuple giving line number, offset within line and error code
 @ytype tuple of (int, int, str)
 """
 nodeType = type(node)
 if nodeType is ast.Assign:
 """
 Private method to check module naming conventions (N807, N808).
 Module and package names should be lowercase.
-@param node AST note to check
+@param node AST node to check
-@param parents list of parent nodes
+@type ast.AST
+@param parents list of parent nodes
+@type list of ast.AST
 @yield tuple giving line number, offset within line and error code
 @ytype tuple of (int, int, str)
 """
 if self.__filename:
 moduleName = os.path.splitext(os.path.basename(self.__filename))[0]
 def __checkImportAs(self, node, parents):  # noqa: U100
 """
 Private method to check that imports don't change the
 naming convention (N811, N812, N813, N814, N815).
-@param node AST note to check
+@param node AST node to check
-@param parents list of parent nodes
+@type ast.Import
+@param parents list of parent nodes
+@type list of ast.AST
 @yield tuple giving line number, offset within line and error code
 @ytype tuple of (int, int, str)
 """
 for name in node.names:
 asname = name.asname

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/Naming/NamingStyleChecker.py

src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/Naming/NamingStyleChecker.py