eric: comparison src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html

-:de9106c55c3d
+:856476537696
 <link rel="stylesheet" href="styles.css">
 </head>
 <body>
 <a NAME="top" ID="top"></a>
 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker</h1>
 <p>
 Module implementing a checker for miscellaneous checks.
 </p>
 <h3>Global Attributes</h3>
 <table>
 <tr><td>BugBearContext</td></tr>
 </table>
 <h3>Classes</h3>
+<table>
-<table>
 <tr>
 <td><a href="#BugBearVisitor">BugBearVisitor</a></td>
 <td>Class implementing a node visitor to check for various topics.</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#TextVisitor">TextVisitor</a></td>
 <td>Class implementing a node visitor for bytes and str instances.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+<table>
-<table>
 <tr>
 <td><a href="#composeCallPath">composeCallPath</a></td>
 <td>Generator function to assemble the call path of a given node.</td>
 </tr>
 <tr>
 <td><a href="#pairwise">pairwise</a></td>
 <td></td>
 </tr>
 </table>
 <hr />
 <hr />
 <a NAME="BugBearVisitor" ID="BugBearVisitor"></a>
 <h2>BugBearVisitor</h2>
 <p>
 Class implementing a node visitor to check for various topics.
 </p>
 <h3>Derived from</h3>
 ast.NodeVisitor
 <h3>Class Attributes</h3>
