--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Imports.ImportsChecker.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Imports.ImportsChecker.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Imports.ImportsChecker</h1>
-
<p>
Module implementing a checker for import statements.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#ImportsChecker">ImportsChecker</a></td>
<td>Class implementing a checker for import statements.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="ImportsChecker" ID="ImportsChecker"></a>
<h2>ImportsChecker</h2>
-
<p>
Class implementing a checker for import statements.
</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="#ImportsChecker.__init__">ImportsChecker</a></td>
<td>Constructor</td>
@@ -99,19 +96,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="ImportsChecker.__init__" ID="ImportsChecker.__init__"></a>
<h4>ImportsChecker (Constructor)</h4>
<b>ImportsChecker</b>(<i>source, filename, tree, select, ignore, expected, repeat, args</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>source</i> (list of str)</dt>
@@ -150,10 +148,10 @@
<a NAME="ImportsChecker.__checkBannedImport" ID="ImportsChecker.__checkBannedImport"></a>
<h4>ImportsChecker.__checkBannedImport</h4>
<b>__checkBannedImport</b>(<i>node</i>)
-
<p>
Private method to check import of banned modules.
</p>
+
<dl>
<dt><i>node</i> (ast.AST)</dt>
@@ -164,10 +162,10 @@
<a NAME="ImportsChecker.__checkBannedRelativeImports" ID="ImportsChecker.__checkBannedRelativeImports"></a>
<h4>ImportsChecker.__checkBannedRelativeImports</h4>
<b>__checkBannedRelativeImports</b>(<i>node</i>)
-
<p>
Private method to check if relative imports are banned.
</p>
+
<dl>
<dt><i>node</i> (ast.AST)</dt>
@@ -178,17 +176,17 @@
<a NAME="ImportsChecker.__checkLocalImports" ID="ImportsChecker.__checkLocalImports"></a>
<h4>ImportsChecker.__checkLocalImports</h4>
<b>__checkLocalImports</b>(<i></i>)
-
<p>
Private method to check local imports.
</p>
+
<a NAME="ImportsChecker.__checkUnnecessaryAlias" ID="ImportsChecker.__checkUnnecessaryAlias"></a>
<h4>ImportsChecker.__checkUnnecessaryAlias</h4>
<b>__checkUnnecessaryAlias</b>(<i>node</i>)
-
<p>
Private method to check unnecessary import aliases.
</p>
+
<dl>
<dt><i>node</i> (ast.AST)</dt>
@@ -199,11 +197,11 @@
<a NAME="ImportsChecker.__compileUnstructuredGlob" ID="ImportsChecker.__compileUnstructuredGlob"></a>
<h4>ImportsChecker.__compileUnstructuredGlob</h4>
<b>__compileUnstructuredGlob</b>(<i>module</i>)
-
<p>
Private method to convert a pattern to a regex such that ".*" matches zero or
more modules.
</p>
+
<dl>
<dt><i>module</i> (str)</dt>
@@ -226,10 +224,10 @@
<a NAME="ImportsChecker.__error" ID="ImportsChecker.__error"></a>
<h4>ImportsChecker.__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>
@@ -252,10 +250,10 @@
<a NAME="ImportsChecker.__ignoreCode" ID="ImportsChecker.__ignoreCode"></a>
<h4>ImportsChecker.__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>
@@ -278,10 +276,10 @@
<a NAME="ImportsChecker.__isModuleBanned" ID="ImportsChecker.__isModuleBanned"></a>
<h4>ImportsChecker.__isModuleBanned</h4>
<b>__isModuleBanned</b>(<i>moduleName</i>)
-
<p>
Private method to check, if the given module name banned.
</p>
+
<dl>
<dt><i>moduleName</i> (str)</dt>
@@ -304,18 +302,18 @@
<a NAME="ImportsChecker.__tidyImports" ID="ImportsChecker.__tidyImports"></a>
<h4>ImportsChecker.__tidyImports</h4>
<b>__tidyImports</b>(<i></i>)
-
<p>
Private method to check various other import related topics.
</p>
+
<a NAME="ImportsChecker.run" ID="ImportsChecker.run"></a>
<h4>ImportsChecker.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>
