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