Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Unused.UnusedChecker.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Unused.UnusedChecker.html

branch
eric7
changeset 10479
856476537696
parent 10070
9f5758c0fec1
child 11150
73d80859079c
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Unused.UnusedChecker.html	Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Unused.UnusedChecker.html	Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
 <body>
 <a NAME="top" ID="top"></a>
 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Unused.UnusedChecker</h1>
-
 <p>
 Module implementing a checker for unused arguments, variables, ... .
 </p>
+
 <h3>Global Attributes</h3>
-
 <table>
 <tr><td>GlobalVariableStoreInfo</td></tr>
 </table>
+
 <h3>Classes</h3>
-
 <table>
-
 <tr>
 <td><a href="#FunctionFinder">FunctionFinder</a></td>
 <td>Class to find all defined functions and methods.</td>
@@ -37,35 +35,34 @@
 <td>Class implementing a checker for unused arguments, variables, ...</td>
 </tr>
 </table>
+
 <h3>Functions</h3>
-
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <hr />
 <hr />
 <a NAME="FunctionFinder" ID="FunctionFinder"></a>
 <h2>FunctionFinder</h2>
-
 <p>
     Class to find all defined functions and methods.
 </p>
+
 <h3>Derived from</h3>
 ast.NodeVisitor
 <h3>Class Attributes</h3>
-
 <table>
 <tr><td>visit_AsyncFunctionDef</td></tr>
 </table>
+
 <h3>Class Methods</h3>
-
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <h3>Methods</h3>
-
 <table>
-
 <tr>
 <td><a href="#FunctionFinder.__init__">FunctionFinder</a></td>
 <td>Constructor</td>
@@ -79,19 +76,20 @@
 <td>Public method to get the list of detected functions and lambdas.</td>
 </tr>
 </table>
+
 <h3>Static Methods</h3>
-
 <table>
 <tr><td>None</td></tr>
 </table>
 
+
 <a NAME="FunctionFinder.__init__" ID="FunctionFinder.__init__"></a>
 <h4>FunctionFinder (Constructor)</h4>
 <b>FunctionFinder</b>(<i>onlyTopLevel=False</i>)
-
 <p>
         Constructor
 </p>
+
 <dl>
 
 <dt><i>onlyTopLevel</i> (bool (optional))</dt>
@@ -103,10 +101,10 @@
 <a NAME="FunctionFinder.__visitFunctionTypes" ID="FunctionFinder.__visitFunctionTypes"></a>
 <h4>FunctionFinder.__visitFunctionTypes</h4>
 <b>__visitFunctionTypes</b>(<i>functionNode</i>)
-
 <p>
         Private method to handle an AST node defining a function or lambda.
 </p>
+
 <dl>
 
 <dt><i>functionNode</i> (ast.AsyncFunctionDef, ast.FunctionDef or ast.Lambda)</dt>
@@ -117,10 +115,10 @@
 <a NAME="FunctionFinder.functionNodes" ID="FunctionFinder.functionNodes"></a>
 <h4>FunctionFinder.functionNodes</h4>
 <b>functionNodes</b>(<i></i>)
-
 <p>
         Public method to get the list of detected functions and lambdas.
 </p>
+
 <dl>
 <dt>Return:</dt>
 <dd>
@@ -138,26 +136,24 @@
 <hr />
 <a NAME="GlobalVariableLoadCounter" ID="GlobalVariableLoadCounter"></a>
 <h2>GlobalVariableLoadCounter</h2>
-
 <p>
     Class to find all defined global variables and count their usages.
 </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>
-
 <tr>
 <td><a href="#GlobalVariableLoadCounter.__init__">GlobalVariableLoadCounter</a></td>
 <td>Constructor</td>
@@ -175,26 +171,27 @@
 <td>Public method to record the definition and use of a global variable.</td>
 </tr>
 </table>
+
 <h3>Static Methods</h3>
-
 <table>
 <tr><td>None</td></tr>
 </table>
 
+
 <a NAME="GlobalVariableLoadCounter.__init__" ID="GlobalVariableLoadCounter.__init__"></a>
 <h4>GlobalVariableLoadCounter (Constructor)</h4>
 <b>GlobalVariableLoadCounter</b>(<i></i>)
-
 <p>
         Constructor
 </p>
