Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html
Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html
- branch
- Py2 comp.
- changeset 3456
- 96232974dcdb
- parent 3209
- c5432abceb25
equal
deleted
inserted
replaced
| 3178:f25fc1364c88 | 3456:96232974dcdb |
|---|---|
| 46 </p> | 46 </p> |
| 47 <h3>Derived from</h3> | 47 <h3>Derived from</h3> |
| 48 object | 48 object |
| 49 <h3>Class Attributes</h3> | 49 <h3>Class Attributes</h3> |
| 50 <table> | 50 <table> |
| 51 <tr><td>CamelcaseRegexp</td></tr><tr><td>Codes</td></tr><tr><td>LowercaseRegex</td></tr><tr><td>Messages</td></tr><tr><td>MixedcaseRegexp</td></tr><tr><td>UppercaseRegexp</td></tr> | 51 <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> |
| 52 </table> | 52 </table> |
| 53 <h3>Class Methods</h3> | 53 <h3>Class Methods</h3> |
| 54 <table> | 54 <table> |
| 55 <tr> | 55 <tr><td>None</td></tr> |
| 56 <td><a href="#NamingStyleChecker.getMessage">getMessage</a></td> | |
| 57 <td>Class method to get a translated and formatted message for a given code.</td> | |
| 58 </tr> | |
| 59 </table> | 56 </table> |
| 60 <h3>Methods</h3> | 57 <h3>Methods</h3> |
| 61 <table> | 58 <table> |
| 62 <tr> | 59 <tr> |
| 63 <td><a href="#NamingStyleChecker.__init__">NamingStyleChecker</a></td> | 60 <td><a href="#NamingStyleChecker.__init__">NamingStyleChecker</a></td> |
| 105 <td><a href="#NamingStyleChecker.__visitTree">__visitTree</a></td> | 102 <td><a href="#NamingStyleChecker.__visitTree">__visitTree</a></td> |
| 106 <td>Private method to scan the given AST tree.</td> | 103 <td>Private method to scan the given AST tree.</td> |
| 107 </tr><tr> | 104 </tr><tr> |
| 108 <td><a href="#NamingStyleChecker.run">run</a></td> | 105 <td><a href="#NamingStyleChecker.run">run</a></td> |
| 109 <td>Public method run by the pep8.py checker.</td> | 106 <td>Public method run by the pep8.py checker.</td> |
| 107 </tr><tr> | |
| 108 <td><a href="#NamingStyleChecker.unpackArgs">unpackArgs</a></td> | |
| 109 <td>Local helper function to unpack function argument names.</td> | |
| 110 </tr> | 110 </tr> |
| 111 </table> | 111 </table> |
| 112 <h3>Static Methods</h3> | 112 <h3>Static Methods</h3> |
| 113 <table> | 113 <table> |
| 114 <tr><td>None</td></tr> | 114 <tr><td>None</td></tr> |
| 115 </table> | 115 </table> |
| 116 <a NAME="NamingStyleChecker.getMessage" ID="NamingStyleChecker.getMessage"></a> | 116 <a NAME="NamingStyleChecker.__init__" ID="NamingStyleChecker.__init__"></a> |
| 117 <h4>NamingStyleChecker.getMessage (class method)</h4> | |
| 118 <b>getMessage</b>(<i>code, *args</i>) | |
| 119 <p> | |
| 120 Class method to get a translated and formatted message for a | |
| 121 given code. | |
| 122 </p><dl> | |
| 123 <dt><i>code</i></dt> | |
| 124 <dd> | |
| 125 message code (string) | |
| 126 </dd><dt><i>args</i></dt> | |
| 127 <dd> | |
| 128 arguments for a formatted message (list) | |
| 129 </dd> | |
| 130 </dl><dl> | |
| 131 <dt>Returns:</dt> | |
| 132 <dd> | |
| 133 translated and formatted message (string) | |
| 134 </dd> | |
| 135 </dl><a NAME="NamingStyleChecker.__init__" ID="NamingStyleChecker.__init__"></a> | |
| 136 <h4>NamingStyleChecker (Constructor)</h4> | 117 <h4>NamingStyleChecker (Constructor)</h4> |
| 137 <b>NamingStyleChecker</b>(<i>tree, filename, options</i>) | 118 <b>NamingStyleChecker</b>(<i>tree, filename, options</i>) |
| 138 <p> | 119 <p> |
| 139 Constructor (according to 'extended' pep8.py API) | 120 Constructor (according to 'extended' pep8.py API) |
| 140 </p><dl> | 121 </p><dl> |
| 413 <dt>Returns:</dt> | 394 <dt>Returns:</dt> |
| 414 <dd> | 395 <dd> |
| 415 tuple giving line number, offset within line, code and | 396 tuple giving line number, offset within line, code and |
| 416 checker function | 397 checker function |
| 417 </dd> | 398 </dd> |
| 399 </dl><a NAME="NamingStyleChecker.unpackArgs" ID="NamingStyleChecker.unpackArgs"></a> | |
| 400 <h4>NamingStyleChecker.unpackArgs</h4> | |
| 401 <b>unpackArgs</b>(<i></i>) | |
| 402 <p> | |
| 403 Local helper function to unpack function argument names. | |
| 404 </p><dl> | |
| 405 <dt><i>args</i></dt> | |
| 406 <dd> | |
| 407 list of AST node arguments | |
| 408 </dd> | |
| 409 </dl><dl> | |
| 410 <dt>Returns:</dt> | |
| 411 <dd> | |
| 412 list of argument names (list of string) | |
| 413 </dd> | |
| 418 </dl> | 414 </dl> |
| 419 <div align="right"><a href="#top">Up</a></div> | 415 <div align="right"><a href="#top">Up</a></div> |
| 420 <hr /> | 416 <hr /> |
| 421 </body></html> | 417 </body></html> |
