--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.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.Annotations.AnnotationsChecker</h1>
-
<p>
Module implementing a checker for function type annotations.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#AnnotationsChecker">AnnotationsChecker</a></td>
<td>Class implementing a checker for function type annotations.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="AnnotationsChecker" ID="AnnotationsChecker"></a>
<h2>AnnotationsChecker</h2>
-
<p>
Class implementing a checker for function type annotations.
</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="#AnnotationsChecker.__init__">AnnotationsChecker</a></td>
<td>Constructor</td>
@@ -119,19 +116,20 @@
<td>Public method to check the given source against annotation issues.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="AnnotationsChecker.__init__" ID="AnnotationsChecker.__init__"></a>
<h4>AnnotationsChecker (Constructor)</h4>
<b>AnnotationsChecker</b>(<i>source, filename, tree, select, ignore, expected, repeat, args</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>source</i> (list of str)</dt>
@@ -170,10 +168,10 @@
<a NAME="AnnotationsChecker.__argumentErrorClassifier" ID="AnnotationsChecker.__argumentErrorClassifier"></a>
<h4>AnnotationsChecker.__argumentErrorClassifier</h4>
<b>__argumentErrorClassifier</b>(<i>isClassMethod, isFirstArg, classDecoratorType, annotationType</i>)
-
<p>
Private method to classify an argument type annotation issue.
</p>
+
<dl>
<dt><i>isClassMethod</i> (bool)</dt>
@@ -208,49 +206,48 @@
<a NAME="AnnotationsChecker.__checkAnnotationComplexity" ID="AnnotationsChecker.__checkAnnotationComplexity"></a>
<h4>AnnotationsChecker.__checkAnnotationComplexity</h4>
<b>__checkAnnotationComplexity</b>(<i></i>)
-
<p>
Private method to check the type annotation complexity.
</p>
+
<a NAME="AnnotationsChecker.__checkAnnotationPep604" ID="AnnotationsChecker.__checkAnnotationPep604"></a>
<h4>AnnotationsChecker.__checkAnnotationPep604</h4>
<b>__checkAnnotationPep604</b>(<i></i>)
-
<p>
Private method to check the use of typing.Union.
</p>
+
<a NAME="AnnotationsChecker.__checkAnnotationsCoverage" ID="AnnotationsChecker.__checkAnnotationsCoverage"></a>
<h4>AnnotationsChecker.__checkAnnotationsCoverage</h4>
<b>__checkAnnotationsCoverage</b>(<i></i>)
-
<p>
Private method to check for function annotation coverage.
</p>
+
<a NAME="AnnotationsChecker.__checkAnnotationsFuture" ID="AnnotationsChecker.__checkAnnotationsFuture"></a>
<h4>AnnotationsChecker.__checkAnnotationsFuture</h4>
<b>__checkAnnotationsFuture</b>(<i></i>)
-
<p>
Private method to check the use of __future__ and typing imports.
</p>
+
<a NAME="AnnotationsChecker.__checkDeprecatedTypingSymbols" ID="AnnotationsChecker.__checkDeprecatedTypingSymbols"></a>
<h4>AnnotationsChecker.__checkDeprecatedTypingSymbols</h4>
<b>__checkDeprecatedTypingSymbols</b>(<i></i>)
-
<p>
Private method to check the use of deprecated 'typing' symbols.
</p>
+
<a NAME="AnnotationsChecker.__checkFunctionAnnotations" ID="AnnotationsChecker.__checkFunctionAnnotations"></a>
<h4>AnnotationsChecker.__checkFunctionAnnotations</h4>
<b>__checkFunctionAnnotations</b>(<i></i>)
-
<p>
Private method to check for function annotation issues.
</p>
+
<a NAME="AnnotationsChecker.__classifyError" ID="AnnotationsChecker.__classifyError"></a>
<h4>AnnotationsChecker.__classifyError</h4>
<b>__classifyError</b>(<i>function, arg</i>)
-
<p>
Private method to classify the missing type annotation based on the
Function & Argument metadata.
@@ -264,6 +261,7 @@
This function provides an initial classificaton, then passes relevant
attributes to cached helper function(s).
</p>
+
<dl>
<dt><i>function</i> (Function)</dt>
@@ -278,10 +276,10 @@
<a NAME="AnnotationsChecker.__error" ID="AnnotationsChecker.__error"></a>
<h4>AnnotationsChecker.__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>
@@ -304,10 +302,10 @@
<a NAME="AnnotationsChecker.__getAnnotationComplexity" ID="AnnotationsChecker.__getAnnotationComplexity"></a>
<h4>AnnotationsChecker.__getAnnotationComplexity</h4>
<b>__getAnnotationComplexity</b>(<i>annotationNode, defaultComplexity=1</i>)
-
<p>
Private method to determine the annotation complexity.
</p>
+
<dl>
<dt><i>annotationNode</i> (ast.AST)</dt>
@@ -335,10 +333,10 @@
<a NAME="AnnotationsChecker.__getAnnotationLength" ID="AnnotationsChecker.__getAnnotationLength"></a>
<h4>AnnotationsChecker.__getAnnotationLength</h4>
<b>__getAnnotationLength</b>(<i>annotationNode</i>)
-
<p>
Private method to determine the annotation length.
</p>
+
<dl>
<dt><i>annotationNode</i> (ast.AST)</dt>
@@ -362,10 +360,10 @@
<a NAME="AnnotationsChecker.__hasTypeAnnotations" ID="AnnotationsChecker.__hasTypeAnnotations"></a>
<h4>AnnotationsChecker.__hasTypeAnnotations</h4>
<b>__hasTypeAnnotations</b>(<i>funcNode</i>)
-
<p>
Private method to check for type annotations.
</p>
+
<dl>
<dt><i>funcNode</i> (ast.AsyncFunctionDef or ast.FunctionDef)</dt>
@@ -388,10 +386,10 @@
<a NAME="AnnotationsChecker.__ignoreCode" ID="AnnotationsChecker.__ignoreCode"></a>
<h4>AnnotationsChecker.__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>
@@ -414,10 +412,10 @@
<a NAME="AnnotationsChecker.__returnErrorClassifier" ID="AnnotationsChecker.__returnErrorClassifier"></a>
<h4>AnnotationsChecker.__returnErrorClassifier</h4>
<b>__returnErrorClassifier</b>(<i>isClassMethod, classDecoratorType, functionType</i>)
-
<p>
Private method to classify a return type annotation issue.
</p>
+
<dl>
<dt><i>isClassMethod</i> (bool)</dt>
@@ -448,10 +446,10 @@
<a NAME="AnnotationsChecker.run" ID="AnnotationsChecker.run"></a>
<h4>AnnotationsChecker.run</h4>
<b>run</b>(<i></i>)
-
<p>
Public method to check the given source against annotation issues.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