+<table>
-<table>
+<tr><td>CONTEXTFUL_NODES</td></tr>
-<tr><td>CONTEXTFUL_NODES</td></tr><tr><td>FUNCTION_NODES</td></tr><tr><td>NodeWindowSize</td></tr>
+<tr><td>FUNCTION_NODES</td></tr>
-</table>
+<tr><td>NodeWindowSize</td></tr>
+</table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+<table>
-<table>
 <tr>
 <td><a href="#BugBearVisitor.__init__">BugBearVisitor</a></td>
 <td>Constructor</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#BugBearVisitor.visit_With">visit_With</a></td>
 <td>Public method to handle 'with' statements.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="BugBearVisitor.__init__" ID="BugBearVisitor.__init__"></a>
 <h4>BugBearVisitor (Constructor)</h4>
 <b>BugBearVisitor</b>(<i></i>)
 <p>
 Constructor
 </p>
 <a NAME="BugBearVisitor.__checkForM505" ID="BugBearVisitor.__checkForM505"></a>
 <h4>BugBearVisitor.__checkForM505</h4>
 <b>__checkForM505</b>(<i>node</i>)
 <p>
 Private method to check the use of *strip().
 </p>
 <dl>
 <dt><i>node</i> (ast.Call)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM507" ID="BugBearVisitor.__checkForM507"></a>
 <h4>BugBearVisitor.__checkForM507</h4>
 <b>__checkForM507</b>(<i>node</i>)
 <p>
 Private method to check for unused loop variables.
 </p>
 <dl>
 <dt><i>node</i> (ast.For or ast.AsyncFor)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM512" ID="BugBearVisitor.__checkForM512"></a>
 <h4>BugBearVisitor.__checkForM512</h4>
 <b>__checkForM512</b>(<i>node</i>)
 <p>
 Private method to check for return/continue/break inside finally blocks.
 </p>
 <dl>
 <dt><i>node</i> (ast.Try)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM515" ID="BugBearVisitor.__checkForM515"></a>
 <h4>BugBearVisitor.__checkForM515</h4>
 <b>__checkForM515</b>(<i>node</i>)
 <p>
 Private method to check for pointless comparisons.
 </p>
 <dl>
 <dt><i>node</i> (ast.Compare)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM516" ID="BugBearVisitor.__checkForM516"></a>
 <h4>BugBearVisitor.__checkForM516</h4>
 <b>__checkForM516</b>(<i>node</i>)
 <p>
 Private method to check for raising a literal instead of an exception.
 </p>
 <dl>
 <dt><i>node</i> (ast.Raise)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM517" ID="BugBearVisitor.__checkForM517"></a>
 <h4>BugBearVisitor.__checkForM517</h4>
 <b>__checkForM517</b>(<i>node</i>)
 <p>
 Private method to check for use of the evil syntax
 'with assertRaises(Exception): or 'with pytest.raises(Exception):'.
 </p>
 <dl>
 <dt><i>node</i> (ast.With)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM518" ID="BugBearVisitor.__checkForM518"></a>
 <h4>BugBearVisitor.__checkForM518</h4>
 <b>__checkForM518</b>(<i>node</i>)
 <p>
 Private method to check for useless expressions.
 </p>
 <dl>
 <dt><i>node</i> (ast.FunctionDef)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM519" ID="BugBearVisitor.__checkForM519"></a>
 <h4>BugBearVisitor.__checkForM519</h4>
 <b>__checkForM519</b>(<i>node</i>)
 <p>
 Private method to check for use of 'functools.lru_cache' or 'functools.cache'.
 </p>
 <dl>
 <dt><i>node</i> (ast.FunctionDef)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM520" ID="BugBearVisitor.__checkForM520"></a>
 <h4>BugBearVisitor.__checkForM520</h4>
 <b>__checkForM520</b>(<i>node</i>)
 <p>
 Private method to check for a loop that modifies its iterable.
 </p>
 <dl>
 <dt><i>node</i> (ast.For or ast.AsyncFor)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM521" ID="BugBearVisitor.__checkForM521"></a>
 <h4>BugBearVisitor.__checkForM521</h4>
 <b>__checkForM521</b>(<i>node</i>)
 <p>
 Private method to check for use of an f-string as docstring.
 </p>
 <dl>
 <dt><i>node</i> (ast.FunctionDef or ast.ClassDef)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM522" ID="BugBearVisitor.__checkForM522"></a>
 <h4>BugBearVisitor.__checkForM522</h4>
 <b>__checkForM522</b>(<i>node</i>)
 <p>
 Private method to check for use of an f-string as docstring.
 </p>
 <dl>
 <dt><i>node</i> (ast.With)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM523" ID="BugBearVisitor.__checkForM523"></a>
 <h4>BugBearVisitor.__checkForM523</h4>
 <b>__checkForM523</b>(<i>loopNode</i>)
 <p>
 Private method to check that functions (including lambdas) do not use loop
 variables.
 </p>
 <dl>
 <dt><i>loopNode</i> (ast.For, ast.AsyncFor, ast.While, ast.ListComp, ast.SetComp,ast.DictComp,)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM524AndM527" ID="BugBearVisitor.__checkForM524AndM527"></a>
 <h4>BugBearVisitor.__checkForM524AndM527</h4>
 <b>__checkForM524AndM527</b>(<i>node</i>)
 <p>
 Private method to check for inheritance from abstract classes in abc and lack of
 any methods decorated with abstract*.
 </p>
 <dl>
 <dt><i>node</i> (ast.ClassDef)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM525" ID="BugBearVisitor.__checkForM525"></a>
 <h4>BugBearVisitor.__checkForM525</h4>
 <b>__checkForM525</b>(<i>node</i>)
 <p>
 Private method to check for exceptions being handled multiple times.
 </p>
 <dl>
 <dt><i>node</i> (ast.Try)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM526" ID="BugBearVisitor.__checkForM526"></a>
 <h4>BugBearVisitor.__checkForM526</h4>
 <b>__checkForM526</b>(<i>node</i>)
 <p>
 Private method to check for Star-arg unpacking after keyword argument.
 </p>
 <dl>
 <dt><i>node</i> (ast.Call)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM528" ID="BugBearVisitor.__checkForM528"></a>
 <h4>BugBearVisitor.__checkForM528</h4>
 <b>__checkForM528</b>(<i>node</i>)
 <p>
 Private method to check for warn without stacklevel.
 </p>
 <dl>
 <dt><i>node</i> (ast.Call)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM531" ID="BugBearVisitor.__checkForM531"></a>
 <h4>BugBearVisitor.__checkForM531</h4>
 <b>__checkForM531</b>(<i>loopNode</i>)
 <p>
 Private method to check that 'itertools.groupby' isn't iterated over more than
 once.
 </p>
 <p>
 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.
 </p>
 <dl>
 <dt><i>loopNode</i> (ast.For or ast.AsyncFor)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM532" ID="BugBearVisitor.__checkForM532"></a>
 <h4>BugBearVisitor.__checkForM532</h4>
 <b>__checkForM532</b>(<i>node</i>)
 <p>
 Private method to check for possible unintentional typing annotation.
 </p>
 <dl>
 <dt><i>node</i> (ast.AnnAssign)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM533" ID="BugBearVisitor.__checkForM533"></a>
 <h4>BugBearVisitor.__checkForM533</h4>
 <b>__checkForM533</b>(<i>node</i>)
 <p>
 Private method to check a set for duplicate items.
 </p>
 <dl>
 <dt><i>node</i> (ast.Set)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM534" ID="BugBearVisitor.__checkForM534"></a>
 <h4>BugBearVisitor.__checkForM534</h4>
 <b>__checkForM534</b>(<i>node</i>)
 <p>
 Private method to check that re.sub/subn/split arguments flags/count/maxsplit
 are passed as keyword arguments.
 </p>
 <dl>
 <dt><i>node</i> (ast.Call)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkForM535" ID="BugBearVisitor.__checkForM535"></a>
 <h4>BugBearVisitor.__checkForM535</h4>
 <b>__checkForM535</b>(<i>node: ast.DictComp</i>)
 <p>
 Private method to check that a static key isn't used in a dict comprehension.
 </p>
 <p>
 Record a warning if a likely unchanging key is used - either a constant,
 or a variable that isn't coming from the generator expression.
 </p>
 <dl>
 <dt><i>node</i> (ast.DictComp)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__checkRedundantExcepthandlers" ID="BugBearVisitor.__checkRedundantExcepthandlers"></a>
 <h4>BugBearVisitor.__checkRedundantExcepthandlers</h4>
 <b>__checkRedundantExcepthandlers</b>(<i>names, node</i>)
 <p>
 Private method to check for redundant exception types in an exception handler.
 </p>
 <dl>
 <dt><i>names</i> (list of ast.Name)</dt>
 <dd>
 list of exception types to be checked
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__childrenInScope" ID="BugBearVisitor.__childrenInScope"></a>
 <h4>BugBearVisitor.__childrenInScope</h4>
 <b>__childrenInScope</b>(<i>node</i>)
 <p>
 Private method to get all child nodes in the given scope.
 </p>
 <dl>
 <dt><i>node</i> (ast.Node)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__composeCallPath" ID="BugBearVisitor.__composeCallPath"></a>
 <h4>BugBearVisitor.__composeCallPath</h4>
 <b>__composeCallPath</b>(<i>node</i>)
 <p>
 Private method get the individual elements of the call path of a node.
 </p>
 <dl>
 <dt><i>node</i> (ast.Node)</dt>
 <dd>
 reference to the node
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__flattenExcepthandler" ID="BugBearVisitor.__flattenExcepthandler"></a>
 <h4>BugBearVisitor.__flattenExcepthandler</h4>
 <b>__flattenExcepthandler</b>(<i>node</i>)
 <p>
 Private method to flatten the list of exceptions handled by an except handler.
 </p>
 <dl>
 <dt><i>node</i> (ast.Node)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__getAssignedNames" ID="BugBearVisitor.__getAssignedNames"></a>
 <h4>BugBearVisitor.__getAssignedNames</h4>
 <b>__getAssignedNames</b>(<i>loopNode</i>)
 <p>
 Private method to get the names of a for loop.
 </p>
 <dl>
 <dt><i>loopNode</i> (ast.For)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__getDictCompLoopVarNames" ID="BugBearVisitor.__getDictCompLoopVarNames"></a>
 <h4>BugBearVisitor.__getDictCompLoopVarNames</h4>
 <b>__getDictCompLoopVarNames</b>(<i>node</i>)
 <p>
 Private method to get the names of comprehension loop variables.
 </p>
 <dl>
 <dt><i>node</i> (ast.DictComp)</dt>
 <dd>
 ast node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__getNamesFromTuple" ID="BugBearVisitor.__getNamesFromTuple"></a>
 <h4>BugBearVisitor.__getNamesFromTuple</h4>
 <b>__getNamesFromTuple</b>(<i>node</i>)
 <p>
 Private method to get the names from an ast.Tuple node.
 </p>
 <dl>
 <dt><i>node</i> (ast.Tuple)</dt>
 <dd>
 ast node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__isIdentifier" ID="BugBearVisitor.__isIdentifier"></a>
 <h4>BugBearVisitor.__isIdentifier</h4>
 <b>__isIdentifier</b>(<i>arg</i>)
 <p>
 Private method to check if arg is a valid identifier.
 </p>
 <p>
 See https://docs.python.org/2/reference/lexical_analysis.html#identifiers
 </p>
 <dl>
 <dt><i>arg</i> (ast.Node)</dt>
 <dd>
 reference to an argument node
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__namesFromAssignments" ID="BugBearVisitor.__namesFromAssignments"></a>
 <h4>BugBearVisitor.__namesFromAssignments</h4>
 <b>__namesFromAssignments</b>(<i>assignTarget</i>)
 <p>
 Private method to get names of an assignment.
 </p>
 <dl>
 <dt><i>assignTarget</i> (ast.Node)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__toNameStr" ID="BugBearVisitor.__toNameStr"></a>
 <h4>BugBearVisitor.__toNameStr</h4>
 <b>__toNameStr</b>(<i>node</i>)
 <p>
 Private method to turn Name and Attribute nodes to strings, handling any
 depth of attribute accesses.
 </p>
 <p>
 </p>
 <dl>
 <dt><i>node</i> (ast.Name or ast.Attribute)</dt>
 <dd>
 reference to the node
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__typesafeIssubclass" ID="BugBearVisitor.__typesafeIssubclass"></a>
 <h4>BugBearVisitor.__typesafeIssubclass</h4>
 <b>__typesafeIssubclass</b>(<i>obj, classOrTuple</i>)
 <p>
 Private method implementing a type safe issubclass() function.
 </p>
 <dl>
 <dt><i>obj</i> (Any)</dt>
 <dd>
 reference to the object to be tested
 </dd>
 </dl>
 <a NAME="BugBearVisitor.__walkList" ID="BugBearVisitor.__walkList"></a>
 <h4>BugBearVisitor.__walkList</h4>
 <b>__walkList</b>(<i>nodes</i>)
 <p>
 Private method to walk a given list of nodes.
 </p>
 <dl>
 <dt><i>nodes</i> (list of ast.Node)</dt>
 <dd>
 list of nodes to walk
 <b>isStrOrEllipsis</b>(<i></i>)
 <a NAME="BugBearVisitor.nodeStack" ID="BugBearVisitor.nodeStack"></a>
 <h4>BugBearVisitor.nodeStack</h4>
 <b>nodeStack</b>(<i></i>)
 <p>
 Public method to get a reference to the most recent node stack.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 reference to the most recent node stack
 </dd>
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit" ID="BugBearVisitor.visit"></a>
 <h4>BugBearVisitor.visit</h4>
 <b>visit</b>(<i>node</i>)
 <p>
 Public method to traverse a given AST node.
 </p>
 <dl>
 <dt><i>node</i> (ast.Node)</dt>
 <dd>
 AST node to be traversed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_AnnAssign" ID="BugBearVisitor.visit_AnnAssign"></a>
 <h4>BugBearVisitor.visit_AnnAssign</h4>
 <b>visit_AnnAssign</b>(<i>node</i>)
 <p>
 Public method to check annotated assign statements.
 </p>
 <dl>
 <dt><i>node</i> (ast.AnnAssign)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_Assert" ID="BugBearVisitor.visit_Assert"></a>
 <h4>BugBearVisitor.visit_Assert</h4>
 <b>visit_Assert</b>(<i>node</i>)
 <p>
 Public method to handle 'assert' statements.
 </p>
 <dl>
 <dt><i>node</i> (ast.Assert)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_Assign" ID="BugBearVisitor.visit_Assign"></a>
 <h4>BugBearVisitor.visit_Assign</h4>
 <b>visit_Assign</b>(<i>node</i>)
 <p>
 Public method to handle assignments.
 </p>
 <dl>
 <dt><i>node</i> (ast.Assign)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_AsyncFor" ID="BugBearVisitor.visit_AsyncFor"></a>
 <h4>BugBearVisitor.visit_AsyncFor</h4>
 <b>visit_AsyncFor</b>(<i>node</i>)
 <p>
 Public method to handle 'for' statements.
 </p>
 <dl>
 <dt><i>node</i> (ast.AsyncFor)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_Call" ID="BugBearVisitor.visit_Call"></a>
 <h4>BugBearVisitor.visit_Call</h4>
 <b>visit_Call</b>(<i>node</i>)
 <p>
 Public method to handle a function call.
 </p>
 <dl>
 <dt><i>node</i> (ast.Call)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_ClassDef" ID="BugBearVisitor.visit_ClassDef"></a>
 <h4>BugBearVisitor.visit_ClassDef</h4>
 <b>visit_ClassDef</b>(<i>node</i>)
 <p>
 Public method to handle class definitions.
 </p>
 <dl>
 <dt><i>node</i> (ast.ClassDef)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_Compare" ID="BugBearVisitor.visit_Compare"></a>
 <h4>BugBearVisitor.visit_Compare</h4>
 <b>visit_Compare</b>(<i>node</i>)
 <p>
 Public method to handle comparison statements.
 </p>
 <dl>
 <dt><i>node</i> (ast.Compare)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_DictComp" ID="BugBearVisitor.visit_DictComp"></a>
 <h4>BugBearVisitor.visit_DictComp</h4>
 <b>visit_DictComp</b>(<i>node</i>)
 <p>
 Public method to handle dictionary comprehensions.
 </p>
 <dl>
 <dt><i>node</i> (ast.DictComp)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_ExceptHandler" ID="BugBearVisitor.visit_ExceptHandler"></a>
 <h4>BugBearVisitor.visit_ExceptHandler</h4>
 <b>visit_ExceptHandler</b>(<i>node</i>)
 <p>
 Public method to handle exception handlers.
 </p>
 <dl>
 <dt><i>node</i> (ast.ExceptHandler)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_For" ID="BugBearVisitor.visit_For"></a>
 <h4>BugBearVisitor.visit_For</h4>
 <b>visit_For</b>(<i>node</i>)
 <p>
 Public method to handle 'for' statements.
 </p>
 <dl>
 <dt><i>node</i> (ast.For)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_FunctionDef" ID="BugBearVisitor.visit_FunctionDef"></a>
 <h4>BugBearVisitor.visit_FunctionDef</h4>
 <b>visit_FunctionDef</b>(<i>node</i>)
 <p>
 Public method to handle function definitions.
 </p>
 <dl>
 <dt><i>node</i> (ast.FunctionDef)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_GeneratorExp" ID="BugBearVisitor.visit_GeneratorExp"></a>
 <h4>BugBearVisitor.visit_GeneratorExp</h4>
 <b>visit_GeneratorExp</b>(<i>node</i>)
 <p>
 Public method to handle generator expressions.
 </p>
 <dl>
 <dt><i>node</i> (ast.GeneratorExp)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_Import" ID="BugBearVisitor.visit_Import"></a>
 <h4>BugBearVisitor.visit_Import</h4>
 <b>visit_Import</b>(<i>node</i>)
 <p>
 Public method to check imports.
 </p>
 <dl>
 <dt><i>node</i> (ast.Import)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_ImportFrom" ID="BugBearVisitor.visit_ImportFrom"></a>
 <h4>BugBearVisitor.visit_ImportFrom</h4>
 <b>visit_ImportFrom</b>(<i>node</i>)
 <p>
 Public method to check from imports.
 </p>
 <dl>
 <dt><i>node</i> (ast.Import)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_JoinedStr" ID="BugBearVisitor.visit_JoinedStr"></a>
 <h4>BugBearVisitor.visit_JoinedStr</h4>
 <b>visit_JoinedStr</b>(<i>node</i>)
 <p>
 Public method to handle f-string arguments.
 </p>
 <dl>
 <dt><i>node</i> (ast.JoinedStr)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_ListComp" ID="BugBearVisitor.visit_ListComp"></a>
 <h4>BugBearVisitor.visit_ListComp</h4>
 <b>visit_ListComp</b>(<i>node</i>)
 <p>
 Public method to handle list comprehensions.
 </p>
 <dl>
 <dt><i>node</i> (ast.ListComp)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_Module" ID="BugBearVisitor.visit_Module"></a>
 <h4>BugBearVisitor.visit_Module</h4>
 <b>visit_Module</b>(<i>node</i>)
 <p>
 Public method to handle a module node.
 </p>
 <dl>
 <dt><i>node</i> (ast.Module)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_Raise" ID="BugBearVisitor.visit_Raise"></a>
 <h4>BugBearVisitor.visit_Raise</h4>
 <b>visit_Raise</b>(<i>node</i>)
 <p>
 Public method to handle 'raise' statements.
 </p>
 <dl>
 <dt><i>node</i> (ast.Raise)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_Set" ID="BugBearVisitor.visit_Set"></a>
 <h4>BugBearVisitor.visit_Set</h4>
 <b>visit_Set</b>(<i>node</i>)
 <p>
 Public method to check a set.
 </p>
 <dl>
 <dt><i>node</i> (ast.Set)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_SetComp" ID="BugBearVisitor.visit_SetComp"></a>
 <h4>BugBearVisitor.visit_SetComp</h4>
 <b>visit_SetComp</b>(<i>node</i>)
 <p>
 Public method to handle set comprehensions.
 </p>
 <dl>
 <dt><i>node</i> (ast.SetComp)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_Try" ID="BugBearVisitor.visit_Try"></a>
 <h4>BugBearVisitor.visit_Try</h4>
 <b>visit_Try</b>(<i>node</i>)
 <p>
 Public method to handle 'try' statements'.
 </p>
 <dl>
 <dt><i>node</i> (ast.Try)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_UAdd" ID="BugBearVisitor.visit_UAdd"></a>
 <h4>BugBearVisitor.visit_UAdd</h4>
 <b>visit_UAdd</b>(<i>node</i>)
 <p>
 Public method to handle unary additions.
 </p>
 <dl>
 <dt><i>node</i> (ast.UAdd)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_While" ID="BugBearVisitor.visit_While"></a>
 <h4>BugBearVisitor.visit_While</h4>
 <b>visit_While</b>(<i>node</i>)
 <p>
 Public method to handle 'while' statements.
 </p>
 <dl>
 <dt><i>node</i> (ast.While)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="BugBearVisitor.visit_With" ID="BugBearVisitor.visit_With"></a>
 <h4>BugBearVisitor.visit_With</h4>
 <b>visit_With</b>(<i>node</i>)
 <p>
 Public method to handle 'with' statements.
 </p>
 <dl>
 <dt><i>node</i> (ast.With)</dt>
 <dd>
 reference to the node to be processed
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="DateTimeVisitor" ID="DateTimeVisitor"></a>
 <h2>DateTimeVisitor</h2>
 <p>
 Class implementing a node visitor to check datetime function calls.
 </p>
 <p>
 Note: This class is modeled after flake8_datetimez checker.
 </p>
 <h3>Derived from</h3>
 ast.NodeVisitor
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+<table>
-<table>
 <tr>
 <td><a href="#DateTimeVisitor.__init__">DateTimeVisitor</a></td>
 <td>Constructor</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#DateTimeVisitor.visit_Call">visit_Call</a></td>
 <td>Public method to handle a function call.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="DateTimeVisitor.__init__" ID="DateTimeVisitor.__init__"></a>
 <h4>DateTimeVisitor (Constructor)</h4>
 <b>DateTimeVisitor</b>(<i></i>)
 <p>
 Constructor
 </p>
 <a NAME="DateTimeVisitor.__getFromKeywords" ID="DateTimeVisitor.__getFromKeywords"></a>
 <h4>DateTimeVisitor.__getFromKeywords</h4>
 <b>__getFromKeywords</b>(<i>keywords, name</i>)
 <p>
 Private method to get a keyword node given its name.
 </p>
 <dl>
 <dt><i>keywords</i> (list of ast.AST)</dt>
 <dd>
 list of keyword argument nodes
 </dd>
 </dl>
 <a NAME="DateTimeVisitor.visit_Call" ID="DateTimeVisitor.visit_Call"></a>
 <h4>DateTimeVisitor.visit_Call</h4>
 <b>visit_Call</b>(<i>node</i>)
 <p>
 Public method to handle a function call.
 </p>
 <p>
 Every datetime related function call is check for use of the naive
 variant (i.e. use without TZ info).
 </p>
 <dl>
 <dt><i>node</i> (ast.Call)</dt>
 <dd>
 reference to the node to be processed
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="M520NameFinder" ID="M520NameFinder"></a>
 <h2>M520NameFinder</h2>
 <p>
 Class to extract a name out of a tree of nodes ignoring names defined within the
 local scope of a comprehension.
 </p>
 <h3>Derived from</h3>
 NameFinder
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+<table>
-<table>
 <tr>
 <td><a href="#M520NameFinder.visit_DictComp">visit_DictComp</a></td>
 <td>Public method  to handle a dictionary comprehension.</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#M520NameFinder.visit_comprehension">visit_comprehension</a></td>
 <td>Public method  to handle the 'for' of a comprehension.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="M520NameFinder.visit_DictComp" ID="M520NameFinder.visit_DictComp"></a>
 <h4>M520NameFinder.visit_DictComp</h4>
 <b>visit_DictComp</b>(<i>node</i>)
 <p>
 Public method  to handle a dictionary comprehension.
 </p>
 <dl>
 <dt><i>node</i> (TYPE)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="M520NameFinder.visit_GeneratorExp" ID="M520NameFinder.visit_GeneratorExp"></a>
 <h4>M520NameFinder.visit_GeneratorExp</h4>
 <b>visit_GeneratorExp</b>(<i>node</i>)
 <p>
 Public method to handle a generator expressions.
 </p>
 <dl>
 <dt><i>node</i> (ast.GeneratorExp)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="M520NameFinder.visit_Lambda" ID="M520NameFinder.visit_Lambda"></a>
 <h4>M520NameFinder.visit_Lambda</h4>
 <b>visit_Lambda</b>(<i>node</i>)
 <p>
 Public method  to handle a Lambda function.
 </p>
 <dl>
 <dt><i>node</i> (ast.Lambda)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="M520NameFinder.visit_ListComp" ID="M520NameFinder.visit_ListComp"></a>
 <h4>M520NameFinder.visit_ListComp</h4>
 <b>visit_ListComp</b>(<i>node</i>)
 <p>
 Public method  to handle a list comprehension.
 </p>
 <dl>
 <dt><i>node</i> (TYPE)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="M520NameFinder.visit_comprehension" ID="M520NameFinder.visit_comprehension"></a>
 <h4>M520NameFinder.visit_comprehension</h4>
 <b>visit_comprehension</b>(<i>node</i>)
 <p>
 Public method  to handle the 'for' of a comprehension.
 </p>
 <dl>
 <dt><i>node</i> (ast.comprehension)</dt>
 <dd>
 reference to the node to be processed
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="MiscellaneousChecker" ID="MiscellaneousChecker"></a>
 <h2>MiscellaneousChecker</h2>
 <p>
 Class implementing a checker for miscellaneous checks.
 </p>
 <h3>Derived from</h3>
 None
 <h3>Class Attributes</h3>
