eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker

Module implementing a checker for miscellaneous checks.

Global Attributes

BugBearContext

Classes

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.

Functions

composeCallPath Generator function to assemble the call path of a given node.
pairwise


BugBearVisitor

Class implementing a node visitor to check for various topics.

Derived from

ast.NodeVisitor

Class Attributes

CONTEXTFUL_NODES
FUNCTION_NODES
NodeWindowSize

Class Methods

None

Methods

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.

Static Methods

None

BugBearVisitor (Constructor)

BugBearVisitor()

Constructor

BugBearVisitor.__checkForM505

__checkForM505(node)

Private method to check the use of *strip().

node (ast.Call)
reference to the node to be processed

BugBearVisitor.__checkForM507

__checkForM507(node)

Private method to check for unused loop variables.

node (ast.For or ast.AsyncFor)
reference to the node to be processed

BugBearVisitor.__checkForM512

__checkForM512(node)

Private method to check for return/continue/break inside finally blocks.

node (ast.Try)
reference to the node to be processed

BugBearVisitor.__checkForM515

__checkForM515(node)

Private method to check for pointless comparisons.

node (ast.Compare)
reference to the node to be processed

BugBearVisitor.__checkForM516

__checkForM516(node)

Private method to check for raising a literal instead of an exception.

node (ast.Raise)
reference to the node to be processed

BugBearVisitor.__checkForM517

__checkForM517(node)

Private method to check for use of the evil syntax 'with assertRaises(Exception): or 'with pytest.raises(Exception):'.

node (ast.With)
reference to the node to be processed

BugBearVisitor.__checkForM518

__checkForM518(node)

Private method to check for useless expressions.

node (ast.FunctionDef)
reference to the node to be processed

BugBearVisitor.__checkForM519

__checkForM519(node)

Private method to check for use of 'functools.lru_cache' or 'functools.cache'.

node (ast.FunctionDef)
reference to the node to be processed

BugBearVisitor.__checkForM520

__checkForM520(node)

Private method to check for a loop that modifies its iterable.

node (ast.For or ast.AsyncFor)
reference to the node to be processed

BugBearVisitor.__checkForM521

__checkForM521(node)

Private method to check for use of an f-string as docstring.

node (ast.FunctionDef or ast.ClassDef)
reference to the node to be processed

BugBearVisitor.__checkForM522

__checkForM522(node)

Private method to check for use of an f-string as docstring.

node (ast.With)
reference to the node to be processed

BugBearVisitor.__checkForM523

__checkForM523(loopNode)

Private method to check that functions (including lambdas) do not use loop variables.

loopNode (ast.For, ast.AsyncFor, ast.While, ast.ListComp, ast.SetComp,ast.DictComp,)
reference to the node to be processed or ast.GeneratorExp

BugBearVisitor.__checkForM524AndM527

__checkForM524AndM527(node)

Private method to check for inheritance from abstract classes in abc and lack of any methods decorated with abstract*.

node (ast.ClassDef)
reference to the node to be processed

BugBearVisitor.__checkForM525

__checkForM525(node)

Private method to check for exceptions being handled multiple times.

node (ast.Try)
reference to the node to be processed

BugBearVisitor.__checkForM526

__checkForM526(node)

Private method to check for Star-arg unpacking after keyword argument.

node (ast.Call)
reference to the node to be processed

BugBearVisitor.__checkForM528

__checkForM528(node)

Private method to check for warn without stacklevel.

node (ast.Call)
reference to the node to be processed

BugBearVisitor.__checkForM531

__checkForM531(loopNode)

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.

loopNode (ast.For or ast.AsyncFor)
reference to the node to be processed

BugBearVisitor.__checkForM532

__checkForM532(node)

Private method to check for possible unintentional typing annotation.

node (ast.AnnAssign)
reference to the node to be processed

BugBearVisitor.__checkForM533

__checkForM533(node)

Private method to check a set for duplicate items.

node (ast.Set)
reference to the node to be processed

BugBearVisitor.__checkForM534

__checkForM534(node)

Private method to check that re.sub/subn/split arguments flags/count/maxsplit are passed as keyword arguments.

node (ast.Call)
reference to the node to be processed

BugBearVisitor.__checkForM535

__checkForM535(node)

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.

node (ast.DictComp)
reference to the node to be processed

BugBearVisitor.__checkForM569

__checkForM569(node)

