--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.NameOrder.NameOrderChecker.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.NameOrder.NameOrderChecker.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,34 +7,32 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.NameOrder.NameOrderChecker</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="#NameOrderChecker">NameOrderChecker</a></td>
<td>Class implementing a checker for name ordering.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="NameOrderChecker" ID="NameOrderChecker"></a>
<h2>NameOrderChecker</h2>
-
<p>
Class implementing a checker for name ordering.
</p>
@@ -42,22 +40,21 @@
Note: Name ordering is checked for import statements, the '__all__' statement
and exception names of exception handlers.
</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="#NameOrderChecker.__init__">NameOrderChecker</a></td>
<td>Constructor</td>
@@ -123,19 +120,20 @@
<td>Public method to sort the given list of names.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="NameOrderChecker.__init__" ID="NameOrderChecker.__init__"></a>
<h4>NameOrderChecker (Constructor)</h4>
<b>NameOrderChecker</b>(<i>source, filename, tree, select, ignore, expected, repeat, args</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>source</i> (list of str)</dt>
@@ -174,10 +172,10 @@
<a NAME="NameOrderChecker.__atoi" ID="NameOrderChecker.__atoi"></a>
<h4>NameOrderChecker.__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>
@@ -200,17 +198,17 @@
<a NAME="NameOrderChecker.__checkNameOrder" ID="NameOrderChecker.__checkNameOrder"></a>
<h4>NameOrderChecker.__checkNameOrder</h4>
<b>__checkNameOrder</b>(<i></i>)
-
<p>
Private method to check the order of import statements and handled exceptions.
</p>
+
<a NAME="NameOrderChecker.__error" ID="NameOrderChecker.__error"></a>
<h4>NameOrderChecker.__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>
@@ -233,10 +231,10 @@
<a NAME="NameOrderChecker.__findErrorInAll" ID="NameOrderChecker.__findErrorInAll"></a>
<h4>NameOrderChecker.__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>
@@ -260,10 +258,10 @@
<a NAME="NameOrderChecker.__findExceptionListErrors" ID="NameOrderChecker.__findExceptionListErrors"></a>
<h4>NameOrderChecker.__findExceptionListErrors</h4>
<b>__findExceptionListErrors</b>(<i>nodes</i>)
-
<p>
Private method to check the exception node for errors.
</p>
+
<dl>
<dt><i>nodes</i> (list of ast.List or ast.Tuple)</dt>
@@ -286,10 +284,10 @@
<a NAME="NameOrderChecker.__findExceptionListNodes" ID="NameOrderChecker.__findExceptionListNodes"></a>
<h4>NameOrderChecker.__findExceptionListNodes</h4>
<b>__findExceptionListNodes</b>(<i>tree</i>)
-
<p>
Private method to find all exception types handled by given tree.
</p>
+
<dl>
<dt><i>tree</i> (ast.AST)</dt>
@@ -312,10 +310,10 @@
<a NAME="NameOrderChecker.__findExceptionListStr" ID="NameOrderChecker.__findExceptionListStr"></a>
<h4>NameOrderChecker.__findExceptionListStr</h4>
<b>__findExceptionListStr</b>(<i>node</i>)
-
<p>
Private method to get the exception name out of an exception handler type node.
</p>
+
<dl>
<dt><i>node</i> (ast.Name or ast.Attribute)</dt>
@@ -338,11 +336,11 @@
<a NAME="NameOrderChecker.__findNodes" ID="NameOrderChecker.__findNodes"></a>
<h4>NameOrderChecker.__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>
@@ -367,10 +365,10 @@
<a NAME="NameOrderChecker.__ignoreCode" ID="NameOrderChecker.__ignoreCode"></a>
<h4>NameOrderChecker.__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>
@@ -393,10 +391,10 @@
<a NAME="NameOrderChecker.__naturalKeys" ID="NameOrderChecker.__naturalKeys"></a>
<h4>NameOrderChecker.__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>
@@ -419,7 +417,6 @@
<a NAME="NameOrderChecker.__naturally" ID="NameOrderChecker.__naturally"></a>
<h4>NameOrderChecker.__naturally</h4>
<b>__naturally</b>(<i>toSort, key=None, reverse=False</i>)
-
<p>
Private method to sort the given list of names naturally.
</p>
@@ -428,6 +425,7 @@
[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>
@@ -462,10 +460,10 @@
<a NAME="NameOrderChecker.moduleKey" ID="NameOrderChecker.moduleKey"></a>
<h4>NameOrderChecker.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>
@@ -493,18 +491,18 @@
<a NAME="NameOrderChecker.run" ID="NameOrderChecker.run"></a>
<h4>NameOrderChecker.run</h4>
<b>run</b>(<i></i>)
-
<p>
Public method to check the given source against miscellaneous
conditions.
</p>
+
<a NAME="NameOrderChecker.sorted" ID="NameOrderChecker.sorted"></a>
<h4>NameOrderChecker.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>
@@ -534,4 +532,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
