Documentation/Source/eric6.Plugins.CheckerPlugins.Tabnanny.Tabnanny.html

changeset 4237
ff8a3e769fca
parent 3673
e26d7d0c1088
child 5606
da305d172769
equal deleted inserted replaced
4236:8d4e498a7af8 4237:ff8a3e769fca
55 </tr> 55 </tr>
56 </table> 56 </table>
57 <h3>Functions</h3> 57 <h3>Functions</h3>
58 <table> 58 <table>
59 <tr> 59 <tr>
60 <td><a href="#__check">__check</a></td>
61 <td>Private function to check one Python source file for whitespace related problems.</td>
62 </tr><tr>
63 <td><a href="#batchCheck">batchCheck</a></td>
64 <td>Module function to check a batch of files for whitespace related problems.</td>
65 </tr><tr>
60 <td><a href="#check">check</a></td> 66 <td><a href="#check">check</a></td>
61 <td>Private function to check one Python source file for whitespace related problems.</td> 67 <td>Private function to check one Python source file for whitespace related problems.</td>
62 </tr><tr> 68 </tr><tr>
63 <td><a href="#format_witnesses">format_witnesses</a></td> 69 <td><a href="#format_witnesses">format_witnesses</a></td>
64 <td>Function to format the witnesses as a readable string.</td> 70 <td>Function to format the witnesses as a readable string.</td>
65 </tr><tr> 71 </tr><tr>
72 <td><a href="#initBatchService">initBatchService</a></td>
73 <td>Initialize the batch service and return the entry point.</td>
74 </tr><tr>
66 <td><a href="#initService">initService</a></td> 75 <td><a href="#initService">initService</a></td>
67 <td>Initialize the service and return the entry point.</td> 76 <td>Initialize the service and return the entry point.</td>
68 </tr><tr> 77 </tr><tr>
69 <td><a href="#process_tokens">process_tokens</a></td> 78 <td><a href="#process_tokens">process_tokens</a></td>
70 <td>Function processing all tokens generated by a tokenizer run.</td> 79 <td>Function processing all tokens generated by a tokenizer run.</td>
80 </tr><tr>
81 <td><a href="#worker">worker</a></td>
82 <td>Module function acting as the parallel worker for the style check.</td>
71 </tr> 83 </tr>
72 </table> 84 </table>
73 <hr /><hr /> 85 <hr /><hr />
74 <a NAME="NannyNag" ID="NannyNag"></a> 86 <a NAME="NannyNag" ID="NannyNag"></a>
75 <h2>NannyNag</h2> 87 <h2>NannyNag</h2>
310 i1 == self.indent_level(ts) >= other.indent_level(ts) == i2. 322 i1 == self.indent_level(ts) >= other.indent_level(ts) == i2.
311 </dd> 323 </dd>
312 </dl> 324 </dl>
313 <div align="right"><a href="#top">Up</a></div> 325 <div align="right"><a href="#top">Up</a></div>
314 <hr /><hr /> 326 <hr /><hr />
327 <a NAME="__check" ID="__check"></a>
328 <h2>__check</h2>
329 <b>__check</b>(<i>file, text=""</i>)
330 <p>
331 Private function to check one Python source file for whitespace related
332 problems.
333 </p><dl>
334 <dt><i>file</i></dt>
335 <dd>
336 source filename (string)
337 </dd><dt><i>text</i></dt>
338 <dd>
339 source text (string)
340 </dd>
341 </dl><dl>
342 <dt>Returns:</dt>
343 <dd>
344 A tuple indicating status (True = an error was found), the
345 filename, the linenumber and the error message
346 (boolean, string, string). The values are only
347 valid, if the status is True.
348 </dd>
349 </dl>
350 <div align="right"><a href="#top">Up</a></div>
351 <hr /><hr />
352 <a NAME="batchCheck" ID="batchCheck"></a>
353 <h2>batchCheck</h2>
354 <b>batchCheck</b>(<i>argumentsList, send, fx, cancelled</i>)
355 <p>
356 Module function to check a batch of files for whitespace related problems.
357 </p><dl>
358 <dt><i>argumentsList</i></dt>
359 <dd>
360 list of arguments tuples as given for check
361 </dd><dt><i>send</i></dt>
362 <dd>
363 reference to send function (function)
364 </dd><dt><i>fx</i></dt>
365 <dd>
366 registered service name (string)
367 </dd><dt><i>cancelled</i></dt>
368 <dd>
369 reference to function checking for a cancellation
370 (function)
371 </dd>
372 </dl>
373 <div align="right"><a href="#top">Up</a></div>
374 <hr /><hr />
315 <a NAME="check" ID="check"></a> 375 <a NAME="check" ID="check"></a>
316 <h2>check</h2> 376 <h2>check</h2>
317 <b>check</b>(<i>file, text=""</i>) 377 <b>check</b>(<i>file, text=""</i>)
318 <p> 378 <p>
319 Private function to check one Python source file for whitespace related 379 Private function to check one Python source file for whitespace related
353 A formated string of the witnesses. 413 A formated string of the witnesses.
354 </dd> 414 </dd>
355 </dl> 415 </dl>
356 <div align="right"><a href="#top">Up</a></div> 416 <div align="right"><a href="#top">Up</a></div>
357 <hr /><hr /> 417 <hr /><hr />
418 <a NAME="initBatchService" ID="initBatchService"></a>
419 <h2>initBatchService</h2>
420 <b>initBatchService</b>(<i></i>)
421 <p>
422 Initialize the batch service and return the entry point.
423 </p><dl>
424 <dt>Returns:</dt>
425 <dd>
426 the entry point for the background client (function)
427 </dd>
428 </dl>
429 <div align="right"><a href="#top">Up</a></div>
430 <hr /><hr />
358 <a NAME="initService" ID="initService"></a> 431 <a NAME="initService" ID="initService"></a>
359 <h2>initService</h2> 432 <h2>initService</h2>
360 <b>initService</b>(<i></i>) 433 <b>initService</b>(<i></i>)
361 <p> 434 <p>
362 Initialize the service and return the entry point. 435 Initialize the service and return the entry point.
383 <dd> 456 <dd>
384 raised to indicate an indentation error 457 raised to indicate an indentation error
385 </dd> 458 </dd>
386 </dl> 459 </dl>
387 <div align="right"><a href="#top">Up</a></div> 460 <div align="right"><a href="#top">Up</a></div>
461 <hr /><hr />
462 <a NAME="worker" ID="worker"></a>
463 <h2>worker</h2>
464 <b>worker</b>(<i>input, output</i>)
465 <p>
466 Module function acting as the parallel worker for the style check.
467 </p><dl>
468 <dt><i>input</i></dt>
469 <dd>
470 input queue (multiprocessing.Queue)
471 </dd><dt><i>output</i></dt>
472 <dd>
473 output queue (multiprocessing.Queue)
474 </dd>
475 </dl>
476 <div align="right"><a href="#top">Up</a></div>
388 <hr /> 477 <hr />
389 </body></html> 478 </body></html>

eric ide

mercurial