Private method to check for changes to a loop's mutable iterable.

node (ast.For)
loop node to be checked

BugBearVisitor.__checkRedundantExcepthandlers

__checkRedundantExcepthandlers(names, node)

Private method to check for redundant exception types in an exception handler.

names (list of ast.Name)
list of exception types to be checked
node (ast.ExceptionHandler)
reference to the exception handler node
Return:
tuple containing the error data
Return Type:
tuple of (ast.Node, str, str, str, str)

BugBearVisitor.__childrenInScope

__childrenInScope(node)

Private method to get all child nodes in the given scope.

node (ast.Node)
reference to the node to be processed
Yield:
reference to a child node
Yield Type:
ast.Node

BugBearVisitor.__composeCallPath

__composeCallPath(node)

Private method get the individual elements of the call path of a node.

node (ast.Node)
reference to the node
Yield:
one element of the call path
Yield Type:
ast.Node

BugBearVisitor.__flattenExcepthandler

__flattenExcepthandler(node)

Private method to flatten the list of exceptions handled by an except handler.

node (ast.Node)
reference to the node to be processed
Yield:
reference to the exception type node
Yield Type:
ast.Node

BugBearVisitor.__getAssignedNames

__getAssignedNames(loopNode)

Private method to get the names of a for loop.

loopNode (ast.For)
reference to the node to be processed
Yield:
DESCRIPTION
Yield Type:
TYPE

BugBearVisitor.__getDictCompLoopAndNamedExprVarNames

__getDictCompLoopAndNamedExprVarNames(node)

Private method to get the names of comprehension loop variables.

node (ast.DictComp)
ast node to be processed
Yield:
loop variable names
Yield Type:
str

BugBearVisitor.__getNamesFromTuple

__getNamesFromTuple(node)

Private method to get the names from an ast.Tuple node.

node (ast.Tuple)
ast node to be processed
Yield:
names
Yield Type:
str

BugBearVisitor.__inClassInit

__inClassInit()

Private method to check, if we are inside an '__init__' method.

Return:
flag indicating being within the '__init__' method
Return Type:
bool

BugBearVisitor.__isIdentifier

__isIdentifier(arg)

Private method to check if arg is a valid identifier.

See https://docs.python.org/2/reference/lexical_analysis.html#identifiers

arg (ast.Node)
reference to an argument node
Return:
flag indicating a valid identifier
Return Type:
TYPE

BugBearVisitor.__namesFromAssignments

__namesFromAssignments(assignTarget)

Private method to get names of an assignment.

assignTarget (ast.Node)
reference to the node to be processed
Yield:
name of the assignment
Yield Type:
str

BugBearVisitor.__typesafeIssubclass

__typesafeIssubclass(obj, classOrTuple)

Private method implementing a type safe issubclass() function.

obj (Any)
reference to the object to be tested
classOrTuple (type)
type to check against
Return:
flag indicating a subclass
Return Type:
bool

BugBearVisitor.__walkList

__walkList(nodes)

Private method to walk a given list of nodes.

nodes (list of ast.Node)
list of nodes to walk
Yield:
node references as determined by the ast.walk() function
Yield Type:
ast.Node

BugBearVisitor._loop

_loop(badNodeTypes)

BugBearVisitor.check

check(paramName)

BugBearVisitor.emptyBody

emptyBody()

BugBearVisitor.isAbcClass

isAbcClass(name="ABC")

BugBearVisitor.isAbstractDecorator

isAbstractDecorator()

BugBearVisitor.isOverload

isOverload()

BugBearVisitor.isStrOrEllipsis

isStrOrEllipsis()

BugBearVisitor.nodeStack

nodeStack()

Public method to get a reference to the most recent node stack.

Return:
reference to the most recent node stack
Return Type:
list

BugBearVisitor.toNameStr

toNameStr(node)

Public method to turn Name and Attribute nodes to strings, handling any depth of attribute accesses.

node (ast.Name or ast.Attribute)
reference to the node
Return:
string representation
Return Type:
str

BugBearVisitor.visit

visit(node)

Public method to traverse a given AST node.

node (ast.Node)
AST node to be traversed

BugBearVisitor.visit_AnnAssign

visit_AnnAssign(node)

Public method to check annotated assign statements.

node (ast.AnnAssign)
reference to the node to be processed

BugBearVisitor.visit_Assert

visit_Assert(node)

