Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html

changeset 2923
01ac1f364b38
parent 2912
9ff696796092
child 2925
04896af1b0e1
equal deleted inserted replaced
2922:16905f0f48be 2923:01ac1f364b38
73 <td>Private method to check, if the code should be fixed.</td> 73 <td>Private method to check, if the code should be fixed.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#Pep8Fixer.__findLogical">__findLogical</a></td> 75 <td><a href="#Pep8Fixer.__findLogical">__findLogical</a></td>
76 <td>Private method to extract the index of all the starts and ends of lines.</td> 76 <td>Private method to extract the index of all the starts and ends of lines.</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#Pep8Fixer.__fixD121">__fixD121</a></td>
79 <td>Private method to fix a single line docstring on multiple lines (D121).</td>
80 </tr><tr>
81 <td><a href="#Pep8Fixer.__fixD131">__fixD131</a></td>
82 <td>Private method to fix a single line docstring on multiple lines (D121).</td>
83 </tr><tr>
84 <td><a href="#Pep8Fixer.__fixD141">__fixD141</a></td>
85 <td>Private method to fix a function/method docstring preceded by a blank line (D141).</td>
86 </tr><tr>
87 <td><a href="#Pep8Fixer.__fixD142">__fixD142</a></td>
88 <td>Private method to fix a class docstring not preceded by a blank line (D142).</td>
89 </tr><tr>
90 <td><a href="#Pep8Fixer.__fixD143">__fixD143</a></td>
91 <td>Private method to fix a class docstring not followed by a blank line (D143).</td>
92 </tr><tr>
93 <td><a href="#Pep8Fixer.__fixD144">__fixD144</a></td>
94 <td>Private method to fix a docstring summary not followed by a blank line (D144).</td>
95 </tr><tr>
96 <td><a href="#Pep8Fixer.__fixD145">__fixD145</a></td>
97 <td>Private method to fix the last paragraph of a multi-line docstring not followed by a blank line (D143).</td>
98 </tr><tr>
78 <td><a href="#Pep8Fixer.__fixE101">__fixE101</a></td> 99 <td><a href="#Pep8Fixer.__fixE101">__fixE101</a></td>
79 <td>Private method to fix obsolete tab usage and indentation errors (E101, E111, W191).</td> 100 <td>Private method to fix obsolete tab usage and indentation errors (E101, E111, W191).</td>
80 </tr><tr> 101 </tr><tr>
81 <td><a href="#Pep8Fixer.__fixE121">__fixE121</a></td> 102 <td><a href="#Pep8Fixer.__fixE121">__fixE121</a></td>
82 <td>Private method to fix the indentation of continuation lines and closing brackets (E121, E124).</td> 103 <td>Private method to fix the indentation of continuation lines and closing brackets (E121, E124).</td>
255 </p><dl> 276 </p><dl>
256 <dt>Returns:</dt> 277 <dt>Returns:</dt>
257 <dd> 278 <dd>
258 tuple containing two lists of integer with start and end tuples 279 tuple containing two lists of integer with start and end tuples
259 of lines 280 of lines
281 </dd>
282 </dl><a NAME="Pep8Fixer.__fixD121" ID="Pep8Fixer.__fixD121"></a>
283 <h4>Pep8Fixer.__fixD121</h4>
284 <b>__fixD121</b>(<i>code, line, pos, apply=False</i>)
285 <p>
286 Private method to fix a single line docstring on multiple lines (D121).
287 </p><dl>
288 <dt><i>code</i></dt>
289 <dd>
290 code of the issue (string)
291 </dd><dt><i>line</i></dt>
292 <dd>
293 line number of the issue (integer)
294 </dd><dt><i>pos</i></dt>
295 <dd>
296 position inside line (integer)
297 </dd><dt><i>apply=</i></dt>
298 <dd>
299 flag indicating, that the fix should be applied
300 (boolean)
301 </dd>
302 </dl><dl>
303 <dt>Returns:</dt>
304 <dd>
305 value indicating an applied/deferred fix (-1, 0, 1),
306 a message for the fix (string) and an ID for a deferred
307 fix (integer)
308 </dd>
309 </dl><a NAME="Pep8Fixer.__fixD131" ID="Pep8Fixer.__fixD131"></a>
310 <h4>Pep8Fixer.__fixD131</h4>
311 <b>__fixD131</b>(<i>code, line, pos</i>)
312 <p>
313 Private method to fix a single line docstring on multiple lines (D121).
314 </p><dl>
315 <dt><i>code</i></dt>
316 <dd>
317 code of the issue (string)
318 </dd><dt><i>line</i></dt>
319 <dd>
320 line number of the issue (integer)
321 </dd><dt><i>pos</i></dt>
322 <dd>
323 position inside line (integer)
324 </dd>
325 </dl><dl>
326 <dt>Returns:</dt>
327 <dd>
328 value indicating an applied/deferred fix (-1, 0, 1),
329 a message for the fix (string) and an ID for a deferred
330 fix (integer)
331 </dd>
332 </dl><a NAME="Pep8Fixer.__fixD141" ID="Pep8Fixer.__fixD141"></a>
333 <h4>Pep8Fixer.__fixD141</h4>
334 <b>__fixD141</b>(<i>code, line, pos, apply=False</i>)
335 <p>
336 Private method to fix a function/method docstring preceded by a
337 blank line (D141).
338 </p><dl>
339 <dt><i>code</i></dt>
340 <dd>
341 code of the issue (string)
342 </dd><dt><i>line</i></dt>
343 <dd>
344 line number of the issue (integer)
345 </dd><dt><i>pos</i></dt>
346 <dd>
347 position inside line (integer)
348 </dd><dt><i>apply=</i></dt>
349 <dd>
350 flag indicating, that the fix should be applied
351 (boolean)
352 </dd>
353 </dl><dl>
354 <dt>Returns:</dt>
355 <dd>
356 value indicating an applied/deferred fix (-1, 0, 1),
357 a message for the fix (string) and an ID for a deferred
358 fix (integer)
359 </dd>
360 </dl><a NAME="Pep8Fixer.__fixD142" ID="Pep8Fixer.__fixD142"></a>
361 <h4>Pep8Fixer.__fixD142</h4>
362 <b>__fixD142</b>(<i>code, line, pos, apply=False</i>)
363 <p>
364 Private method to fix a class docstring not preceded by a
365 blank line (D142).
366 </p><dl>
367 <dt><i>code</i></dt>
368 <dd>
369 code of the issue (string)
370 </dd><dt><i>line</i></dt>
371 <dd>
372 line number of the issue (integer)
373 </dd><dt><i>pos</i></dt>
374 <dd>
375 position inside line (integer)
376 </dd><dt><i>apply=</i></dt>
377 <dd>
378 flag indicating, that the fix should be applied
379 (boolean)
380 </dd>
381 </dl><dl>
382 <dt>Returns:</dt>
383 <dd>
384 value indicating an applied/deferred fix (-1, 0, 1),
385 a message for the fix (string) and an ID for a deferred
386 fix (integer)
387 </dd>
388 </dl><a NAME="Pep8Fixer.__fixD143" ID="Pep8Fixer.__fixD143"></a>
389 <h4>Pep8Fixer.__fixD143</h4>
390 <b>__fixD143</b>(<i>code, line, pos, apply=False</i>)
391 <p>
392 Private method to fix a class docstring not followed by a
393 blank line (D143).
394 </p><dl>
395 <dt><i>code</i></dt>
396 <dd>
397 code of the issue (string)
398 </dd><dt><i>line</i></dt>
399 <dd>
400 line number of the issue (integer)
401 </dd><dt><i>pos</i></dt>
402 <dd>
403 position inside line (integer)
404 </dd><dt><i>apply=</i></dt>
405 <dd>
406 flag indicating, that the fix should be applied
407 (boolean)
408 </dd>
409 </dl><dl>
410 <dt>Returns:</dt>
411 <dd>
412 value indicating an applied/deferred fix (-1, 0, 1),
413 a message for the fix (string) and an ID for a deferred
414 fix (integer)
415 </dd>
416 </dl><a NAME="Pep8Fixer.__fixD144" ID="Pep8Fixer.__fixD144"></a>
417 <h4>Pep8Fixer.__fixD144</h4>
418 <b>__fixD144</b>(<i>code, line, pos, apply=False</i>)
419 <p>
420 Private method to fix a docstring summary not followed by a
421 blank line (D144).
422 </p><dl>
423 <dt><i>code</i></dt>
424 <dd>
425 code of the issue (string)
426 </dd><dt><i>line</i></dt>
427 <dd>
428 line number of the issue (integer)
429 </dd><dt><i>pos</i></dt>
430 <dd>
431 position inside line (integer)
432 </dd><dt><i>apply=</i></dt>
433 <dd>
434 flag indicating, that the fix should be applied
435 (boolean)
436 </dd>
437 </dl><dl>
438 <dt>Returns:</dt>
439 <dd>
440 value indicating an applied/deferred fix (-1, 0, 1),
441 a message for the fix (string) and an ID for a deferred
442 fix (integer)
443 </dd>
444 </dl><a NAME="Pep8Fixer.__fixD145" ID="Pep8Fixer.__fixD145"></a>
445 <h4>Pep8Fixer.__fixD145</h4>
446 <b>__fixD145</b>(<i>code, line, pos, apply=False</i>)
447 <p>
448 Private method to fix the last paragraph of a multi-line docstring
449 not followed by a blank line (D143).
450 </p><dl>
451 <dt><i>code</i></dt>
452 <dd>
453 code of the issue (string)
454 </dd><dt><i>line</i></dt>
455 <dd>
456 line number of the issue (integer)
457 </dd><dt><i>pos</i></dt>
458 <dd>
459 position inside line (integer)
460 </dd><dt><i>apply=</i></dt>
461 <dd>
462 flag indicating, that the fix should be applied
463 (boolean)
464 </dd>
465 </dl><dl>
466 <dt>Returns:</dt>
467 <dd>
468 value indicating an applied/deferred fix (-1, 0, 1),
469 a message for the fix (string) and an ID for a deferred
470 fix (integer)
260 </dd> 471 </dd>
261 </dl><a NAME="Pep8Fixer.__fixE101" ID="Pep8Fixer.__fixE101"></a> 472 </dl><a NAME="Pep8Fixer.__fixE101" ID="Pep8Fixer.__fixE101"></a>
262 <h4>Pep8Fixer.__fixE101</h4> 473 <h4>Pep8Fixer.__fixE101</h4>
263 <b>__fixE101</b>(<i>code, line, pos</i>) 474 <b>__fixE101</b>(<i>code, line, pos</i>)
264 <p> 475 <p>

eric ide

mercurial