Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.pyCheckSyntax.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.pyCheckSyntax.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10341
- 3fdffd9cc21d
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.pyCheckSyntax</h1> | 9 <h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.pyCheckSyntax</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the syntax check for Python 3. | 11 Module implementing the syntax check for Python 3. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>VcsConflictMarkerRegExpList</td></tr> | 16 <tr><td>VcsConflictMarkerRegExpList</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 20 <table> |
| 22 <tr><td>None</td></tr> | 21 <tr><td>None</td></tr> |
| 23 </table> | 22 </table> |
| 23 | |
| 24 <h3>Functions</h3> | 24 <h3>Functions</h3> |
| 25 | |
| 26 <table> | 25 <table> |
| 27 | |
| 28 <tr> | 26 <tr> |
| 29 <td><a href="#__pySyntaxAndPyflakesCheck">__pySyntaxAndPyflakesCheck</a></td> | 27 <td><a href="#__pySyntaxAndPyflakesCheck">__pySyntaxAndPyflakesCheck</a></td> |
| 30 <td>Function to compile one Python source file to Python bytecode and to perform a pyflakes check.</td> | 28 <td>Function to compile one Python source file to Python bytecode and to perform a pyflakes check.</td> |
| 31 </tr> | 29 </tr> |
| 32 <tr> | 30 <tr> |
| 56 <tr> | 54 <tr> |
| 57 <td><a href="#workerTask">workerTask</a></td> | 55 <td><a href="#workerTask">workerTask</a></td> |
| 58 <td>Module function acting as the parallel worker for the syntax check.</td> | 56 <td>Module function acting as the parallel worker for the syntax check.</td> |
| 59 </tr> | 57 </tr> |
| 60 </table> | 58 </table> |
| 59 | |
| 61 <hr /> | 60 <hr /> |
| 62 <hr /> | 61 <hr /> |
| 63 <a NAME="__pySyntaxAndPyflakesCheck" ID="__pySyntaxAndPyflakesCheck"></a> | 62 <a NAME="__pySyntaxAndPyflakesCheck" ID="__pySyntaxAndPyflakesCheck"></a> |
| 64 <h2>__pySyntaxAndPyflakesCheck</h2> | 63 <h2>__pySyntaxAndPyflakesCheck</h2> |
| 65 <b>__pySyntaxAndPyflakesCheck</b>(<i>filename, codestring, checkFlakes=True, ignoreStarImportWarnings=False, additionalBuiltins=None, </i>) | 64 <b>__pySyntaxAndPyflakesCheck</b>(<i>filename, codestring, checkFlakes=True, ignoreStarImportWarnings=False, additionalBuiltins=None, </i>) |
| 66 | |
| 67 <p> | 65 <p> |
| 68 Function to compile one Python source file to Python bytecode | 66 Function to compile one Python source file to Python bytecode |
| 69 and to perform a pyflakes check. | 67 and to perform a pyflakes check. |
| 70 </p> | 68 </p> |
| 69 | |
| 71 <dl> | 70 <dl> |
| 72 | 71 |
| 73 <dt><i>filename</i> (str)</dt> | 72 <dt><i>filename</i> (str)</dt> |
| 74 <dd> | 73 <dd> |
| 75 source filename | 74 source filename |
| 112 <hr /> | 111 <hr /> |
| 113 <hr /> | 112 <hr /> |
| 114 <a NAME="extractLineFlags" ID="extractLineFlags"></a> | 113 <a NAME="extractLineFlags" ID="extractLineFlags"></a> |
| 115 <h2>extractLineFlags</h2> | 114 <h2>extractLineFlags</h2> |
| 116 <b>extractLineFlags</b>(<i>line, startComment="</i>) | 115 <b>extractLineFlags</b>(<i>line, startComment="</i>) |
| 117 | |
| 118 <p> | 116 <p> |
| 119 Function to extract flags starting and ending with '__' from a line | 117 Function to extract flags starting and ending with '__' from a line |
| 120 comment. | 118 comment. |
| 121 </p> | 119 </p> |
| 120 | |
| 122 <dl> | 121 <dl> |
| 123 | 122 |
| 124 <dt><i>line</i> (str)</dt> | 123 <dt><i>line</i> (str)</dt> |
| 125 <dd> | 124 <dd> |
| 126 line to extract flags from | 125 line to extract flags from |
| 154 <hr /> | 153 <hr /> |
| 155 <hr /> | 154 <hr /> |
| 156 <a NAME="initBatchService" ID="initBatchService"></a> | 155 <a NAME="initBatchService" ID="initBatchService"></a> |
| 157 <h2>initBatchService</h2> | 156 <h2>initBatchService</h2> |
| 158 <b>initBatchService</b>(<i></i>) | 157 <b>initBatchService</b>(<i></i>) |
| 159 | |
| 160 <p> | 158 <p> |
| 161 Initialize the batch service and return the entry point. | 159 Initialize the batch service and return the entry point. |
| 162 </p> | 160 </p> |
| 161 | |
| 163 <dl> | 162 <dl> |
| 164 <dt>Return:</dt> | 163 <dt>Return:</dt> |
| 165 <dd> | 164 <dd> |
| 166 the entry point for the background client | 165 the entry point for the background client |
| 167 </dd> | 166 </dd> |
| 176 <hr /> | 175 <hr /> |
| 177 <hr /> | 176 <hr /> |
| 178 <a NAME="initService" ID="initService"></a> | 177 <a NAME="initService" ID="initService"></a> |
| 179 <h2>initService</h2> | 178 <h2>initService</h2> |
| 180 <b>initService</b>(<i></i>) | 179 <b>initService</b>(<i></i>) |
| 181 | |
| 182 <p> | 180 <p> |
| 183 Initialize the service and return the entry point. | 181 Initialize the service and return the entry point. |
| 184 </p> | 182 </p> |
| 183 | |
| 185 <dl> | 184 <dl> |
| 186 <dt>Return:</dt> | 185 <dt>Return:</dt> |
| 187 <dd> | 186 <dd> |
| 188 the entry point for the background client | 187 the entry point for the background client |
| 189 </dd> | 188 </dd> |
| 198 <hr /> | 197 <hr /> |
| 199 <hr /> | 198 <hr /> |
| 200 <a NAME="pySyntaxAndPyflakesBatchCheck" ID="pySyntaxAndPyflakesBatchCheck"></a> | 199 <a NAME="pySyntaxAndPyflakesBatchCheck" ID="pySyntaxAndPyflakesBatchCheck"></a> |
| 201 <h2>pySyntaxAndPyflakesBatchCheck</h2> | 200 <h2>pySyntaxAndPyflakesBatchCheck</h2> |
| 202 <b>pySyntaxAndPyflakesBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) | 201 <b>pySyntaxAndPyflakesBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) |
| 203 | |
| 204 <p> | 202 <p> |
| 205 Module function to check syntax for a batch of files. | 203 Module function to check syntax for a batch of files. |
| 206 </p> | 204 </p> |
| 205 | |
| 207 <dl> | 206 <dl> |
| 208 | 207 |
| 209 <dt><i>argumentsList</i> (list)</dt> | 208 <dt><i>argumentsList</i> (list)</dt> |
| 210 <dd> | 209 <dd> |
| 211 list of arguments tuples as given for pySyntaxAndPyflakesCheck | 210 list of arguments tuples as given for pySyntaxAndPyflakesCheck |
| 231 <hr /> | 230 <hr /> |
| 232 <hr /> | 231 <hr /> |
| 233 <a NAME="pySyntaxAndPyflakesCheck" ID="pySyntaxAndPyflakesCheck"></a> | 232 <a NAME="pySyntaxAndPyflakesCheck" ID="pySyntaxAndPyflakesCheck"></a> |
| 234 <h2>pySyntaxAndPyflakesCheck</h2> | 233 <h2>pySyntaxAndPyflakesCheck</h2> |
| 235 <b>pySyntaxAndPyflakesCheck</b>(<i>filename, codestring, checkFlakes=True, ignoreStarImportWarnings=False, additionalBuiltins=None, </i>) | 234 <b>pySyntaxAndPyflakesCheck</b>(<i>filename, codestring, checkFlakes=True, ignoreStarImportWarnings=False, additionalBuiltins=None, </i>) |
| 236 | |
| 237 <p> | 235 <p> |
| 238 Function to compile one Python source file to Python bytecode | 236 Function to compile one Python source file to Python bytecode |
| 239 and to perform a pyflakes check. | 237 and to perform a pyflakes check. |
| 240 </p> | 238 </p> |
| 239 | |
| 241 <dl> | 240 <dl> |
| 242 | 241 |
| 243 <dt><i>filename</i> (str)</dt> | 242 <dt><i>filename</i> (str)</dt> |
| 244 <dd> | 243 <dd> |
| 245 source filename | 244 source filename |
| 288 <hr /> | 287 <hr /> |
| 289 <hr /> | 288 <hr /> |
| 290 <a NAME="workerTask" ID="workerTask"></a> | 289 <a NAME="workerTask" ID="workerTask"></a> |
| 291 <h2>workerTask</h2> | 290 <h2>workerTask</h2> |
| 292 <b>workerTask</b>(<i>inputQueue, outputQueue</i>) | 291 <b>workerTask</b>(<i>inputQueue, outputQueue</i>) |
| 293 | |
| 294 <p> | 292 <p> |
| 295 Module function acting as the parallel worker for the syntax check. | 293 Module function acting as the parallel worker for the syntax check. |
| 296 </p> | 294 </p> |
| 295 | |
| 297 <dl> | 296 <dl> |
| 298 | 297 |
| 299 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> | 298 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> |
| 300 <dd> | 299 <dd> |
| 301 input queue | 300 input queue |
