Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html
eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html
- changeset 7624
- 6eabbcf3bdf8
- parent 7610
- df7025fe26a3
- child 7900
- 72b88fb20261
equal
deleted
inserted
replaced
| 7623:ddea119f0b1d | 7624:6eabbcf3bdf8 |
|---|---|
| 46 <tr> | 46 <tr> |
| 47 <td><a href="#__checkCodeStyle">__checkCodeStyle</a></td> | 47 <td><a href="#__checkCodeStyle">__checkCodeStyle</a></td> |
| 48 <td>Private module function to perform the code style check and/or fix found errors.</td> | 48 <td>Private module function to perform the code style check and/or fix found errors.</td> |
| 49 </tr> | 49 </tr> |
| 50 <tr> | 50 <tr> |
| 51 <td><a href="#__checkSyntax">__checkSyntax</a></td> | |
| 52 <td>Private module function to perform a syntax check.</td> | |
| 53 </tr> | |
| 54 <tr> | |
| 51 <td><a href="#codeStyleBatchCheck">codeStyleBatchCheck</a></td> | 55 <td><a href="#codeStyleBatchCheck">codeStyleBatchCheck</a></td> |
| 52 <td>Module function to check code style for a batch of files.</td> | 56 <td>Module function to check code style for a batch of files.</td> |
| 53 </tr> | 57 </tr> |
| 54 <tr> | 58 <tr> |
| 55 <td><a href="#codeStyleCheck">codeStyleCheck</a></td> | 59 <td><a href="#codeStyleCheck">codeStyleCheck</a></td> |
| 68 <td>Initialize the batch service and return the entry point.</td> | 72 <td>Initialize the batch service and return the entry point.</td> |
| 69 </tr> | 73 </tr> |
| 70 <tr> | 74 <tr> |
| 71 <td><a href="#initService">initService</a></td> | 75 <td><a href="#initService">initService</a></td> |
| 72 <td>Initialize the service and return the entry point.</td> | 76 <td>Initialize the service and return the entry point.</td> |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#securityOk">securityOk</a></td> | |
| 80 <td>Function to check, if the given code is an acknowledged security report.</td> | |
| 73 </tr> | 81 </tr> |
| 74 <tr> | 82 <tr> |
| 75 <td><a href="#worker">worker</a></td> | 83 <td><a href="#worker">worker</a></td> |
| 76 <td>Module function acting as the parallel worker for the style check.</td> | 84 <td>Module function acting as the parallel worker for the style check.</td> |
| 77 </tr> | 85 </tr> |
| 190 <dd> | 198 <dd> |
| 191 arguments used by the codeStyleCheck function (list of | 199 arguments used by the codeStyleCheck function (list of |
| 192 excludeMessages, includeMessages, repeatMessages, fixCodes, | 200 excludeMessages, includeMessages, repeatMessages, fixCodes, |
| 193 noFixCodes, fixIssues, maxLineLength, maxDocLineLength, blankLines, | 201 noFixCodes, fixIssues, maxLineLength, maxDocLineLength, blankLines, |
| 194 hangClosing, docType, codeComplexityArgs, miscellaneousArgs, | 202 hangClosing, docType, codeComplexityArgs, miscellaneousArgs, |
| 195 annotationArgs, errors, eol, encoding, backup) | 203 annotationArgs, securityArgs, errors, eol, encoding, backup) |
| 196 bool, str, dict, dict, list of str, str, str, bool) | 204 bool, str, dict, dict, dict, list of str, str, str, bool) |
| 197 </dd> | 205 </dd> |
| 198 </dl> | 206 </dl> |
| 199 <dl> | 207 <dl> |
| 200 <dt>Returns:</dt> | 208 <dt>Returns:</dt> |
| 201 <dd> | 209 <dd> |
| 222 </dd> | 230 </dd> |
| 223 </dl> | 231 </dl> |
| 224 <div align="right"><a href="#top">Up</a></div> | 232 <div align="right"><a href="#top">Up</a></div> |
| 225 <hr /> | 233 <hr /> |
| 226 <hr /> | 234 <hr /> |
| 235 <a NAME="__checkSyntax" ID="__checkSyntax"></a> | |
| 236 <h2>__checkSyntax</h2> | |
| 237 <b>__checkSyntax</b>(<i>filename, source</i>) | |
| 238 | |
| 239 <p> | |
| 240 Private module function to perform a syntax check. | |
| 241 </p> | |
| 242 <dl> | |
| 243 | |
| 244 <dt><i>filename</i> (str)</dt> | |
| 245 <dd> | |
| 246 source filename | |
| 247 </dd> | |
| 248 <dt><i>source</i> (str)</dt> | |
| 249 <dd> | |
| 250 string containing the code to check | |
| 251 </dd> | |
| 252 </dl> | |
| 253 <dl> | |
| 254 <dt>Returns:</dt> | |
| 255 <dd> | |
| 256 tuple containing the error dictionary with syntax error details | |
| 257 and a statistics dictionary or a tuple containing two None | |
| 258 </dd> | |
| 259 </dl> | |
| 260 <dl> | |
| 261 <dt>Return Type:</dt> | |
| 262 <dd> | |
| 263 tuple of (dict, dict) or tuple of (None, None) | |
| 264 </dd> | |
| 265 </dl> | |
| 266 <div align="right"><a href="#top">Up</a></div> | |
| 267 <hr /> | |
| 268 <hr /> | |
| 227 <a NAME="codeStyleBatchCheck" ID="codeStyleBatchCheck"></a> | 269 <a NAME="codeStyleBatchCheck" ID="codeStyleBatchCheck"></a> |
| 228 <h2>codeStyleBatchCheck</h2> | 270 <h2>codeStyleBatchCheck</h2> |
| 229 <b>codeStyleBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) | 271 <b>codeStyleBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) |
| 230 | 272 |
| 231 <p> | 273 <p> |
| 401 </dd> | 443 </dd> |
| 402 </dl> | 444 </dl> |
| 403 <div align="right"><a href="#top">Up</a></div> | 445 <div align="right"><a href="#top">Up</a></div> |
| 404 <hr /> | 446 <hr /> |
| 405 <hr /> | 447 <hr /> |
| 448 <a NAME="securityOk" ID="securityOk"></a> | |
| 449 <h2>securityOk</h2> | |
| 450 <b>securityOk</b>(<i>code, lineFlags</i>) | |
| 451 | |
| 452 <p> | |
| 453 Function to check, if the given code is an acknowledged security report. | |
| 454 </p> | |
| 455 <dl> | |
| 456 | |
| 457 <dt><i>code</i> (str)</dt> | |
| 458 <dd> | |
| 459 error code to be checked | |
| 460 </dd> | |
| 461 <dt><i>lineFlags</i> (list of str)</dt> | |
| 462 <dd> | |
| 463 list of line flags to check against | |
| 464 </dd> | |
| 465 </dl> | |
| 466 <dl> | |
| 467 <dt>Returns:</dt> | |
| 468 <dd> | |
| 469 flag indicating an acknowledged security report | |
| 470 </dd> | |
| 471 </dl> | |
| 472 <dl> | |
| 473 <dt>Return Type:</dt> | |
| 474 <dd> | |
| 475 bool | |
| 476 </dd> | |
| 477 </dl> | |
| 478 <div align="right"><a href="#top">Up</a></div> | |
| 479 <hr /> | |
| 480 <hr /> | |
| 406 <a NAME="worker" ID="worker"></a> | 481 <a NAME="worker" ID="worker"></a> |
| 407 <h2>worker</h2> | 482 <h2>worker</h2> |
| 408 <b>worker</b>(<i>inputQueue, outputQueue</i>) | 483 <b>worker</b>(<i>inputQueue, outputQueue</i>) |
| 409 | 484 |
| 410 <p> | 485 <p> |
