Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html

branch
eric7
changeset 11150
73d80859079c
parent 11144
8c40c5e1ebe0
equal deleted inserted replaced
11149:fc45672fae42 11150:73d80859079c
36 <p> 36 <p>
37 Class implementing a checker for naming conventions. 37 Class implementing a checker for naming conventions.
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="#NamingStyleChecker.__classVariableCheck">__classVariableCheck</a></td> 88 <td><a href="#NamingStyleChecker.__classVariableCheck">__classVariableCheck</a></td>
88 <td>Private method to determine the error code for a variable in class scope.</td> 89 <td>Private method to determine the error code for a variable in class scope.</td>
89 </tr> 90 </tr>
90 <tr> 91 <tr>
91 <td><a href="#NamingStyleChecker.__error">__error</a></td>
92 <td>Private method to build the error information.</td>
93 </tr>
94 <tr>
95 <td><a href="#NamingStyleChecker.__extractNames">__extractNames</a></td> 92 <td><a href="#NamingStyleChecker.__extractNames">__extractNames</a></td>
96 <td>Private method to extract the names from the target node.</td> 93 <td>Private method to extract the names from the target node.</td>
97 </tr> 94 </tr>
98 <tr> 95 <tr>
99 <td><a href="#NamingStyleChecker.__findGlobalDefs">__findGlobalDefs</a></td> 96 <td><a href="#NamingStyleChecker.__findGlobalDefs">__findGlobalDefs</a></td>
118 <tr> 115 <tr>
119 <td><a href="#NamingStyleChecker.__globalVariableCheck">__globalVariableCheck</a></td> 116 <td><a href="#NamingStyleChecker.__globalVariableCheck">__globalVariableCheck</a></td>
120 <td>Private method to determine the error code for a variable in global scope.</td> 117 <td>Private method to determine the error code for a variable in global scope.</td>
121 </tr> 118 </tr>
122 <tr> 119 <tr>
123 <td><a href="#NamingStyleChecker.__ignoreCode">__ignoreCode</a></td>
124 <td>Private method to check if the message code should be ignored.</td>
125 </tr>
126 <tr>
127 <td><a href="#NamingStyleChecker.__isMixedCase">__isMixedCase</a></td> 120 <td><a href="#NamingStyleChecker.__isMixedCase">__isMixedCase</a></td>
128 <td>Private method to check, if the given name is mixed case.</td> 121 <td>Private method to check, if the given name is mixed case.</td>
129 </tr> 122 </tr>
130 <tr> 123 <tr>
131 <td><a href="#NamingStyleChecker.__isNameToBeAvoided">__isNameToBeAvoided</a></td> 124 <td><a href="#NamingStyleChecker.__isNameToBeAvoided">__isNameToBeAvoided</a></td>
150 <tr> 143 <tr>
151 <td><a href="#NamingStyleChecker.__visitTree">__visitTree</a></td> 144 <td><a href="#NamingStyleChecker.__visitTree">__visitTree</a></td>
152 <td>Private method to scan the given AST tree.</td> 145 <td>Private method to scan the given AST tree.</td>
153 </tr> 146 </tr>
154 <tr> 147 <tr>
148 <td><a href="#NamingStyleChecker.addErrorFromNode">addErrorFromNode</a></td>
149 <td>Public method to build the error information.</td>
150 </tr>
151 <tr>
155 <td><a href="#NamingStyleChecker.run">run</a></td> 152 <td><a href="#NamingStyleChecker.run">run</a></td>
156 <td>Public method run by the pycodestyle.py checker.</td> 153 <td>Public method to execute the relevant checks.</td>
157 </tr> 154 </tr>
158 </table> 155 </table>
159 156
160 <h3>Static Methods</h3> 157 <h3>Static Methods</h3>
161 <table> 158 <table>
382 <dt>Return Type:</dt> 379 <dt>Return Type:</dt>
383 <dd> 380 <dd>
384 str or None 381 str or None
385 </dd> 382 </dd>
386 </dl> 383 </dl>
387 <a NAME="NamingStyleChecker.__error" ID="NamingStyleChecker.__error"></a>
388 <h4>NamingStyleChecker.__error</h4>
389 <b>__error</b>(<i>node, code</i>)
390 <p>
391 Private method to build the error information.
392 </p>
393
394 <dl>
395
396 <dt><i>node</i> (ast.AST)</dt>
397 <dd>
398 AST node to report an error for
399 </dd>
400 <dt><i>code</i> (str)</dt>
401 <dd>
402 error code to report
403 </dd>
404 </dl>
405 <a NAME="NamingStyleChecker.__extractNames" ID="NamingStyleChecker.__extractNames"></a> 384 <a NAME="NamingStyleChecker.__extractNames" ID="NamingStyleChecker.__extractNames"></a>
406 <h4>NamingStyleChecker.__extractNames</h4> 385 <h4>NamingStyleChecker.__extractNames</h4>
407 <b>__extractNames</b>(<i>assignmentTarget</i>) 386 <b>__extractNames</b>(<i>assignmentTarget</i>)
408 <p> 387 <p>
409 Private method to extract the names from the target node. 388 Private method to extract the names from the target node.
570 <dt>Return Type:</dt> 549 <dt>Return Type:</dt>
571 <dd> 550 <dd>
572 str or None 551 str or None
573 </dd> 552 </dd>
574 </dl> 553 </dl>
575 <a NAME="NamingStyleChecker.__ignoreCode" ID="NamingStyleChecker.__ignoreCode"></a>
576 <h4>NamingStyleChecker.__ignoreCode</h4>
577 <b>__ignoreCode</b>(<i>code</i>)
578 <p>
579 Private method to check if the message code should be ignored.
580 </p>
581
582 <dl>
583
584 <dt><i>code</i> (str)</dt>
585 <dd>
586 message code to check for
587 </dd>
588 </dl>
589 <dl>
590 <dt>Return:</dt>
591 <dd>
592 flag indicating to ignore the given code
593 </dd>
594 </dl>
595 <dl>
596 <dt>Return Type:</dt>
597 <dd>
598 bool
599 </dd>
600 </dl>
601 <a NAME="NamingStyleChecker.__isMixedCase" ID="NamingStyleChecker.__isMixedCase"></a> 554 <a NAME="NamingStyleChecker.__isMixedCase" ID="NamingStyleChecker.__isMixedCase"></a>
602 <h4>NamingStyleChecker.__isMixedCase</h4> 555 <h4>NamingStyleChecker.__isMixedCase</h4>
603 <b>__isMixedCase</b>(<i>name</i>) 556 <b>__isMixedCase</b>(<i>name</i>)
604 <p> 557 <p>
605 Private method to check, if the given name is mixed case. 558 Private method to check, if the given name is mixed case.
751 <dt><i>node</i> (ast.AST)</dt> 704 <dt><i>node</i> (ast.AST)</dt>
752 <dd> 705 <dd>
753 AST tree node to scan 706 AST tree node to scan
754 </dd> 707 </dd>
755 </dl> 708 </dl>
709 <a NAME="NamingStyleChecker.addErrorFromNode" ID="NamingStyleChecker.addErrorFromNode"></a>
710 <h4>NamingStyleChecker.addErrorFromNode</h4>
711 <b>addErrorFromNode</b>(<i>node, msgCode</i>)
712 <p>
713 Public method to build the error information.
714 </p>
715
716 <dl>
717
718 <dt><i>node</i> (ast.AST)</dt>
719 <dd>
720 AST node to report an error for
721 </dd>
722 <dt><i>msgCode</i> (str)</dt>
723 <dd>
724 message code
725 </dd>
726 </dl>
756 <a NAME="NamingStyleChecker.run" ID="NamingStyleChecker.run"></a> 727 <a NAME="NamingStyleChecker.run" ID="NamingStyleChecker.run"></a>
757 <h4>NamingStyleChecker.run</h4> 728 <h4>NamingStyleChecker.run</h4>
758 <b>run</b>(<i></i>) 729 <b>run</b>(<i></i>)
759 <p> 730 <p>
760 Public method run by the pycodestyle.py checker. 731 Public method to execute the relevant checks.
761 </p> 732 </p>
762 733
763 <dl>
764 <dt>Return:</dt>
765 <dd>
766 tuple giving line number, offset within line, code and
767 checker function
768 </dd>
769 </dl>
770 <dl>
771 <dt>Return Type:</dt>
772 <dd>
773 tuple of (int, int, str, function)
774 </dd>
775 </dl>
776 <div align="right"><a href="#top">Up</a></div> 734 <div align="right"><a href="#top">Up</a></div>
777 <hr /> 735 <hr />
778 </body></html> 736 </body></html>

Mercurial Repository: eric

eric ide

mercurial