|
1 # -*- coding: utf-8 -*- |
|
2 |
|
3 # Copyright (c) 2010 - 2013 Detlev Offenbach <detlev@die-offenbachs.de> |
|
4 # |
|
5 # Original (c) 2005 Divmod, Inc. See LICENSE file for details |
|
6 # |
|
7 # This module is based on pyflakes for Python2 but was heavily hacked to |
|
8 # work within Eric5 and Qt (translatable messages) |
|
9 |
|
10 """ |
|
11 Module implementing the messages for pyflakes. |
|
12 """ |
|
13 |
|
14 # Tell 'lupdate' which strings to keep for translation. |
|
15 QT_TRANSLATE_NOOP = lambda mod, txt: txt |
|
16 |
|
17 |
|
18 class Message(object): |
|
19 """ |
|
20 Class defining the base for all specific message classes. |
|
21 """ |
|
22 message = '' |
|
23 message_args = () |
|
24 |
|
25 def __init__(self, filename, lineno): |
|
26 """ |
|
27 Constructor |
|
28 |
|
29 @param filename name of the file (string) |
|
30 @param lineno line number (integer) |
|
31 """ |
|
32 self.filename = filename |
|
33 self.lineno = lineno |
|
34 |
|
35 def __str__(self): |
|
36 """ |
|
37 Special method return a string representation of the instance object. |
|
38 |
|
39 @return string representation of the object (string) |
|
40 """ |
|
41 return '%s:%s: %s' % ( |
|
42 self.filename, self.lineno, self.message % self.message_args) |
|
43 |
|
44 def getMessageData(self): |
|
45 """ |
|
46 Public method to get the individual message data elements. |
|
47 |
|
48 @return tuple containing file name, line number and message |
|
49 (string, integer, string) |
|
50 """ |
|
51 return (self.filename, self.lineno, self.message, self.message_args) |
|
52 |
|
53 |
|
54 class UnusedImport(Message): |
|
55 """ |
|
56 Class defining the "Unused Import" message. |
|
57 """ |
|
58 message = QT_TRANSLATE_NOOP( |
|
59 'py3Flakes', |
|
60 '{0!r} imported but unused.') |
|
61 |
|
62 def __init__(self, filename, lineno, name): |
|
63 """ |
|
64 Constructor |
|
65 |
|
66 @param filename name of the file (string) |
|
67 @param lineno line number (integer) |
|
68 @param name name of the unused import (string) |
|
69 """ |
|
70 Message.__init__(self, filename, lineno) |
|
71 self.message_args = (name,) |
|
72 |
|
73 |
|
74 class RedefinedWhileUnused(Message): |
|
75 """ |
|
76 Class defining the "Redefined While Unused" message. |
|
77 """ |
|
78 message = QT_TRANSLATE_NOOP( |
|
79 'py3Flakes', |
|
80 'Redefinition of unused {0!r} from line {1!r}.') |
|
81 |
|
82 def __init__(self, filename, lineno, name, orig_lineno): |
|
83 """ |
|
84 Constructor |
|
85 |
|
86 @param filename name of the file (string) |
|
87 @param lineno line number (integer) |
|
88 @param name name of the redefined object (string) |
|
89 @param orig_lineno line number of the original definition (integer) |
|
90 """ |
|
91 Message.__init__(self, filename, lineno) |
|
92 self.message_args = (name, orig_lineno) |
|
93 |
|
94 |
|
95 class RedefinedInListComp(Message): |
|
96 """ |
|
97 Class defining the list comprehension redefinition. |
|
98 """ |
|
99 message = QT_TRANSLATE_NOOP( |
|
100 'py3Flakes', |
|
101 'List comprehension redefines {0!r} from line {1!r}.') |
|
102 |
|
103 def __init__(self, filename, lineno, name, orig_lineno): |
|
104 """ |
|
105 Constructor |
|
106 |
|
107 @param filename name of the file (string) |
|
108 @param lineno line number (integer) |
|
109 @param name name of the redefined object (string) |
|
110 @param orig_lineno line number of the original definition (integer) |
|
111 """ |
|
112 Message.__init__(self, filename, lineno) |
|
113 self.message_args = (name, orig_lineno) |
|
114 |
|
115 |
|
116 class ImportShadowedByLoopVar(Message): |
|
117 """ |
|
118 Class defining the "Import Shadowed By Loop Var" message. |
|
119 """ |
|
120 message = QT_TRANSLATE_NOOP( |
|
121 'py3Flakes', |
|
122 'Import {0!r} from line {1!r} shadowed by loop variable.') |
|
123 |
|
124 def __init__(self, filename, lineno, name, orig_lineno): |
|
125 """ |
|
126 Constructor |
|
127 |
|
128 @param filename name of the file (string) |
|
129 @param lineno line number (integer) |
|
130 @param name name of the shadowed import (string) |
|
131 @param orig_lineno line number of the import (integer) |
|
132 """ |
|
133 Message.__init__(self, filename, lineno) |
|
134 self.message_args = (name, orig_lineno) |
|
135 |
|
136 |
|
137 class ImportStarUsed(Message): |
|
138 """ |
|
139 Class defining the "Import Star Used" message. |
|
140 """ |
|
141 message = QT_TRANSLATE_NOOP( |
|
142 'py3Flakes', |
|
143 "'from {0} import *' used; unable to detect undefined names.") |
|
144 |
|
145 def __init__(self, filename, lineno, modname): |
|
146 """ |
|
147 Constructor |
|
148 |
|
149 @param filename name of the file (string) |
|
150 @param lineno line number (integer) |
|
151 @param modname name of the module imported using star import (string) |
|
152 """ |
|
153 Message.__init__(self, filename, lineno) |
|
154 self.message_args = (modname,) |
|
155 |
|
156 |
|
157 class UndefinedName(Message): |
|
158 """ |
|
159 Class defining the "Undefined Name" message. |
|
160 """ |
|
161 message = QT_TRANSLATE_NOOP('py3Flakes', 'Undefined name {0!r}.') |
|
162 |
|
163 def __init__(self, filename, lineno, name): |
|
164 """ |
|
165 Constructor |
|
166 |
|
167 @param filename name of the file (string) |
|
168 @param lineno line number (integer) |
|
169 @param name undefined name (string) |
|
170 """ |
|
171 Message.__init__(self, filename, lineno) |
|
172 self.message_args = (name,) |
|
173 |
|
174 |
|
175 class UndefinedExport(Message): |
|
176 """ |
|
177 Class defining the "Undefined Export" message. |
|
178 """ |
|
179 message = QT_TRANSLATE_NOOP( |
|
180 'py3Flakes', |
|
181 'Undefined name {0!r} in __all__.') |
|
182 |
|
183 def __init__(self, filename, lineno, name): |
|
184 """ |
|
185 Constructor |
|
186 |
|
187 @param filename name of the file (string) |
|
188 @param lineno line number (integer) |
|
189 @param name undefined exported name (string) |
|
190 """ |
|
191 Message.__init__(self, filename, lineno) |
|
192 self.message_args = (name,) |
|
193 |
|
194 |
|
195 class UndefinedLocal(Message): |
|
196 """ |
|
197 Class defining the "Undefined Local Variable" message. |
|
198 """ |
|
199 message = QT_TRANSLATE_NOOP( |
|
200 'py3Flakes', |
|
201 "Local variable {0!r} (defined in enclosing scope on line {1!r})" |
|
202 " referenced before assignment.") |
|
203 |
|
204 def __init__(self, filename, lineno, name, orig_lineno): |
|
205 """ |
|
206 Constructor |
|
207 |
|
208 @param filename name of the file (string) |
|
209 @param lineno line number (integer) |
|
210 @param name name of the prematurely referenced variable (string) |
|
211 @param orig_lineno line number of the variable definition (integer) |
|
212 """ |
|
213 Message.__init__(self, filename, lineno) |
|
214 self.message_args = (name, orig_lineno) |
|
215 |
|
216 |
|
217 class DuplicateArgument(Message): |
|
218 """ |
|
219 Class defining the "Duplicate Argument" message. |
|
220 """ |
|
221 message = QT_TRANSLATE_NOOP( |
|
222 'py3Flakes', |
|
223 'Duplicate argument {0!r} in function definition.') |
|
224 |
|
225 def __init__(self, filename, lineno, name): |
|
226 """ |
|
227 Constructor |
|
228 |
|
229 @param filename name of the file (string) |
|
230 @param lineno line number (integer) |
|
231 @param name name of the duplicate argument (string) |
|
232 """ |
|
233 Message.__init__(self, filename, lineno) |
|
234 self.message_args = (name,) |
|
235 |
|
236 |
|
237 class Redefined(Message): |
|
238 """ |
|
239 Class defining the "Redefined" message. |
|
240 """ |
|
241 message = QT_TRANSLATE_NOOP( |
|
242 'py3Flakes', |
|
243 'Redefinition of {0!r} from line {1!r}.') |
|
244 |
|
245 def __init__(self, filename, lineno, name, orig_lineno): |
|
246 """ |
|
247 Constructor |
|
248 |
|
249 @param filename name of the file (string) |
|
250 @param lineno line number (integer) |
|
251 @param name name of the redefined function (string) |
|
252 @param orig_lineno line number of the original definition (integer) |
|
253 """ |
|
254 Message.__init__(self, filename, lineno) |
|
255 self.message_args = (name, orig_lineno) |
|
256 |
|
257 |
|
258 class LateFutureImport(Message): |
|
259 """ |
|
260 Class defining the "Late Future Import" message. |
|
261 """ |
|
262 message = QT_TRANSLATE_NOOP( |
|
263 'py3Flakes', |
|
264 'Future import(s) {0!r} after other statements.') |
|
265 |
|
266 def __init__(self, filename, lineno, names): |
|
267 """ |
|
268 Constructor |
|
269 |
|
270 @param filename name of the file (string) |
|
271 @param lineno line number (integer) |
|
272 @param names names of the imported futures (string) |
|
273 """ |
|
274 Message.__init__(self, filename, lineno) |
|
275 self.message_args = (names,) |
|
276 |
|
277 |
|
278 class UnusedVariable(Message): |
|
279 """ |
|
280 Class defining the "Unused Variable" message. |
|
281 |
|
282 Indicates that a variable has been explicitly assigned to but not actually |
|
283 used. |
|
284 """ |
|
285 message = QT_TRANSLATE_NOOP( |
|
286 'py3Flakes', |
|
287 'Local variable {0!r} is assigned to but never used.') |
|
288 |
|
289 def __init__(self, filename, lineno, names): |
|
290 """ |
|
291 Constructor |
|
292 |
|
293 @param filename name of the file (string) |
|
294 @param lineno line number (integer) |
|
295 @param names names of the unused variable (string) |
|
296 """ |
|
297 Message.__init__(self, filename, lineno) |
|
298 self.message_args = (names,) |