Public method to handle 'assert' statements.

node (ast.Assert)
reference to the node to be processed

BugBearVisitor.visit_Assign

visit_Assign(node)

Public method to handle assignments.

node (ast.Assign)
reference to the node to be processed

BugBearVisitor.visit_AsyncFor

visit_AsyncFor(node)

Public method to handle 'for' statements.

node (ast.AsyncFor)
reference to the node to be processed

BugBearVisitor.visit_Call

visit_Call(node)

Public method to handle a function call.

node (ast.Call)
reference to the node to be processed

BugBearVisitor.visit_ClassDef

visit_ClassDef(node)

Public method to handle class definitions.

node (ast.ClassDef)
reference to the node to be processed

BugBearVisitor.visit_Compare

visit_Compare(node)

Public method to handle comparison statements.

node (ast.Compare)
reference to the node to be processed

BugBearVisitor.visit_DictComp

visit_DictComp(node)

Public method to handle dictionary comprehensions.

node (ast.DictComp)
reference to the node to be processed

BugBearVisitor.visit_ExceptHandler

visit_ExceptHandler(node)

Public method to handle exception handlers.

node (ast.ExceptHandler)
reference to the node to be processed

BugBearVisitor.visit_For

visit_For(node)

Public method to handle 'for' statements.

node (ast.For)
reference to the node to be processed

BugBearVisitor.visit_FunctionDef

visit_FunctionDef(node)

Public method to handle function definitions.

node (ast.FunctionDef)
reference to the node to be processed

BugBearVisitor.visit_GeneratorExp

visit_GeneratorExp(node)

Public method to handle generator expressions.

node (ast.GeneratorExp)
reference to the node to be processed

BugBearVisitor.visit_Import

visit_Import(node)

Public method to check imports.

node (ast.Import)
reference to the node to be processed

BugBearVisitor.visit_ImportFrom

visit_ImportFrom(node)

Public method to check from imports.

node (ast.Import)
reference to the node to be processed

BugBearVisitor.visit_JoinedStr

visit_JoinedStr(node)

Public method to handle f-string arguments.

node (ast.JoinedStr)
reference to the node to be processed

BugBearVisitor.visit_ListComp

visit_ListComp(node)

Public method to handle list comprehensions.

node (ast.ListComp)
reference to the node to be processed

BugBearVisitor.visit_Module

visit_Module(node)

Public method to handle a module node.

node (ast.Module)
reference to the node to be processed

BugBearVisitor.visit_Raise

visit_Raise(node)

Public method to handle 'raise' statements.

node (ast.Raise)
reference to the node to be processed

BugBearVisitor.visit_Return

visit_Return(node)

Public method to handle 'Return' nodes.

node (ast.Return)
reference to the node to be processed

BugBearVisitor.visit_Set

visit_Set(node)

Public method to check a set.

node (ast.Set)
reference to the node to be processed

BugBearVisitor.visit_SetComp

visit_SetComp(node)

Public method to handle set comprehensions.

node (ast.SetComp)
reference to the node to be processed

BugBearVisitor.visit_Try

visit_Try(node)

Public method to handle 'try' statements'.

node (ast.Try)
reference to the node to be processed

BugBearVisitor.visit_UAdd

visit_UAdd(node)

Public method to handle unary additions.

node (ast.UAdd)
reference to the node to be processed

BugBearVisitor.visit_While

visit_While(node)

Public method to handle 'while' statements.

node (ast.While)
reference to the node to be processed

BugBearVisitor.visit_With

visit_With(node)

Public method to handle 'with' statements.

node (ast.With)
reference to the node to be processed

BugBearVisitor.visit_Yield

visit_Yield(node)

Public method to handle 'Yield' nodes.

node (ast.Yield)
reference to the node to be processed

BugBearVisitor.visit_YieldFrom

visit_YieldFrom(node)

Public method to handle 'YieldFrom' nodes.

node (ast.YieldFrom)
reference to the node to be processed
Up


DateTimeVisitor

Class implementing a node visitor to check datetime function calls.

Note: This class is modeled after flake8_datetimez checker.

Derived from

ast.NodeVisitor

Class Attributes

None

Class Methods

None

Methods

DateTimeVisitor Constructor
__getFromKeywords Private method to get a keyword node given its name.
visit_Call Public method to handle a function call.

Static Methods

None

DateTimeVisitor (Constructor)

