--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.PathLib.PathlibChecker.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.PathLib.PathlibChecker.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,20 +7,18 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.PathLib.PathlibChecker</h1> - <p> Module implementing the checker for functions that can be replaced by use of the pathlib module. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#NameResolver">NameResolver</a></td> <td>Class to resolve a Name or Attribute node.</td> @@ -34,35 +32,34 @@ <td>Class to traverse the AST node tree and check for potential issues.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="NameResolver" ID="NameResolver"></a> <h2>NameResolver</h2> - <p> Class to resolve a Name or Attribute node. </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="#NameResolver.__init__">NameResolver</a></td> <td>Constructor</td> @@ -80,19 +77,20 @@ <td>Public method to handle the Name AST node.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="NameResolver.__init__" ID="NameResolver.__init__"></a> <h4>NameResolver (Constructor)</h4> <b>NameResolver</b>(<i>importAlias</i>) - <p> Constructor </p> + <dl> <dt><i>importAlias</i> (dict)</dt> @@ -103,10 +101,10 @@ <a NAME="NameResolver.name" ID="NameResolver.name"></a> <h4>NameResolver.name</h4> <b>name</b>(<i></i>) - <p> Public method to resolve the name. </p> + <dl> <dt>Return:</dt> <dd> @@ -122,10 +120,10 @@ <a NAME="NameResolver.visit_Attribute" ID="NameResolver.visit_Attribute"></a> <h4>NameResolver.visit_Attribute</h4> <b>visit_Attribute</b>(<i>node</i>) - <p> Public method to handle the Attribute AST node. </p> + <dl> <dt><i>node</i> (ast.Attribute)</dt> @@ -136,10 +134,10 @@ <a NAME="NameResolver.visit_Name" ID="NameResolver.visit_Name"></a> <h4>NameResolver.visit_Name</h4> <b>visit_Name</b>(<i>node</i>) - <p> Public method to handle the Name AST node. </p> + <dl> <dt><i>node</i> (ast.Name)</dt> @@ -152,27 +150,26 @@ <hr /> <a NAME="PathlibChecker" ID="PathlibChecker"></a> <h2>PathlibChecker</h2> - <p> Class implementing a checker for functions that can be replaced by use of the pathlib module. </p> + <h3>Derived from</h3> None <h3>Class Attributes</h3> +<table> +<tr><td>Codes</td></tr> +<tr><td>Function2Code</td></tr> +</table> -<table> -<tr><td>Codes</td></tr><tr><td>Function2Code</td></tr> -</table> <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#PathlibChecker.__init__">PathlibChecker</a></td> <td>Constructor</td> @@ -194,19 +191,20 @@ <td>Public method to check the given source against functions to be replaced by 'pathlib' equivalents.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="PathlibChecker.__init__" ID="PathlibChecker.__init__"></a> <h4>PathlibChecker (Constructor)</h4> <b>PathlibChecker</b>(<i>source, filename, tree, selected, ignored, expected, repeat</i>) - <p> Constructor </p> + <dl> <dt><i>source</i> (list of str)</dt> @@ -241,11 +239,11 @@ <a NAME="PathlibChecker.__checkForReplacement" ID="PathlibChecker.__checkForReplacement"></a> <h4>PathlibChecker.__checkForReplacement</h4> <b>__checkForReplacement</b>(<i>node, name</i>) - <p> Private method to check the given node for the need for a replacement. </p> + <dl> <dt><i>node</i> (ast.AST)</dt> @@ -260,10 +258,10 @@ <a NAME="PathlibChecker.__error" ID="PathlibChecker.__error"></a> <h4>PathlibChecker.__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> @@ -286,10 +284,10 @@ <a NAME="PathlibChecker.__ignoreCode" ID="PathlibChecker.__ignoreCode"></a> <h4>PathlibChecker.__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> @@ -312,36 +310,34 @@ <a NAME="PathlibChecker.run" ID="PathlibChecker.run"></a> <h4>PathlibChecker.run</h4> <b>run</b>(<i></i>) - <p> Public method to check the given source against functions to be replaced by 'pathlib' equivalents. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="PathlibVisitor" ID="PathlibVisitor"></a> <h2>PathlibVisitor</h2> - <p> Class to traverse the AST node tree and check for potential issues. </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="#PathlibVisitor.__init__">PathlibVisitor</a></td> <td>Constructor</td> @@ -359,19 +355,20 @@ <td>Public method handle the ImportFrom AST node.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="PathlibVisitor.__init__" ID="PathlibVisitor.__init__"></a> <h4>PathlibVisitor (Constructor)</h4> <b>PathlibVisitor</b>(<i>checkCallback</i>) - <p> Constructor </p> + <dl> <dt><i>checkCallback</i> (func)</dt> @@ -383,10 +380,10 @@ <a NAME="PathlibVisitor.visit_Call" ID="PathlibVisitor.visit_Call"></a> <h4>PathlibVisitor.visit_Call</h4> <b>visit_Call</b>(<i>node</i>) - <p> Public method to handle the Call AST node. </p> + <dl> <dt><i>node</i> (ast.Call)</dt> @@ -397,10 +394,10 @@ <a NAME="PathlibVisitor.visit_Import" ID="PathlibVisitor.visit_Import"></a> <h4>PathlibVisitor.visit_Import</h4> <b>visit_Import</b>(<i>node</i>) - <p> Public method to handle the Import AST node. </p> + <dl> <dt><i>node</i> (ast.Import)</dt> @@ -411,10 +408,10 @@ <a NAME="PathlibVisitor.visit_ImportFrom" ID="PathlibVisitor.visit_ImportFrom"></a> <h4>PathlibVisitor.visit_ImportFrom</h4> <b>visit_ImportFrom</b>(<i>node</i>) - <p> Public method handle the ImportFrom AST node. </p> + <dl> <dt><i>node</i> (ast.ImportFrom)</dt> @@ -424,4 +421,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>