+
 <a NAME="GlobalVariableLoadCounter.getLoads" ID="GlobalVariableLoadCounter.getLoads"></a>
 <h4>GlobalVariableLoadCounter.getLoads</h4>
 <b>getLoads</b>(<i></i>)
-
 <p>
         Public method to get an iterator of the detected variable loads.
 </p>
+
 <dl>
 <dt>Return:</dt>
 <dd>
@@ -210,10 +207,10 @@
 <a NAME="GlobalVariableLoadCounter.getStoreInfo" ID="GlobalVariableLoadCounter.getStoreInfo"></a>
 <h4>GlobalVariableLoadCounter.getStoreInfo</h4>
 <b>getStoreInfo</b>(<i>variableId</i>)
-
 <p>
         Public method to get the store info data of a given variable ID.
 </p>
+
 <dl>
 
 <dt><i>variableId</i> (str)</dt>
@@ -236,10 +233,10 @@
 <a NAME="GlobalVariableLoadCounter.visit_Name" ID="GlobalVariableLoadCounter.visit_Name"></a>
 <h4>GlobalVariableLoadCounter.visit_Name</h4>
 <b>visit_Name</b>(<i>nameNode</i>)
-
 <p>
         Public method to record the definition and use of a global variable.
 </p>
+
 <dl>
 
 <dt><i>nameNode</i> (ast.Name)</dt>
@@ -252,44 +249,43 @@
 <hr />
 <a NAME="NameFinder" ID="NameFinder"></a>
 <h2>NameFinder</h2>
-
 <p>
             Class to find the used argument names.
 </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>
-
 <tr>
 <td><a href="#NameFinder.visit_Name">visit_Name</a></td>
 <td>Public method to check a Name node.</td>
 </tr>
 </table>
+
 <h3>Static Methods</h3>
-
 <table>
 <tr><td>None</td></tr>
 </table>
 
+
 <a NAME="NameFinder.visit_Name" ID="NameFinder.visit_Name"></a>
 <h4>NameFinder.visit_Name</h4>
 <b>visit_Name</b>(<i>name</i>)
-
 <p>
                 Public method to check a Name node.
 </p>
+
 <dl>
 
 <dt><i>name</i> (ast.Name)</dt>
@@ -302,26 +298,24 @@
 <hr />
 <a NAME="UnusedChecker" ID="UnusedChecker"></a>
 <h2>UnusedChecker</h2>
-
 <p>
     Class implementing a checker for unused arguments, variables, ... .
 </p>
+
 <h3>Derived from</h3>
 None
 <h3>Class Attributes</h3>
-
 <table>
 <tr><td>Codes</td></tr>
 </table>
+
 <h3>Class Methods</h3>
-
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <h3>Methods</h3>
-
 <table>
-
 <tr>
 <td><a href="#UnusedChecker.__init__">UnusedChecker</a></td>
 <td>Constructor</td>
@@ -375,19 +369,20 @@
 <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="UnusedChecker.__init__" ID="UnusedChecker.__init__"></a>
 <h4>UnusedChecker (Constructor)</h4>
 <b>UnusedChecker</b>(<i>source, filename, tree, select, ignore, expected, repeat, args</i>)
-
 <p>
         Constructor
 </p>
+
 <dl>
 
 <dt><i>source</i> (list of str)</dt>
@@ -426,24 +421,24 @@
 <a NAME="UnusedChecker.__checkUnusedArguments" ID="UnusedChecker.__checkUnusedArguments"></a>
 <h4>UnusedChecker.__checkUnusedArguments</h4>
 <b>__checkUnusedArguments</b>(<i></i>)
-
 <p>
         Private method to check function and method definitions for unused arguments.
 </p>
+
 <a NAME="UnusedChecker.__checkUnusedGlobals" ID="UnusedChecker.__checkUnusedGlobals"></a>
 <h4>UnusedChecker.__checkUnusedGlobals</h4>
 <b>__checkUnusedGlobals</b>(<i></i>)
-
 <p>
         Private method to check for unused global variables.
 </p>
+
 <a NAME="UnusedChecker.__error" ID="UnusedChecker.__error"></a>
 <h4>UnusedChecker.__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>
