Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Utilities.pyflakes.checker.html

Documentation/Source/eric5.Utilities.pyflakes.checker.html

changeset 3208
884465a61753
parent 3207
6cf664694e3c
equal deleted inserted replaced
3207:6cf664694e3c 3208:884465a61753
38 <td>Represents the binding of a value to a name.</td> 38 <td>Represents the binding of a value to a name.</td>
39 </tr><tr> 39 </tr><tr>
40 <td><a href="#Checker">Checker</a></td> 40 <td><a href="#Checker">Checker</a></td>
41 <td>Class to check the cleanliness and sanity of Python code.</td> 41 <td>Class to check the cleanliness and sanity of Python code.</td>
42 </tr><tr> 42 </tr><tr>
43 <td><a href="#ClassDefinition">ClassDefinition</a></td>
44 <td>Represents a class definition.</td>
45 </tr><tr>
43 <td><a href="#ClassScope">ClassScope</a></td> 46 <td><a href="#ClassScope">ClassScope</a></td>
44 <td>Class representing a name scope for a class.</td> 47 <td>Class representing a name scope for a class.</td>
45 </tr><tr> 48 </tr><tr>
49 <td><a href="#Definition">Definition</a></td>
50 <td>A binding that defines a function or a class.</td>
51 </tr><tr>
46 <td><a href="#ExportBinding">ExportBinding</a></td> 52 <td><a href="#ExportBinding">ExportBinding</a></td>
47 <td>A binding created by an __all__ assignment.</td> 53 <td>A binding created by an __all__ assignment.</td>
48 </tr><tr> 54 </tr><tr>
49 <td><a href="#FunctionDefinition">FunctionDefinition</a></td> 55 <td><a href="#FunctionDefinition">FunctionDefinition</a></td>
50 <td>Represents a function definition.</td> 56 <td>Represents a function definition.</td>
51 </tr><tr> 57 </tr><tr>
52 <td><a href="#FunctionScope">FunctionScope</a></td> 58 <td><a href="#FunctionScope">FunctionScope</a></td>
53 <td>Class representing a name scope for a function.</td> 59 <td>Class representing a name scope for a function.</td>
54 </tr><tr> 60 </tr><tr>
61 <td><a href="#GeneratorScope">GeneratorScope</a></td>
62 <td>Class representing a name scope for a generator function.</td>
63 </tr><tr>
55 <td><a href="#Importation">Importation</a></td> 64 <td><a href="#Importation">Importation</a></td>
56 <td>A binding created by an import statement.</td> 65 <td>A binding created by an import statement.</td>
57 </tr><tr> 66 </tr><tr>
58 <td><a href="#ModuleScope">ModuleScope</a></td> 67 <td><a href="#ModuleScope">ModuleScope</a></td>
59 <td>Class representing a name scope for a module.</td> 68 <td>Class representing a name scope for a module.</td>
60 </tr><tr> 69 </tr><tr>
61 <td><a href="#Scope">Scope</a></td> 70 <td><a href="#Scope">Scope</a></td>
62 <td>Class defining the scope base class.</td> 71 <td>Class defining the scope base class.</td>
63 </tr><tr>
64 <td><a href="#UnBinding">UnBinding</a></td>
65 <td>Created by the 'del' operator.</td>
66 </tr> 72 </tr>
67 </table> 73 </table>
68 <h3>Functions</h3> 74 <h3>Functions</h3>
69 <table> 75 <table>
70 <tr><td>None</td></tr> 76 <tr>
77 <td><a href="#__init__">__init__</a></td>
78 <td></td>
79 </tr><tr>
80 <td><a href="#__init___1">__init__</a></td>
81 <td></td>
82 </tr><tr>
83 <td><a href="#__init___2">__init__</a></td>
84 <td></td>
85 </tr><tr>
86 <td><a href="#__repr__">__repr__</a></td>
87 <td></td>
88 </tr><tr>
89 <td><a href="#__repr___1">__repr__</a></td>
90 <td></td>
91 </tr><tr>
92 <td><a href="#__str__">__str__</a></td>
93 <td></td>
94 </tr><tr>
95 <td><a href="#getNodeName">getNodeName</a></td>
96 <td>Module function for getting the name of a node.</td>
97 </tr><tr>
98 <td><a href="#getNodeType">getNodeType</a></td>
99 <td></td>
100 </tr><tr>
101 <td><a href="#getNodeType_1">getNodeType</a></td>
102 <td></td>
103 </tr><tr>
104 <td><a href="#iter_child_nodes">iter_child_nodes</a></td>
105 <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>
106 </tr><tr>
107 <td><a href="#names">names</a></td>
108 <td>Return a list of the names referenced by this binding.</td>
109 </tr><tr>
110 <td><a href="#unusedAssignments">unusedAssignments</a></td>
111 <td>Return a generator for the assignments which have not been used.</td>
112 </tr>
71 </table> 113 </table>
72 <hr /><hr /> 114 <hr /><hr />
73 <a NAME="Argument" ID="Argument"></a> 115 <a NAME="Argument" ID="Argument"></a>
74 <h2>Argument</h2> 116 <h2>Argument</h2>
75 <p> 117 <p>
145 <table> 187 <table>
146 <tr><td>None</td></tr> 188 <tr><td>None</td></tr>
147 </table> 189 </table>
148 <h3>Methods</h3> 190 <h3>Methods</h3>
149 <table> 191 <table>
150 <tr> 192 <tr><td>None</td></tr>
151 <td><a href="#Binding.__init__">Binding</a></td> 193 </table>
152 <td></td> 194 <h3>Static Methods</h3>
153 </tr><tr> 195 <table>
154 <td><a href="#Binding.__repr__">__repr__</a></td> 196 <tr><td>None</td></tr>
155 <td></td> 197 </table>
156 </tr><tr>
157 <td><a href="#Binding.__str__">__str__</a></td>
158 <td></td>
159 </tr>
160 </table>
161 <h3>Static Methods</h3>
162 <table>
163 <tr><td>None</td></tr>
164 </table>
165 <a NAME="Binding.__init__" ID="Binding.__init__"></a>
166 <h4>Binding (Constructor)</h4>
167 <b>Binding</b>(<i>name, source</i>)
168 <a NAME="Binding.__repr__" ID="Binding.__repr__"></a>
169 <h4>Binding.__repr__</h4>
170 <b>__repr__</b>(<i></i>)
171 <a NAME="Binding.__str__" ID="Binding.__str__"></a>
172 <h4>Binding.__str__</h4>
173 <b>__str__</b>(<i></i>)
174 198
175 <div align="right"><a href="#top">Up</a></div> 199 <div align="right"><a href="#top">Up</a></div>
176 <hr /><hr /> 200 <hr /><hr />
177 <a NAME="Checker" ID="Checker"></a> 201 <a NAME="Checker" ID="Checker"></a>
178 <h2>Checker</h2> 202 <h2>Checker</h2>
181 </p> 205 </p>
182 <h3>Derived from</h3> 206 <h3>Derived from</h3>
183 object 207 object
184 <h3>Class Attributes</h3> 208 <h3>Class Attributes</h3>
185 <table> 209 <table>
186 <tr><td>ATTRIBUTES</td></tr><tr><td>BOOLOP</td></tr><tr><td>CALL</td></tr><tr><td>COMPREHENSION</td></tr><tr><td>INVERT</td></tr><tr><td>ISNOT</td></tr><tr><td>LOAD</td></tr><tr><td>MOD</td></tr><tr><td>NONLOCAL</td></tr><tr><td>PASS</td></tr><tr><td>RETURN</td></tr><tr><td>SETCOMP</td></tr><tr><td>SLICE</td></tr><tr><td>TRY</td></tr><tr><td>nodeDepth</td></tr><tr><td>scope</td></tr><tr><td>traceTree</td></tr> 210 <tr><td>AND</td></tr><tr><td>BOOLOP</td></tr><tr><td>COMPREHENSION</td></tr><tr><td>CONTINUE</td></tr><tr><td>LOAD</td></tr><tr><td>NONLOCAL</td></tr><tr><td>NUM</td></tr><tr><td>RETURN</td></tr><tr><td>SETCOMP</td></tr><tr><td>SLICE</td></tr><tr><td>TRYEXCEPT</td></tr><tr><td>_customBuiltIns</td></tr><tr><td>_getDoctestExamples</td></tr><tr><td>builtIns</td></tr><tr><td>nodeDepth</td></tr><tr><td>offset</td></tr><tr><td>traceTree</td></tr><tr><td>withDoctest</td></tr>
187 </table> 211 </table>
188 <h3>Class Methods</h3> 212 <h3>Class Methods</h3>
189 <table> 213 <table>
190 <tr><td>None</td></tr> 214 <tr><td>None</td></tr>
191 </table> 215 </table>
214 <td>Process bindings for loop variables.</td> 238 <td>Process bindings for loop variables.</td>
215 </tr><tr> 239 </tr><tr>
216 <td><a href="#Checker.FUNCTIONDEF">FUNCTIONDEF</a></td> 240 <td><a href="#Checker.FUNCTIONDEF">FUNCTIONDEF</a></td>
217 <td></td> 241 <td></td>
218 </tr><tr> 242 </tr><tr>
243 <td><a href="#Checker.GENERATOREXP">GENERATOREXP</a></td>
244 <td></td>
245 </tr><tr>
219 <td><a href="#Checker.GLOBAL">GLOBAL</a></td> 246 <td><a href="#Checker.GLOBAL">GLOBAL</a></td>
220 <td>Keep track of globals declarations.</td> 247 <td>Keep track of globals declarations.</td>
221 </tr><tr> 248 </tr><tr>
222 <td><a href="#Checker.IMPORT">IMPORT</a></td> 249 <td><a href="#Checker.IMPORT">IMPORT</a></td>
223 <td></td> 250 <td></td>
232 <td></td> 259 <td></td>
233 </tr><tr> 260 </tr><tr>
234 <td><a href="#Checker.NAME">NAME</a></td> 261 <td><a href="#Checker.NAME">NAME</a></td>
235 <td>Handle occurrence of Name (which can be a load/store/delete access.)</td> 262 <td>Handle occurrence of Name (which can be a load/store/delete access.)</td>
236 </tr><tr> 263 </tr><tr>
237 <td><a href="#Checker.STARRED">STARRED</a></td> 264 <td><a href="#Checker.TRY">TRY</a></td>
238 <td></td> 265 <td></td>
239 </tr><tr>
240 <td><a href="#Checker._runDeferred">_runDeferred</a></td>
241 <td>Run the callables in deferred using their associated scope stack.</td>
242 </tr><tr> 266 </tr><tr>
243 <td><a href="#Checker.addArgs">addArgs</a></td> 267 <td><a href="#Checker.addArgs">addArgs</a></td>
244 <td></td> 268 <td></td>
245 </tr><tr> 269 </tr><tr>
246 <td><a href="#Checker.addBinding">addBinding</a></td> 270 <td><a href="#Checker.addBinding">addBinding</a></td>
247 <td>Called when a binding is altered.</td> 271 <td>Called when a binding is altered.</td>
248 </tr><tr> 272 </tr><tr>
273 <td><a href="#Checker.checkDeadScopes">checkDeadScopes</a></td>
274 <td>Look at scopes which have been fully examined and report names in them which were imported but unused.</td>
275 </tr><tr>
249 <td><a href="#Checker.checkUnusedAssignments">checkUnusedAssignments</a></td> 276 <td><a href="#Checker.checkUnusedAssignments">checkUnusedAssignments</a></td>
250 <td>Check to see if any assignments have not been used.</td> 277 <td>Check to see if any assignments have not been used.</td>
251 </tr><tr> 278 </tr><tr>
252 <td><a href="#Checker.check_dead_scopes">check_dead_scopes</a></td>
253 <td>Look at scopes which have been fully examined and report names in them which were imported but unused.</td>
254 </tr><tr>
255 <td><a href="#Checker.collectLoopVars">collectLoopVars</a></td> 279 <td><a href="#Checker.collectLoopVars">collectLoopVars</a></td>
256 <td></td> 280 <td></td>
257 </tr><tr> 281 </tr><tr>
258 <td><a href="#Checker.deferAssignment">deferAssignment</a></td> 282 <td><a href="#Checker.deferAssignment">deferAssignment</a></td>
259 <td>Schedule an assignment handler to be called just after deferred function handlers.</td> 283 <td>Schedule an assignment handler to be called just after deferred function handlers.</td>
260 </tr><tr> 284 </tr><tr>
261 <td><a href="#Checker.deferFunction">deferFunction</a></td> 285 <td><a href="#Checker.deferFunction">deferFunction</a></td>
262 <td>Schedule a function handler to be called just before completion.</td> 286 <td>Schedule a function handler to be called just before completion.</td>
263 </tr><tr> 287 </tr><tr>
264 <td><a href="#Checker.handleAssignName">handleAssignName</a></td> 288 <td><a href="#Checker.descendantOf">descendantOf</a></td>
265 <td></td> 289 <td></td>
266 </tr><tr> 290 </tr><tr>
267 <td><a href="#Checker.handleBody">handleBody</a></td> 291 <td><a href="#Checker.differentForks">differentForks</a></td>
292 <td>True, if lnode and rnode are located on different forks of IF/TRY</td>
293 </tr><tr>
294 <td><a href="#Checker.getCommonAncestor">getCommonAncestor</a></td>
295 <td></td>
296 </tr><tr>
297 <td><a href="#Checker.getDocstring">getDocstring</a></td>
298 <td></td>
299 </tr><tr>
300 <td><a href="#Checker.getNodeHandler">getNodeHandler</a></td>
268 <td></td> 301 <td></td>
269 </tr><tr> 302 </tr><tr>
270 <td><a href="#Checker.handleChildren">handleChildren</a></td> 303 <td><a href="#Checker.handleChildren">handleChildren</a></td>
271 <td></td> 304 <td></td>
272 </tr><tr> 305 </tr><tr>
306 <td><a href="#Checker.handleDoctests">handleDoctests</a></td>
307 <td></td>
308 </tr><tr>
273 <td><a href="#Checker.handleNode">handleNode</a></td> 309 <td><a href="#Checker.handleNode">handleNode</a></td>
310 <td></td>
311 </tr><tr>
312 <td><a href="#Checker.handleNodeDelete">handleNodeDelete</a></td>
313 <td></td>
314 </tr><tr>
315 <td><a href="#Checker.handleNodeLoad">handleNodeLoad</a></td>
316 <td></td>
317 </tr><tr>
318 <td><a href="#Checker.handleNodeStore">handleNodeStore</a></td>
319 <td></td>
320 </tr><tr>
321 <td><a href="#Checker.hasParent">hasParent</a></td>
274 <td></td> 322 <td></td>
275 </tr><tr> 323 </tr><tr>
276 <td><a href="#Checker.ignore">ignore</a></td> 324 <td><a href="#Checker.ignore">ignore</a></td>
277 <td></td> 325 <td></td>
278 </tr><tr> 326 </tr><tr>
279 <td><a href="#Checker.isDocstring">isDocstring</a></td> 327 <td><a href="#Checker.isDocstring">isDocstring</a></td>
280 <td>Determine if the given node is a docstring, as long as it is at the correct place in the node tree.</td> 328 <td>Determine if the given node is a docstring, as long as it is at the correct place in the node tree.</td>
281 </tr><tr> 329 </tr><tr>
330 <td><a href="#Checker.onFork">onFork</a></td>
331 <td></td>
332 </tr><tr>
282 <td><a href="#Checker.popScope">popScope</a></td> 333 <td><a href="#Checker.popScope">popScope</a></td>
283 <td></td> 334 <td></td>
284 </tr><tr> 335 </tr><tr>
285 <td><a href="#Checker.pushClassScope">pushClassScope</a></td> 336 <td><a href="#Checker.pushClassScope">pushClassScope</a></td>
286 <td></td> 337 <td></td>
287 </tr><tr> 338 </tr><tr>
288 <td><a href="#Checker.pushFunctionScope">pushFunctionScope</a></td> 339 <td><a href="#Checker.pushFunctionScope">pushFunctionScope</a></td>
289 <td></td> 340 <td></td>
290 </tr><tr> 341 </tr><tr>
342 <td><a href="#Checker.pushScope">pushScope</a></td>
343 <td></td>
344 </tr><tr>
291 <td><a href="#Checker.report">report</a></td> 345 <td><a href="#Checker.report">report</a></td>
292 <td></td> 346 <td></td>
347 </tr><tr>
348 <td><a href="#Checker.runDeferred">runDeferred</a></td>
349 <td>Run the callables in deferred using their associated scope stack.</td>
293 </tr><tr> 350 </tr><tr>
294 <td><a href="#Checker.runFunction">runFunction</a></td> 351 <td><a href="#Checker.runFunction">runFunction</a></td>
295 <td></td> 352 <td></td>
296 </tr><tr> 353 </tr><tr>
297 <td><a href="#Checker.scope">scope</a></td> 354 <td><a href="#Checker.scope">scope</a></td>
302 <table> 359 <table>
303 <tr><td>None</td></tr> 360 <tr><td>None</td></tr>
304 </table> 361 </table>
305 <a NAME="Checker.__init__" ID="Checker.__init__"></a> 362 <a NAME="Checker.__init__" ID="Checker.__init__"></a>
306 <h4>Checker (Constructor)</h4> 363 <h4>Checker (Constructor)</h4>
307 <b>Checker</b>(<i>module, filename='(none)'</i>) 364 <b>Checker</b>(<i>tree, filename='(none)', builtins=None</i>)
308 <p> 365 <p>
309 Constructor 366 Constructor
310 </p><dl> 367 </p><dl>
311 <dt><i>module</i></dt> 368 <dt><i>tree</i></dt>
312 <dd> 369 <dd>
313 parsed module tree or module source code 370 parsed module tree or module source code
314 </dd><dt><i>filename</i></dt> 371 </dd><dt><i>filename</i></dt>
315 <dd> 372 <dd>
316 name of the module file (string) 373 name of the module file (string)
374 </dd><dt><i>builtins</i></dt>
375 <dd>
376 set of names to be treated as builtins (set of string)
317 </dd> 377 </dd>
318 </dl><a NAME="Checker.ASSIGN" ID="Checker.ASSIGN"></a> 378 </dl><a NAME="Checker.ASSIGN" ID="Checker.ASSIGN"></a>
319 <h4>Checker.ASSIGN</h4> 379 <h4>Checker.ASSIGN</h4>
320 <b>ASSIGN</b>(<i>node</i>) 380 <b>ASSIGN</b>(<i>node</i>)
321 <a NAME="Checker.AUGASSIGN" ID="Checker.AUGASSIGN"></a> 381 <a NAME="Checker.AUGASSIGN" ID="Checker.AUGASSIGN"></a>
340 <p> 400 <p>
341 Process bindings for loop variables. 401 Process bindings for loop variables.
342 </p><a NAME="Checker.FUNCTIONDEF" ID="Checker.FUNCTIONDEF"></a> 402 </p><a NAME="Checker.FUNCTIONDEF" ID="Checker.FUNCTIONDEF"></a>
343 <h4>Checker.FUNCTIONDEF</h4> 403 <h4>Checker.FUNCTIONDEF</h4>
344 <b>FUNCTIONDEF</b>(<i>node</i>) 404 <b>FUNCTIONDEF</b>(<i>node</i>)
405 <a NAME="Checker.GENERATOREXP" ID="Checker.GENERATOREXP"></a>
406 <h4>Checker.GENERATOREXP</h4>
407 <b>GENERATOREXP</b>(<i>node</i>)
345 <a NAME="Checker.GLOBAL" ID="Checker.GLOBAL"></a> 408 <a NAME="Checker.GLOBAL" ID="Checker.GLOBAL"></a>
346 <h4>Checker.GLOBAL</h4> 409 <h4>Checker.GLOBAL</h4>
347 <b>GLOBAL</b>(<i>node</i>) 410 <b>GLOBAL</b>(<i>node</i>)
348 <p> 411 <p>
349 Keep track of globals declarations. 412 Keep track of globals declarations.
362 <a NAME="Checker.NAME" ID="Checker.NAME"></a> 425 <a NAME="Checker.NAME" ID="Checker.NAME"></a>
363 <h4>Checker.NAME</h4> 426 <h4>Checker.NAME</h4>
364 <b>NAME</b>(<i>node</i>) 427 <b>NAME</b>(<i>node</i>)
365 <p> 428 <p>
366 Handle occurrence of Name (which can be a load/store/delete access.) 429 Handle occurrence of Name (which can be a load/store/delete access.)
367 </p><a NAME="Checker.STARRED" ID="Checker.STARRED"></a> 430 </p><a NAME="Checker.TRY" ID="Checker.TRY"></a>
368 <h4>Checker.STARRED</h4> 431 <h4>Checker.TRY</h4>
369 <b>STARRED</b>(<i>node</i>) 432 <b>TRY</b>(<i>node</i>)
370 <a NAME="Checker._runDeferred" ID="Checker._runDeferred"></a> 433 <a NAME="Checker.addArgs" ID="Checker.addArgs"></a>
371 <h4>Checker._runDeferred</h4>
372 <b>_runDeferred</b>(<i>deferred</i>)
373 <p>
374 Run the callables in deferred using their associated scope stack.
375 </p><a NAME="Checker.addArgs" ID="Checker.addArgs"></a>
376 <h4>Checker.addArgs</h4> 434 <h4>Checker.addArgs</h4>
377 <b>addArgs</b>(<i></i>) 435 <b>addArgs</b>(<i></i>)
378 <a NAME="Checker.addBinding" ID="Checker.addBinding"></a> 436 <a NAME="Checker.addBinding" ID="Checker.addBinding"></a>
379 <h4>Checker.addBinding</h4> 437 <h4>Checker.addBinding</h4>
380 <b>addBinding</b>(<i>lineno, value, reportRedef=True</i>) 438 <b>addBinding</b>(<i>node, value, reportRedef=True</i>)
381 <p> 439 <p>
382 Called when a binding is altered. 440 Called when a binding is altered.
383 </p><dl> 441 </p><p>
384 <dt><i>lineno</i></dt> 442 - `node` is the statement responsible for the change
385 <dd> 443 - `value` is the optional new value, a Binding instance, associated
386 line of the statement responsible for the change 444 with the binding; if None, the binding is deleted if it exists.
387 (integer) 445 - if `reportRedef` is True (default), rebinding while unused will be
388 </dd><dt><i>value</i></dt> 446 reported.
389 <dd> 447 </p><a NAME="Checker.checkDeadScopes" ID="Checker.checkDeadScopes"></a>
390 the optional new value, a Binding instance, associated 448 <h4>Checker.checkDeadScopes</h4>
391 with the binding; if None, the binding is deleted if it exists 449 <b>checkDeadScopes</b>(<i></i>)
392 </dd><dt><i>reportRedef</i></dt> 450 <p>
393 <dd> 451 Look at scopes which have been fully examined and report names in them
394 flag indicating if rebinding while unused will be 452 which were imported but unused.
395 reported (boolean) 453 </p><a NAME="Checker.checkUnusedAssignments" ID="Checker.checkUnusedAssignments"></a>
396 </dd>
397 </dl><a NAME="Checker.checkUnusedAssignments" ID="Checker.checkUnusedAssignments"></a>
398 <h4>Checker.checkUnusedAssignments</h4> 454 <h4>Checker.checkUnusedAssignments</h4>
399 <b>checkUnusedAssignments</b>(<i></i>) 455 <b>checkUnusedAssignments</b>(<i></i>)
400 <p> 456 <p>
401 Check to see if any assignments have not been used. 457 Check to see if any assignments have not been used.
402 </p><a NAME="Checker.check_dead_scopes" ID="Checker.check_dead_scopes"></a>
403 <h4>Checker.check_dead_scopes</h4>
404 <b>check_dead_scopes</b>(<i></i>)
405 <p>
406 Look at scopes which have been fully examined and report names in them
407 which were imported but unused.
408 </p><a NAME="Checker.collectLoopVars" ID="Checker.collectLoopVars"></a> 458 </p><a NAME="Checker.collectLoopVars" ID="Checker.collectLoopVars"></a>
409 <h4>Checker.collectLoopVars</h4> 459 <h4>Checker.collectLoopVars</h4>
410 <b>collectLoopVars</b>(<i></i>) 460 <b>collectLoopVars</b>(<i></i>)
411 <a NAME="Checker.deferAssignment" ID="Checker.deferAssignment"></a> 461 <a NAME="Checker.deferAssignment" ID="Checker.deferAssignment"></a>
412 <h4>Checker.deferAssignment</h4> 462 <h4>Checker.deferAssignment</h4>
422 </p><p> 472 </p><p>
423 This is used for handling function bodies, which must be deferred 473 This is used for handling function bodies, which must be deferred
424 because code later in the file might modify the global scope. When 474 because code later in the file might modify the global scope. When
425 `callable` is called, the scope at the time this is called will be 475 `callable` is called, the scope at the time this is called will be
426 restored, however it will contain any new bindings added to it. 476 restored, however it will contain any new bindings added to it.
427 </p><a NAME="Checker.handleAssignName" ID="Checker.handleAssignName"></a> 477 </p><a NAME="Checker.descendantOf" ID="Checker.descendantOf"></a>
428 <h4>Checker.handleAssignName</h4> 478 <h4>Checker.descendantOf</h4>
429 <b>handleAssignName</b>(<i>node</i>) 479 <b>descendantOf</b>(<i>node, ancestors, stop=None</i>)
430 <a NAME="Checker.handleBody" ID="Checker.handleBody"></a> 480 <a NAME="Checker.differentForks" ID="Checker.differentForks"></a>
431 <h4>Checker.handleBody</h4> 481 <h4>Checker.differentForks</h4>
432 <b>handleBody</b>(<i>tree</i>) 482 <b>differentForks</b>(<i>lnode, rnode</i>)
483 <p>
484 True, if lnode and rnode are located on different forks of IF/TRY
485 </p><a NAME="Checker.getCommonAncestor" ID="Checker.getCommonAncestor"></a>
486 <h4>Checker.getCommonAncestor</h4>
487 <b>getCommonAncestor</b>(<i>lnode, rnode, stop=None</i>)
488 <a NAME="Checker.getDocstring" ID="Checker.getDocstring"></a>
489 <h4>Checker.getDocstring</h4>
490 <b>getDocstring</b>(<i>node</i>)
491 <a NAME="Checker.getNodeHandler" ID="Checker.getNodeHandler"></a>
492 <h4>Checker.getNodeHandler</h4>
493 <b>getNodeHandler</b>(<i>node_class</i>)
433 <a NAME="Checker.handleChildren" ID="Checker.handleChildren"></a> 494 <a NAME="Checker.handleChildren" ID="Checker.handleChildren"></a>
434 <h4>Checker.handleChildren</h4> 495 <h4>Checker.handleChildren</h4>
435 <b>handleChildren</b>(<i>tree</i>) 496 <b>handleChildren</b>(<i>tree</i>)
497 <a NAME="Checker.handleDoctests" ID="Checker.handleDoctests"></a>
498 <h4>Checker.handleDoctests</h4>
499 <b>handleDoctests</b>(<i>node</i>)
436 <a NAME="Checker.handleNode" ID="Checker.handleNode"></a> 500 <a NAME="Checker.handleNode" ID="Checker.handleNode"></a>
437 <h4>Checker.handleNode</h4> 501 <h4>Checker.handleNode</h4>
438 <b>handleNode</b>(<i>node, parent</i>) 502 <b>handleNode</b>(<i>node, parent</i>)
503 <a NAME="Checker.handleNodeDelete" ID="Checker.handleNodeDelete"></a>
504 <h4>Checker.handleNodeDelete</h4>
505 <b>handleNodeDelete</b>(<i>node</i>)
506 <a NAME="Checker.handleNodeLoad" ID="Checker.handleNodeLoad"></a>
507 <h4>Checker.handleNodeLoad</h4>
508 <b>handleNodeLoad</b>(<i>node</i>)
509 <a NAME="Checker.handleNodeStore" ID="Checker.handleNodeStore"></a>
510 <h4>Checker.handleNodeStore</h4>
511 <b>handleNodeStore</b>(<i>node</i>)
512 <a NAME="Checker.hasParent" ID="Checker.hasParent"></a>
513 <h4>Checker.hasParent</h4>
514 <b>hasParent</b>(<i>node, kind</i>)
439 <a NAME="Checker.ignore" ID="Checker.ignore"></a> 515 <a NAME="Checker.ignore" ID="Checker.ignore"></a>
440 <h4>Checker.ignore</h4> 516 <h4>Checker.ignore</h4>
441 <b>ignore</b>(<i>node</i>) 517 <b>ignore</b>(<i>node</i>)
442 <a NAME="Checker.isDocstring" ID="Checker.isDocstring"></a> 518 <a NAME="Checker.isDocstring" ID="Checker.isDocstring"></a>
443 <h4>Checker.isDocstring</h4> 519 <h4>Checker.isDocstring</h4>
444 <b>isDocstring</b>(<i>node</i>) 520 <b>isDocstring</b>(<i>node</i>)
445 <p> 521 <p>
446 Determine if the given node is a docstring, as long as it is at the 522 Determine if the given node is a docstring, as long as it is at the
447 correct place in the node tree. 523 correct place in the node tree.
448 </p><a NAME="Checker.popScope" ID="Checker.popScope"></a> 524 </p><a NAME="Checker.onFork" ID="Checker.onFork"></a>
525 <h4>Checker.onFork</h4>
526 <b>onFork</b>(<i>parent, lnode, rnode, items</i>)
527 <a NAME="Checker.popScope" ID="Checker.popScope"></a>
449 <h4>Checker.popScope</h4> 528 <h4>Checker.popScope</h4>
450 <b>popScope</b>(<i></i>) 529 <b>popScope</b>(<i></i>)
451 <a NAME="Checker.pushClassScope" ID="Checker.pushClassScope"></a> 530 <a NAME="Checker.pushClassScope" ID="Checker.pushClassScope"></a>
452 <h4>Checker.pushClassScope</h4> 531 <h4>Checker.pushClassScope</h4>
453 <b>pushClassScope</b>(<i></i>) 532 <b>pushClassScope</b>(<i></i>)
454 <a NAME="Checker.pushFunctionScope" ID="Checker.pushFunctionScope"></a> 533 <a NAME="Checker.pushFunctionScope" ID="Checker.pushFunctionScope"></a>
455 <h4>Checker.pushFunctionScope</h4> 534 <h4>Checker.pushFunctionScope</h4>
456 <b>pushFunctionScope</b>(<i></i>) 535 <b>pushFunctionScope</b>(<i></i>)
536 <a NAME="Checker.pushScope" ID="Checker.pushScope"></a>
537 <h4>Checker.pushScope</h4>
538 <b>pushScope</b>(<i>scopeClass=FunctionScope</i>)
457 <a NAME="Checker.report" ID="Checker.report"></a> 539 <a NAME="Checker.report" ID="Checker.report"></a>
458 <h4>Checker.report</h4> 540 <h4>Checker.report</h4>
459 <b>report</b>(<i>messageClass, *args, **kwargs</i>) 541 <b>report</b>(<i>messageClass, *args, **kwargs</i>)
460 <a NAME="Checker.runFunction" ID="Checker.runFunction"></a> 542 <a NAME="Checker.runDeferred" ID="Checker.runDeferred"></a>
543 <h4>Checker.runDeferred</h4>
544 <b>runDeferred</b>(<i>deferred</i>)
545 <p>
546 Run the callables in deferred using their associated scope stack.
547 </p><a NAME="Checker.runFunction" ID="Checker.runFunction"></a>
461 <h4>Checker.runFunction</h4> 548 <h4>Checker.runFunction</h4>
462 <b>runFunction</b>(<i></i>) 549 <b>runFunction</b>(<i></i>)
463 <a NAME="Checker.scope" ID="Checker.scope"></a> 550 <a NAME="Checker.scope" ID="Checker.scope"></a>
464 <h4>Checker.scope</h4> 551 <h4>Checker.scope</h4>
465 <b>scope</b>(<i></i>) 552 <b>scope</b>(<i></i>)
466 553
467 <div align="right"><a href="#top">Up</a></div> 554 <div align="right"><a href="#top">Up</a></div>
468 <hr /><hr /> 555 <hr /><hr />
556 <a NAME="ClassDefinition" ID="ClassDefinition"></a>
557 <h2>ClassDefinition</h2>
558 <p>
559 Represents a class definition.
560 </p>
561 <h3>Derived from</h3>
562 Definition
563 <h3>Class Attributes</h3>
564 <table>
565 <tr><td>None</td></tr>
566 </table>
567 <h3>Class Methods</h3>
568 <table>
569 <tr><td>None</td></tr>
570 </table>
571 <h3>Methods</h3>
572 <table>
573 <tr><td>None</td></tr>
574 </table>
575 <h3>Static Methods</h3>
576 <table>
577 <tr><td>None</td></tr>
578 </table>
579
580 <div align="right"><a href="#top">Up</a></div>
581 <hr /><hr />
469 <a NAME="ClassScope" ID="ClassScope"></a> 582 <a NAME="ClassScope" ID="ClassScope"></a>
470 <h2>ClassScope</h2> 583 <h2>ClassScope</h2>
471 <p> 584 <p>
472 Class representing a name scope for a class. 585 Class representing a name scope for a class.
473 </p> 586 </p>
474 <h3>Derived from</h3> 587 <h3>Derived from</h3>
475 Scope 588 Scope
589 <h3>Class Attributes</h3>
590 <table>
591 <tr><td>None</td></tr>
592 </table>
593 <h3>Class Methods</h3>
594 <table>
595 <tr><td>None</td></tr>
596 </table>
597 <h3>Methods</h3>
598 <table>
599 <tr><td>None</td></tr>
600 </table>
601 <h3>Static Methods</h3>
602 <table>
603 <tr><td>None</td></tr>
604 </table>
605
606 <div align="right"><a href="#top">Up</a></div>
607 <hr /><hr />
608 <a NAME="Definition" ID="Definition"></a>
609 <h2>Definition</h2>
610 <p>
611 A binding that defines a function or a class.
612 </p>
613 <h3>Derived from</h3>
614 Binding
476 <h3>Class Attributes</h3> 615 <h3>Class Attributes</h3>
477 <table> 616 <table>
478 <tr><td>None</td></tr> 617 <tr><td>None</td></tr>
479 </table> 618 </table>
480 <h3>Class Methods</h3> 619 <h3>Class Methods</h3>
517 <table> 656 <table>
518 <tr><td>None</td></tr> 657 <tr><td>None</td></tr>
519 </table> 658 </table>
520 <h3>Methods</h3> 659 <h3>Methods</h3>
521 <table> 660 <table>
522 <tr> 661 <tr><td>None</td></tr>
523 <td><a href="#ExportBinding.names">names</a></td> 662 </table>
524 <td>Return a list of the names referenced by this binding.</td> 663 <h3>Static Methods</h3>
525 </tr> 664 <table>
526 </table> 665 <tr><td>None</td></tr>
527 <h3>Static Methods</h3> 666 </table>
528 <table> 667
529 <tr><td>None</td></tr>
530 </table>
531 <a NAME="ExportBinding.names" ID="ExportBinding.names"></a>
532 <h4>ExportBinding.names</h4>
533 <b>names</b>(<i></i>)
534 <p>
535 Return a list of the names referenced by this binding.
536 </p>
537 <div align="right"><a href="#top">Up</a></div> 668 <div align="right"><a href="#top">Up</a></div>
538 <hr /><hr /> 669 <hr /><hr />
539 <a NAME="FunctionDefinition" ID="FunctionDefinition"></a> 670 <a NAME="FunctionDefinition" ID="FunctionDefinition"></a>
540 <h2>FunctionDefinition</h2> 671 <h2>FunctionDefinition</h2>
541 <p> 672 <p>
542 Represents a function definition. 673 Represents a function definition.
543 </p> 674 </p>
544 <h3>Derived from</h3> 675 <h3>Derived from</h3>
545 Binding 676 Definition
546 <h3>Class Attributes</h3> 677 <h3>Class Attributes</h3>
547 <table> 678 <table>
548 <tr><td>is_property</td></tr> 679 <tr><td>None</td></tr>
549 </table> 680 </table>
550 <h3>Class Methods</h3> 681 <h3>Class Methods</h3>
551 <table> 682 <table>
552 <tr><td>None</td></tr> 683 <tr><td>None</td></tr>
553 </table> 684 </table>
569 </p> 700 </p>
570 <h3>Derived from</h3> 701 <h3>Derived from</h3>
571 Scope 702 Scope
572 <h3>Class Attributes</h3> 703 <h3>Class Attributes</h3>
573 <table> 704 <table>
574 <tr><td>None</td></tr> 705 <tr><td>alwaysUsed</td></tr><tr><td>usesLocals</td></tr>
575 </table> 706 </table>
576 <h3>Class Methods</h3> 707 <h3>Class Methods</h3>
577 <table> 708 <table>
578 <tr><td>None</td></tr> 709 <tr><td>None</td></tr>
579 </table> 710 </table>
580 <h3>Methods</h3> 711 <h3>Methods</h3>
581 <table> 712 <table>
582 <tr> 713 <tr><td>None</td></tr>
583 <td><a href="#FunctionScope.__init__">FunctionScope</a></td> 714 </table>
584 <td></td> 715 <h3>Static Methods</h3>
585 </tr> 716 <table>
586 </table> 717 <tr><td>None</td></tr>
587 <h3>Static Methods</h3> 718 </table>
588 <table> 719
589 <tr><td>None</td></tr> 720 <div align="right"><a href="#top">Up</a></div>
590 </table> 721 <hr /><hr />
591 <a NAME="FunctionScope.__init__" ID="FunctionScope.__init__"></a> 722 <a NAME="GeneratorScope" ID="GeneratorScope"></a>
592 <h4>FunctionScope (Constructor)</h4> 723 <h2>GeneratorScope</h2>
593 <b>FunctionScope</b>(<i></i>) 724 <p>
725 Class representing a name scope for a generator function.
726 </p>
727 <h3>Derived from</h3>
728 Scope
729 <h3>Class Attributes</h3>
730 <table>
731 <tr><td>None</td></tr>
732 </table>
733 <h3>Class Methods</h3>
734 <table>
735 <tr><td>None</td></tr>
736 </table>
737 <h3>Methods</h3>
738 <table>
739 <tr><td>None</td></tr>
740 </table>
741 <h3>Static Methods</h3>
742 <table>
743 <tr><td>None</td></tr>
744 </table>
594 745
595 <div align="right"><a href="#top">Up</a></div> 746 <div align="right"><a href="#top">Up</a></div>
596 <hr /><hr /> 747 <hr /><hr />
597 <a NAME="Importation" ID="Importation"></a> 748 <a NAME="Importation" ID="Importation"></a>
598 <h2>Importation</h2> 749 <h2>Importation</h2>
609 <table> 760 <table>
610 <tr><td>None</td></tr> 761 <tr><td>None</td></tr>
611 </table> 762 </table>
612 <h3>Methods</h3> 763 <h3>Methods</h3>
613 <table> 764 <table>
614 <tr> 765 <tr><td>None</td></tr>
615 <td><a href="#Importation.__init__">Importation</a></td> 766 </table>
616 <td></td> 767 <h3>Static Methods</h3>
617 </tr> 768 <table>
618 </table> 769 <tr><td>None</td></tr>
619 <h3>Static Methods</h3> 770 </table>
620 <table>
621 <tr><td>None</td></tr>
622 </table>
623 <a NAME="Importation.__init__" ID="Importation.__init__"></a>
624 <h4>Importation (Constructor)</h4>
625 <b>Importation</b>(<i>name, source</i>)
626 771
627 <div align="right"><a href="#top">Up</a></div> 772 <div align="right"><a href="#top">Up</a></div>
628 <hr /><hr /> 773 <hr /><hr />
629 <a NAME="ModuleScope" ID="ModuleScope"></a> 774 <a NAME="ModuleScope" ID="ModuleScope"></a>
630 <h2>ModuleScope</h2> 775 <h2>ModuleScope</h2>
667 <table> 812 <table>
668 <tr><td>None</td></tr> 813 <tr><td>None</td></tr>
669 </table> 814 </table>
670 <h3>Methods</h3> 815 <h3>Methods</h3>
671 <table> 816 <table>
672 <tr> 817 <tr><td>None</td></tr>
673 <td><a href="#Scope.__init__">Scope</a></td> 818 </table>
674 <td></td> 819 <h3>Static Methods</h3>
675 </tr><tr> 820 <table>
676 <td><a href="#Scope.__repr__">__repr__</a></td> 821 <tr><td>None</td></tr>
677 <td></td> 822 </table>
678 </tr> 823
679 </table> 824 <div align="right"><a href="#top">Up</a></div>
680 <h3>Static Methods</h3> 825 <hr /><hr />
681 <table> 826 <a NAME="__init__" ID="__init__"></a>
682 <tr><td>None</td></tr> 827 <h2>__init__</h2>
683 </table> 828 <b>__init__</b>(<i>self, name, source</i>)
684 <a NAME="Scope.__init__" ID="Scope.__init__"></a> 829
685 <h4>Scope (Constructor)</h4> 830 <div align="right"><a href="#top">Up</a></div>
686 <b>Scope</b>(<i></i>) 831 <hr /><hr />
687 <a NAME="Scope.__repr__" ID="Scope.__repr__"></a> 832 <a NAME="__init___1" ID="__init___1"></a>
688 <h4>Scope.__repr__</h4> 833 <h2>__init__</h2>
689 <b>__repr__</b>(<i></i>) 834 <b>__init__</b>(<i>self, name, source</i>)
690 835
691 <div align="right"><a href="#top">Up</a></div> 836 <div align="right"><a href="#top">Up</a></div>
692 <hr /><hr /> 837 <hr /><hr />
693 <a NAME="UnBinding" ID="UnBinding"></a> 838 <a NAME="__init___2" ID="__init___2"></a>
694 <h2>UnBinding</h2> 839 <h2>__init__</h2>
695 <p> 840 <b>__init__</b>(<i>self</i>)
696 Created by the 'del' operator. 841
697 </p> 842 <div align="right"><a href="#top">Up</a></div>
698 <h3>Derived from</h3> 843 <hr /><hr />
699 Binding 844 <a NAME="__repr__" ID="__repr__"></a>
700 <h3>Class Attributes</h3> 845 <h2>__repr__</h2>
701 <table> 846 <b>__repr__</b>(<i>self</i>)
702 <tr><td>None</td></tr> 847
703 </table> 848 <div align="right"><a href="#top">Up</a></div>
704 <h3>Class Methods</h3> 849 <hr /><hr />
705 <table> 850 <a NAME="__repr___1" ID="__repr___1"></a>
706 <tr><td>None</td></tr> 851 <h2>__repr__</h2>
707 </table> 852 <b>__repr__</b>(<i>self</i>)
708 <h3>Methods</h3> 853
709 <table> 854 <div align="right"><a href="#top">Up</a></div>
710 <tr><td>None</td></tr> 855 <hr /><hr />
711 </table> 856 <a NAME="__str__" ID="__str__"></a>
712 <h3>Static Methods</h3> 857 <h2>__str__</h2>
713 <table> 858 <b>__str__</b>(<i>self</i>)
714 <tr><td>None</td></tr> 859
715 </table> 860 <div align="right"><a href="#top">Up</a></div>
716 861 <hr /><hr />
862 <a NAME="getNodeName" ID="getNodeName"></a>
863 <h2>getNodeName</h2>
864 <b>getNodeName</b>(<i>node</i>)
865 <p>
866 Module function for getting the name of a node.
867 </p>
868 <div align="right"><a href="#top">Up</a></div>
869 <hr /><hr />
870 <a NAME="getNodeType" ID="getNodeType"></a>
871 <h2>getNodeType</h2>
872 <b>getNodeType</b>(<i>node_class</i>)
873
874 <div align="right"><a href="#top">Up</a></div>
875 <hr /><hr />
876 <a NAME="getNodeType_1" ID="getNodeType_1"></a>
877 <h2>getNodeType</h2>
878 <b>getNodeType</b>(<i>node_class</i>)
879
880 <div align="right"><a href="#top">Up</a></div>
881 <hr /><hr />
882 <a NAME="iter_child_nodes" ID="iter_child_nodes"></a>
883 <h2>iter_child_nodes</h2>
884 <b>iter_child_nodes</b>(<i>node</i>)
885 <p>
886 Yield all direct child nodes of *node*, that is, all fields that
887 are nodes and all items of fields that are lists of nodes.
888 </p>
889 <div align="right"><a href="#top">Up</a></div>
890 <hr /><hr />
891 <a NAME="names" ID="names"></a>
892 <h2>names</h2>
893 <b>names</b>(<i>self</i>)
894 <p>
895 Return a list of the names referenced by this binding.
896 </p>
897 <div align="right"><a href="#top">Up</a></div>
898 <hr /><hr />
899 <a NAME="unusedAssignments" ID="unusedAssignments"></a>
900 <h2>unusedAssignments</h2>
901 <b>unusedAssignments</b>(<i>self</i>)
902 <p>
903 Return a generator for the assignments which have not been used.
904 </p>
717 <div align="right"><a href="#top">Up</a></div> 905 <div align="right"><a href="#top">Up</a></div>
718 <hr /> 906 <hr />
719 </body></html> 907 </body></html>

Mercurial Repository: eric

eric ide

mercurial