+<table>
-<table>
+<tr><td>BuiltinsWhiteList</td></tr>
-<tr><td>BuiltinsWhiteList</td></tr><tr><td>Codes</td></tr><tr><td>FormatFieldRegex</td></tr><tr><td>Formatter</td></tr>
+<tr><td>Codes</td></tr>
-</table>
+<tr><td>FormatFieldRegex</td></tr>
+<tr><td>Formatter</td></tr>
+</table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+<table>
-<table>
 <tr>
 <td><a href="#MiscellaneousChecker.__init__">MiscellaneousChecker</a></td>
 <td>Constructor</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#MiscellaneousChecker.run">run</a></td>
 <td>Public method to check the given source against miscellaneous conditions.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="MiscellaneousChecker.__init__" ID="MiscellaneousChecker.__init__"></a>
 <h4>MiscellaneousChecker (Constructor)</h4>
 <b>MiscellaneousChecker</b>(<i>source, filename, tree, select, ignore, expected, repeat, args</i>)
 <p>
 Constructor
 </p>
 <dl>
 <dt><i>source</i> (list of str)</dt>
 <dd>
 source code to be checked
 </dd>
 </dl>
 <a NAME="MiscellaneousChecker.__checkBugBear" ID="MiscellaneousChecker.__checkBugBear"></a>
 <h4>MiscellaneousChecker.__checkBugBear</h4>
 <b>__checkBugBear</b>(<i></i>)
 <p>
 Private method for bugbear checks.
 </p>
 <a NAME="MiscellaneousChecker.__checkBuiltins" ID="MiscellaneousChecker.__checkBuiltins"></a>
 <h4>MiscellaneousChecker.__checkBuiltins</h4>
 <b>__checkBuiltins</b>(<i></i>)
 <p>
 Private method to check, if built-ins are shadowed.
 </p>
 <a NAME="MiscellaneousChecker.__checkCoding" ID="MiscellaneousChecker.__checkCoding"></a>
 <h4>MiscellaneousChecker.__checkCoding</h4>
 <b>__checkCoding</b>(<i></i>)
 <p>
 Private method to check the presence of a coding line and valid
 encodings.
 </p>
 <a NAME="MiscellaneousChecker.__checkCommentedCode" ID="MiscellaneousChecker.__checkCommentedCode"></a>
 <h4>MiscellaneousChecker.__checkCommentedCode</h4>
 <b>__checkCommentedCode</b>(<i></i>)
 <p>
 Private method to check for commented code.
 </p>
 <a NAME="MiscellaneousChecker.__checkComprehensions" ID="MiscellaneousChecker.__checkComprehensions"></a>
 <h4>MiscellaneousChecker.__checkComprehensions</h4>
 <b>__checkComprehensions</b>(<i></i>)
 <p>
 Private method to check some comprehension related things.
 </p>
 <p>
 This method is adapted from: flake8-comprehensions v3.14.0
 Original: Copyright (c) 2017 Adam Johnson
 </p>
 <a NAME="MiscellaneousChecker.__checkCopyright" ID="MiscellaneousChecker.__checkCopyright"></a>
 <h4>MiscellaneousChecker.__checkCopyright</h4>
 <b>__checkCopyright</b>(<i></i>)
 <p>
 Private method to check the presence of a copyright statement.
 </p>
 <a NAME="MiscellaneousChecker.__checkDateTime" ID="MiscellaneousChecker.__checkDateTime"></a>
 <h4>MiscellaneousChecker.__checkDateTime</h4>
 <b>__checkDateTime</b>(<i></i>)
 <p>
 Private method to check use of naive datetime functions.
 </p>
 <a NAME="MiscellaneousChecker.__checkDictWithSortedKeys" ID="MiscellaneousChecker.__checkDictWithSortedKeys"></a>
 <h4>MiscellaneousChecker.__checkDictWithSortedKeys</h4>
 <b>__checkDictWithSortedKeys</b>(<i></i>)
 <p>
 Private method to check, if dictionary keys appear in sorted order.
 </p>
 <a NAME="MiscellaneousChecker.__checkExplicitStringConcat" ID="MiscellaneousChecker.__checkExplicitStringConcat"></a>
 <h4>MiscellaneousChecker.__checkExplicitStringConcat</h4>
 <b>__checkExplicitStringConcat</b>(<i></i>)
 <p>
 Private method to check for explicitly concatenated strings.
 </p>
 <a NAME="MiscellaneousChecker.__checkFormatString" ID="MiscellaneousChecker.__checkFormatString"></a>
 <h4>MiscellaneousChecker.__checkFormatString</h4>
 <b>__checkFormatString</b>(<i></i>)
 <p>
 Private method to check string format strings.
 </p>
 <a NAME="MiscellaneousChecker.__checkFuture" ID="MiscellaneousChecker.__checkFuture"></a>
 <h4>MiscellaneousChecker.__checkFuture</h4>
 <b>__checkFuture</b>(<i></i>)
 <p>
 Private method to check the __future__ imports.
 </p>
 <a NAME="MiscellaneousChecker.__checkGettext" ID="MiscellaneousChecker.__checkGettext"></a>
 <h4>MiscellaneousChecker.__checkGettext</h4>
 <b>__checkGettext</b>(<i></i>)
 <p>
 Private method to check the 'gettext' import statement.
 </p>
 <a NAME="MiscellaneousChecker.__checkImplicitStringConcat" ID="MiscellaneousChecker.__checkImplicitStringConcat"></a>
 <h4>MiscellaneousChecker.__checkImplicitStringConcat</h4>
 <b>__checkImplicitStringConcat</b>(<i></i>)
 <p>
 Private method to check for implicitly concatenated strings.
 </p>
 <a NAME="MiscellaneousChecker.__checkLineContinuation" ID="MiscellaneousChecker.__checkLineContinuation"></a>
 <h4>MiscellaneousChecker.__checkLineContinuation</h4>
 <b>__checkLineContinuation</b>(<i></i>)
 <p>
 Private method to check line continuation using backslash.
 </p>
 <a NAME="MiscellaneousChecker.__checkMutableDefault" ID="MiscellaneousChecker.__checkMutableDefault"></a>
 <h4>MiscellaneousChecker.__checkMutableDefault</h4>
 <b>__checkMutableDefault</b>(<i></i>)
 <p>
 Private method to check for use of mutable types as default arguments.
 </p>
 <a NAME="MiscellaneousChecker.__checkPep3101" ID="MiscellaneousChecker.__checkPep3101"></a>
 <h4>MiscellaneousChecker.__checkPep3101</h4>
 <b>__checkPep3101</b>(<i></i>)
 <p>
 Private method to check for old style string formatting.
 </p>
 <a NAME="MiscellaneousChecker.__checkPrintStatements" ID="MiscellaneousChecker.__checkPrintStatements"></a>
 <h4>MiscellaneousChecker.__checkPrintStatements</h4>
 <b>__checkPrintStatements</b>(<i></i>)
 <p>
 Private method to check for print statements.
 </p>
 <a NAME="MiscellaneousChecker.__checkProperties" ID="MiscellaneousChecker.__checkProperties"></a>
 <h4>MiscellaneousChecker.__checkProperties</h4>
 <b>__checkProperties</b>(<i></i>)
 <p>
 Private method to check for issue with property related methods.
 </p>
 <a NAME="MiscellaneousChecker.__checkReturn" ID="MiscellaneousChecker.__checkReturn"></a>
 <h4>MiscellaneousChecker.__checkReturn</h4>
 <b>__checkReturn</b>(<i></i>)
 <p>
 Private method to check return statements.
 </p>
 <a NAME="MiscellaneousChecker.__checkSysVersion" ID="MiscellaneousChecker.__checkSysVersion"></a>
 <h4>MiscellaneousChecker.__checkSysVersion</h4>
 <b>__checkSysVersion</b>(<i></i>)
 <p>
 Private method to check the use of sys.version and sys.version_info.
 </p>
 <a NAME="MiscellaneousChecker.__checkTuple" ID="MiscellaneousChecker.__checkTuple"></a>
 <h4>MiscellaneousChecker.__checkTuple</h4>
 <b>__checkTuple</b>(<i></i>)
 <p>
 Private method to check for one element tuples.
 </p>
 <a NAME="MiscellaneousChecker.__dictShouldBeChecked" ID="MiscellaneousChecker.__dictShouldBeChecked"></a>
 <h4>MiscellaneousChecker.__dictShouldBeChecked</h4>
 <b>__dictShouldBeChecked</b>(<i>node</i>)
 <p>
 Private function to test, if the node should be checked.
 </p>
 <dl>
 <dt><i>node</i> (ast.Dict)</dt>
 <dd>
 reference to the AST node
 </dd>
 </dl>
 <a NAME="MiscellaneousChecker.__error" ID="MiscellaneousChecker.__error"></a>
 <h4>MiscellaneousChecker.__error</h4>
 <b>__error</b>(<i>lineNumber, offset, code, *args</i>)
 <p>
 Private method to record an issue.
 </p>
 <dl>
 <dt><i>lineNumber</i> (int)</dt>
 <dd>
 line number of the issue
 </dd>
 </dl>
 <a NAME="MiscellaneousChecker.__getCoding" ID="MiscellaneousChecker.__getCoding"></a>
 <h4>MiscellaneousChecker.__getCoding</h4>
 <b>__getCoding</b>(<i></i>)
 <p>
 Private method to get the defined coding of the source.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 tuple containing the line number and the coding
 </dd>
 </dd>
 </dl>
 <a NAME="MiscellaneousChecker.__getFields" ID="MiscellaneousChecker.__getFields"></a>
 <h4>MiscellaneousChecker.__getFields</h4>
 <b>__getFields</b>(<i>string</i>)
 <p>
 Private method to extract the format field information.
 </p>
 <dl>
 <dt><i>string</i> (str)</dt>
 <dd>
 format string to be parsed
 </dd>
 </dl>
 <a NAME="MiscellaneousChecker.__ignoreCode" ID="MiscellaneousChecker.__ignoreCode"></a>
 <h4>MiscellaneousChecker.__ignoreCode</h4>
 <b>__ignoreCode</b>(<i>code</i>)
 <p>
 Private method to check if the message code should be ignored.
 </p>
 <dl>
 <dt><i>code</i> (str)</dt>
 <dd>
 message code to check for
 </dd>
 </dl>
 <a NAME="MiscellaneousChecker.__isImplicitStringConcat" ID="MiscellaneousChecker.__isImplicitStringConcat"></a>
 <h4>MiscellaneousChecker.__isImplicitStringConcat</h4>
 <b>__isImplicitStringConcat</b>(<i>first, second</i>)
 <p>
 Private method to check, if the given strings indicate an implicit string
 concatenation.
 </p>
 <dl>
 <dt><i>first</i> (tuple)</dt>
 <dd>
 first token
 </dd>
 </dl>
 <a NAME="MiscellaneousChecker.run" ID="MiscellaneousChecker.run"></a>
 <h4>MiscellaneousChecker.run</h4>
 <b>run</b>(<i></i>)
 <p>
 Public method to check the given source against miscellaneous
 conditions.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="NameFinder" ID="NameFinder"></a>
 <h2>NameFinder</h2>
 <p>
 Class to extract a name out of a tree of nodes.
 </p>
 <h3>Derived from</h3>
 ast.NodeVisitor
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+<table>
-<table>
 <tr>
 <td><a href="#NameFinder.__init__">NameFinder</a></td>
 <td>Constructor</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#NameFinder.visit_Name">visit_Name</a></td>
 <td>Public method to handle 'Name' nodes.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="NameFinder.__init__" ID="NameFinder.__init__"></a>
 <h4>NameFinder (Constructor)</h4>
 <b>NameFinder</b>(<i></i>)
 <p>
 Constructor
 </p>
 <a NAME="NameFinder.getNames" ID="NameFinder.getNames"></a>
 <h4>NameFinder.getNames</h4>
 <b>getNames</b>(<i></i>)
 <p>
 Public method to return the extracted names and Name nodes.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 dictionary containing the names as keys and the list of nodes
 </dd>
 </dd>
 </dl>
 <a NAME="NameFinder.visit" ID="NameFinder.visit"></a>
 <h4>NameFinder.visit</h4>
 <b>visit</b>(<i>node</i>)
 <p>
 Public method to traverse a given AST node.
 </p>
 <dl>
 <dt><i>node</i> (ast.Node)</dt>
 <dd>
 AST node to be traversed
 </dd>
 </dl>
 <a NAME="NameFinder.visit_Name" ID="NameFinder.visit_Name"></a>
 <h4>NameFinder.visit_Name</h4>
 <b>visit_Name</b>(<i>node</i>)
 <p>
 Public method to handle 'Name' nodes.
 </p>
 <dl>
 <dt><i>node</i> (ast.Name)</dt>
 <dd>
 reference to the node to be processed
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="ReturnVisitor" ID="ReturnVisitor"></a>
 <h2>ReturnVisitor</h2>
 <p>
 Class implementing a node visitor to check return statements.
 </p>
 <h3>Derived from</h3>
 ast.NodeVisitor
 <h3>Class Attributes</h3>
