Documentation/Source/eric5.Plugins.CheckerPlugins.SyntaxChecker.pyflakes.checker.html

branch
Py2 comp.
changeset 3525
66f4b8646622
parent 3524
c6141071339a
child 3526
b00ee853bceb
equal deleted inserted replaced
3524:c6141071339a 3525:66f4b8646622
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric5.Plugins.CheckerPlugins.SyntaxChecker.pyflakes.checker</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.Plugins.CheckerPlugins.SyntaxChecker.pyflakes.checker</h1>
23 <p>
24 Main module.
25 </p><p>
26 Implement the central Checker class.
27 Also, it models the Bindings and Scopes.
28 </p>
29 <h3>Global Attributes</h3>
30 <table>
31 <tr><td>_MAGIC_GLOBALS</td></tr>
32 </table>
33 <h3>Classes</h3>
34 <table>
35 <tr>
36 <td><a href="#Argument">Argument</a></td>
37 <td>Represents binding a name as an argument.</td>
38 </tr><tr>
39 <td><a href="#Assignment">Assignment</a></td>
40 <td>Represents binding a name with an explicit assignment.</td>
41 </tr><tr>
42 <td><a href="#Binding">Binding</a></td>
43 <td>Represents the binding of a value to a name.</td>
44 </tr><tr>
45 <td><a href="#Checker">Checker</a></td>
46 <td>I check the cleanliness and sanity of Python code.</td>
47 </tr><tr>
48 <td><a href="#ClassDefinition">ClassDefinition</a></td>
49 <td></td>
50 </tr><tr>
51 <td><a href="#ClassScope">ClassScope</a></td>
52 <td></td>
53 </tr><tr>
54 <td><a href="#Definition">Definition</a></td>
55 <td>A binding that defines a function or a class.</td>
56 </tr><tr>
57 <td><a href="#ExportBinding">ExportBinding</a></td>
58 <td>A binding created by an C{__all__} assignment.</td>
59 </tr><tr>
60 <td><a href="#FunctionDefinition">FunctionDefinition</a></td>
61 <td></td>
62 </tr><tr>
63 <td><a href="#FunctionScope">FunctionScope</a></td>
64 <td>I represent a name scope for a function.</td>
65 </tr><tr>
66 <td><a href="#GeneratorScope">GeneratorScope</a></td>
67 <td></td>
68 </tr><tr>
69 <td><a href="#Importation">Importation</a></td>
70 <td>A binding created by an import statement.</td>
71 </tr><tr>
72 <td><a href="#ModuleScope">ModuleScope</a></td>
73 <td></td>
74 </tr><tr>
75 <td><a href="#Scope">Scope</a></td>
76 <td></td>
77 </tr>
78 </table>
79 <h3>Functions</h3>
80 <table>
81 <tr>
82 <td><a href="#__init__">__init__</a></td>
83 <td></td>
84 </tr><tr>
85 <td><a href="#__init___1">__init__</a></td>
86 <td></td>
87 </tr><tr>
88 <td><a href="#__init___2">__init__</a></td>
89 <td></td>
90 </tr><tr>
91 <td><a href="#__repr__">__repr__</a></td>
92 <td></td>
93 </tr><tr>
94 <td><a href="#__repr___1">__repr__</a></td>
95 <td></td>
96 </tr><tr>
97 <td><a href="#__str__">__str__</a></td>
98 <td></td>
99 </tr><tr>
100 <td><a href="#getNodeName">getNodeName</a></td>
101 <td></td>
102 </tr><tr>
103 <td><a href="#getNodeType">getNodeType</a></td>
104 <td></td>
105 </tr><tr>
106 <td><a href="#getNodeType_1">getNodeType</a></td>
107 <td></td>
108 </tr><tr>
109 <td><a href="#iter_child_nodes">iter_child_nodes</a></td>
110 <td>Yield all direct child nodes of *node*, that is, all fields that are nodes and all items of fields that are lists of nodes.</td>
111 </tr><tr>
112 <td><a href="#names">names</a></td>
113 <td>Return a list of the names referenced by this binding.</td>
114 </tr><tr>
115 <td><a href="#unusedAssignments">unusedAssignments</a></td>
116 <td>Return a generator for the assignments which have not been used.</td>
117 </tr>
118 </table>
119 <hr /><hr />
120 <a NAME="Argument" ID="Argument"></a>
121 <h2>Argument</h2>
122 <p>
123 Represents binding a name as an argument.
124 </p>
125 <h3>Derived from</h3>
126 Binding
127 <h3>Class Attributes</h3>
128 <table>
129 <tr><td>None</td></tr>
130 </table>
131 <h3>Class Methods</h3>
132 <table>
133 <tr><td>None</td></tr>
134 </table>
135 <h3>Methods</h3>
136 <table>
137 <tr><td>None</td></tr>
138 </table>
139 <h3>Static Methods</h3>
140 <table>
141 <tr><td>None</td></tr>
142 </table>
143
144 <div align="right"><a href="#top">Up</a></div>
145 <hr /><hr />
146 <a NAME="Assignment" ID="Assignment"></a>
147 <h2>Assignment</h2>
148 <p>
149 Represents binding a name with an explicit assignment.
150 </p><p>
151 The checker will raise warnings for any Assignment that isn't used. Also,
152 the checker does not consider assignments in tuple/list unpacking to be
153 Assignments, rather it treats them as simple Bindings.
154 </p>
155 <h3>Derived from</h3>
156 Binding
157 <h3>Class Attributes</h3>
158 <table>
159 <tr><td>None</td></tr>
160 </table>
161 <h3>Class Methods</h3>
162 <table>
163 <tr><td>None</td></tr>
164 </table>
165 <h3>Methods</h3>
166 <table>
167 <tr><td>None</td></tr>
168 </table>
169 <h3>Static Methods</h3>
170 <table>
171 <tr><td>None</td></tr>
172 </table>
173
174 <div align="right"><a href="#top">Up</a></div>
175 <hr /><hr />
176 <a NAME="ClassDefinition" ID="ClassDefinition"></a>
177 <h2>ClassDefinition</h2>
178
179 <h3>Derived from</h3>
180 Definition
181 <h3>Class Attributes</h3>
182 <table>
183 <tr><td>None</td></tr>
184 </table>
185 <h3>Class Methods</h3>
186 <table>
187 <tr><td>None</td></tr>
188 </table>
189 <h3>Methods</h3>
190 <table>
191 <tr><td>None</td></tr>
192 </table>
193 <h3>Static Methods</h3>
194 <table>
195 <tr><td>None</td></tr>
196 </table>
197
198 <div align="right"><a href="#top">Up</a></div>
199 <hr /><hr />
200 <a NAME="ClassScope" ID="ClassScope"></a>
201 <h2>ClassScope</h2>
202
203 <h3>Derived from</h3>
204 Scope
205 <h3>Class Attributes</h3>
206 <table>
207 <tr><td>None</td></tr>
208 </table>
209 <h3>Class Methods</h3>
210 <table>
211 <tr><td>None</td></tr>
212 </table>
213 <h3>Methods</h3>
214 <table>
215 <tr><td>None</td></tr>
216 </table>
217 <h3>Static Methods</h3>
218 <table>
219 <tr><td>None</td></tr>
220 </table>
221
222 <div align="right"><a href="#top">Up</a></div>
223 <hr /><hr />
224 <a NAME="Definition" ID="Definition"></a>
225 <h2>Definition</h2>
226 <p>
227 A binding that defines a function or a class.
228 </p>
229 <h3>Derived from</h3>
230 Binding
231 <h3>Class Attributes</h3>
232 <table>
233 <tr><td>None</td></tr>
234 </table>
235 <h3>Class Methods</h3>
236 <table>
237 <tr><td>None</td></tr>
238 </table>
239 <h3>Methods</h3>
240 <table>
241 <tr><td>None</td></tr>
242 </table>
243 <h3>Static Methods</h3>
244 <table>
245 <tr><td>None</td></tr>
246 </table>
247
248 <div align="right"><a href="#top">Up</a></div>
249 <hr /><hr />
250 <a NAME="ExportBinding" ID="ExportBinding"></a>
251 <h2>ExportBinding</h2>
252 <p>
253 A binding created by an C{__all__} assignment. If the names in the list
254 can be determined statically, they will be treated as names for export and
255 additional checking applied to them.
256 </p><p>
257 The only C{__all__} assignment that can be recognized is one which takes
258 the value of a literal list containing literal strings. For example::
259 </p><p>
260 __all__ = ["foo", "bar"]
261 </p><p>
262 Names which are imported and not otherwise used but appear in the value of
263 C{__all__} will not have an unused import warning reported for them.
264 </p>
265 <h3>Derived from</h3>
266 Binding
267 <h3>Class Attributes</h3>
268 <table>
269 <tr><td>None</td></tr>
270 </table>
271 <h3>Class Methods</h3>
272 <table>
273 <tr><td>None</td></tr>
274 </table>
275 <h3>Methods</h3>
276 <table>
277 <tr><td>None</td></tr>
278 </table>
279 <h3>Static Methods</h3>
280 <table>
281 <tr><td>None</td></tr>
282 </table>
283
284 <div align="right"><a href="#top">Up</a></div>
285 <hr /><hr />
286 <a NAME="FunctionDefinition" ID="FunctionDefinition"></a>
287 <h2>FunctionDefinition</h2>
288
289 <h3>Derived from</h3>
290 Definition
291 <h3>Class Attributes</h3>
292 <table>
293 <tr><td>None</td></tr>
294 </table>
295 <h3>Class Methods</h3>
296 <table>
297 <tr><td>None</td></tr>
298 </table>
299 <h3>Methods</h3>
300 <table>
301 <tr><td>None</td></tr>
302 </table>
303 <h3>Static Methods</h3>
304 <table>
305 <tr><td>None</td></tr>
306 </table>
307
308 <div align="right"><a href="#top">Up</a></div>
309 <hr /><hr />
310 <a NAME="GeneratorScope" ID="GeneratorScope"></a>
311 <h2>GeneratorScope</h2>
312
313 <h3>Derived from</h3>
314 Scope
315 <h3>Class Attributes</h3>
316 <table>
317 <tr><td>None</td></tr>
318 </table>
319 <h3>Class Methods</h3>
320 <table>
321 <tr><td>None</td></tr>
322 </table>
323 <h3>Methods</h3>
324 <table>
325 <tr><td>None</td></tr>
326 </table>
327 <h3>Static Methods</h3>
328 <table>
329 <tr><td>None</td></tr>
330 </table>
331
332 <div align="right"><a href="#top">Up</a></div>
333 <hr /><hr />
334 <a NAME="ModuleScope" ID="ModuleScope"></a>
335 <h2>ModuleScope</h2>
336
337 <h3>Derived from</h3>
338 Scope
339 <h3>Class Attributes</h3>
340 <table>
341 <tr><td>None</td></tr>
342 </table>
343 <h3>Class Methods</h3>
344 <table>
345 <tr><td>None</td></tr>
346 </table>
347 <h3>Methods</h3>
348 <table>
349 <tr><td>None</td></tr>
350 </table>
351 <h3>Static Methods</h3>
352 <table>
353 <tr><td>None</td></tr>
354 </table>
355
356 <div align="right"><a href="#top">Up</a></div>
357 <hr /><hr />
358 <a NAME="Scope" ID="Scope"></a>
359 <h2>Scope</h2>
360
361 <h3>Derived from</h3>
362 dict
363 <h3>Class Attributes</h3>
364 <table>
365 <tr><td>importStarred</td></tr>
366 </table>
367 <h3>Class Methods</h3>
368 <table>
369 <tr><td>None</td></tr>
370 </table>
371 <h3>Methods</h3>
372 <table>
373 <tr><td>None</td></tr>
374 </table>
375 <h3>Static Methods</h3>
376 <table>
377 <tr><td>None</td></tr>
378 </table>
379
380 <div align="right"><a href="#top">Up</a></div>
381 <hr /><hr />
382 <a NAME="__init__" ID="__init__"></a>
383 <h2>__init__</h2>
384 <b>__init__</b>(<i>self, name, source</i>)
385
386 <div align="right"><a href="#top">Up</a></div>
387 <hr /><hr />
388 <a NAME="__init___1" ID="__init___1"></a>
389 <h2>__init__</h2>
390 <b>__init__</b>(<i>self, name, source</i>)
391
392 <div align="right"><a href="#top">Up</a></div>
393 <hr /><hr />
394 <a NAME="__init___2" ID="__init___2"></a>
395 <h2>__init__</h2>
396 <b>__init__</b>(<i>self</i>)
397
398 <div align="right"><a href="#top">Up</a></div>
399 <hr /><hr />
400 <a NAME="__repr__" ID="__repr__"></a>
401 <h2>__repr__</h2>
402 <b>__repr__</b>(<i>self</i>)
403
404 <div align="right"><a href="#top">Up</a></div>
405 <hr /><hr />
406 <a NAME="__repr___1" ID="__repr___1"></a>
407 <h2>__repr__</h2>
408 <b>__repr__</b>(<i>self</i>)
409
410 <div align="right"><a href="#top">Up</a></div>
411 <hr /><hr />
412 <a NAME="__str__" ID="__str__"></a>
413 <h2>__str__</h2>
414 <b>__str__</b>(<i>self</i>)
415
416 <div align="right"><a href="#top">Up</a></div>
417 <hr /><hr />
418 <a NAME="getNodeName" ID="getNodeName"></a>
419 <h2>getNodeName</h2>
420 <b>getNodeName</b>(<i>node</i>)
421
422 <div align="right"><a href="#top">Up</a></div>
423 <hr /><hr />
424 <a NAME="getNodeType" ID="getNodeType"></a>
425 <h2>getNodeType</h2>
426 <b>getNodeType</b>(<i>node_class</i>)
427
428 <div align="right"><a href="#top">Up</a></div>
429 <hr /><hr />
430 <a NAME="getNodeType_1" ID="getNodeType_1"></a>
431 <h2>getNodeType</h2>
432 <b>getNodeType</b>(<i>node_class</i>)
433
434 <div align="right"><a href="#top">Up</a></div>
435 <hr /><hr />
436 <a NAME="iter_child_nodes" ID="iter_child_nodes"></a>
437 <h2>iter_child_nodes</h2>
438 <b>iter_child_nodes</b>(<i>node</i>)
439 <p>
440 Yield all direct child nodes of *node*, that is, all fields that
441 are nodes and all items of fields that are lists of nodes.
442 </p>
443 <div align="right"><a href="#top">Up</a></div>
444 <hr /><hr />
445 <a NAME="names" ID="names"></a>
446 <h2>names</h2>
447 <b>names</b>(<i>self</i>)
448 <p>
449 Return a list of the names referenced by this binding.
450 </p>
451 <div align="right"><a href="#top">Up</a></div>
452 <hr /><hr />
453 <a NAME="unusedAssignments" ID="unusedAssignments"></a>
454 <h2>unusedAssignments</h2>
455 <b>unusedAssignments</b>(<i>self</i>)
456 <p>
457 Return a generator for the assignments which have not been used.
458 </p>
459 <div align="right"><a href="#top">Up</a></div>
460 <hr />
461 </body></html>

eric ide

mercurial