Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8652
- 8cacde11f4fd
- child 9507
- 1f39839655ea
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the syntax check for YAML. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Functions</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#__yamlSyntaxCheck">__yamlSyntaxCheck</a></td> | |
| 30 <td>Function to check a YAML source file for syntax errors.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#initBatchService">initBatchService</a></td> | |
| 34 <td>Initialize the batch service and return the entry point.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#initService">initService</a></td> | |
| 38 <td>Initialize the service and return the entry point.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#normalizeCode">normalizeCode</a></td> | |
| 42 <td>Function to normalize the given code.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#workerTask">workerTask</a></td> | |
| 46 <td>Module function acting as the parallel worker for the syntax check.</td> | |
| 47 </tr> | |
| 48 <tr> | |
| 49 <td><a href="#yamlSyntaxBatchCheck">yamlSyntaxBatchCheck</a></td> | |
| 50 <td>Module function to check syntax for a batch of files.</td> | |
| 51 </tr> | |
| 52 <tr> | |
| 53 <td><a href="#yamlSyntaxCheck">yamlSyntaxCheck</a></td> | |
| 54 <td>Function to check a YAML source file for syntax errors.</td> | |
| 55 </tr> | |
| 56 </table> | |
| 57 <hr /> | |
| 58 <hr /> | |
| 59 <a NAME="__yamlSyntaxCheck" ID="__yamlSyntaxCheck"></a> | |
| 60 <h2>__yamlSyntaxCheck</h2> | |
| 61 <b>__yamlSyntaxCheck</b>(<i>file, codestring</i>) | |
| 62 | |
| 63 <p> | |
| 64 Function to check a YAML source file for syntax errors. | |
| 65 </p> | |
| 66 <dl> | |
| 67 | |
| 68 <dt><i>file</i> (str)</dt> | |
| 69 <dd> | |
| 70 source filename | |
| 71 </dd> | |
| 72 <dt><i>codestring</i> (str)</dt> | |
| 73 <dd> | |
| 74 string containing the code to check | |
| 75 </dd> | |
| 76 </dl> | |
| 77 <dl> | |
| 78 <dt>Return:</dt> | |
| 79 <dd> | |
| 80 dictionary with the keys 'error' and 'warnings' which | |
| 81 hold a list containing details about the error/ warnings | |
| 82 (file name, line number, column, codestring (only at syntax | |
| 83 errors), the message, a list with arguments for the message) | |
| 84 </dd> | |
| 85 </dl> | |
| 86 <dl> | |
| 87 <dt>Return Type:</dt> | |
| 88 <dd> | |
| 89 dict | |
| 90 </dd> | |
| 91 </dl> | |
| 92 <div align="right"><a href="#top">Up</a></div> | |
| 93 <hr /> | |
| 94 <hr /> | |
| 95 <a NAME="initBatchService" ID="initBatchService"></a> | |
| 96 <h2>initBatchService</h2> | |
| 97 <b>initBatchService</b>(<i></i>) | |
| 98 | |
| 99 <p> | |
| 100 Initialize the batch service and return the entry point. | |
| 101 </p> | |
| 102 <dl> | |
| 103 <dt>Return:</dt> | |
| 104 <dd> | |
| 105 the entry point for the background client | |
| 106 </dd> | |
| 107 </dl> | |
| 108 <dl> | |
| 109 <dt>Return Type:</dt> | |
| 110 <dd> | |
| 111 func | |
| 112 </dd> | |
| 113 </dl> | |
| 114 <div align="right"><a href="#top">Up</a></div> | |
| 115 <hr /> | |
| 116 <hr /> | |
| 117 <a NAME="initService" ID="initService"></a> | |
| 118 <h2>initService</h2> | |
| 119 <b>initService</b>(<i></i>) | |
| 120 | |
| 121 <p> | |
| 122 Initialize the service and return the entry point. | |
| 123 </p> | |
| 124 <dl> | |
| 125 <dt>Return:</dt> | |
| 126 <dd> | |
| 127 the entry point for the background client | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <dl> | |
| 131 <dt>Return Type:</dt> | |
| 132 <dd> | |
| 133 func | |
| 134 </dd> | |
| 135 </dl> | |
| 136 <div align="right"><a href="#top">Up</a></div> | |
| 137 <hr /> | |
| 138 <hr /> | |
| 139 <a NAME="normalizeCode" ID="normalizeCode"></a> | |
| 140 <h2>normalizeCode</h2> | |
| 141 <b>normalizeCode</b>(<i>codestring</i>) | |
| 142 | |
| 143 <p> | |
| 144 Function to normalize the given code. | |
| 145 </p> | |
| 146 <dl> | |
| 147 | |
| 148 <dt><i>codestring</i> (str)</dt> | |
| 149 <dd> | |
| 150 code to be normalized | |
| 151 </dd> | |
| 152 </dl> | |
| 153 <dl> | |
| 154 <dt>Return:</dt> | |
| 155 <dd> | |
| 156 normalized code | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <dl> | |
| 160 <dt>Return Type:</dt> | |
| 161 <dd> | |
| 162 str | |
| 163 </dd> | |
| 164 </dl> | |
| 165 <div align="right"><a href="#top">Up</a></div> | |
| 166 <hr /> | |
| 167 <hr /> | |
| 168 <a NAME="workerTask" ID="workerTask"></a> | |
| 169 <h2>workerTask</h2> | |
| 170 <b>workerTask</b>(<i>inputQueue, outputQueue</i>) | |
| 171 | |
| 172 <p> | |
| 173 Module function acting as the parallel worker for the syntax check. | |
| 174 </p> | |
| 175 <dl> | |
| 176 | |
| 177 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> | |
| 178 <dd> | |
| 179 input queue | |
| 180 </dd> | |
| 181 <dt><i>outputQueue</i> (multiprocessing.Queue)</dt> | |
| 182 <dd> | |
| 183 output queue | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <div align="right"><a href="#top">Up</a></div> | |
| 187 <hr /> | |
| 188 <hr /> | |
| 189 <a NAME="yamlSyntaxBatchCheck" ID="yamlSyntaxBatchCheck"></a> | |
| 190 <h2>yamlSyntaxBatchCheck</h2> | |
| 191 <b>yamlSyntaxBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) | |
| 192 | |
| 193 <p> | |
| 194 Module function to check syntax for a batch of files. | |
| 195 </p> | |
| 196 <dl> | |
| 197 | |
| 198 <dt><i>argumentsList</i> (list)</dt> | |
| 199 <dd> | |
| 200 list of arguments tuples as given for yamlSyntaxCheck | |
| 201 </dd> | |
| 202 <dt><i>send</i> (func)</dt> | |
| 203 <dd> | |
| 204 reference to send function | |
| 205 </dd> | |
| 206 <dt><i>fx</i> (str)</dt> | |
| 207 <dd> | |
| 208 registered service name | |
| 209 </dd> | |
| 210 <dt><i>cancelled</i> (func)</dt> | |
| 211 <dd> | |
| 212 reference to function checking for a cancellation | |
| 213 </dd> | |
| 214 <dt><i>maxProcesses</i> (int)</dt> | |
| 215 <dd> | |
| 216 number of processes to be used | |
| 217 </dd> | |
| 218 </dl> | |
| 219 <div align="right"><a href="#top">Up</a></div> | |
| 220 <hr /> | |
| 221 <hr /> | |
| 222 <a NAME="yamlSyntaxCheck" ID="yamlSyntaxCheck"></a> | |
| 223 <h2>yamlSyntaxCheck</h2> | |
| 224 <b>yamlSyntaxCheck</b>(<i>file, codestring</i>) | |
| 225 | |
| 226 <p> | |
| 227 Function to check a YAML source file for syntax errors. | |
| 228 </p> | |
| 229 <dl> | |
| 230 | |
| 231 <dt><i>file</i> (str)</dt> | |
| 232 <dd> | |
| 233 source filename | |
| 234 </dd> | |
| 235 <dt><i>codestring</i> (str)</dt> | |
| 236 <dd> | |
| 237 string containing the code to check | |
| 238 </dd> | |
| 239 </dl> | |
| 240 <dl> | |
| 241 <dt>Return:</dt> | |
| 242 <dd> | |
| 243 dictionary with the keys 'error' and 'warnings' which | |
| 244 hold a list containing details about the error/ warnings | |
| 245 (file name, line number, column, codestring (only at syntax | |
| 246 errors), the message, a list with arguments for the message) | |
| 247 </dd> | |
| 248 </dl> | |
| 249 <dl> | |
| 250 <dt>Return Type:</dt> | |
| 251 <dd> | |
| 252 dict | |
| 253 </dd> | |
| 254 </dl> | |
| 255 <div align="right"><a href="#top">Up</a></div> | |
| 256 <hr /> | |
| 257 </body></html> |