DateTimeVisitor()

Constructor

DateTimeVisitor.__getFromKeywords

__getFromKeywords(keywords, name)

Private method to get a keyword node given its name.

keywords (list of ast.AST)
list of keyword argument nodes
name (str)
name of the keyword node
Return:
keyword node
Return Type:
ast.AST

DateTimeVisitor.visit_Call

visit_Call(node)

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).

node (ast.Call)
reference to the node to be processed
Up


ExceptBaseExceptionVisitor

Class to determine, if a 'BaseException' is re-raised.

Derived from

ast.NodeVisitor

Class Attributes

None

Class Methods

None

Methods

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.

Static Methods

None

ExceptBaseExceptionVisitor (Constructor)

ExceptBaseExceptionVisitor(exceptNode)

Constructor

exceptNode (ast.ExceptHandler)
exception node to be inspected

ExceptBaseExceptionVisitor.reRaised

reRaised()

Public method to check, if the exception is re-raised.

Return:
flag indicating a re-raised exception
Return Type:
bool

ExceptBaseExceptionVisitor.visit_ExceptHandler

visit_ExceptHandler(node: ast.ExceptHandler)

Public method to handle 'ExceptHandler' nodes.

node (ast.ExceptHandler)
reference to the node to be processed

ExceptBaseExceptionVisitor.visit_Raise

visit_Raise(node)

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.

node (ast.Raise)
reference to the node to be processed
Up


M520NameFinder

Class to extract a name out of a tree of nodes ignoring names defined within the local scope of a comprehension.

Derived from

NameFinder

Class Attributes

None

Class Methods

None

Methods

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.

Static Methods

None

M520NameFinder.visit_DictComp

visit_DictComp(node)

Public method to handle a dictionary comprehension.

node (TYPE)
reference to the node to be processed

M520NameFinder.visit_GeneratorExp

visit_GeneratorExp(node)

Public method to handle a generator expressions.

node (ast.GeneratorExp)
reference to the node to be processed

M520NameFinder.visit_Lambda

visit_Lambda(node)

Public method to handle a Lambda function.

node (ast.Lambda)
reference to the node to be processed

M520NameFinder.visit_ListComp

visit_ListComp(node)

Public method to handle a list comprehension.

node (TYPE)
reference to the node to be processed

M520NameFinder.visit_comprehension

visit_comprehension(node)

Public method to handle the 'for' of a comprehension.

node (ast.comprehension)
reference to the node to be processed
Up


M569Checker

Class traversing a 'for' loop body to check for modifications to a loop's mutable iterable.

Derived from

ast.NodeVisitor

Class Attributes

MUTATING_FUNCTIONS

Class Methods

None

Methods

M569Checker Constructor
visit Public method to inspect an ast node.
visit_Call Public method handling 'Call' nodes.
visit_Delete Public method handling 'Delete' nodes.

Static Methods

None

M569Checker (Constructor)

M569Checker(name, bugbear)

Constructor

name (str)
name of the iterator
bugbear (BugBearVisitor)
reference to the bugbear visitor

M569Checker.visit

visit(node)

Public method to inspect an ast node.

Like super-visit but supports iteration over lists.

node (TYPE)
AST node to be traversed
Return:
reference to the last processed node
Return Type:
ast.Node

M569Checker.visit_Call

visit_Call(node)

Public method handling 'Call' nodes.

node (ast.Call)
reference to the node to be processed

M569Checker.visit_Delete

visit_Delete(node)

Public method handling 'Delete' nodes.

node (ast.Delete)
reference to the node to be processed
Up


MiscellaneousChecker

Class implementing a checker for miscellaneous checks.

Derived from

None

Class Attributes

BuiltinsWhiteList
Codes
FormatFieldRegex
Formatter

Class Methods

None

Methods

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.

Static Methods

None

MiscellaneousChecker (Constructor)

MiscellaneousChecker(source, filename, tree, select, ignore, expected, repeat, args)

Constructor

source (list of str)
source code to be checked
filename (str)
name of the source file
tree (ast.Module)
AST tree of the source code
select (list of str)
list of selected codes
ignore (list of str)
list of codes to be ignored
expected (list of str)
list of expected codes
repeat (bool)
flag indicating to report each occurrence of a code
args (dict)
dictionary of arguments for the miscellaneous checks

MiscellaneousChecker.__checkBugBear

__checkBugBear()