@@ -466,10 +461,10 @@
 <a NAME="UnusedChecker.__extractGlobalVariables" ID="UnusedChecker.__extractGlobalVariables"></a>
 <h4>UnusedChecker.__extractGlobalVariables</h4>
 <b>__extractGlobalVariables</b>(<i></i>)
-
 <p>
         Private method to get the names of all global variables.
 </p>
+
 <dl>
 <dt>Return:</dt>
 <dd>
@@ -485,10 +480,10 @@
 <a NAME="UnusedChecker.__getArguments" ID="UnusedChecker.__getArguments"></a>
 <h4>UnusedChecker.__getArguments</h4>
 <b>__getArguments</b>(<i>functionNode</i>)
-
 <p>
         Private method to get all argument names of the given function.
 </p>
+
 <dl>
 
 <dt><i>functionNode</i> (ast.AsyncFunctionDef, ast.FunctionDef or ast.Lambda)</dt>
@@ -511,10 +506,10 @@
 <a NAME="UnusedChecker.__getDecoratorNames" ID="UnusedChecker.__getDecoratorNames"></a>
 <h4>UnusedChecker.__getDecoratorNames</h4>
 <b>__getDecoratorNames</b>(<i>functionNode</i>)
-
 <p>
         Private method to yield the decorator names of the function.
 </p>
+
 <dl>
 
 <dt><i>functionNode</i> (ast.AsyncFunctionDef, ast.FunctionDef or ast.Lambda)</dt>
@@ -537,10 +532,10 @@
 <a NAME="UnusedChecker.__getUnusedArguments" ID="UnusedChecker.__getUnusedArguments"></a>
 <h4>UnusedChecker.__getUnusedArguments</h4>
 <b>__getUnusedArguments</b>(<i>functionNode</i>)
-
 <p>
         Private method to get a list of unused arguments of the given function.
 </p>
+
 <dl>
 
 <dt><i>functionNode</i> (ast.AsyncFunctionDef, ast.FunctionDef or ast.Lambda)</dt>
@@ -563,10 +558,10 @@
 <a NAME="UnusedChecker.__ignoreCode" ID="UnusedChecker.__ignoreCode"></a>
 <h4>UnusedChecker.__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>
@@ -589,10 +584,10 @@
 <a NAME="UnusedChecker.__isDunderMethod" ID="UnusedChecker.__isDunderMethod"></a>
 <h4>UnusedChecker.__isDunderMethod</h4>
 <b>__isDunderMethod</b>(<i>functionNode</i>)
-
 <p>
         Private method to check, if the function node defines a special function.
 </p>
+
 <dl>
 
 <dt><i>functionNode</i> (ast.AsyncFunctionDef, ast.FunctionDef or ast.Lambda)</dt>
@@ -615,7 +610,6 @@
 <a NAME="UnusedChecker.__isEventHandlerMethod" ID="UnusedChecker.__isEventHandlerMethod"></a>
 <h4>UnusedChecker.__isEventHandlerMethod</h4>
 <b>__isEventHandlerMethod</b>(<i>functionNode</i>)
-
 <p>
         Private method to check, if the function node defines a Qt event handler.
 </p>
@@ -624,6 +618,7 @@
         'event' or 'eventFilter'. Only standard methodes (i.e. ast.FunctionDef)
         are assumed to be potential event handlers.
 </p>
+
 <dl>
 
 <dt><i>functionNode</i> (ast.AsyncFunctionDef, ast.FunctionDef or ast.Lambda)</dt>
@@ -646,10 +641,10 @@
 <a NAME="UnusedChecker.__isStubFunction" ID="UnusedChecker.__isStubFunction"></a>
 <h4>UnusedChecker.__isStubFunction</h4>
 <b>__isStubFunction</b>(<i>functionNode</i>)
-
 <p>
         Private method to check, if the given function node defines a stub function.
 </p>
+
 <dl>
 
 <dt><i>functionNode</i> (ast.AsyncFunctionDef, ast.FunctionDef or ast.Lambda)</dt>
@@ -672,11 +667,11 @@
 <a NAME="UnusedChecker.run" ID="UnusedChecker.run"></a>
 <h4>UnusedChecker.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 />
-</body></html>
\ No newline at end of file
+</body></html>

Mercurial Repository: eric

eric ide

mercurial