diff -r f5c57f8d17a4 -r 35b27af462ef src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Imports.ImportsChecker.html --- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Imports.ImportsChecker.html Sat May 20 19:50:13 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Imports.ImportsChecker.html Sun May 21 15:26:11 2023 +0200 @@ -59,10 +59,6 @@ <td>Constructor</td> </tr> <tr> -<td><a href="#ImportsChecker.__atoi">__atoi</a></td> -<td>Private method to convert the given text to an integer number.</td> -</tr> -<tr> <td><a href="#ImportsChecker.__checkBannedImport">__checkBannedImport</a></td> <td>Private method to check import of banned modules.</td> </tr> @@ -71,10 +67,6 @@ <td>Private method to check if relative imports are banned.</td> </tr> <tr> -<td><a href="#ImportsChecker.__checkImportOrder">__checkImportOrder</a></td> -<td>Private method to check the order of import statements.</td> -</tr> -<tr> <td><a href="#ImportsChecker.__checkLocalImports">__checkLocalImports</a></td> <td>Private method to check local imports.</td> </tr> @@ -91,14 +83,6 @@ <td>Private method to record an issue.</td> </tr> <tr> -<td><a href="#ImportsChecker.__findErrorInAll">__findErrorInAll</a></td> -<td>Private method to check the '__all__' node for errors.</td> -</tr> -<tr> -<td><a href="#ImportsChecker.__findNodes">__findNodes</a></td> -<td>Private method to find all import and import from nodes of the given tree.</td> -</tr> -<tr> <td><a href="#ImportsChecker.__ignoreCode">__ignoreCode</a></td> <td>Private method to check if the message code should be ignored.</td> </tr> @@ -107,37 +91,13 @@ <td>Private method to check, if the given module name banned.</td> </tr> <tr> -<td><a href="#ImportsChecker.__naturalKeys">__naturalKeys</a></td> -<td>Private method to generate keys for natural sorting.</td> -</tr> -<tr> -<td><a href="#ImportsChecker.__naturally">__naturally</a></td> -<td>Private method to sort the given list of names naturally.</td> -</tr> -<tr> <td><a href="#ImportsChecker.__tidyImports">__tidyImports</a></td> <td>Private method to check various other import related topics.</td> </tr> <tr> -<td><a href="#ImportsChecker.getStandardModules">getStandardModules</a></td> -<td>Public method to get a list of modules of the standard library.</td> -</tr> -<tr> -<td><a href="#ImportsChecker.keyCallback">keyCallback</a></td> -<td></td> -</tr> -<tr> -<td><a href="#ImportsChecker.moduleKey">moduleKey</a></td> -<td>Public method to generate a key for the given module name.</td> -</tr> -<tr> <td><a href="#ImportsChecker.run">run</a></td> <td>Public method to check the given source against miscellaneous conditions.</td> </tr> -<tr> -<td><a href="#ImportsChecker.sorted">sorted</a></td> -<td>Public method to sort the given list of names.</td> -</tr> </table> <h3>Static Methods</h3> @@ -187,32 +147,6 @@ dictionary of arguments for the various checks </dd> </dl> -<a NAME="ImportsChecker.__atoi" ID="ImportsChecker.__atoi"></a> -<h4>ImportsChecker.__atoi</h4> -<b>__atoi</b>(<i>text</i>) - -<p> - Private method to convert the given text to an integer number. -</p> -<dl> - -<dt><i>text</i> (str)</dt> -<dd> -text to be converted -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -integer number -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -int -</dd> -</dl> <a NAME="ImportsChecker.__checkBannedImport" ID="ImportsChecker.__checkBannedImport"></a> <h4>ImportsChecker.__checkBannedImport</h4> <b>__checkBannedImport</b>(<i>node</i>) @@ -241,13 +175,6 @@ reference to the node to be checked </dd> </dl> -<a NAME="ImportsChecker.__checkImportOrder" ID="ImportsChecker.__checkImportOrder"></a> -<h4>ImportsChecker.__checkImportOrder</h4> -<b>__checkImportOrder</b>(<i></i>) - -<p> - Private method to check the order of import statements. -</p> <a NAME="ImportsChecker.__checkLocalImports" ID="ImportsChecker.__checkLocalImports"></a> <h4>ImportsChecker.__checkLocalImports</h4> <b>__checkLocalImports</b>(<i></i>) @@ -322,59 +249,6 @@ arguments for the message </dd> </dl> -<a NAME="ImportsChecker.__findErrorInAll" ID="ImportsChecker.__findErrorInAll"></a> -<h4>ImportsChecker.__findErrorInAll</h4> -<b>__findErrorInAll</b>(<i>node</i>) - -<p> - Private method to check the '__all__' node for errors. -</p> -<dl> - -<dt><i>node</i> (ast.List or ast.Tuple)</dt> -<dd> -reference to the '__all__' node -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -tuple containing a reference to the node and an error code -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -rtype tuple of (ast.List | ast.Tuple, str) -</dd> -</dl> -<a NAME="ImportsChecker.__findNodes" ID="ImportsChecker.__findNodes"></a> -<h4>ImportsChecker.__findNodes</h4> -<b>__findNodes</b>(<i>tree</i>) - -<p> - Private method to find all import and import from nodes of the given - tree. -</p> -<dl> - -<dt><i>tree</i> (ast.AST)</dt> -<dd> -reference to the ast node tree to be parsed -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -tuple containing a list of import nodes and the '__all__' node -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -tuple of (ast.Import | ast.ImportFrom, ast.List | ast.Tuple) -</dd> -</dl> <a NAME="ImportsChecker.__ignoreCode" ID="ImportsChecker.__ignoreCode"></a> <h4>ImportsChecker.__ignoreCode</h4> <b>__ignoreCode</b>(<i>code</i>) @@ -427,71 +301,6 @@ bool </dd> </dl> -<a NAME="ImportsChecker.__naturalKeys" ID="ImportsChecker.__naturalKeys"></a> -<h4>ImportsChecker.__naturalKeys</h4> -<b>__naturalKeys</b>(<i>text</i>) - -<p> - Private method to generate keys for natural sorting. -</p> -<dl> - -<dt><i>text</i> (str)</dt> -<dd> -text to generate a key for -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -key for natural sorting -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -list of str or int -</dd> -</dl> -<a NAME="ImportsChecker.__naturally" ID="ImportsChecker.__naturally"></a> -<h4>ImportsChecker.__naturally</h4> -<b>__naturally</b>(<i>toSort, key=None, reverse=False</i>) - -<p> - Private method to sort the given list of names naturally. -</p> -<p> - Note: Natural sorting maintains the sort order of numbers (i.e. - [Q1, Q10, Q2] is sorted as [Q1, Q2, Q10] while the Python - standard sort would yield [Q1, Q10, Q2]. -</p> -<dl> - -<dt><i>toSort</i> (list of str)</dt> -<dd> -list of names to be sorted -</dd> -<dt><i>key</i> (function (optional))</dt> -<dd> -function to generate keys (defaults to None) -</dd> -<dt><i>reverse</i> (bool (optional))</dt> -<dd> -flag indicating a reverse sort (defaults to False) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -sorted list of names -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -list of str -</dd> -</dl> <a NAME="ImportsChecker.__tidyImports" ID="ImportsChecker.__tidyImports"></a> <h4>ImportsChecker.__tidyImports</h4> <b>__tidyImports</b>(<i></i>) @@ -499,60 +308,6 @@ <p> Private method to check various other import related topics. </p> -<a NAME="ImportsChecker.getStandardModules" ID="ImportsChecker.getStandardModules"></a> -<h4>ImportsChecker.getStandardModules</h4> -<b>getStandardModules</b>(<i></i>) - -<p> - Public method to get a list of modules of the standard library. -</p> -<dl> -<dt>Return:</dt> -<dd> -set of builtin modules -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -set of str -</dd> -</dl> -<a NAME="ImportsChecker.keyCallback" ID="ImportsChecker.keyCallback"></a> -<h4>ImportsChecker.keyCallback</h4> -<b>keyCallback</b>(<i></i>) - -<a NAME="ImportsChecker.moduleKey" ID="ImportsChecker.moduleKey"></a> -<h4>ImportsChecker.moduleKey</h4> -<b>moduleKey</b>(<i>moduleName, subImports=False</i>) - -<p> - Public method to generate a key for the given module name. -</p> -<dl> - -<dt><i>moduleName</i> (str)</dt> -<dd> -module name -</dd> -<dt><i>subImports</i> (bool (optional))</dt> -<dd> -flag indicating a sub import like in - 'from foo import bar, baz' (defaults to False) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -generated key -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl> <a NAME="ImportsChecker.run" ID="ImportsChecker.run"></a> <h4>ImportsChecker.run</h4> <b>run</b>(<i></i>) @@ -561,40 +316,6 @@ Public method to check the given source against miscellaneous conditions. </p> -<a NAME="ImportsChecker.sorted" ID="ImportsChecker.sorted"></a> -<h4>ImportsChecker.sorted</h4> -<b>sorted</b>(<i>toSort, key=None, reverse=False</i>) - -<p> - Public method to sort the given list of names. -</p> -<dl> - -<dt><i>toSort</i> (list of str)</dt> -<dd> -list of names to be sorted -</dd> -<dt><i>key</i> (function (optional))</dt> -<dd> -function to generate keys (defaults to None) -</dd> -<dt><i>reverse</i> (bool (optional))</dt> -<dd> -flag indicating a reverse sort (defaults to False) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -sorted list of names -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -list of str -</dd> -</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file