Private method for bugbear checks.

MiscellaneousChecker.__checkBuiltins

__checkBuiltins()

Private method to check, if built-ins are shadowed.

MiscellaneousChecker.__checkCoding

__checkCoding()

Private method to check the presence of a coding line and valid encodings.

MiscellaneousChecker.__checkCommentedCode

__checkCommentedCode()

Private method to check for commented code.

MiscellaneousChecker.__checkComprehensions

__checkComprehensions()

Private method to check some comprehension related things.

This method is adapted from: flake8-comprehensions v3.14.0 Original: Copyright (c) 2017 Adam Johnson

MiscellaneousChecker.__checkCopyright

__checkCopyright()

Private method to check the presence of a copyright statement.

MiscellaneousChecker.__checkDateTime

__checkDateTime()

Private method to check use of naive datetime functions.

MiscellaneousChecker.__checkDictWithSortedKeys

__checkDictWithSortedKeys()

Private method to check, if dictionary keys appear in sorted order.

MiscellaneousChecker.__checkExplicitStringConcat

__checkExplicitStringConcat()

Private method to check for explicitly concatenated strings.

MiscellaneousChecker.__checkFormatString

__checkFormatString()

Private method to check string format strings.

MiscellaneousChecker.__checkFuture

__checkFuture()

Private method to check the __future__ imports.

MiscellaneousChecker.__checkGettext

__checkGettext()

Private method to check the 'gettext' import statement.

MiscellaneousChecker.__checkImplicitStringConcat

__checkImplicitStringConcat()

Private method to check for implicitly concatenated strings.

MiscellaneousChecker.__checkLineContinuation

__checkLineContinuation()

Private method to check line continuation using backslash.

MiscellaneousChecker.__checkMutableDefault

__checkMutableDefault()

Private method to check for use of mutable types as default arguments.

MiscellaneousChecker.__checkPep3101

__checkPep3101()

Private method to check for old style string formatting.

MiscellaneousChecker.__checkPrintStatements

__checkPrintStatements()

Private method to check for print statements.

MiscellaneousChecker.__checkProperties

__checkProperties()

Private method to check for issue with property related methods.

MiscellaneousChecker.__checkReturn

__checkReturn()

Private method to check return statements.

MiscellaneousChecker.__checkSysVersion

__checkSysVersion()

Private method to check the use of sys.version and sys.version_info.

MiscellaneousChecker.__checkTuple

__checkTuple()

Private method to check for one element tuples.

MiscellaneousChecker.__dictShouldBeChecked

__dictShouldBeChecked(node)

Private function to test, if the node should be checked.

node (ast.Dict)
reference to the AST node
Return:
flag indicating to check the node
Return Type:
bool

MiscellaneousChecker.__error

__error(lineNumber, offset, code, *args)

Private method to record an issue.

lineNumber (int)
line number of the issue
offset (int)
position within line of the issue
code (str)
message code
args (list)
arguments for the message

MiscellaneousChecker.__getCoding

__getCoding()

Private method to get the defined coding of the source.

Return:
tuple containing the line number and the coding
Return Type:
tuple of int and str

MiscellaneousChecker.__getFields

__getFields(string)

Private method to extract the format field information.

string (str)
format string to be parsed
Return:
format field information as a tuple with fields, implicit field definitions present and explicit field definitions present
Return Type:
tuple of set of str, bool, bool

MiscellaneousChecker.__ignoreCode

__ignoreCode(code)

Private method to check if the message code should be ignored.

code (str)
message code to check for
Return:
flag indicating to ignore the given code
Return Type:
bool

MiscellaneousChecker.__isImplicitStringConcat

__isImplicitStringConcat(first, second)

Private method to check, if the given strings indicate an implicit string concatenation.

first (tuple)
first token
second (tuple)
second token
Return:
flag indicating an implicit string concatenation
Return Type:
bool

MiscellaneousChecker.run

run()

Public method to check the given source against miscellaneous conditions.

Up


NameFinder

Class to extract a name out of a tree of nodes.

Derived from

ast.NodeVisitor

Class Attributes

None

Class Methods

None

Methods

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.

Static Methods

None

NameFinder (Constructor)

NameFinder()

Constructor

NameFinder.getNames

getNames()

Public method to return the extracted names and Name nodes.

Return:
dictionary containing the names as keys and the list of nodes
Return Type:
dict

NameFinder.visit