+<table>
-<table>
+<tr><td>Assigns</td></tr>
-<tr><td>Assigns</td></tr><tr><td>Refs</td></tr><tr><td>Returns</td></tr>
+<tr><td>Refs</td></tr>
-</table>
+<tr><td>Returns</td></tr>
+</table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+<table>
-<table>
 <tr>
 <td><a href="#ReturnVisitor.__init__">ReturnVisitor</a></td>
 <td>Constructor</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#ReturnVisitor.visit_While">visit_While</a></td>
 <td>Public method to handle a while loop.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="ReturnVisitor.__init__" ID="ReturnVisitor.__init__"></a>
 <h4>ReturnVisitor (Constructor)</h4>
 <b>ReturnVisitor</b>(<i></i>)
 <p>
 Constructor
 </p>
 <a NAME="ReturnVisitor.__checkFunction" ID="ReturnVisitor.__checkFunction"></a>
 <h4>ReturnVisitor.__checkFunction</h4>
 <b>__checkFunction</b>(<i>node</i>)
 <p>
 Private method to check a function definition node.
 </p>
 <dl>
 <dt><i>node</i> (ast.AsyncFunctionDef or ast.FunctionDef)</dt>
 <dd>
 reference to the node to check
 </dd>
 </dl>
 <a NAME="ReturnVisitor.__checkImplicitReturn" ID="ReturnVisitor.__checkImplicitReturn"></a>
 <h4>ReturnVisitor.__checkImplicitReturn</h4>
 <b>__checkImplicitReturn</b>(<i>node</i>)
 <p>
 Private method to check for an implicit return statement.
 </p>
 <dl>
 <dt><i>node</i> (ast.AST)</dt>
 <dd>
 reference to the node to check
 </dd>
 </dl>
 <a NAME="ReturnVisitor.__checkImplicitReturnValue" ID="ReturnVisitor.__checkImplicitReturnValue"></a>
 <h4>ReturnVisitor.__checkImplicitReturnValue</h4>
 <b>__checkImplicitReturnValue</b>(<i></i>)
 <p>
 Private method to check for implicit return values.
 </p>
 <a NAME="ReturnVisitor.__checkUnnecessaryAssign" ID="ReturnVisitor.__checkUnnecessaryAssign"></a>
 <h4>ReturnVisitor.__checkUnnecessaryAssign</h4>
 <b>__checkUnnecessaryAssign</b>(<i>node</i>)
 <p>
 Private method to check for an unnecessary assign statement.
 </p>
 <dl>
 <dt><i>node</i> (ast.AST)</dt>
 <dd>
 reference to the node to check
 </dd>
 </dl>
 <a NAME="ReturnVisitor.__checkUnnecessaryReturnNone" ID="ReturnVisitor.__checkUnnecessaryReturnNone"></a>
 <h4>ReturnVisitor.__checkUnnecessaryReturnNone</h4>
 <b>__checkUnnecessaryReturnNone</b>(<i></i>)
 <p>
 Private method to check for an unnecessary 'return None' statement.
 </p>
 <a NAME="ReturnVisitor.__hasRefsBeforeNextAssign" ID="ReturnVisitor.__hasRefsBeforeNextAssign"></a>
 <h4>ReturnVisitor.__hasRefsBeforeNextAssign</h4>
 <b>__hasRefsBeforeNextAssign</b>(<i>varname, returnLineno</i>)
 <p>
 Private method to check for references before a following assign
 statement.
 </p>
 <dl>
 <dt><i>varname</i> (str)</dt>
 <dd>
 variable name to check for
 </dd>
 </dl>
 <a NAME="ReturnVisitor.__isFalse" ID="ReturnVisitor.__isFalse"></a>
 <h4>ReturnVisitor.__isFalse</h4>
 <b>__isFalse</b>(<i>node</i>)
 <p>
 Private method to check, if a node value is False.
 </p>
 <dl>
 <dt><i>node</i> (ast.AST)</dt>
 <dd>
 reference to the node to check
 </dd>
 </dl>
 <a NAME="ReturnVisitor.__isNone" ID="ReturnVisitor.__isNone"></a>
 <h4>ReturnVisitor.__isNone</h4>
 <b>__isNone</b>(<i>node</i>)
 <p>
 Private method to check, if a node value is None.
 </p>
 <dl>
 <dt><i>node</i> (ast.AST)</dt>
 <dd>
 reference to the node to check
 </dd>
 </dl>
 <a NAME="ReturnVisitor.__resultExists" ID="ReturnVisitor.__resultExists"></a>
 <h4>ReturnVisitor.__resultExists</h4>
 <b>__resultExists</b>(<i></i>)
 <p>
 Private method to check the existance of a return result.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 flag indicating the existence of a return result
 </dd>
 </dd>
 </dl>
 <a NAME="ReturnVisitor.__visitAssignTarget" ID="ReturnVisitor.__visitAssignTarget"></a>
 <h4>ReturnVisitor.__visitAssignTarget</h4>
 <b>__visitAssignTarget</b>(<i>node</i>)
 <p>
 Private method to handle an assign target node.
 </p>
 <dl>
 <dt><i>node</i> (ast.AST)</dt>
 <dd>
 reference to the node to handle
 </dd>
 </dl>
 <a NAME="ReturnVisitor.__visitLoop" ID="ReturnVisitor.__visitLoop"></a>
 <h4>ReturnVisitor.__visitLoop</h4>
 <b>__visitLoop</b>(<i>node</i>)
 <p>
 Private method to handle loop nodes.
 </p>
 <dl>
 <dt><i>node</i> (ast.For, ast.AsyncFor or ast.While)</dt>
 <dd>
 reference to the loop node to handle
 </dd>
 </dl>
 <a NAME="ReturnVisitor.__visitWithStack" ID="ReturnVisitor.__visitWithStack"></a>
 <h4>ReturnVisitor.__visitWithStack</h4>
 <b>__visitWithStack</b>(<i>node</i>)
 <p>
 Private method to traverse a given function node using a stack.
 </p>
 <dl>
 <dt><i>node</i> (ast.FunctionDef or ast.AsyncFunctionDef)</dt>
 <dd>
 AST node to be traversed
 </dd>
 </dl>
 <a NAME="ReturnVisitor.assigns" ID="ReturnVisitor.assigns"></a>
 <h4>ReturnVisitor.assigns</h4>
 <b>assigns</b>(<i></i>)
 <p>
 Public method to get the Assign nodes.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 dictionary containing the node name as key and line number
 as value
 </dd>
 </dl>
 <a NAME="ReturnVisitor.refs" ID="ReturnVisitor.refs"></a>
 <h4>ReturnVisitor.refs</h4>
 <b>refs</b>(<i></i>)
 <p>
 Public method to get the References nodes.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 dictionary containing the node name as key and line number
 as value
 </dd>
 </dl>
 <a NAME="ReturnVisitor.returns" ID="ReturnVisitor.returns"></a>
 <h4>ReturnVisitor.returns</h4>
 <b>returns</b>(<i></i>)
 <p>
 Public method to get the Return nodes.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
 dictionary containing the node name as key and line number
 as value
 </dd>
 </dl>
 <a NAME="ReturnVisitor.visit_Assign" ID="ReturnVisitor.visit_Assign"></a>
 <h4>ReturnVisitor.visit_Assign</h4>
 <b>visit_Assign</b>(<i>node</i>)
 <p>
 Public method to handle an assign node.
 </p>
 <dl>
 <dt><i>node</i> (ast.Assign)</dt>
 <dd>
 reference to the node to handle
 </dd>
 </dl>
 <a NAME="ReturnVisitor.visit_AsyncFor" ID="ReturnVisitor.visit_AsyncFor"></a>
 <h4>ReturnVisitor.visit_AsyncFor</h4>
 <b>visit_AsyncFor</b>(<i>node</i>)
 <p>
 Public method to handle an async for loop.
 </p>
 <dl>
 <dt><i>node</i> (ast.AsyncFor)</dt>
 <dd>
 reference to the async for node to handle
 </dd>
 </dl>
 <a NAME="ReturnVisitor.visit_AsyncFunctionDef" ID="ReturnVisitor.visit_AsyncFunctionDef"></a>
 <h4>ReturnVisitor.visit_AsyncFunctionDef</h4>
 <b>visit_AsyncFunctionDef</b>(<i>node</i>)
 <p>
 Public method to handle a function definition.
 </p>
 <dl>
 <dt><i>node</i> (ast.AsyncFunctionDef)</dt>
 <dd>
 reference to the node to handle
 </dd>
 </dl>
 <a NAME="ReturnVisitor.visit_For" ID="ReturnVisitor.visit_For"></a>
 <h4>ReturnVisitor.visit_For</h4>
 <b>visit_For</b>(<i>node</i>)
 <p>
 Public method to handle a for loop.
 </p>
 <dl>
 <dt><i>node</i> (ast.For)</dt>
 <dd>
 reference to the for node to handle
 </dd>
 </dl>
 <a NAME="ReturnVisitor.visit_FunctionDef" ID="ReturnVisitor.visit_FunctionDef"></a>
 <h4>ReturnVisitor.visit_FunctionDef</h4>
 <b>visit_FunctionDef</b>(<i>node</i>)
 <p>
 Public method to handle a function definition.
 </p>
 <dl>
 <dt><i>node</i> (ast.FunctionDef)</dt>
 <dd>
 reference to the node to handle
 </dd>
 </dl>
 <a NAME="ReturnVisitor.visit_Name" ID="ReturnVisitor.visit_Name"></a>
 <h4>ReturnVisitor.visit_Name</h4>
 <b>visit_Name</b>(<i>node</i>)
 <p>
 Public method to handle a name node.
 </p>
 <dl>
 <dt><i>node</i> (ast.Name)</dt>
 <dd>
 reference to the node to handle
 </dd>
 </dl>
 <a NAME="ReturnVisitor.visit_Return" ID="ReturnVisitor.visit_Return"></a>
 <h4>ReturnVisitor.visit_Return</h4>
 <b>visit_Return</b>(<i>node</i>)
 <p>
 Public method to handle a return node.
 </p>
 <dl>
 <dt><i>node</i> (ast.Return)</dt>
 <dd>
 reference to the node to handle
 </dd>
 </dl>
 <a NAME="ReturnVisitor.visit_While" ID="ReturnVisitor.visit_While"></a>
 <h4>ReturnVisitor.visit_While</h4>
 <b>visit_While</b>(<i>node</i>)
 <p>
 Public method to handle a while loop.
 </p>
 <dl>
 <dt><i>node</i> (ast.While)</dt>
 <dd>
 reference to the while node to handle
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="SysVersionVisitor" ID="SysVersionVisitor"></a>
 <h2>SysVersionVisitor</h2>
 <p>
 Class implementing a node visitor to check the use of sys.version and
 sys.version_info.
 </p>
 <p>
 Note: This class is modeled after flake8-2020 checker.
 </p>
 <h3>Derived from</h3>
 ast.NodeVisitor
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+<table>
-<table>
 <tr>
 <td><a href="#SysVersionVisitor.__init__">SysVersionVisitor</a></td>
 <td>Constructor</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#SysVersionVisitor.visit_Subscript">visit_Subscript</a></td>
 <td>Public method to handle a subscript.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="SysVersionVisitor.__init__" ID="SysVersionVisitor.__init__"></a>
 <h4>SysVersionVisitor (Constructor)</h4>
 <b>SysVersionVisitor</b>(<i></i>)
 <p>
 Constructor
 </p>
 <a NAME="SysVersionVisitor.__isSys" ID="SysVersionVisitor.__isSys"></a>
 <h4>SysVersionVisitor.__isSys</h4>
 <b>__isSys</b>(<i>attr, node</i>)
 <p>
 Private method to check for a reference to sys attribute.
 </p>
 <dl>
 <dt><i>attr</i> (str)</dt>
 <dd>
 attribute name
 </dd>
 </dl>
 <a NAME="SysVersionVisitor.__isSysVersionUpperSlice" ID="SysVersionVisitor.__isSysVersionUpperSlice"></a>
 <h4>SysVersionVisitor.__isSysVersionUpperSlice</h4>
 <b>__isSysVersionUpperSlice</b>(<i>node, n</i>)
 <p>
 Private method to check the upper slice of sys.version.
 </p>
 <dl>
 <dt><i>node</i> (ast.Node)</dt>
 <dd>
 reference to the node to be checked
 </dd>
 </dl>
 <a NAME="SysVersionVisitor.visit_Attribute" ID="SysVersionVisitor.visit_Attribute"></a>
 <h4>SysVersionVisitor.visit_Attribute</h4>
 <b>visit_Attribute</b>(<i>node</i>)
 <p>
 Public method to handle an attribute.
 </p>
 <dl>
 <dt><i>node</i> (ast.Attribute)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="SysVersionVisitor.visit_Compare" ID="SysVersionVisitor.visit_Compare"></a>
 <h4>SysVersionVisitor.visit_Compare</h4>
 <b>visit_Compare</b>(<i>node</i>)
 <p>
 Public method to handle a comparison.
 </p>
 <dl>
 <dt><i>node</i> (ast.Compare)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="SysVersionVisitor.visit_ImportFrom" ID="SysVersionVisitor.visit_ImportFrom"></a>
 <h4>SysVersionVisitor.visit_ImportFrom</h4>
 <b>visit_ImportFrom</b>(<i>node</i>)
 <p>
 Public method to handle a from ... import ... statement.
 </p>
 <dl>
 <dt><i>node</i> (ast.ImportFrom)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="SysVersionVisitor.visit_Name" ID="SysVersionVisitor.visit_Name"></a>
 <h4>SysVersionVisitor.visit_Name</h4>
 <b>visit_Name</b>(<i>node</i>)
 <p>
 Public method to handle an name.
 </p>
 <dl>
 <dt><i>node</i> (ast.Name)</dt>
 <dd>
 reference to the node to be processed
 </dd>
 </dl>
 <a NAME="SysVersionVisitor.visit_Subscript" ID="SysVersionVisitor.visit_Subscript"></a>
 <h4>SysVersionVisitor.visit_Subscript</h4>
 <b>visit_Subscript</b>(<i>node</i>)
 <p>
 Public method to handle a subscript.
 </p>
 <dl>
 <dt><i>node</i> (ast.Subscript)</dt>
 <dd>
 reference to the node to be processed
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="TextVisitor" ID="TextVisitor"></a>
 <h2>TextVisitor</h2>
 <p>
 Class implementing a node visitor for bytes and str instances.
 </p>
 <p>
 It tries to detect docstrings as string of the first expression of each
 module, class or function.
 </p>
 <h3>Derived from</h3>
 ast.NodeVisitor
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+<table>
-<table>
 <tr>
 <td><a href="#TextVisitor.__init__">TextVisitor</a></td>
 <td>Constructor</td>
 </tr>
 <tr>
 <tr>
 <td><a href="#TextVisitor.visit_Module">visit_Module</a></td>
 <td>Public method to handle a module.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="TextVisitor.__init__" ID="TextVisitor.__init__"></a>
 <h4>TextVisitor (Constructor)</h4>
 <b>TextVisitor</b>(<i></i>)
 <p>
 Constructor
 </p>
 <a NAME="TextVisitor.__addNode" ID="TextVisitor.__addNode"></a>
 <h4>TextVisitor.__addNode</h4>
 <b>__addNode</b>(<i>node</i>)
 <p>
 Private method to add a node to our list of nodes.
 </p>
 <dl>
 <dt><i>node</i> (ast.AST)</dt>
 <dd>
 reference to the node to add
 </dd>
 </dl>
 <a NAME="TextVisitor.__visitBody" ID="TextVisitor.__visitBody"></a>
 <h4>TextVisitor.__visitBody</h4>
 <b>__visitBody</b>(<i>node</i>)
 <p>
 Private method to traverse the body of the node manually.
 </p>
 <p>
 If the first node is an expression which contains a string or bytes it
 marks that as a docstring.
 </p>
 <dl>
 <dt><i>node</i> (ast.AST)</dt>
 <dd>
 reference to the node to traverse
 </dd>
 </dl>
 <a NAME="TextVisitor.__visitDefinition" ID="TextVisitor.__visitDefinition"></a>
 <h4>TextVisitor.__visitDefinition</h4>
 <b>__visitDefinition</b>(<i>node</i>)
 <p>
 Private method handling class and function definitions.
 </p>
 <dl>
 <dt><i>node</i> (ast.FunctionDef, ast.AsyncFunctionDef or ast.ClassDef)</dt>
 <dd>
 reference to the node to handle
 </dd>
 </dl>
 <a NAME="TextVisitor.visit_AsyncFunctionDef" ID="TextVisitor.visit_AsyncFunctionDef"></a>
 <h4>TextVisitor.visit_AsyncFunctionDef</h4>
 <b>visit_AsyncFunctionDef</b>(<i>node</i>)
 <p>
 Public method to handle an asynchronous function definition.
 </p>
 <dl>
 <dt><i>node</i> (ast.AsyncFunctionDef)</dt>
 <dd>
 reference to the node to handle
 </dd>
 </dl>
 <a NAME="TextVisitor.visit_Call" ID="TextVisitor.visit_Call"></a>
 <h4>TextVisitor.visit_Call</h4>
 <b>visit_Call</b>(<i>node</i>)
 <p>
 Public method to handle a function call.
 </p>
 <dl>
 <dt><i>node</i> (ast.Call)</dt>
 <dd>
 reference to the node to handle
 </dd>
 </dl>
 <a NAME="TextVisitor.visit_ClassDef" ID="TextVisitor.visit_ClassDef"></a>
 <h4>TextVisitor.visit_ClassDef</h4>
 <b>visit_ClassDef</b>(<i>node</i>)
 <p>
 Public method to handle a class definition.
 </p>
 <dl>
 <dt><i>node</i> (ast.ClassDef)</dt>
 <dd>
 reference to the node to handle
 </dd>
 </dl>
 <a NAME="TextVisitor.visit_Constant" ID="TextVisitor.visit_Constant"></a>
 <h4>TextVisitor.visit_Constant</h4>
 <b>visit_Constant</b>(<i>node</i>)
 <p>
 Public method to handle constant nodes.
 </p>
 <dl>
 <dt><i>node</i> (ast.Constant)</dt>
 <dd>
 reference to the bytes node
 </dd>
 </dl>
 <a NAME="TextVisitor.visit_FunctionDef" ID="TextVisitor.visit_FunctionDef"></a>
 <h4>TextVisitor.visit_FunctionDef</h4>
 <b>visit_FunctionDef</b>(<i>node</i>)
 <p>
 Public method to handle a function definition.
 </p>
 <dl>
 <dt><i>node</i> (ast.FunctionDef)</dt>
 <dd>
 reference to the node to handle
 </dd>
 </dl>
 <a NAME="TextVisitor.visit_Module" ID="TextVisitor.visit_Module"></a>
 <h4>TextVisitor.visit_Module</h4>
 <b>visit_Module</b>(<i>node</i>)
 <p>
 Public method to handle a module.
 </p>
 <dl>
 <dt><i>node</i> (ast.Module)</dt>
 <dd>
 reference to the node to handle
 <hr />
 <hr />
 <a NAME="composeCallPath" ID="composeCallPath"></a>
 <h2>composeCallPath</h2>
 <b>composeCallPath</b>(<i>node</i>)
 <p>
 Generator function to assemble the call path of a given node.
 </p>
 <dl>
 <dt><i>node</i> (ast.Node)</dt>
 <dd>
 node to assemble call path for

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html