Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html
- branch
- eric7
- changeset 11150
- 73d80859079c
- parent 10479
- 856476537696
equal
deleted
inserted
replaced
| 11149:fc45672fae42 | 11150:73d80859079c |
|---|---|
| 36 <p> | 36 <p> |
| 37 Class implementing a checker for function type annotations. | 37 Class implementing a checker for function type annotations. |
| 38 </p> | 38 </p> |
| 39 | 39 |
| 40 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 41 None | 41 CodeStyleTopicChecker |
| 42 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 43 <table> | 43 <table> |
| 44 <tr><td>Category</td></tr> | |
| 44 <tr><td>Codes</td></tr> | 45 <tr><td>Codes</td></tr> |
| 45 </table> | 46 </table> |
| 46 | 47 |
| 47 <h3>Class Methods</h3> | 48 <h3>Class Methods</h3> |
| 48 <table> | 49 <table> |
| 86 <tr> | 87 <tr> |
| 87 <td><a href="#AnnotationsChecker.__classifyError">__classifyError</a></td> | 88 <td><a href="#AnnotationsChecker.__classifyError">__classifyError</a></td> |
| 88 <td>Private method to classify the missing type annotation based on the Function & Argument metadata.</td> | 89 <td>Private method to classify the missing type annotation based on the Function & Argument metadata.</td> |
| 89 </tr> | 90 </tr> |
| 90 <tr> | 91 <tr> |
| 91 <td><a href="#AnnotationsChecker.__error">__error</a></td> | |
| 92 <td>Private method to record an issue.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#AnnotationsChecker.__getAnnotationComplexity">__getAnnotationComplexity</a></td> | 92 <td><a href="#AnnotationsChecker.__getAnnotationComplexity">__getAnnotationComplexity</a></td> |
| 96 <td>Private method to determine the annotation complexity.</td> | 93 <td>Private method to determine the annotation complexity.</td> |
| 97 </tr> | 94 </tr> |
| 98 <tr> | 95 <tr> |
| 99 <td><a href="#AnnotationsChecker.__getAnnotationLength">__getAnnotationLength</a></td> | 96 <td><a href="#AnnotationsChecker.__getAnnotationLength">__getAnnotationLength</a></td> |
| 102 <tr> | 99 <tr> |
| 103 <td><a href="#AnnotationsChecker.__hasTypeAnnotations">__hasTypeAnnotations</a></td> | 100 <td><a href="#AnnotationsChecker.__hasTypeAnnotations">__hasTypeAnnotations</a></td> |
| 104 <td>Private method to check for type annotations.</td> | 101 <td>Private method to check for type annotations.</td> |
| 105 </tr> | 102 </tr> |
| 106 <tr> | 103 <tr> |
| 107 <td><a href="#AnnotationsChecker.__ignoreCode">__ignoreCode</a></td> | |
| 108 <td>Private method to check if the message code should be ignored.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#AnnotationsChecker.__returnErrorClassifier">__returnErrorClassifier</a></td> | 104 <td><a href="#AnnotationsChecker.__returnErrorClassifier">__returnErrorClassifier</a></td> |
| 112 <td>Private method to classify a return type annotation issue.</td> | 105 <td>Private method to classify a return type annotation issue.</td> |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#AnnotationsChecker.run">run</a></td> | |
| 116 <td>Public method to check the given source against annotation issues.</td> | |
| 117 </tr> | 106 </tr> |
| 118 </table> | 107 </table> |
| 119 | 108 |
| 120 <h3>Static Methods</h3> | 109 <h3>Static Methods</h3> |
| 121 <table> | 110 <table> |
| 271 <dt><i>arg</i> (Argument)</dt> | 260 <dt><i>arg</i> (Argument)</dt> |
| 272 <dd> | 261 <dd> |
| 273 reference to the Argument object | 262 reference to the Argument object |
| 274 </dd> | 263 </dd> |
| 275 </dl> | 264 </dl> |
| 276 <a NAME="AnnotationsChecker.__error" ID="AnnotationsChecker.__error"></a> | |
| 277 <h4>AnnotationsChecker.__error</h4> | |
| 278 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) | |
| 279 <p> | |
| 280 Private method to record an issue. | |
| 281 </p> | |
| 282 | |
| 283 <dl> | |
| 284 | |
| 285 <dt><i>lineNumber</i> (int)</dt> | |
| 286 <dd> | |
| 287 line number of the issue | |
| 288 </dd> | |
| 289 <dt><i>offset</i> (int)</dt> | |
| 290 <dd> | |
| 291 position within line of the issue | |
| 292 </dd> | |
| 293 <dt><i>code</i> (str)</dt> | |
| 294 <dd> | |
| 295 message code | |
| 296 </dd> | |
| 297 <dt><i>args</i> (list)</dt> | |
| 298 <dd> | |
| 299 arguments for the message | |
| 300 </dd> | |
| 301 </dl> | |
| 302 <a NAME="AnnotationsChecker.__getAnnotationComplexity" ID="AnnotationsChecker.__getAnnotationComplexity"></a> | 265 <a NAME="AnnotationsChecker.__getAnnotationComplexity" ID="AnnotationsChecker.__getAnnotationComplexity"></a> |
| 303 <h4>AnnotationsChecker.__getAnnotationComplexity</h4> | 266 <h4>AnnotationsChecker.__getAnnotationComplexity</h4> |
| 304 <b>__getAnnotationComplexity</b>(<i>annotationNode, defaultComplexity=1</i>) | 267 <b>__getAnnotationComplexity</b>(<i>annotationNode, defaultComplexity=1</i>) |
| 305 <p> | 268 <p> |
| 306 Private method to determine the annotation complexity. | 269 Private method to determine the annotation complexity. |
| 381 <dt>Return Type:</dt> | 344 <dt>Return Type:</dt> |
| 382 <dd> | 345 <dd> |
| 383 bool | 346 bool |
| 384 </dd> | 347 </dd> |
| 385 </dl> | 348 </dl> |
| 386 <a NAME="AnnotationsChecker.__ignoreCode" ID="AnnotationsChecker.__ignoreCode"></a> | |
| 387 <h4>AnnotationsChecker.__ignoreCode</h4> | |
| 388 <b>__ignoreCode</b>(<i>code</i>) | |
| 389 <p> | |
| 390 Private method to check if the message code should be ignored. | |
| 391 </p> | |
| 392 | |
| 393 <dl> | |
| 394 | |
| 395 <dt><i>code</i> (str)</dt> | |
| 396 <dd> | |
| 397 message code to check for | |
| 398 </dd> | |
| 399 </dl> | |
| 400 <dl> | |
| 401 <dt>Return:</dt> | |
| 402 <dd> | |
| 403 flag indicating to ignore the given code | |
| 404 </dd> | |
| 405 </dl> | |
| 406 <dl> | |
| 407 <dt>Return Type:</dt> | |
| 408 <dd> | |
| 409 bool | |
| 410 </dd> | |
| 411 </dl> | |
| 412 <a NAME="AnnotationsChecker.__returnErrorClassifier" ID="AnnotationsChecker.__returnErrorClassifier"></a> | 349 <a NAME="AnnotationsChecker.__returnErrorClassifier" ID="AnnotationsChecker.__returnErrorClassifier"></a> |
| 413 <h4>AnnotationsChecker.__returnErrorClassifier</h4> | 350 <h4>AnnotationsChecker.__returnErrorClassifier</h4> |
| 414 <b>__returnErrorClassifier</b>(<i>isClassMethod, classDecoratorType, functionType</i>) | 351 <b>__returnErrorClassifier</b>(<i>isClassMethod, classDecoratorType, functionType</i>) |
| 415 <p> | 352 <p> |
| 416 Private method to classify a return type annotation issue. | 353 Private method to classify a return type annotation issue. |
| 441 <dt>Return Type:</dt> | 378 <dt>Return Type:</dt> |
| 442 <dd> | 379 <dd> |
| 443 str | 380 str |
| 444 </dd> | 381 </dd> |
| 445 </dl> | 382 </dl> |
| 446 <a NAME="AnnotationsChecker.run" ID="AnnotationsChecker.run"></a> | |
| 447 <h4>AnnotationsChecker.run</h4> | |
| 448 <b>run</b>(<i></i>) | |
| 449 <p> | |
| 450 Public method to check the given source against annotation issues. | |
| 451 </p> | |
| 452 | |
| 453 <div align="right"><a href="#top">Up</a></div> | 383 <div align="right"><a href="#top">Up</a></div> |
| 454 <hr /> | 384 <hr /> |
| 455 </body></html> | 385 </body></html> |