visit(node)

Public method to traverse a given AST node.

node (ast.Node)
AST node to be traversed
Return:
reference to the last processed node
Return Type:
ast.Node

NameFinder.visit_Name

visit_Name(node)

Public method to handle 'Name' nodes.

node (ast.Name)
reference to the node to be processed
Up


NamedExprFinder

Class to extract names defined through an ast.NamedExpr.

Derived from

ast.NodeVisitor

Class Attributes

None

Class Methods

None

Methods

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.

Static Methods

None

NamedExprFinder (Constructor)

NamedExprFinder()

Constructor

NamedExprFinder.getNames

getNames()

Public method to return the extracted names and Name nodes.

Return:
dictionary containing the names as keys and the list of nodes
Return Type:
dict

NamedExprFinder.visit

visit(node)

Public method to traverse a given AST node.

Like super-visit but supports iteration over lists.

node (TYPE)
AST node to be traversed
Return:
reference to the last processed node
Return Type:
ast.Node

NamedExprFinder.visit_NamedExpr

visit_NamedExpr(node: ast.NamedExpr)

Public method handling 'NamedExpr' nodes.

node (ast.NamedExpr)
reference to the node to be processed
Up


ReturnVisitor

Class implementing a node visitor to check return statements.

Derived from

ast.NodeVisitor

Class Attributes

Assigns
Refs
Returns

Class Methods

None

Methods

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.

Static Methods

None

ReturnVisitor (Constructor)

ReturnVisitor()

Constructor

ReturnVisitor.__checkFunction

__checkFunction(node)

Private method to check a function definition node.

node (ast.AsyncFunctionDef or ast.FunctionDef)
reference to the node to check

ReturnVisitor.__checkImplicitReturn

__checkImplicitReturn(node)

Private method to check for an implicit return statement.

node (ast.AST)
reference to the node to check

ReturnVisitor.__checkImplicitReturnValue

__checkImplicitReturnValue()

Private method to check for implicit return values.

ReturnVisitor.__checkUnnecessaryAssign

__checkUnnecessaryAssign(node)

Private method to check for an unnecessary assign statement.

node (ast.AST)
reference to the node to check

ReturnVisitor.__checkUnnecessaryReturnNone

__checkUnnecessaryReturnNone()

Private method to check for an unnecessary 'return None' statement.

ReturnVisitor.__hasRefsBeforeNextAssign

__hasRefsBeforeNextAssign(varname, returnLineno)

Private method to check for references before a following assign statement.

varname (str)
variable name to check for
returnLineno (int)
line number of the return statement
Return:
flag indicating the existence of references
Return Type:
bool

ReturnVisitor.__isFalse

__isFalse(node)

Private method to check, if a node value is False.

node (ast.AST)
reference to the node to check
Return:
flag indicating the node contains a False value
Return Type:
bool

ReturnVisitor.__isNone

__isNone(node)

Private method to check, if a node value is None.

node (ast.AST)
reference to the node to check
Return:
flag indicating the node contains a None value
Return Type:
bool

ReturnVisitor.__resultExists

__resultExists()

Private method to check the existance of a return result.

Return:
flag indicating the existence of a return result
Return Type:
bool

ReturnVisitor.__visitAssignTarget

__visitAssignTarget(node)

Private method to handle an assign target node.

node (ast.AST)
reference to the node to handle

ReturnVisitor.__visitLoop

__visitLoop(node)

Private method to handle loop nodes.

node (ast.For, ast.AsyncFor or ast.While)
reference to the loop node to handle

ReturnVisitor.__visitWithStack

__visitWithStack(node)

Private method to traverse a given function node using a stack.

node (ast.FunctionDef or ast.AsyncFunctionDef)
AST node to be traversed

ReturnVisitor.assigns

assigns()

Public method to get the Assign nodes.

Return:
dictionary containing the node name as key and line number as value
Return Type:
dict

ReturnVisitor.refs

refs()

Public method to get the References nodes.

Return:
dictionary containing the node name as key and line number as value
Return Type:
dict

ReturnVisitor.returns

returns()

Public method to get the Return nodes.

Return:
dictionary containing the node name as key and line number as value
Return Type:
dict

ReturnVisitor.visit_Assign

visit_Assign(node)

Public method to handle an assign node.

node (ast.Assign)
reference to the node to handle

ReturnVisitor.visit_AsyncFor

