Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.UtilitiesPython2.pyflakes.checker.html
Documentation/Source/eric5.UtilitiesPython2.pyflakes.checker.html
- changeset 3246
- 4cd58a0d6c28
equal
deleted
inserted
replaced
| 3244:1a54f34202b8 | 3246:4cd58a0d6c28 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric5.UtilitiesPython2.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.UtilitiesPython2.pyflakes.checker</h1> | |
| 23 | |
| 24 <h3>Global Attributes</h3> | |
| 25 <table> | |
| 26 <tr><td>_MAGIC_GLOBALS</td></tr> | |
| 27 </table> | |
| 28 <h3>Classes</h3> | |
| 29 <table> | |
| 30 <tr> | |
| 31 <td><a href="#Argument">Argument</a></td> | |
| 32 <td>Represents binding a name as an argument.</td> | |
| 33 </tr><tr> | |
| 34 <td><a href="#Assignment">Assignment</a></td> | |
| 35 <td>Represents binding a name with an explicit assignment.</td> | |
| 36 </tr><tr> | |
| 37 <td><a href="#Binding">Binding</a></td> | |
| 38 <td>Represents the binding of a value to a name.</td> | |
| 39 </tr><tr> | |
| 40 <td><a href="#Checker">Checker</a></td> | |
| 41 <td>Class to check the cleanliness and sanity of Python code.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#ClassDefinition">ClassDefinition</a></td> | |
| 44 <td>Represents a class definition.</td> | |
| 45 </tr><tr> | |
| 46 <td><a href="#ClassScope">ClassScope</a></td> | |
| 47 <td>Class representing a name scope for a class.</td> | |
| 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> | |
| 52 <td><a href="#ExportBinding">ExportBinding</a></td> | |
| 53 <td>A binding created by an __all__ assignment.</td> | |
| 54 </tr><tr> | |
| 55 <td><a href="#FunctionDefinition">FunctionDefinition</a></td> | |
| 56 <td>Represents a function definition.</td> | |
| 57 </tr><tr> | |
| 58 <td><a href="#FunctionScope">FunctionScope</a></td> | |
| 59 <td>Class representing a name scope for a function.</td> | |
| 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> | |
| 64 <td><a href="#Importation">Importation</a></td> | |
| 65 <td>A binding created by an import statement.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#ModuleScope">ModuleScope</a></td> | |
| 68 <td>Class representing a name scope for a module.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#Scope">Scope</a></td> | |
| 71 <td>Class defining the scope base class.</td> | |
| 72 </tr> | |
| 73 </table> | |
| 74 <h3>Functions</h3> | |
| 75 <table> | |
| 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> | |
| 113 </table> | |
| 114 <hr /><hr /> | |
| 115 <a NAME="Argument" ID="Argument"></a> | |
| 116 <h2>Argument</h2> | |
| 117 <p> | |
| 118 Represents binding a name as an argument. | |
| 119 </p> | |
| 120 <h3>Derived from</h3> | |
| 121 Binding | |
| 122 <h3>Class Attributes</h3> | |
| 123 <table> | |
| 124 <tr><td>None</td></tr> | |
| 125 </table> | |
| 126 <h3>Class Methods</h3> | |
| 127 <table> | |
| 128 <tr><td>None</td></tr> | |
| 129 </table> | |
| 130 <h3>Methods</h3> | |
| 131 <table> | |
| 132 <tr><td>None</td></tr> | |
| 133 </table> | |
| 134 <h3>Static Methods</h3> | |
| 135 <table> | |
| 136 <tr><td>None</td></tr> | |
| 137 </table> | |
| 138 | |
| 139 <div align="right"><a href="#top">Up</a></div> | |
| 140 <hr /><hr /> | |
| 141 <a NAME="Assignment" ID="Assignment"></a> | |
| 142 <h2>Assignment</h2> | |
| 143 <p> | |
| 144 Represents binding a name with an explicit assignment. | |
| 145 </p><p> | |
| 146 The checker will raise warnings for any Assignment that isn't used. Also, | |
| 147 the checker does not consider assignments in tuple/list unpacking to be | |
| 148 Assignments, rather it treats them as simple Bindings. | |
| 149 </p> | |
| 150 <h3>Derived from</h3> | |
| 151 Binding | |
| 152 <h3>Class Attributes</h3> | |
| 153 <table> | |
| 154 <tr><td>None</td></tr> | |
| 155 </table> | |
| 156 <h3>Class Methods</h3> | |
| 157 <table> | |
| 158 <tr><td>None</td></tr> | |
| 159 </table> | |
| 160 <h3>Methods</h3> | |
| 161 <table> | |
| 162 <tr><td>None</td></tr> | |
| 163 </table> | |
| 164 <h3>Static Methods</h3> | |
| 165 <table> | |
| 166 <tr><td>None</td></tr> | |
| 167 </table> | |
| 168 | |
| 169 <div align="right"><a href="#top">Up</a></div> | |
| 170 <hr /><hr /> | |
| 171 <a NAME="Binding" ID="Binding"></a> | |
| 172 <h2>Binding</h2> | |
| 173 <p> | |
| 174 Represents the binding of a value to a name. | |
| 175 </p><p> | |
| 176 The checker uses this to keep track of which names have been bound and | |
| 177 which names have not. See Assignment for a special type of binding that | |
| 178 is checked with stricter rules. | |
| 179 </p> | |
| 180 <h3>Derived from</h3> | |
| 181 object | |
| 182 <h3>Class Attributes</h3> | |
| 183 <table> | |
| 184 <tr><td>None</td></tr> | |
| 185 </table> | |
| 186 <h3>Class Methods</h3> | |
| 187 <table> | |
| 188 <tr><td>None</td></tr> | |
| 189 </table> | |
| 190 <h3>Methods</h3> | |
| 191 <table> | |
| 192 <tr><td>None</td></tr> | |
| 193 </table> | |
| 194 <h3>Static Methods</h3> | |
| 195 <table> | |
| 196 <tr><td>None</td></tr> | |
| 197 </table> | |
| 198 | |
| 199 <div align="right"><a href="#top">Up</a></div> | |
| 200 <hr /><hr /> | |
| 201 <a NAME="Checker" ID="Checker"></a> | |
| 202 <h2>Checker</h2> | |
| 203 <p> | |
| 204 Class to check the cleanliness and sanity of Python code. | |
| 205 </p> | |
| 206 <h3>Derived from</h3> | |
| 207 object | |
| 208 <h3>Class Attributes</h3> | |
| 209 <table> | |
| 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> | |
| 211 </table> | |
| 212 <h3>Class Methods</h3> | |
| 213 <table> | |
| 214 <tr><td>None</td></tr> | |
| 215 </table> | |
| 216 <h3>Methods</h3> | |
| 217 <table> | |
| 218 <tr> | |
| 219 <td><a href="#Checker.__init__">Checker</a></td> | |
| 220 <td>Constructor</td> | |
| 221 </tr><tr> | |
| 222 <td><a href="#Checker.ASSIGN">ASSIGN</a></td> | |
| 223 <td></td> | |
| 224 </tr><tr> | |
| 225 <td><a href="#Checker.AUGASSIGN">AUGASSIGN</a></td> | |
| 226 <td></td> | |
| 227 </tr><tr> | |
| 228 <td><a href="#Checker.CLASSDEF">CLASSDEF</a></td> | |
| 229 <td>Check names used in a class definition, including its decorators, base classes, and the body of its definition.</td> | |
| 230 </tr><tr> | |
| 231 <td><a href="#Checker.DICTCOMP">DICTCOMP</a></td> | |
| 232 <td></td> | |
| 233 </tr><tr> | |
| 234 <td><a href="#Checker.EXCEPTHANDLER">EXCEPTHANDLER</a></td> | |
| 235 <td></td> | |
| 236 </tr><tr> | |
| 237 <td><a href="#Checker.FOR">FOR</a></td> | |
| 238 <td>Process bindings for loop variables.</td> | |
| 239 </tr><tr> | |
| 240 <td><a href="#Checker.FUNCTIONDEF">FUNCTIONDEF</a></td> | |
| 241 <td></td> | |
| 242 </tr><tr> | |
| 243 <td><a href="#Checker.GENERATOREXP">GENERATOREXP</a></td> | |
| 244 <td></td> | |
| 245 </tr><tr> | |
| 246 <td><a href="#Checker.GLOBAL">GLOBAL</a></td> | |
| 247 <td>Keep track of globals declarations.</td> | |
| 248 </tr><tr> | |
| 249 <td><a href="#Checker.IMPORT">IMPORT</a></td> | |
| 250 <td></td> | |
| 251 </tr><tr> | |
| 252 <td><a href="#Checker.IMPORTFROM">IMPORTFROM</a></td> | |
| 253 <td></td> | |
| 254 </tr><tr> | |
| 255 <td><a href="#Checker.LAMBDA">LAMBDA</a></td> | |
| 256 <td></td> | |
| 257 </tr><tr> | |
| 258 <td><a href="#Checker.LISTCOMP">LISTCOMP</a></td> | |
| 259 <td></td> | |
| 260 </tr><tr> | |
| 261 <td><a href="#Checker.NAME">NAME</a></td> | |
| 262 <td>Handle occurrence of Name (which can be a load/store/delete access.)</td> | |
| 263 </tr><tr> | |
| 264 <td><a href="#Checker.TRY">TRY</a></td> | |
| 265 <td></td> | |
| 266 </tr><tr> | |
| 267 <td><a href="#Checker.addArgs">addArgs</a></td> | |
| 268 <td></td> | |
| 269 </tr><tr> | |
| 270 <td><a href="#Checker.addBinding">addBinding</a></td> | |
| 271 <td>Called when a binding is altered.</td> | |
| 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> | |
| 276 <td><a href="#Checker.checkUnusedAssignments">checkUnusedAssignments</a></td> | |
| 277 <td>Check to see if any assignments have not been used.</td> | |
| 278 </tr><tr> | |
| 279 <td><a href="#Checker.collectLoopVars">collectLoopVars</a></td> | |
| 280 <td></td> | |
| 281 </tr><tr> | |
| 282 <td><a href="#Checker.deferAssignment">deferAssignment</a></td> | |
| 283 <td>Schedule an assignment handler to be called just after deferred function handlers.</td> | |
| 284 </tr><tr> | |
| 285 <td><a href="#Checker.deferFunction">deferFunction</a></td> | |
| 286 <td>Schedule a function handler to be called just before completion.</td> | |
| 287 </tr><tr> | |
| 288 <td><a href="#Checker.descendantOf">descendantOf</a></td> | |
| 289 <td></td> | |
| 290 </tr><tr> | |
| 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> | |
| 301 <td></td> | |
| 302 </tr><tr> | |
| 303 <td><a href="#Checker.handleChildren">handleChildren</a></td> | |
| 304 <td></td> | |
| 305 </tr><tr> | |
| 306 <td><a href="#Checker.handleDoctests">handleDoctests</a></td> | |
| 307 <td></td> | |
| 308 </tr><tr> | |
| 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> | |
| 322 <td></td> | |
| 323 </tr><tr> | |
| 324 <td><a href="#Checker.ignore">ignore</a></td> | |
| 325 <td></td> | |
| 326 </tr><tr> | |
| 327 <td><a href="#Checker.isDocstring">isDocstring</a></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> | |
| 329 </tr><tr> | |
| 330 <td><a href="#Checker.onFork">onFork</a></td> | |
| 331 <td></td> | |
| 332 </tr><tr> | |
| 333 <td><a href="#Checker.popScope">popScope</a></td> | |
| 334 <td></td> | |
| 335 </tr><tr> | |
| 336 <td><a href="#Checker.pushClassScope">pushClassScope</a></td> | |
| 337 <td></td> | |
| 338 </tr><tr> | |
| 339 <td><a href="#Checker.pushFunctionScope">pushFunctionScope</a></td> | |
| 340 <td></td> | |
| 341 </tr><tr> | |
| 342 <td><a href="#Checker.pushScope">pushScope</a></td> | |
| 343 <td></td> | |
| 344 </tr><tr> | |
| 345 <td><a href="#Checker.report">report</a></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> | |
| 350 </tr><tr> | |
| 351 <td><a href="#Checker.runFunction">runFunction</a></td> | |
| 352 <td></td> | |
| 353 </tr><tr> | |
| 354 <td><a href="#Checker.scope">scope</a></td> | |
| 355 <td></td> | |
| 356 </tr> | |
| 357 </table> | |
| 358 <h3>Static Methods</h3> | |
| 359 <table> | |
| 360 <tr><td>None</td></tr> | |
| 361 </table> | |
| 362 <a NAME="Checker.__init__" ID="Checker.__init__"></a> | |
| 363 <h4>Checker (Constructor)</h4> | |
| 364 <b>Checker</b>(<i>tree, filename='(none)', builtins=None</i>) | |
| 365 <p> | |
| 366 Constructor | |
| 367 </p><dl> | |
| 368 <dt><i>tree</i></dt> | |
| 369 <dd> | |
| 370 parsed module tree or module source code | |
| 371 </dd><dt><i>filename</i></dt> | |
| 372 <dd> | |
| 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) | |
| 377 </dd> | |
| 378 </dl><a NAME="Checker.ASSIGN" ID="Checker.ASSIGN"></a> | |
| 379 <h4>Checker.ASSIGN</h4> | |
| 380 <b>ASSIGN</b>(<i>node</i>) | |
| 381 <a NAME="Checker.AUGASSIGN" ID="Checker.AUGASSIGN"></a> | |
| 382 <h4>Checker.AUGASSIGN</h4> | |
| 383 <b>AUGASSIGN</b>(<i>node</i>) | |
| 384 <a NAME="Checker.CLASSDEF" ID="Checker.CLASSDEF"></a> | |
| 385 <h4>Checker.CLASSDEF</h4> | |
| 386 <b>CLASSDEF</b>(<i>node</i>) | |
| 387 <p> | |
| 388 Check names used in a class definition, including its decorators, base | |
| 389 classes, and the body of its definition. Additionally, add its name to | |
| 390 the current scope. | |
| 391 </p><a NAME="Checker.DICTCOMP" ID="Checker.DICTCOMP"></a> | |
| 392 <h4>Checker.DICTCOMP</h4> | |
| 393 <b>DICTCOMP</b>(<i>node</i>) | |
| 394 <a NAME="Checker.EXCEPTHANDLER" ID="Checker.EXCEPTHANDLER"></a> | |
| 395 <h4>Checker.EXCEPTHANDLER</h4> | |
| 396 <b>EXCEPTHANDLER</b>(<i>node</i>) | |
| 397 <a NAME="Checker.FOR" ID="Checker.FOR"></a> | |
| 398 <h4>Checker.FOR</h4> | |
| 399 <b>FOR</b>(<i>node</i>) | |
| 400 <p> | |
| 401 Process bindings for loop variables. | |
| 402 </p><a NAME="Checker.FUNCTIONDEF" ID="Checker.FUNCTIONDEF"></a> | |
| 403 <h4>Checker.FUNCTIONDEF</h4> | |
| 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>) | |
| 408 <a NAME="Checker.GLOBAL" ID="Checker.GLOBAL"></a> | |
| 409 <h4>Checker.GLOBAL</h4> | |
| 410 <b>GLOBAL</b>(<i>node</i>) | |
| 411 <p> | |
| 412 Keep track of globals declarations. | |
| 413 </p><a NAME="Checker.IMPORT" ID="Checker.IMPORT"></a> | |
| 414 <h4>Checker.IMPORT</h4> | |
| 415 <b>IMPORT</b>(<i>node</i>) | |
| 416 <a NAME="Checker.IMPORTFROM" ID="Checker.IMPORTFROM"></a> | |
| 417 <h4>Checker.IMPORTFROM</h4> | |
| 418 <b>IMPORTFROM</b>(<i>node</i>) | |
| 419 <a NAME="Checker.LAMBDA" ID="Checker.LAMBDA"></a> | |
| 420 <h4>Checker.LAMBDA</h4> | |
| 421 <b>LAMBDA</b>(<i>node</i>) | |
| 422 <a NAME="Checker.LISTCOMP" ID="Checker.LISTCOMP"></a> | |
| 423 <h4>Checker.LISTCOMP</h4> | |
| 424 <b>LISTCOMP</b>(<i>node</i>) | |
| 425 <a NAME="Checker.NAME" ID="Checker.NAME"></a> | |
| 426 <h4>Checker.NAME</h4> | |
| 427 <b>NAME</b>(<i>node</i>) | |
| 428 <p> | |
| 429 Handle occurrence of Name (which can be a load/store/delete access.) | |
| 430 </p><a NAME="Checker.TRY" ID="Checker.TRY"></a> | |
| 431 <h4>Checker.TRY</h4> | |
| 432 <b>TRY</b>(<i>node</i>) | |
| 433 <a NAME="Checker.addArgs" ID="Checker.addArgs"></a> | |
| 434 <h4>Checker.addArgs</h4> | |
| 435 <b>addArgs</b>(<i></i>) | |
| 436 <a NAME="Checker.addBinding" ID="Checker.addBinding"></a> | |
| 437 <h4>Checker.addBinding</h4> | |
| 438 <b>addBinding</b>(<i>node, value, reportRedef=True</i>) | |
| 439 <p> | |
| 440 Called when a binding is altered. | |
| 441 </p><p> | |
| 442 - `node` is the statement responsible for the change | |
| 443 - `value` is the optional new value, a Binding instance, associated | |
| 444 with the binding; if None, the binding is deleted if it exists. | |
| 445 - if `reportRedef` is True (default), rebinding while unused will be | |
| 446 reported. | |
| 447 </p><a NAME="Checker.checkDeadScopes" ID="Checker.checkDeadScopes"></a> | |
| 448 <h4>Checker.checkDeadScopes</h4> | |
| 449 <b>checkDeadScopes</b>(<i></i>) | |
| 450 <p> | |
| 451 Look at scopes which have been fully examined and report names in them | |
| 452 which were imported but unused. | |
| 453 </p><a NAME="Checker.checkUnusedAssignments" ID="Checker.checkUnusedAssignments"></a> | |
| 454 <h4>Checker.checkUnusedAssignments</h4> | |
| 455 <b>checkUnusedAssignments</b>(<i></i>) | |
| 456 <p> | |
| 457 Check to see if any assignments have not been used. | |
| 458 </p><a NAME="Checker.collectLoopVars" ID="Checker.collectLoopVars"></a> | |
| 459 <h4>Checker.collectLoopVars</h4> | |
| 460 <b>collectLoopVars</b>(<i></i>) | |
| 461 <a NAME="Checker.deferAssignment" ID="Checker.deferAssignment"></a> | |
| 462 <h4>Checker.deferAssignment</h4> | |
| 463 <b>deferAssignment</b>(<i>callable</i>) | |
| 464 <p> | |
| 465 Schedule an assignment handler to be called just after deferred | |
| 466 function handlers. | |
| 467 </p><a NAME="Checker.deferFunction" ID="Checker.deferFunction"></a> | |
| 468 <h4>Checker.deferFunction</h4> | |
| 469 <b>deferFunction</b>(<i>callable</i>) | |
| 470 <p> | |
| 471 Schedule a function handler to be called just before completion. | |
| 472 </p><p> | |
| 473 This is used for handling function bodies, which must be deferred | |
| 474 because code later in the file might modify the global scope. When | |
| 475 `callable` is called, the scope at the time this is called will be | |
| 476 restored, however it will contain any new bindings added to it. | |
| 477 </p><a NAME="Checker.descendantOf" ID="Checker.descendantOf"></a> | |
| 478 <h4>Checker.descendantOf</h4> | |
| 479 <b>descendantOf</b>(<i>node, ancestors, stop=None</i>) | |
| 480 <a NAME="Checker.differentForks" ID="Checker.differentForks"></a> | |
| 481 <h4>Checker.differentForks</h4> | |
| 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>) | |
| 494 <a NAME="Checker.handleChildren" ID="Checker.handleChildren"></a> | |
| 495 <h4>Checker.handleChildren</h4> | |
| 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>) | |
| 500 <a NAME="Checker.handleNode" ID="Checker.handleNode"></a> | |
| 501 <h4>Checker.handleNode</h4> | |
| 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>) | |
| 515 <a NAME="Checker.ignore" ID="Checker.ignore"></a> | |
| 516 <h4>Checker.ignore</h4> | |
| 517 <b>ignore</b>(<i>node</i>) | |
| 518 <a NAME="Checker.isDocstring" ID="Checker.isDocstring"></a> | |
| 519 <h4>Checker.isDocstring</h4> | |
| 520 <b>isDocstring</b>(<i>node</i>) | |
| 521 <p> | |
| 522 Determine if the given node is a docstring, as long as it is at the | |
| 523 correct place in the node tree. | |
| 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> | |
| 528 <h4>Checker.popScope</h4> | |
| 529 <b>popScope</b>(<i></i>) | |
| 530 <a NAME="Checker.pushClassScope" ID="Checker.pushClassScope"></a> | |
| 531 <h4>Checker.pushClassScope</h4> | |
| 532 <b>pushClassScope</b>(<i></i>) | |
| 533 <a NAME="Checker.pushFunctionScope" ID="Checker.pushFunctionScope"></a> | |
| 534 <h4>Checker.pushFunctionScope</h4> | |
| 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>) | |
| 539 <a NAME="Checker.report" ID="Checker.report"></a> | |
| 540 <h4>Checker.report</h4> | |
| 541 <b>report</b>(<i>messageClass, *args, **kwargs</i>) | |
| 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> | |
| 548 <h4>Checker.runFunction</h4> | |
| 549 <b>runFunction</b>(<i></i>) | |
| 550 <a NAME="Checker.scope" ID="Checker.scope"></a> | |
| 551 <h4>Checker.scope</h4> | |
| 552 <b>scope</b>(<i></i>) | |
| 553 | |
| 554 <div align="right"><a href="#top">Up</a></div> | |
| 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 /> | |
| 582 <a NAME="ClassScope" ID="ClassScope"></a> | |
| 583 <h2>ClassScope</h2> | |
| 584 <p> | |
| 585 Class representing a name scope for a class. | |
| 586 </p> | |
| 587 <h3>Derived from</h3> | |
| 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 | |
| 615 <h3>Class Attributes</h3> | |
| 616 <table> | |
| 617 <tr><td>None</td></tr> | |
| 618 </table> | |
| 619 <h3>Class Methods</h3> | |
| 620 <table> | |
| 621 <tr><td>None</td></tr> | |
| 622 </table> | |
| 623 <h3>Methods</h3> | |
| 624 <table> | |
| 625 <tr><td>None</td></tr> | |
| 626 </table> | |
| 627 <h3>Static Methods</h3> | |
| 628 <table> | |
| 629 <tr><td>None</td></tr> | |
| 630 </table> | |
| 631 | |
| 632 <div align="right"><a href="#top">Up</a></div> | |
| 633 <hr /><hr /> | |
| 634 <a NAME="ExportBinding" ID="ExportBinding"></a> | |
| 635 <h2>ExportBinding</h2> | |
| 636 <p> | |
| 637 A binding created by an __all__ assignment. If the names in the list | |
| 638 can be determined statically, they will be treated as names for export and | |
| 639 additional checking applied to them. | |
| 640 </p><p> | |
| 641 The only __all__ assignment that can be recognized is one which takes | |
| 642 the value of a literal list containing literal strings. For example:: | |
| 643 </p><p> | |
| 644 __all__ = ["foo", "bar"] | |
| 645 </p><p> | |
| 646 Names which are imported and not otherwise used but appear in the value of | |
| 647 __all__ will not have an unused import warning reported for them. | |
| 648 </p> | |
| 649 <h3>Derived from</h3> | |
| 650 Binding | |
| 651 <h3>Class Attributes</h3> | |
| 652 <table> | |
| 653 <tr><td>None</td></tr> | |
| 654 </table> | |
| 655 <h3>Class Methods</h3> | |
| 656 <table> | |
| 657 <tr><td>None</td></tr> | |
| 658 </table> | |
| 659 <h3>Methods</h3> | |
| 660 <table> | |
| 661 <tr><td>None</td></tr> | |
| 662 </table> | |
| 663 <h3>Static Methods</h3> | |
| 664 <table> | |
| 665 <tr><td>None</td></tr> | |
| 666 </table> | |
| 667 | |
| 668 <div align="right"><a href="#top">Up</a></div> | |
| 669 <hr /><hr /> | |
| 670 <a NAME="FunctionDefinition" ID="FunctionDefinition"></a> | |
| 671 <h2>FunctionDefinition</h2> | |
| 672 <p> | |
| 673 Represents a function definition. | |
| 674 </p> | |
| 675 <h3>Derived from</h3> | |
| 676 Definition | |
| 677 <h3>Class Attributes</h3> | |
| 678 <table> | |
| 679 <tr><td>None</td></tr> | |
| 680 </table> | |
| 681 <h3>Class Methods</h3> | |
| 682 <table> | |
| 683 <tr><td>None</td></tr> | |
| 684 </table> | |
| 685 <h3>Methods</h3> | |
| 686 <table> | |
| 687 <tr><td>None</td></tr> | |
| 688 </table> | |
| 689 <h3>Static Methods</h3> | |
| 690 <table> | |
| 691 <tr><td>None</td></tr> | |
| 692 </table> | |
| 693 | |
| 694 <div align="right"><a href="#top">Up</a></div> | |
| 695 <hr /><hr /> | |
| 696 <a NAME="FunctionScope" ID="FunctionScope"></a> | |
| 697 <h2>FunctionScope</h2> | |
| 698 <p> | |
| 699 Class representing a name scope for a function. | |
| 700 </p> | |
| 701 <h3>Derived from</h3> | |
| 702 Scope | |
| 703 <h3>Class Attributes</h3> | |
| 704 <table> | |
| 705 <tr><td>alwaysUsed</td></tr><tr><td>usesLocals</td></tr> | |
| 706 </table> | |
| 707 <h3>Class Methods</h3> | |
| 708 <table> | |
| 709 <tr><td>None</td></tr> | |
| 710 </table> | |
| 711 <h3>Methods</h3> | |
| 712 <table> | |
| 713 <tr><td>None</td></tr> | |
| 714 </table> | |
| 715 <h3>Static Methods</h3> | |
| 716 <table> | |
| 717 <tr><td>None</td></tr> | |
| 718 </table> | |
| 719 | |
| 720 <div align="right"><a href="#top">Up</a></div> | |
| 721 <hr /><hr /> | |
| 722 <a NAME="GeneratorScope" ID="GeneratorScope"></a> | |
| 723 <h2>GeneratorScope</h2> | |
| 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> | |
| 745 | |
| 746 <div align="right"><a href="#top">Up</a></div> | |
| 747 <hr /><hr /> | |
| 748 <a NAME="Importation" ID="Importation"></a> | |
| 749 <h2>Importation</h2> | |
| 750 <p> | |
| 751 A binding created by an import statement. | |
| 752 </p> | |
| 753 <h3>Derived from</h3> | |
| 754 Binding | |
| 755 <h3>Class Attributes</h3> | |
| 756 <table> | |
| 757 <tr><td>None</td></tr> | |
| 758 </table> | |
| 759 <h3>Class Methods</h3> | |
| 760 <table> | |
| 761 <tr><td>None</td></tr> | |
| 762 </table> | |
| 763 <h3>Methods</h3> | |
| 764 <table> | |
| 765 <tr><td>None</td></tr> | |
| 766 </table> | |
| 767 <h3>Static Methods</h3> | |
| 768 <table> | |
| 769 <tr><td>None</td></tr> | |
| 770 </table> | |
| 771 | |
| 772 <div align="right"><a href="#top">Up</a></div> | |
| 773 <hr /><hr /> | |
| 774 <a NAME="ModuleScope" ID="ModuleScope"></a> | |
| 775 <h2>ModuleScope</h2> | |
| 776 <p> | |
| 777 Class representing a name scope for a module. | |
| 778 </p> | |
| 779 <h3>Derived from</h3> | |
| 780 Scope | |
| 781 <h3>Class Attributes</h3> | |
| 782 <table> | |
| 783 <tr><td>None</td></tr> | |
| 784 </table> | |
| 785 <h3>Class Methods</h3> | |
| 786 <table> | |
| 787 <tr><td>None</td></tr> | |
| 788 </table> | |
| 789 <h3>Methods</h3> | |
| 790 <table> | |
| 791 <tr><td>None</td></tr> | |
| 792 </table> | |
| 793 <h3>Static Methods</h3> | |
| 794 <table> | |
| 795 <tr><td>None</td></tr> | |
| 796 </table> | |
| 797 | |
| 798 <div align="right"><a href="#top">Up</a></div> | |
| 799 <hr /><hr /> | |
| 800 <a NAME="Scope" ID="Scope"></a> | |
| 801 <h2>Scope</h2> | |
| 802 <p> | |
| 803 Class defining the scope base class. | |
| 804 </p> | |
| 805 <h3>Derived from</h3> | |
| 806 dict | |
| 807 <h3>Class Attributes</h3> | |
| 808 <table> | |
| 809 <tr><td>importStarred</td></tr> | |
| 810 </table> | |
| 811 <h3>Class Methods</h3> | |
| 812 <table> | |
| 813 <tr><td>None</td></tr> | |
| 814 </table> | |
| 815 <h3>Methods</h3> | |
| 816 <table> | |
| 817 <tr><td>None</td></tr> | |
| 818 </table> | |
| 819 <h3>Static Methods</h3> | |
| 820 <table> | |
| 821 <tr><td>None</td></tr> | |
| 822 </table> | |
| 823 | |
| 824 <div align="right"><a href="#top">Up</a></div> | |
| 825 <hr /><hr /> | |
| 826 <a NAME="__init__" ID="__init__"></a> | |
| 827 <h2>__init__</h2> | |
| 828 <b>__init__</b>(<i>self, name, source</i>) | |
| 829 | |
| 830 <div align="right"><a href="#top">Up</a></div> | |
| 831 <hr /><hr /> | |
| 832 <a NAME="__init___1" ID="__init___1"></a> | |
| 833 <h2>__init__</h2> | |
| 834 <b>__init__</b>(<i>self, name, source</i>) | |
| 835 | |
| 836 <div align="right"><a href="#top">Up</a></div> | |
| 837 <hr /><hr /> | |
| 838 <a NAME="__init___2" ID="__init___2"></a> | |
| 839 <h2>__init__</h2> | |
| 840 <b>__init__</b>(<i>self</i>) | |
| 841 | |
| 842 <div align="right"><a href="#top">Up</a></div> | |
| 843 <hr /><hr /> | |
| 844 <a NAME="__repr__" ID="__repr__"></a> | |
| 845 <h2>__repr__</h2> | |
| 846 <b>__repr__</b>(<i>self</i>) | |
| 847 | |
| 848 <div align="right"><a href="#top">Up</a></div> | |
| 849 <hr /><hr /> | |
| 850 <a NAME="__repr___1" ID="__repr___1"></a> | |
| 851 <h2>__repr__</h2> | |
| 852 <b>__repr__</b>(<i>self</i>) | |
| 853 | |
| 854 <div align="right"><a href="#top">Up</a></div> | |
| 855 <hr /><hr /> | |
| 856 <a NAME="__str__" ID="__str__"></a> | |
| 857 <h2>__str__</h2> | |
| 858 <b>__str__</b>(<i>self</i>) | |
| 859 | |
| 860 <div align="right"><a href="#top">Up</a></div> | |
| 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> | |
| 905 <div align="right"><a href="#top">Up</a></div> | |
| 906 <hr /> | |
| 907 </body></html> |
