diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.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.Naming.NamingStyleChecker</h1>
-
<p>
Module implementing a checker for naming conventions.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#NamingStyleChecker">NamingStyleChecker</a></td>
<td>Class implementing a checker for naming conventions.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="NamingStyleChecker" ID="NamingStyleChecker"></a>
<h2>NamingStyleChecker</h2>
-
<p>
Class implementing a checker for naming conventions.
</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="#NamingStyleChecker.__init__">NamingStyleChecker</a></td>
<td>Constructor (according to 'extended' pycodestyle.py API)</td>
@@ -155,19 +152,20 @@
<td>Public method run by the pycodestyle.py checker.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="NamingStyleChecker.__init__" ID="NamingStyleChecker.__init__"></a>
<h4>NamingStyleChecker (Constructor)</h4>
<b>NamingStyleChecker</b>(<i>tree, filename, options</i>)
-
<p>
Constructor (according to 'extended' pycodestyle.py API)
</p>
+
<dl>
<dt><i>tree</i> (ast.AST)</dt>
@@ -186,7 +184,6 @@
<a NAME="NamingStyleChecker.__checkClassName" ID="NamingStyleChecker.__checkClassName"></a>
<h4>NamingStyleChecker.__checkClassName</h4>
<b>__checkClassName</b>(<i>node, parents</i>)
-
<p>
Private class to check the given node for class name
conventions (N801, N818).
@@ -195,6 +192,7 @@
Almost without exception, class names use the CapWords convention.
Classes for internal use have a leading underscore in addition.
</p>
+
<dl>
<dt><i>node</i> (ast.ClassDef)</dt>
@@ -221,7 +219,6 @@
<a NAME="NamingStyleChecker.__checkFunctionArgumentNames" ID="NamingStyleChecker.__checkFunctionArgumentNames"></a>
<h4>NamingStyleChecker.__checkFunctionArgumentNames</h4>
<b>__checkFunctionArgumentNames</b>(<i>node, parents</i>)
-
<p>
Private class to check the argument names of functions
(N803, N804, N805, N806).
@@ -231,6 +228,7 @@
separated by underscores. A class method should have 'cls' as the
first argument. A method should have 'self' as the first argument.
</p>
+
<dl>
<dt><i>node</i> (ast.FunctionDef or ast.AsynFunctionDef)</dt>
@@ -257,7 +255,6 @@
<a NAME="NamingStyleChecker.__checkFunctionName" ID="NamingStyleChecker.__checkFunctionName"></a>
<h4>NamingStyleChecker.__checkFunctionName</h4>
<b>__checkFunctionName</b>(<i>node, parents</i>)
-
<p>
Private class to check the given node for function name
conventions (N802, N809).
@@ -269,6 +266,7 @@
only in contexts where that's already the prevailing style
(e.g. threading.py), to retain backwards compatibility.
</p>
+
<dl>
<dt><i>node</i> (ast.FunctionDef or ast.AsynFunctionDef)</dt>
@@ -295,11 +293,11 @@
<a NAME="NamingStyleChecker.__checkImportAs" ID="NamingStyleChecker.__checkImportAs"></a>
<h4>NamingStyleChecker.__checkImportAs</h4>
<b>__checkImportAs</b>(<i>node, parents</i>)
-
<p>
Private method to check that imports don't change the
naming convention (N811, N812, N813, N814, N815).
</p>
+
<dl>
<dt><i>node</i> (ast.Import)</dt>
@@ -326,13 +324,13 @@
<a NAME="NamingStyleChecker.__checkModule" ID="NamingStyleChecker.__checkModule"></a>
<h4>NamingStyleChecker.__checkModule</h4>
<b>__checkModule</b>(<i>node, parents</i>)
-
<p>
Private method to check module naming conventions (N807, N808).
</p>
<p>
Module and package names should be lowercase.
</p>
+
<dl>
<dt><i>node</i> (ast.AST)</dt>
@@ -359,10 +357,10 @@
<a NAME="NamingStyleChecker.__checkNameToBeAvoided" ID="NamingStyleChecker.__checkNameToBeAvoided"></a>
<h4>NamingStyleChecker.__checkNameToBeAvoided</h4>
<b>__checkNameToBeAvoided</b>(<i>node, parents</i>)
-
<p>
Private class to check the given node for a name to be avoided (N831).
</p>
+
<dl>
<dt><i>node</i> (ast.Ast)</dt>
@@ -389,7 +387,6 @@
<a NAME="NamingStyleChecker.__checkVariableNames" ID="NamingStyleChecker.__checkVariableNames"></a>
<h4>NamingStyleChecker.__checkVariableNames</h4>
<b>__checkVariableNames</b>(<i>node, parents</i>)
-
<p>
Private method to check variable names in function, class and global scope
(N821, N822, N823).
@@ -397,6 +394,7 @@
<p>
Local variables in functions should be lowercase.
</p>
+
<dl>
<dt><i>node</i> (ast.AST)</dt>
@@ -423,10 +421,10 @@
<a NAME="NamingStyleChecker.__classVariableCheck" ID="NamingStyleChecker.__classVariableCheck"></a>
<h4>NamingStyleChecker.__classVariableCheck</h4>
<b>__classVariableCheck</b>(<i>name</i>)
-
<p>
Private method to determine the error code for a variable in class scope.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -449,10 +447,10 @@
<a NAME="NamingStyleChecker.__error" ID="NamingStyleChecker.__error"></a>
<h4>NamingStyleChecker.__error</h4>
<b>__error</b>(<i>node, code</i>)
-
<p>
Private method to build the error information.
</p>
+
<dl>
<dt><i>node</i> (ast.AST)</dt>
@@ -479,10 +477,10 @@
<a NAME="NamingStyleChecker.__extractNames" ID="NamingStyleChecker.__extractNames"></a>
<h4>NamingStyleChecker.__extractNames</h4>
<b>__extractNames</b>(<i>assignmentTarget</i>)
-
<p>
Private method to extract the names from the target node.
</p>
+
<dl>
<dt><i>assignmentTarget</i> (ast.Name, ast.Tuple, ast.List or ast.ExceptHandler)</dt>
@@ -505,10 +503,10 @@
<a NAME="NamingStyleChecker.__findGlobalDefs" ID="NamingStyleChecker.__findGlobalDefs"></a>
<h4>NamingStyleChecker.__findGlobalDefs</h4>
<b>__findGlobalDefs</b>(<i>functionNode</i>)
-
<p>
Private method amend a node with global definitions information.
</p>
+
<dl>
<dt><i>functionNode</i> (ast.FunctionDef or ast.AsyncFunctionDef)</dt>
@@ -519,10 +517,10 @@
<a NAME="NamingStyleChecker.__findVariableNameErrors" ID="NamingStyleChecker.__findVariableNameErrors"></a>
<h4>NamingStyleChecker.__findVariableNameErrors</h4>
<b>__findVariableNameErrors</b>(<i>assignmentTarget, parents</i>)
-
<p>
Private method to check, if there is a variable name error.
</p>
+
<dl>
<dt><i>assignmentTarget</i> (ast.Name, ast.Tuple, ast.List or ast.ExceptHandler)</dt>
@@ -549,10 +547,10 @@
<a NAME="NamingStyleChecker.__functionVariableCheck" ID="NamingStyleChecker.__functionVariableCheck"></a>
<h4>NamingStyleChecker.__functionVariableCheck</h4>
<b>__functionVariableCheck</b>(<i>func, varName</i>)
-
<p>
Private method to determine the error code for a variable in class scope.
</p>
+
<dl>
<dt><i>func</i> (ast.FunctionDef or ast.AsyncFunctionDef)</dt>
@@ -579,10 +577,10 @@
<a NAME="NamingStyleChecker.__getArgNames" ID="NamingStyleChecker.__getArgNames"></a>
<h4>NamingStyleChecker.__getArgNames</h4>
<b>__getArgNames</b>(<i>node</i>)
-
<p>
Private method to get the argument names of a function node.
</p>
+
<dl>
<dt><i>node</i> (ast.FunctionDef or ast.AsyncFunctionDef)</dt>
@@ -605,10 +603,10 @@
<a NAME="NamingStyleChecker.__getClassdef" ID="NamingStyleChecker.__getClassdef"></a>
<h4>NamingStyleChecker.__getClassdef</h4>
<b>__getClassdef</b>(<i>name, parents</i>)
-
<p>
Private method to extract the class definition.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -635,10 +633,10 @@
<a NAME="NamingStyleChecker.__globalVariableCheck" ID="NamingStyleChecker.__globalVariableCheck"></a>
<h4>NamingStyleChecker.__globalVariableCheck</h4>
<b>__globalVariableCheck</b>(<i>name</i>)
-
<p>
Private method to determine the error code for a variable in global scope.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -661,10 +659,10 @@
<a NAME="NamingStyleChecker.__isMixedCase" ID="NamingStyleChecker.__isMixedCase"></a>
<h4>NamingStyleChecker.__isMixedCase</h4>
<b>__isMixedCase</b>(<i>name</i>)
-
<p>
Private method to check, if the given name is mixed case.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -687,10 +685,10 @@
<a NAME="NamingStyleChecker.__isNameToBeAvoided" ID="NamingStyleChecker.__isNameToBeAvoided"></a>
<h4>NamingStyleChecker.__isNameToBeAvoided</h4>
<b>__isNameToBeAvoided</b>(<i>name</i>)
-
<p>
Private method to check, if the given name should be avoided.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -713,10 +711,10 @@
<a NAME="NamingStyleChecker.__isNamedTupel" ID="NamingStyleChecker.__isNamedTupel"></a>
<h4>NamingStyleChecker.__isNamedTupel</h4>
<b>__isNamedTupel</b>(<i>nodeValue</i>)
-
<p>
Private method to check, if a node is a named tuple.
</p>
+
<dl>
<dt><i>nodeValue</i> (ast.AST)</dt>
@@ -739,10 +737,10 @@
<a NAME="NamingStyleChecker.__superClassNames" ID="NamingStyleChecker.__superClassNames"></a>
<h4>NamingStyleChecker.__superClassNames</h4>
<b>__superClassNames</b>(<i>name, parents, names=None</i>)
-
<p>
Private method to extract the names of all super classes.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -773,11 +771,11 @@
<a NAME="NamingStyleChecker.__tagClassFunctions" ID="NamingStyleChecker.__tagClassFunctions"></a>
<h4>NamingStyleChecker.__tagClassFunctions</h4>
<b>__tagClassFunctions</b>(<i>classNode</i>)
-
<p>
Private method to tag functions if they are methods, class methods or
static methods.
</p>
+
<dl>
<dt><i>classNode</i> (ast.ClassDef)</dt>
@@ -788,10 +786,10 @@
<a NAME="NamingStyleChecker.__visitNode" ID="NamingStyleChecker.__visitNode"></a>
<h4>NamingStyleChecker.__visitNode</h4>
<b>__visitNode</b>(<i>node</i>)
-
<p>
Private method to inspect the given AST node.
</p>
+
<dl>
<dt><i>node</i> (ast.AST)</dt>
@@ -814,10 +812,10 @@
<a NAME="NamingStyleChecker.__visitTree" ID="NamingStyleChecker.__visitTree"></a>
<h4>NamingStyleChecker.__visitTree</h4>
<b>__visitTree</b>(<i>node</i>)
-
<p>
Private method to scan the given AST tree.
</p>
+
<dl>
<dt><i>node</i> (ast.AST)</dt>
@@ -840,10 +838,10 @@
<a NAME="NamingStyleChecker.run" ID="NamingStyleChecker.run"></a>
<h4>NamingStyleChecker.run</h4>
<b>run</b>(<i></i>)
-
<p>
Public method run by the pycodestyle.py checker.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -859,4 +857,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