visit_AsyncFor(node)

Public method to handle an async for loop.

node (ast.AsyncFor)
reference to the async for node to handle

ReturnVisitor.visit_AsyncFunctionDef

visit_AsyncFunctionDef(node)

Public method to handle a function definition.

node (ast.AsyncFunctionDef)
reference to the node to handle

ReturnVisitor.visit_For

visit_For(node)

Public method to handle a for loop.

node (ast.For)
reference to the for node to handle

ReturnVisitor.visit_FunctionDef

visit_FunctionDef(node)

Public method to handle a function definition.

node (ast.FunctionDef)
reference to the node to handle

ReturnVisitor.visit_Name

visit_Name(node)

Public method to handle a name node.

node (ast.Name)
reference to the node to handle

ReturnVisitor.visit_Return

visit_Return(node)

Public method to handle a return node.

node (ast.Return)
reference to the node to handle

ReturnVisitor.visit_While

visit_While(node)

Public method to handle a while loop.

node (ast.While)
reference to the while node to handle
Up


SysVersionVisitor

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.

Derived from

ast.NodeVisitor

Class Attributes

None

Class Methods

None

Methods

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.

Static Methods

None

SysVersionVisitor (Constructor)

SysVersionVisitor()

Constructor

SysVersionVisitor.__isSys

__isSys(attr, node)

Private method to check for a reference to sys attribute.

attr (str)
attribute name
node (ast.Node)
reference to the node to be checked
Return:
flag indicating a match
Return Type:
bool

SysVersionVisitor.__isSysVersionUpperSlice

__isSysVersionUpperSlice(node, n)

Private method to check the upper slice of sys.version.

node (ast.Node)
reference to the node to be checked
n (int)
slice value to check against
Return:
flag indicating a match
Return Type:
bool

SysVersionVisitor.visit_Attribute

visit_Attribute(node)

Public method to handle an attribute.

node (ast.Attribute)
reference to the node to be processed

SysVersionVisitor.visit_Compare

visit_Compare(node)

Public method to handle a comparison.

node (ast.Compare)
reference to the node to be processed

SysVersionVisitor.visit_ImportFrom

visit_ImportFrom(node)

Public method to handle a from ... import ... statement.

node (ast.ImportFrom)
reference to the node to be processed

SysVersionVisitor.visit_Name

visit_Name(node)

Public method to handle an name.

node (ast.Name)
reference to the node to be processed

SysVersionVisitor.visit_Subscript

visit_Subscript(node)

Public method to handle a subscript.

node (ast.Subscript)
reference to the node to be processed
Up


TextVisitor

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.

Derived from

ast.NodeVisitor

Class Attributes

None

Class Methods

None

Methods

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.

Static Methods

None

TextVisitor (Constructor)

TextVisitor()

Constructor

TextVisitor.__addNode

__addNode(node)

Private method to add a node to our list of nodes.

node (ast.AST)
reference to the node to add

TextVisitor.__visitBody

__visitBody(node)

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.

node (ast.AST)
reference to the node to traverse

TextVisitor.__visitDefinition

__visitDefinition(node)

Private method handling class and function definitions.

node (ast.FunctionDef, ast.AsyncFunctionDef or ast.ClassDef)
reference to the node to handle

TextVisitor.visit_AsyncFunctionDef

visit_AsyncFunctionDef(node)

Public method to handle an asynchronous function definition.

node (ast.AsyncFunctionDef)
reference to the node to handle

TextVisitor.visit_Call

visit_Call(node)

Public method to handle a function call.

node (ast.Call)
reference to the node to handle

TextVisitor.visit_ClassDef

visit_ClassDef(node)

Public method to handle a class definition.

node (ast.ClassDef)
reference to the node to handle

TextVisitor.visit_Constant

visit_Constant(node)

Public method to handle constant nodes.

node (ast.Constant)
reference to the bytes node

TextVisitor.visit_FunctionDef

visit_FunctionDef(node)

Public method to handle a function definition.

node (ast.FunctionDef)
reference to the node to handle

TextVisitor.visit_Module

visit_Module(node)

Public method to handle a module.

node (ast.Module)
reference to the node to handle
Up


composeCallPath

composeCallPath(node)

Generator function to assemble the call path of a given node.

node (ast.Node)
node to assemble call path for
Yield:
call path components
Yield Type:
str
Up


pairwise

pairwise(iterable)
Up