Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Simplify.SimplifyChecker.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Simplify.SimplifyChecker.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 to help simplifying Python code. | 37 Class implementing a checker for to help simplifying Python code. |
| 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> |
| 58 <tr> | 59 <tr> |
| 59 <td><a href="#SimplifyChecker.__addMeta">__addMeta</a></td> | 60 <td><a href="#SimplifyChecker.__addMeta">__addMeta</a></td> |
| 60 <td>Private method to amend the nodes of the given AST tree with backward and forward references.</td> | 61 <td>Private method to amend the nodes of the given AST tree with backward and forward references.</td> |
| 61 </tr> | 62 </tr> |
| 62 <tr> | 63 <tr> |
| 63 <td><a href="#SimplifyChecker.__error">__error</a></td> | 64 <td><a href="#SimplifyChecker.__checkCodeSimplifications">__checkCodeSimplifications</a></td> |
| 64 <td>Private method to record an issue.</td> | 65 <td>Private method to check for code simplifications.</td> |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#SimplifyChecker.__ignoreCode">__ignoreCode</a></td> | |
| 68 <td>Private method to check if the message code should be ignored.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#SimplifyChecker.run">run</a></td> | |
| 72 <td>Public method to check the given source against functions to be replaced by 'pathlib' equivalents.</td> | |
| 73 </tr> | 66 </tr> |
| 74 </table> | 67 </table> |
| 75 | 68 |
| 76 <h3>Static Methods</h3> | 69 <h3>Static Methods</h3> |
| 77 <table> | 70 <table> |
| 134 <dt><i>level</i> (int (optional))</dt> | 127 <dt><i>level</i> (int (optional))</dt> |
| 135 <dd> | 128 <dd> |
| 136 nesting level (defaults to 0) | 129 nesting level (defaults to 0) |
| 137 </dd> | 130 </dd> |
| 138 </dl> | 131 </dl> |
| 139 <a NAME="SimplifyChecker.__error" ID="SimplifyChecker.__error"></a> | 132 <a NAME="SimplifyChecker.__checkCodeSimplifications" ID="SimplifyChecker.__checkCodeSimplifications"></a> |
| 140 <h4>SimplifyChecker.__error</h4> | 133 <h4>SimplifyChecker.__checkCodeSimplifications</h4> |
| 141 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) | 134 <b>__checkCodeSimplifications</b>(<i></i>) |
| 142 <p> | 135 <p> |
| 143 Private method to record an issue. | 136 Private method to check for code simplifications. |
| 144 </p> | |
| 145 | |
| 146 <dl> | |
| 147 | |
| 148 <dt><i>lineNumber</i> (int)</dt> | |
| 149 <dd> | |
| 150 line number of the issue | |
| 151 </dd> | |
| 152 <dt><i>offset</i> (int)</dt> | |
| 153 <dd> | |
| 154 position within line of the issue | |
| 155 </dd> | |
| 156 <dt><i>code</i> (str)</dt> | |
| 157 <dd> | |
| 158 message code | |
| 159 </dd> | |
| 160 <dt><i>args</i> (list)</dt> | |
| 161 <dd> | |
| 162 arguments for the message | |
| 163 </dd> | |
| 164 </dl> | |
| 165 <a NAME="SimplifyChecker.__ignoreCode" ID="SimplifyChecker.__ignoreCode"></a> | |
| 166 <h4>SimplifyChecker.__ignoreCode</h4> | |
| 167 <b>__ignoreCode</b>(<i>code</i>) | |
| 168 <p> | |
| 169 Private method to check if the message code should be ignored. | |
| 170 </p> | |
| 171 | |
| 172 <dl> | |
| 173 | |
| 174 <dt><i>code</i> (str)</dt> | |
| 175 <dd> | |
| 176 message code to check for | |
| 177 </dd> | |
| 178 </dl> | |
| 179 <dl> | |
| 180 <dt>Return:</dt> | |
| 181 <dd> | |
| 182 flag indicating to ignore the given code | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <dl> | |
| 186 <dt>Return Type:</dt> | |
| 187 <dd> | |
| 188 bool | |
| 189 </dd> | |
| 190 </dl> | |
| 191 <a NAME="SimplifyChecker.run" ID="SimplifyChecker.run"></a> | |
| 192 <h4>SimplifyChecker.run</h4> | |
| 193 <b>run</b>(<i></i>) | |
| 194 <p> | |
| 195 Public method to check the given source against functions | |
| 196 to be replaced by 'pathlib' equivalents. | |
| 197 </p> | 137 </p> |
| 198 | 138 |
| 199 <div align="right"><a href="#top">Up</a></div> | 139 <div align="right"><a href="#top">Up</a></div> |
| 200 <hr /> | 140 <hr /> |
| 201 </body></html> | 141 </body></html> |
