Module implementing a checker for miscellaneous checks.
BugBearContext |
BugBearVisitor | Class implementing a node visitor to check for various topics. |
DateTimeVisitor | Class implementing a node visitor to check datetime function calls. |
ExceptBaseExceptionVisitor | Class to determine, if a 'BaseException' is re-raised. |
M520NameFinder | Class to extract a name out of a tree of nodes ignoring names defined within the local scope of a comprehension. |
M569Checker | Class traversing a 'for' loop body to check for modifications to a loop's mutable iterable. |
MiscellaneousChecker | Class implementing a checker for miscellaneous checks. |
NameFinder | Class to extract a name out of a tree of nodes. |
NamedExprFinder | Class to extract names defined through an ast.NamedExpr. |
ReturnVisitor | Class implementing a node visitor to check return statements. |
SysVersionVisitor | Class implementing a node visitor to check the use of sys.version and sys.version_info. |
TextVisitor | Class implementing a node visitor for bytes and str instances. |
composeCallPath | Generator function to assemble the call path of a given node. |
pairwise |
Class implementing a node visitor to check for various topics.
CONTEXTFUL_NODES |
FUNCTION_NODES |
NodeWindowSize |
None |
BugBearVisitor | Constructor |
__checkForM505 | Private method to check the use of *strip(). |
__checkForM507 | Private method to check for unused loop variables. |
__checkForM512 | Private method to check for return/continue/break inside finally blocks. |
__checkForM515 | Private method to check for pointless comparisons. |
__checkForM516 | Private method to check for raising a literal instead of an exception. |
__checkForM517 | Private method to check for use of the evil syntax 'with assertRaises(Exception): or 'with pytest.raises(Exception):'. |
__checkForM518 | Private method to check for useless expressions. |
__checkForM519 | Private method to check for use of 'functools.lru_cache' or 'functools.cache'. |
__checkForM520 | Private method to check for a loop that modifies its iterable. |
__checkForM521 | Private method to check for use of an f-string as docstring. |
__checkForM522 | Private method to check for use of an f-string as docstring. |
__checkForM523 | Private method to check that functions (including lambdas) do not use loop variables. |
__checkForM524AndM527 | Private method to check for inheritance from abstract classes in abc and lack of any methods decorated with abstract*. |
__checkForM525 | Private method to check for exceptions being handled multiple times. |
__checkForM526 | Private method to check for Star-arg unpacking after keyword argument. |
__checkForM528 | Private method to check for warn without stacklevel. |
__checkForM531 | Private method to check that 'itertools.groupby' isn't iterated over more than once. |
__checkForM532 | Private method to check for possible unintentional typing annotation. |
__checkForM533 | Private method to check a set for duplicate items. |
__checkForM534 | Private method to check that re.sub/subn/split arguments flags/count/maxsplit are passed as keyword arguments. |
__checkForM535 | Private method to check that a static key isn't used in a dict comprehension. |
__checkForM569 | Private method to check for changes to a loop's mutable iterable. |
__checkRedundantExcepthandlers | Private method to check for redundant exception types in an exception handler. |
__childrenInScope | Private method to get all child nodes in the given scope. |
__composeCallPath | Private method get the individual elements of the call path of a node. |
__flattenExcepthandler | Private method to flatten the list of exceptions handled by an except handler. |
__getAssignedNames | Private method to get the names of a for loop. |
__getDictCompLoopAndNamedExprVarNames | Private method to get the names of comprehension loop variables. |
__getNamesFromTuple | Private method to get the names from an ast.Tuple node. |
__inClassInit | Private method to check, if we are inside an '__init__' method. |
__isIdentifier | Private method to check if arg is a valid identifier. |
__namesFromAssignments | Private method to get names of an assignment. |
__typesafeIssubclass | Private method implementing a type safe issubclass() function. |
__walkList | Private method to walk a given list of nodes. |
_loop | |
check | |
emptyBody | |
isAbcClass | |
isAbstractDecorator | |
isOverload | |
isStrOrEllipsis | |
nodeStack | Public method to get a reference to the most recent node stack. |
toNameStr | Public method to turn Name and Attribute nodes to strings, handling any depth of attribute accesses. |
visit | Public method to traverse a given AST node. |
visit_AnnAssign | Public method to check annotated assign statements. |
visit_Assert | Public method to handle 'assert' statements. |
visit_Assign | Public method to handle assignments. |
visit_AsyncFor | Public method to handle 'for' statements. |
visit_Call | Public method to handle a function call. |
visit_ClassDef | Public method to handle class definitions. |
visit_Compare | Public method to handle comparison statements. |
visit_DictComp | Public method to handle dictionary comprehensions. |
visit_ExceptHandler | Public method to handle exception handlers. |
visit_For | Public method to handle 'for' statements. |
visit_FunctionDef | Public method to handle function definitions. |
visit_GeneratorExp | Public method to handle generator expressions. |
visit_Import | Public method to check imports. |
visit_ImportFrom | Public method to check from imports. |
visit_JoinedStr | Public method to handle f-string arguments. |
visit_ListComp | Public method to handle list comprehensions. |
visit_Module | Public method to handle a module node. |
visit_Raise | Public method to handle 'raise' statements. |
visit_Return | Public method to handle 'Return' nodes. |
visit_Set | Public method to check a set. |
visit_SetComp | Public method to handle set comprehensions. |
visit_Try | Public method to handle 'try' statements'. |
visit_UAdd | Public method to handle unary additions. |
visit_While | Public method to handle 'while' statements. |
visit_With | Public method to handle 'with' statements. |
visit_Yield | Public method to handle 'Yield' nodes. |
visit_YieldFrom | Public method to handle 'YieldFrom' nodes. |
None |
Constructor
Private method to check the use of *strip().
Private method to check for unused loop variables.
Private method to check for return/continue/break inside finally blocks.
Private method to check for pointless comparisons.
Private method to check for raising a literal instead of an exception.
Private method to check for use of the evil syntax 'with assertRaises(Exception): or 'with pytest.raises(Exception):'.
Private method to check for useless expressions.
Private method to check for use of 'functools.lru_cache' or 'functools.cache'.
Private method to check for a loop that modifies its iterable.
Private method to check for use of an f-string as docstring.
Private method to check for use of an f-string as docstring.
Private method to check that functions (including lambdas) do not use loop variables.
Private method to check for inheritance from abstract classes in abc and lack of any methods decorated with abstract*.
Private method to check for exceptions being handled multiple times.
Private method to check for Star-arg unpacking after keyword argument.
Private method to check for warn without stacklevel.
Private method to check that 'itertools.groupby' isn't iterated over more than once.
A warning is emitted when the generator returned by 'groupby()' is used more than once inside a loop body or when it's used in a nested loop.
Private method to check for possible unintentional typing annotation.
Private method to check a set for duplicate items.
Private method to check that re.sub/subn/split arguments flags/count/maxsplit are passed as keyword arguments.
Private method to check that a static key isn't used in a dict comprehension.
Record a warning if a likely unchanging key is used - either a constant, or a variable that isn't coming from the generator expression.
Private method to check for changes to a loop's mutable iterable.
Private method to check for redundant exception types in an exception handler.
Private method to get all child nodes in the given scope.
Private method get the individual elements of the call path of a node.
Private method to flatten the list of exceptions handled by an except handler.
Private method to get the names of a for loop.
Private method to get the names of comprehension loop variables.
Private method to get the names from an ast.Tuple node.
Private method to check, if we are inside an '__init__' method.
Private method to check if arg is a valid identifier.
See https://docs.python.org/2/reference/lexical_analysis.html#identifiers
Private method to get names of an assignment.
Private method implementing a type safe issubclass() function.
Private method to walk a given list of nodes.
Public method to get a reference to the most recent node stack.
Public method to turn Name and Attribute nodes to strings, handling any depth of attribute accesses.
Public method to traverse a given AST node.
Public method to check annotated assign statements.
Public method to handle 'assert' statements.
Public method to handle assignments.
Public method to handle 'for' statements.
Public method to handle a function call.
Public method to handle class definitions.
Public method to handle comparison statements.
Public method to handle dictionary comprehensions.
Public method to handle exception handlers.
Public method to handle 'for' statements.
Public method to handle function definitions.
Public method to handle generator expressions.
Public method to check imports.
Public method to check from imports.
Public method to handle f-string arguments.
Public method to handle list comprehensions.
Public method to handle a module node.
Public method to handle 'raise' statements.
Public method to handle 'Return' nodes.
Public method to check a set.
Public method to handle set comprehensions.
Public method to handle 'try' statements'.
Public method to handle unary additions.
Public method to handle 'while' statements.
Public method to handle 'with' statements.
Public method to handle 'Yield' nodes.
Public method to handle 'YieldFrom' nodes.
Class implementing a node visitor to check datetime function calls.
Note: This class is modeled after flake8_datetimez checker.
None |
None |
DateTimeVisitor | Constructor |
__getFromKeywords | Private method to get a keyword node given its name. |
visit_Call | Public method to handle a function call. |
None |
Constructor
Private method to get a keyword node given its name.
Public method to handle a function call.
Every datetime related function call is check for use of the naive variant (i.e. use without TZ info).
Class to determine, if a 'BaseException' is re-raised.
None |
None |
ExceptBaseExceptionVisitor | Constructor |
reRaised | Public method to check, if the exception is re-raised. |
visit_ExceptHandler | Public method to handle 'ExceptHandler' nodes. |
visit_Raise | Public method to handle 'Raise' nodes. |
None |
Constructor
Public method to check, if the exception is re-raised.
Public method to handle 'ExceptHandler' nodes.
Public method to handle 'Raise' nodes.
If we find a corresponding `raise` or `raise e` where e was from `except BaseException as e:` then we mark re_raised as True and can stop scanning.
Class to extract a name out of a tree of nodes ignoring names defined within the local scope of a comprehension.
None |
None |
visit_DictComp | Public method to handle a dictionary comprehension. |
visit_GeneratorExp | Public method to handle a generator expressions. |
visit_Lambda | Public method to handle a Lambda function. |
visit_ListComp | Public method to handle a list comprehension. |
visit_comprehension | Public method to handle the 'for' of a comprehension. |
None |
Public method to handle a dictionary comprehension.
Public method to handle a generator expressions.
Public method to handle a Lambda function.
Public method to handle a list comprehension.
Public method to handle the 'for' of a comprehension.
Class traversing a 'for' loop body to check for modifications to a loop's mutable iterable.
MUTATING_FUNCTIONS |
None |
M569Checker | Constructor |
visit | Public method to inspect an ast node. |
visit_Call | Public method handling 'Call' nodes. |
visit_Delete | Public method handling 'Delete' nodes. |
None |
Constructor
Public method to inspect an ast node.
Like super-visit but supports iteration over lists.
Public method handling 'Call' nodes.
Public method handling 'Delete' nodes.
Class implementing a checker for miscellaneous checks.
BuiltinsWhiteList |
Codes |
FormatFieldRegex |
Formatter |
None |
MiscellaneousChecker | Constructor |
__checkBugBear | Private method for bugbear checks. |
__checkBuiltins | Private method to check, if built-ins are shadowed. |
__checkCoding | Private method to check the presence of a coding line and valid encodings. |
__checkCommentedCode | Private method to check for commented code. |
__checkComprehensions | Private method to check some comprehension related things. |
__checkCopyright | Private method to check the presence of a copyright statement. |
__checkDateTime | Private method to check use of naive datetime functions. |
__checkDictWithSortedKeys | Private method to check, if dictionary keys appear in sorted order. |
__checkExplicitStringConcat | Private method to check for explicitly concatenated strings. |
__checkFormatString | Private method to check string format strings. |
__checkFuture | Private method to check the __future__ imports. |
__checkGettext | Private method to check the 'gettext' import statement. |
__checkImplicitStringConcat | Private method to check for implicitly concatenated strings. |
__checkLineContinuation | Private method to check line continuation using backslash. |
__checkMutableDefault | Private method to check for use of mutable types as default arguments. |
__checkPep3101 | Private method to check for old style string formatting. |
__checkPrintStatements | Private method to check for print statements. |
__checkProperties | Private method to check for issue with property related methods. |
__checkReturn | Private method to check return statements. |
__checkSysVersion | Private method to check the use of sys.version and sys.version_info. |
__checkTuple | Private method to check for one element tuples. |
__dictShouldBeChecked | Private function to test, if the node should be checked. |
__error | Private method to record an issue. |
__getCoding | Private method to get the defined coding of the source. |
__getFields | Private method to extract the format field information. |
__ignoreCode | Private method to check if the message code should be ignored. |
__isImplicitStringConcat | Private method to check, if the given strings indicate an implicit string concatenation. |
run | Public method to check the given source against miscellaneous conditions. |
None |
Constructor
Private method for bugbear checks.
Private method to check, if built-ins are shadowed.
Private method to check the presence of a coding line and valid encodings.
Private method to check for commented code.
Private method to check some comprehension related things.
This method is adapted from: flake8-comprehensions v3.14.0 Original: Copyright (c) 2017 Adam Johnson
Private method to check the presence of a copyright statement.
Private method to check use of naive datetime functions.
Private method to check, if dictionary keys appear in sorted order.
Private method to check for explicitly concatenated strings.
Private method to check string format strings.
Private method to check the __future__ imports.
Private method to check the 'gettext' import statement.
Private method to check for implicitly concatenated strings.
Private method to check line continuation using backslash.
Private method to check for use of mutable types as default arguments.
Private method to check for old style string formatting.
Private method to check for print statements.
Private method to check for issue with property related methods.
Private method to check return statements.
Private method to check the use of sys.version and sys.version_info.
Private method to check for one element tuples.
Private function to test, if the node should be checked.
Private method to record an issue.
Private method to get the defined coding of the source.
Private method to extract the format field information.
Private method to check if the message code should be ignored.
Private method to check, if the given strings indicate an implicit string concatenation.
Public method to check the given source against miscellaneous conditions.
Class to extract a name out of a tree of nodes.
None |
None |
NameFinder | Constructor |
getNames | Public method to return the extracted names and Name nodes. |
visit | Public method to traverse a given AST node. |
visit_Name | Public method to handle 'Name' nodes. |
None |
Constructor
Public method to return the extracted names and Name nodes.
Public method to traverse a given AST node.
Public method to handle 'Name' nodes.
Class to extract names defined through an ast.NamedExpr.
None |
None |
NamedExprFinder | Constructor |
getNames | Public method to return the extracted names and Name nodes. |
visit | Public method to traverse a given AST node. |
visit_NamedExpr | Public method handling 'NamedExpr' nodes. |
None |
Constructor
Public method to return the extracted names and Name nodes.
Public method to traverse a given AST node.
Like super-visit but supports iteration over lists.
Public method handling 'NamedExpr' nodes.
Class implementing a node visitor to check return statements.
Assigns |
Refs |
Returns |
None |
ReturnVisitor | Constructor |
__checkFunction | Private method to check a function definition node. |
__checkImplicitReturn | Private method to check for an implicit return statement. |
__checkImplicitReturnValue | Private method to check for implicit return values. |
__checkUnnecessaryAssign | Private method to check for an unnecessary assign statement. |
__checkUnnecessaryReturnNone | Private method to check for an unnecessary 'return None' statement. |
__hasRefsBeforeNextAssign | Private method to check for references before a following assign statement. |
__isFalse | Private method to check, if a node value is False. |
__isNone | Private method to check, if a node value is None. |
__resultExists | Private method to check the existance of a return result. |
__visitAssignTarget | Private method to handle an assign target node. |
__visitLoop | Private method to handle loop nodes. |
__visitWithStack | Private method to traverse a given function node using a stack. |
assigns | Public method to get the Assign nodes. |
refs | Public method to get the References nodes. |
returns | Public method to get the Return nodes. |
visit_Assign | Public method to handle an assign node. |
visit_AsyncFor | Public method to handle an async for loop. |
visit_AsyncFunctionDef | Public method to handle a function definition. |
visit_For | Public method to handle a for loop. |
visit_FunctionDef | Public method to handle a function definition. |
visit_Name | Public method to handle a name node. |
visit_Return | Public method to handle a return node. |
visit_While | Public method to handle a while loop. |
None |
Constructor
Private method to check a function definition node.
Private method to check for an implicit return statement.
Private method to check for implicit return values.
Private method to check for an unnecessary assign statement.
Private method to check for an unnecessary 'return None' statement.
Private method to check for references before a following assign statement.
Private method to check, if a node value is False.
Private method to check, if a node value is None.
Private method to check the existance of a return result.
Private method to handle an assign target node.
Private method to handle loop nodes.
Private method to traverse a given function node using a stack.
Public method to get the Assign nodes.
Public method to get the References nodes.
Public method to get the Return nodes.
Public method to handle an assign node.
Public method to handle an async for loop.
Public method to handle a function definition.
Public method to handle a for loop.
Public method to handle a function definition.
Public method to handle a name node.
Public method to handle a return node.
Public method to handle a while loop.
Class implementing a node visitor to check the use of sys.version and sys.version_info.
Note: This class is modeled after flake8-2020 checker.
None |
None |
SysVersionVisitor | Constructor |
__isSys | Private method to check for a reference to sys attribute. |
__isSysVersionUpperSlice | Private method to check the upper slice of sys.version. |
visit_Attribute | Public method to handle an attribute. |
visit_Compare | Public method to handle a comparison. |
visit_ImportFrom | Public method to handle a from ... |
visit_Name | Public method to handle an name. |
visit_Subscript | Public method to handle a subscript. |
None |
Constructor
Private method to check for a reference to sys attribute.
Private method to check the upper slice of sys.version.
Public method to handle an attribute.
Public method to handle a comparison.
Public method to handle a from ... import ... statement.
Public method to handle an name.
Public method to handle a subscript.
Class implementing a node visitor for bytes and str instances.
It tries to detect docstrings as string of the first expression of each module, class or function.
None |
None |
TextVisitor | Constructor |
__addNode | Private method to add a node to our list of nodes. |
__visitBody | Private method to traverse the body of the node manually. |
__visitDefinition | Private method handling class and function definitions. |
visit_AsyncFunctionDef | Public method to handle an asynchronous function definition. |
visit_Call | Public method to handle a function call. |
visit_ClassDef | Public method to handle a class definition. |
visit_Constant | Public method to handle constant nodes. |
visit_FunctionDef | Public method to handle a function definition. |
visit_Module | Public method to handle a module. |
None |
Constructor
Private method to add a node to our list of nodes.
Private method to traverse the body of the node manually.
If the first node is an expression which contains a string or bytes it marks that as a docstring.
Private method handling class and function definitions.
Public method to handle an asynchronous function definition.
Public method to handle a function call.
Public method to handle a class definition.
Public method to handle constant nodes.
Public method to handle a function definition.
Public method to handle a module.
Generator function to assemble the call path of a given node.