Documentation/Source/eric5.Utilities.py3flakes.messages.html

branch
Py2 comp.
changeset 3456
96232974dcdb
parent 3178
f25fc1364c88
parent 3445
bf95eac5ce12
child 3484
645c12de6b0c
equal deleted inserted replaced
3178:f25fc1364c88 3456:96232974dcdb
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric5.Utilities.py3flakes.messages</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric5.Utilities.py3flakes.messages</h1>
23 <p>
24 Module implementing the messages for py3flakes.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#DuplicateArgument">DuplicateArgument</a></td>
34 <td>Class defining the "Duplicate Argument" message.</td>
35 </tr><tr>
36 <td><a href="#ImportShadowedByLoopVar">ImportShadowedByLoopVar</a></td>
37 <td>Class defining the "Import Shadowed By Loop Var" message.</td>
38 </tr><tr>
39 <td><a href="#ImportStarUsed">ImportStarUsed</a></td>
40 <td>Class defining the "Import Star Used" message.</td>
41 </tr><tr>
42 <td><a href="#LateFutureImport">LateFutureImport</a></td>
43 <td>Class defining the "Late Future Import" message.</td>
44 </tr><tr>
45 <td><a href="#Message">Message</a></td>
46 <td>Class defining the base for all specific message classes.</td>
47 </tr><tr>
48 <td><a href="#RedefinedFunction">RedefinedFunction</a></td>
49 <td>Class defining the "Redefined Function" message.</td>
50 </tr><tr>
51 <td><a href="#RedefinedWhileUnused">RedefinedWhileUnused</a></td>
52 <td>Class defining the "Redefined While Unused" message.</td>
53 </tr><tr>
54 <td><a href="#UndefinedExport">UndefinedExport</a></td>
55 <td>Class defining the "Undefined Export" message.</td>
56 </tr><tr>
57 <td><a href="#UndefinedLocal">UndefinedLocal</a></td>
58 <td>Class defining the "Undefined Local Variable" message.</td>
59 </tr><tr>
60 <td><a href="#UndefinedName">UndefinedName</a></td>
61 <td>Class defining the "Undefined Name" message.</td>
62 </tr><tr>
63 <td><a href="#UnusedImport">UnusedImport</a></td>
64 <td>Class defining the "Unused Import" message.</td>
65 </tr><tr>
66 <td><a href="#UnusedVariable">UnusedVariable</a></td>
67 <td>Class defining the "Unused Variable" message.</td>
68 </tr>
69 </table>
70 <h3>Functions</h3>
71 <table>
72 <tr>
73 <td><a href="#QT_TRANSLATE_NOOP">QT_TRANSLATE_NOOP</a></td>
74 <td>Function to tell 'lupdate' which strings to keep for translation.</td>
75 </tr>
76 </table>
77 <hr /><hr />
78 <a NAME="DuplicateArgument" ID="DuplicateArgument"></a>
79 <h2>DuplicateArgument</h2>
80 <p>
81 Class defining the "Duplicate Argument" message.
82 </p>
83 <h3>Derived from</h3>
84 Message
85 <h3>Class Attributes</h3>
86 <table>
87 <tr><td>message</td></tr>
88 </table>
89 <h3>Class Methods</h3>
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93 <h3>Methods</h3>
94 <table>
95 <tr>
96 <td><a href="#DuplicateArgument.__init__">DuplicateArgument</a></td>
97 <td>Constructor</td>
98 </tr>
99 </table>
100 <h3>Static Methods</h3>
101 <table>
102 <tr><td>None</td></tr>
103 </table>
104 <a NAME="DuplicateArgument.__init__" ID="DuplicateArgument.__init__"></a>
105 <h4>DuplicateArgument (Constructor)</h4>
106 <b>DuplicateArgument</b>(<i>filename, lineno, name</i>)
107 <p>
108 Constructor
109 </p><dl>
110 <dt><i>filename</i></dt>
111 <dd>
112 name of the file (string)
113 </dd><dt><i>lineno</i></dt>
114 <dd>
115 line number (integer)
116 </dd><dt><i>name</i></dt>
117 <dd>
118 name of the duplicate argument (string)
119 </dd>
120 </dl>
121 <div align="right"><a href="#top">Up</a></div>
122 <hr /><hr />
123 <a NAME="ImportShadowedByLoopVar" ID="ImportShadowedByLoopVar"></a>
124 <h2>ImportShadowedByLoopVar</h2>
125 <p>
126 Class defining the "Import Shadowed By Loop Var" message.
127 </p>
128 <h3>Derived from</h3>
129 Message
130 <h3>Class Attributes</h3>
131 <table>
132 <tr><td>message</td></tr>
133 </table>
134 <h3>Class Methods</h3>
135 <table>
136 <tr><td>None</td></tr>
137 </table>
138 <h3>Methods</h3>
139 <table>
140 <tr>
141 <td><a href="#ImportShadowedByLoopVar.__init__">ImportShadowedByLoopVar</a></td>
142 <td>Constructor</td>
143 </tr>
144 </table>
145 <h3>Static Methods</h3>
146 <table>
147 <tr><td>None</td></tr>
148 </table>
149 <a NAME="ImportShadowedByLoopVar.__init__" ID="ImportShadowedByLoopVar.__init__"></a>
150 <h4>ImportShadowedByLoopVar (Constructor)</h4>
151 <b>ImportShadowedByLoopVar</b>(<i>filename, lineno, name, orig_lineno</i>)
152 <p>
153 Constructor
154 </p><dl>
155 <dt><i>filename</i></dt>
156 <dd>
157 name of the file (string)
158 </dd><dt><i>lineno</i></dt>
159 <dd>
160 line number (integer)
161 </dd><dt><i>name</i></dt>
162 <dd>
163 name of the shadowed import (string)
164 </dd><dt><i>orig_lineno</i></dt>
165 <dd>
166 line number of the import (integer)
167 </dd>
168 </dl>
169 <div align="right"><a href="#top">Up</a></div>
170 <hr /><hr />
171 <a NAME="ImportStarUsed" ID="ImportStarUsed"></a>
172 <h2>ImportStarUsed</h2>
173 <p>
174 Class defining the "Import Star Used" message.
175 </p>
176 <h3>Derived from</h3>
177 Message
178 <h3>Class Attributes</h3>
179 <table>
180 <tr><td>message</td></tr>
181 </table>
182 <h3>Class Methods</h3>
183 <table>
184 <tr><td>None</td></tr>
185 </table>
186 <h3>Methods</h3>
187 <table>
188 <tr>
189 <td><a href="#ImportStarUsed.__init__">ImportStarUsed</a></td>
190 <td>Constructor</td>
191 </tr>
192 </table>
193 <h3>Static Methods</h3>
194 <table>
195 <tr><td>None</td></tr>
196 </table>
197 <a NAME="ImportStarUsed.__init__" ID="ImportStarUsed.__init__"></a>
198 <h4>ImportStarUsed (Constructor)</h4>
199 <b>ImportStarUsed</b>(<i>filename, lineno, modname</i>)
200 <p>
201 Constructor
202 </p><dl>
203 <dt><i>filename</i></dt>
204 <dd>
205 name of the file (string)
206 </dd><dt><i>lineno</i></dt>
207 <dd>
208 line number (integer)
209 </dd><dt><i>modname</i></dt>
210 <dd>
211 name of the module imported using star import (string)
212 </dd>
213 </dl>
214 <div align="right"><a href="#top">Up</a></div>
215 <hr /><hr />
216 <a NAME="LateFutureImport" ID="LateFutureImport"></a>
217 <h2>LateFutureImport</h2>
218 <p>
219 Class defining the "Late Future Import" message.
220 </p>
221 <h3>Derived from</h3>
222 Message
223 <h3>Class Attributes</h3>
224 <table>
225 <tr><td>message</td></tr>
226 </table>
227 <h3>Class Methods</h3>
228 <table>
229 <tr><td>None</td></tr>
230 </table>
231 <h3>Methods</h3>
232 <table>
233 <tr>
234 <td><a href="#LateFutureImport.__init__">LateFutureImport</a></td>
235 <td>Constructor</td>
236 </tr>
237 </table>
238 <h3>Static Methods</h3>
239 <table>
240 <tr><td>None</td></tr>
241 </table>
242 <a NAME="LateFutureImport.__init__" ID="LateFutureImport.__init__"></a>
243 <h4>LateFutureImport (Constructor)</h4>
244 <b>LateFutureImport</b>(<i>filename, lineno, names</i>)
245 <p>
246 Constructor
247 </p><dl>
248 <dt><i>filename</i></dt>
249 <dd>
250 name of the file (string)
251 </dd><dt><i>lineno</i></dt>
252 <dd>
253 line number (integer)
254 </dd><dt><i>names</i></dt>
255 <dd>
256 names of the imported futures (string)
257 </dd>
258 </dl>
259 <div align="right"><a href="#top">Up</a></div>
260 <hr /><hr />
261 <a NAME="Message" ID="Message"></a>
262 <h2>Message</h2>
263 <p>
264 Class defining the base for all specific message classes.
265 </p>
266 <h3>Derived from</h3>
267 object
268 <h3>Class Attributes</h3>
269 <table>
270 <tr><td>message</td></tr><tr><td>message_args</td></tr>
271 </table>
272 <h3>Class Methods</h3>
273 <table>
274 <tr><td>None</td></tr>
275 </table>
276 <h3>Methods</h3>
277 <table>
278 <tr>
279 <td><a href="#Message.__init__">Message</a></td>
280 <td>Constructor</td>
281 </tr><tr>
282 <td><a href="#Message.__str__">__str__</a></td>
283 <td>Special method return a string representation of the instance object.</td>
284 </tr><tr>
285 <td><a href="#Message.getMessageData">getMessageData</a></td>
286 <td>Public method to get the individual message data elements.</td>
287 </tr>
288 </table>
289 <h3>Static Methods</h3>
290 <table>
291 <tr><td>None</td></tr>
292 </table>
293 <a NAME="Message.__init__" ID="Message.__init__"></a>
294 <h4>Message (Constructor)</h4>
295 <b>Message</b>(<i>filename, lineno</i>)
296 <p>
297 Constructor
298 </p><dl>
299 <dt><i>filename</i></dt>
300 <dd>
301 name of the file (string)
302 </dd><dt><i>lineno</i></dt>
303 <dd>
304 line number (integer)
305 </dd>
306 </dl><a NAME="Message.__str__" ID="Message.__str__"></a>
307 <h4>Message.__str__</h4>
308 <b>__str__</b>(<i></i>)
309 <p>
310 Special method return a string representation of the instance object.
311 </p><dl>
312 <dt>Returns:</dt>
313 <dd>
314 string representation of the object (string)
315 </dd>
316 </dl><a NAME="Message.getMessageData" ID="Message.getMessageData"></a>
317 <h4>Message.getMessageData</h4>
318 <b>getMessageData</b>(<i></i>)
319 <p>
320 Public method to get the individual message data elements.
321 </p><dl>
322 <dt>Returns:</dt>
323 <dd>
324 tuple containing file name, line number and message
325 (string, integer, string)
326 </dd>
327 </dl>
328 <div align="right"><a href="#top">Up</a></div>
329 <hr /><hr />
330 <a NAME="RedefinedFunction" ID="RedefinedFunction"></a>
331 <h2>RedefinedFunction</h2>
332 <p>
333 Class defining the "Redefined Function" message.
334 </p>
335 <h3>Derived from</h3>
336 Message
337 <h3>Class Attributes</h3>
338 <table>
339 <tr><td>message</td></tr>
340 </table>
341 <h3>Class Methods</h3>
342 <table>
343 <tr><td>None</td></tr>
344 </table>
345 <h3>Methods</h3>
346 <table>
347 <tr>
348 <td><a href="#RedefinedFunction.__init__">RedefinedFunction</a></td>
349 <td>Constructor</td>
350 </tr>
351 </table>
352 <h3>Static Methods</h3>
353 <table>
354 <tr><td>None</td></tr>
355 </table>
356 <a NAME="RedefinedFunction.__init__" ID="RedefinedFunction.__init__"></a>
357 <h4>RedefinedFunction (Constructor)</h4>
358 <b>RedefinedFunction</b>(<i>filename, lineno, name, orig_lineno</i>)
359 <p>
360 Constructor
361 </p><dl>
362 <dt><i>filename</i></dt>
363 <dd>
364 name of the file (string)
365 </dd><dt><i>lineno</i></dt>
366 <dd>
367 line number (integer)
368 </dd><dt><i>name</i></dt>
369 <dd>
370 name of the redefined function (string)
371 </dd><dt><i>orig_lineno</i></dt>
372 <dd>
373 line number of the original definition (integer)
374 </dd>
375 </dl>
376 <div align="right"><a href="#top">Up</a></div>
377 <hr /><hr />
378 <a NAME="RedefinedWhileUnused" ID="RedefinedWhileUnused"></a>
379 <h2>RedefinedWhileUnused</h2>
380 <p>
381 Class defining the "Redefined While Unused" message.
382 </p>
383 <h3>Derived from</h3>
384 Message
385 <h3>Class Attributes</h3>
386 <table>
387 <tr><td>message</td></tr>
388 </table>
389 <h3>Class Methods</h3>
390 <table>
391 <tr><td>None</td></tr>
392 </table>
393 <h3>Methods</h3>
394 <table>
395 <tr>
396 <td><a href="#RedefinedWhileUnused.__init__">RedefinedWhileUnused</a></td>
397 <td>Constructor</td>
398 </tr>
399 </table>
400 <h3>Static Methods</h3>
401 <table>
402 <tr><td>None</td></tr>
403 </table>
404 <a NAME="RedefinedWhileUnused.__init__" ID="RedefinedWhileUnused.__init__"></a>
405 <h4>RedefinedWhileUnused (Constructor)</h4>
406 <b>RedefinedWhileUnused</b>(<i>filename, lineno, name, orig_lineno</i>)
407 <p>
408 Constructor
409 </p><dl>
410 <dt><i>filename</i></dt>
411 <dd>
412 name of the file (string)
413 </dd><dt><i>lineno</i></dt>
414 <dd>
415 line number (integer)
416 </dd><dt><i>name</i></dt>
417 <dd>
418 name of the redefined object (string)
419 </dd><dt><i>orig_lineno</i></dt>
420 <dd>
421 line number of the original definition (integer)
422 </dd>
423 </dl>
424 <div align="right"><a href="#top">Up</a></div>
425 <hr /><hr />
426 <a NAME="UndefinedExport" ID="UndefinedExport"></a>
427 <h2>UndefinedExport</h2>
428 <p>
429 Class defining the "Undefined Export" message.
430 </p>
431 <h3>Derived from</h3>
432 Message
433 <h3>Class Attributes</h3>
434 <table>
435 <tr><td>message</td></tr>
436 </table>
437 <h3>Class Methods</h3>
438 <table>
439 <tr><td>None</td></tr>
440 </table>
441 <h3>Methods</h3>
442 <table>
443 <tr>
444 <td><a href="#UndefinedExport.__init__">UndefinedExport</a></td>
445 <td>Constructor</td>
446 </tr>
447 </table>
448 <h3>Static Methods</h3>
449 <table>
450 <tr><td>None</td></tr>
451 </table>
452 <a NAME="UndefinedExport.__init__" ID="UndefinedExport.__init__"></a>
453 <h4>UndefinedExport (Constructor)</h4>
454 <b>UndefinedExport</b>(<i>filename, lineno, name</i>)
455 <p>
456 Constructor
457 </p><dl>
458 <dt><i>filename</i></dt>
459 <dd>
460 name of the file (string)
461 </dd><dt><i>lineno</i></dt>
462 <dd>
463 line number (integer)
464 </dd><dt><i>name</i></dt>
465 <dd>
466 undefined exported name (string)
467 </dd>
468 </dl>
469 <div align="right"><a href="#top">Up</a></div>
470 <hr /><hr />
471 <a NAME="UndefinedLocal" ID="UndefinedLocal"></a>
472 <h2>UndefinedLocal</h2>
473 <p>
474 Class defining the "Undefined Local Variable" message.
475 </p>
476 <h3>Derived from</h3>
477 Message
478 <h3>Class Attributes</h3>
479 <table>
480 <tr><td>message</td></tr>
481 </table>
482 <h3>Class Methods</h3>
483 <table>
484 <tr><td>None</td></tr>
485 </table>
486 <h3>Methods</h3>
487 <table>
488 <tr>
489 <td><a href="#UndefinedLocal.__init__">UndefinedLocal</a></td>
490 <td>Constructor</td>
491 </tr>
492 </table>
493 <h3>Static Methods</h3>
494 <table>
495 <tr><td>None</td></tr>
496 </table>
497 <a NAME="UndefinedLocal.__init__" ID="UndefinedLocal.__init__"></a>
498 <h4>UndefinedLocal (Constructor)</h4>
499 <b>UndefinedLocal</b>(<i>filename, lineno, name, orig_lineno</i>)
500 <p>
501 Constructor
502 </p><dl>
503 <dt><i>filename</i></dt>
504 <dd>
505 name of the file (string)
506 </dd><dt><i>lineno</i></dt>
507 <dd>
508 line number (integer)
509 </dd><dt><i>name</i></dt>
510 <dd>
511 name of the prematurely referenced variable (string)
512 </dd><dt><i>orig_lineno</i></dt>
513 <dd>
514 line number of the variable definition (integer)
515 </dd>
516 </dl>
517 <div align="right"><a href="#top">Up</a></div>
518 <hr /><hr />
519 <a NAME="UndefinedName" ID="UndefinedName"></a>
520 <h2>UndefinedName</h2>
521 <p>
522 Class defining the "Undefined Name" message.
523 </p>
524 <h3>Derived from</h3>
525 Message
526 <h3>Class Attributes</h3>
527 <table>
528 <tr><td>message</td></tr>
529 </table>
530 <h3>Class Methods</h3>
531 <table>
532 <tr><td>None</td></tr>
533 </table>
534 <h3>Methods</h3>
535 <table>
536 <tr>
537 <td><a href="#UndefinedName.__init__">UndefinedName</a></td>
538 <td>Constructor</td>
539 </tr>
540 </table>
541 <h3>Static Methods</h3>
542 <table>
543 <tr><td>None</td></tr>
544 </table>
545 <a NAME="UndefinedName.__init__" ID="UndefinedName.__init__"></a>
546 <h4>UndefinedName (Constructor)</h4>
547 <b>UndefinedName</b>(<i>filename, lineno, name</i>)
548 <p>
549 Constructor
550 </p><dl>
551 <dt><i>filename</i></dt>
552 <dd>
553 name of the file (string)
554 </dd><dt><i>lineno</i></dt>
555 <dd>
556 line number (integer)
557 </dd><dt><i>name</i></dt>
558 <dd>
559 undefined name (string)
560 </dd>
561 </dl>
562 <div align="right"><a href="#top">Up</a></div>
563 <hr /><hr />
564 <a NAME="UnusedImport" ID="UnusedImport"></a>
565 <h2>UnusedImport</h2>
566 <p>
567 Class defining the "Unused Import" message.
568 </p>
569 <h3>Derived from</h3>
570 Message
571 <h3>Class Attributes</h3>
572 <table>
573 <tr><td>message</td></tr>
574 </table>
575 <h3>Class Methods</h3>
576 <table>
577 <tr><td>None</td></tr>
578 </table>
579 <h3>Methods</h3>
580 <table>
581 <tr>
582 <td><a href="#UnusedImport.__init__">UnusedImport</a></td>
583 <td>Constructor</td>
584 </tr>
585 </table>
586 <h3>Static Methods</h3>
587 <table>
588 <tr><td>None</td></tr>
589 </table>
590 <a NAME="UnusedImport.__init__" ID="UnusedImport.__init__"></a>
591 <h4>UnusedImport (Constructor)</h4>
592 <b>UnusedImport</b>(<i>filename, lineno, name</i>)
593 <p>
594 Constructor
595 </p><dl>
596 <dt><i>filename</i></dt>
597 <dd>
598 name of the file (string)
599 </dd><dt><i>lineno</i></dt>
600 <dd>
601 line number (integer)
602 </dd><dt><i>name</i></dt>
603 <dd>
604 name of the unused import (string)
605 </dd>
606 </dl>
607 <div align="right"><a href="#top">Up</a></div>
608 <hr /><hr />
609 <a NAME="UnusedVariable" ID="UnusedVariable"></a>
610 <h2>UnusedVariable</h2>
611 <p>
612 Class defining the "Unused Variable" message.
613 </p><p>
614 Indicates that a variable has been explicitly assigned to but not actually
615 used.
616 </p>
617 <h3>Derived from</h3>
618 Message
619 <h3>Class Attributes</h3>
620 <table>
621 <tr><td>message</td></tr>
622 </table>
623 <h3>Class Methods</h3>
624 <table>
625 <tr><td>None</td></tr>
626 </table>
627 <h3>Methods</h3>
628 <table>
629 <tr>
630 <td><a href="#UnusedVariable.__init__">UnusedVariable</a></td>
631 <td>Constructor</td>
632 </tr>
633 </table>
634 <h3>Static Methods</h3>
635 <table>
636 <tr><td>None</td></tr>
637 </table>
638 <a NAME="UnusedVariable.__init__" ID="UnusedVariable.__init__"></a>
639 <h4>UnusedVariable (Constructor)</h4>
640 <b>UnusedVariable</b>(<i>filename, lineno, name</i>)
641 <p>
642 Constructor
643 </p><dl>
644 <dt><i>filename</i></dt>
645 <dd>
646 name of the file (string)
647 </dd><dt><i>lineno</i></dt>
648 <dd>
649 line number (integer)
650 </dd><dt><i>name</i></dt>
651 <dd>
652 name of the unused variable (string)
653 </dd>
654 </dl>
655 <div align="right"><a href="#top">Up</a></div>
656 <hr /><hr />
657 <a NAME="QT_TRANSLATE_NOOP" ID="QT_TRANSLATE_NOOP"></a>
658 <h2>QT_TRANSLATE_NOOP</h2>
659 <b>QT_TRANSLATE_NOOP</b>(<i>mod, txt</i>)
660 <p>
661 Function to tell 'lupdate' which strings to keep for translation.
662 </p><dl>
663 <dt><i>mod</i></dt>
664 <dd>
665 module name
666 </dd><dt><i>txt</i></dt>
667 <dd>
668 translatable string
669 </dd>
670 </dl><dl>
671 <dt>Returns:</dt>
672 <dd>
673 the untranslated! string
674 </dd>
675 </dl>
676 <div align="right"><a href="#top">Up</a></div>
677 <hr />
678 </body></html>

eric ide

mercurial