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

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

eric ide

mercurial