--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html Sun Jul 24 16:41:08 2022 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html Wed Jul 27 15:01:13 2022 +0200
@@ -43,7 +43,7 @@
<h3>Class Attributes</h3>
<table>
-<tr><td>CamelcaseRegexp</td></tr><tr><td>Codes</td></tr><tr><td>LowercaseRegex</td></tr><tr><td>MixedcaseRegexp</td></tr><tr><td>UppercaseRegexp</td></tr>
+<tr><td>Codes</td></tr>
</table>
<h3>Class Methods</h3>
@@ -60,7 +60,7 @@
</tr>
<tr>
<td><a href="#NamingStyleChecker.__checkClassName">__checkClassName</a></td>
-<td>Private class to check the given node for class name conventions (N801).</td>
+<td>Private class to check the given node for class name conventions (N801, N818).</td>
</tr>
<tr>
<td><a href="#NamingStyleChecker.__checkFunctionArgumentNames">__checkFunctionArgumentNames</a></td>
@@ -68,11 +68,11 @@
</tr>
<tr>
<td><a href="#NamingStyleChecker.__checkFunctionName">__checkFunctionName</a></td>
-<td>Private class to check the given node for function name conventions (N802).</td>
+<td>Private class to check the given node for function name conventions (N802, N809).</td>
</tr>
<tr>
<td><a href="#NamingStyleChecker.__checkImportAs">__checkImportAs</a></td>
-<td>Private method to check that imports don't change the naming convention (N811, N812, N813, N814).</td>
+<td>Private method to check that imports don't change the naming convention (N811, N812, N813, N814, N815).</td>
</tr>
<tr>
<td><a href="#NamingStyleChecker.__checkModule">__checkModule</a></td>
@@ -83,26 +83,62 @@
<td>Private class to check the given node for a name to be avoided (N831).</td>
</tr>
<tr>
-<td><a href="#NamingStyleChecker.__checkVariablesInFunction">__checkVariablesInFunction</a></td>
-<td>Private method to check local variables in functions (N821).</td>
+<td><a href="#NamingStyleChecker.__checkVariableNames">__checkVariableNames</a></td>
+<td>Private method to check variable names in function, class and global scope (N821, N822, N823).</td>
+</tr>
+<tr>
+<td><a href="#NamingStyleChecker.__classVariableCheck">__classVariableCheck</a></td>
+<td>Private method to determine the error code for a variable in class scope.</td>
</tr>
<tr>
<td><a href="#NamingStyleChecker.__error">__error</a></td>
<td>Private method to build the error information.</td>
</tr>
<tr>
+<td><a href="#NamingStyleChecker.__extractNames">__extractNames</a></td>
+<td>Private method to extract the names from the target node.</td>
+</tr>
+<tr>
<td><a href="#NamingStyleChecker.__findGlobalDefs">__findGlobalDefs</a></td>
<td>Private method amend a node with global definitions information.</td>
</tr>
<tr>
+<td><a href="#NamingStyleChecker.__findVariableNameErrors">__findVariableNameErrors</a></td>
+<td>Private method to check, if there is a variable name error.</td>
+</tr>
+<tr>
+<td><a href="#NamingStyleChecker.__functionVariableCheck">__functionVariableCheck</a></td>
+<td>Private method to determine the error code for a variable in class scope.</td>
+</tr>
+<tr>
<td><a href="#NamingStyleChecker.__getArgNames">__getArgNames</a></td>
<td>Private method to get the argument names of a function node.</td>
</tr>
<tr>
+<td><a href="#NamingStyleChecker.__getClassdef">__getClassdef</a></td>
+<td>Private method to extract the class definition.</td>
+</tr>
+<tr>
+<td><a href="#NamingStyleChecker.__globalVariableCheck">__globalVariableCheck</a></td>
+<td>Private method to determine the error code for a variable in global scope.</td>
+</tr>
+<tr>
+<td><a href="#NamingStyleChecker.__isMixedCase">__isMixedCase</a></td>
+<td>Private method to check, if the given name is mixed case.</td>
+</tr>
+<tr>
<td><a href="#NamingStyleChecker.__isNameToBeAvoided">__isNameToBeAvoided</a></td>
<td>Private method to check, if the given name should be avoided.</td>
</tr>
<tr>
+<td><a href="#NamingStyleChecker.__isNamedTupel">__isNamedTupel</a></td>
+<td>Private method to check, if a node is a named tuple.</td>
+</tr>
+<tr>
+<td><a href="#NamingStyleChecker.__superClassNames">__superClassNames</a></td>
+<td>Private method to extract the names of all super classes.</td>
+</tr>
+<tr>
<td><a href="#NamingStyleChecker.__tagClassFunctions">__tagClassFunctions</a></td>
<td>Private method to tag functions if they are methods, class methods or static methods.</td>
</tr>
@@ -153,7 +189,7 @@
<p>
Private class to check the given node for class name
- conventions (N801).
+ conventions (N801, N818).
</p>
<p>
Almost without exception, class names use the CapWords convention.
@@ -224,7 +260,7 @@
<p>
Private class to check the given node for function name
- conventions (N802).
+ conventions (N802, N809).
</p>
<p>
Function names should be lowercase, with words separated by underscores
@@ -262,7 +298,7 @@
<p>
Private method to check that imports don't change the
- naming convention (N811, N812, N813, N814).
+ naming convention (N811, N812, N813, N814, N815).
</p>
<dl>
@@ -350,12 +386,13 @@
tuple of (int, int, str)
</dd>
</dl>
-<a NAME="NamingStyleChecker.__checkVariablesInFunction" ID="NamingStyleChecker.__checkVariablesInFunction"></a>
-<h4>NamingStyleChecker.__checkVariablesInFunction</h4>
-<b>__checkVariablesInFunction</b>(<i>node, parents</i>)
+<a NAME="NamingStyleChecker.__checkVariableNames" ID="NamingStyleChecker.__checkVariableNames"></a>
+<h4>NamingStyleChecker.__checkVariableNames</h4>
+<b>__checkVariableNames</b>(<i>node, parents</i>)
<p>
- Private method to check local variables in functions (N821).
+ Private method to check variable names in function, class and global scope
+ (N821, N822, N823).
</p>
<p>
Local variables in functions should be lowercase.
@@ -383,6 +420,32 @@
tuple of (int, int, str)
</dd>
</dl>
+<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>
+<dd>
+variable name to be checked
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+error code or None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str or None
+</dd>
+</dl>
<a NAME="NamingStyleChecker.__error" ID="NamingStyleChecker.__error"></a>
<h4>NamingStyleChecker.__error</h4>
<b>__error</b>(<i>node, code</i>)
@@ -408,6 +471,32 @@
(integer, integer, string)
</dd>
</dl>
+<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>
+<dd>
+target node of the assignment
+</dd>
+</dl>
+<dl>
+<dt>Yield:</dt>
+<dd>
+name of the variable
+</dd>
+</dl>
+<dl>
+<dt>Yield Type:</dt>
+<dd>
+str
+</dd>
+</dl>
<a NAME="NamingStyleChecker.__findGlobalDefs" ID="NamingStyleChecker.__findGlobalDefs"></a>
<h4>NamingStyleChecker.__findGlobalDefs</h4>
<b>__findGlobalDefs</b>(<i>functionNode</i>)
@@ -422,6 +511,66 @@
AST tree node to amend
</dd>
</dl>
+<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>
+<dd>
+target node of the assignment
+</dd>
+<dt><i>parents</i> (ast.AST)</dt>
+<dd>
+list of parent nodes
+</dd>
+</dl>
+<dl>
+<dt>Yield:</dt>
+<dd>
+tuple giving line number, offset within line and error code
+</dd>
+</dl>
+<dl>
+<dt>Yield Type:</dt>
+<dd>
+tuple of (int, int, str)
+</dd>
+</dl>
+<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>
+<dd>
+reference to the function definition node
+</dd>
+<dt><i>varName</i> (str)</dt>
+<dd>
+variable name to be checked
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+error code or None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str or None
+</dd>
+</dl>
<a NAME="NamingStyleChecker.__getArgNames" ID="NamingStyleChecker.__getArgNames"></a>
<h4>NamingStyleChecker.__getArgNames</h4>
<b>__getArgNames</b>(<i>node</i>)
@@ -442,6 +591,88 @@
list of argument names (list of string)
</dd>
</dl>
+<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>
+<dd>
+name of the class
+</dd>
+<dt><i>parents</i> (ast.AST)</dt>
+<dd>
+list of parent nodes
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+node containing the class definition
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+ast.ClassDef
+</dd>
+</dl>
+<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>
+<dd>
+variable name to be checked
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+error code or None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str or None
+</dd>
+</dl>
+<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>
+<dd>
+variable name to be checked
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating mixed case
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
<a NAME="NamingStyleChecker.__isNameToBeAvoided" ID="NamingStyleChecker.__isNameToBeAvoided"></a>
<h4>NamingStyleChecker.__isNameToBeAvoided</h4>
<b>__isNameToBeAvoided</b>(<i>name</i>)
@@ -462,6 +693,66 @@
flag indicating to avoid it (boolen)
</dd>
</dl>
+<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>
+<dd>
+node to be checked
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a nemd tuple
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<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>
+<dd>
+name of the class
+</dd>
+<dt><i>parents</i> (ast.AST)</dt>
+<dd>
+list of parent nodes
+</dd>
+<dt><i>names</i> (set of str (optional))</dt>
+<dd>
+set of collected class names (defaults to None)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+set of class names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+set of str
+</dd>
+</dl>
<a NAME="NamingStyleChecker.__tagClassFunctions" ID="NamingStyleChecker.__tagClassFunctions"></a>
<h4>NamingStyleChecker.__tagClassFunctions</h4>
<b>__tagClassFunctions</b>(<i>classNode</i>)
