1 #!/usr/bin/env python 2 3 """ 4 Inspect source files, obtaining details of classes and attributes. 5 6 Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 Paul Boddie <paul@boddie.org.uk> 7 8 This program is free software; you can redistribute it and/or modify it under 9 the terms of the GNU General Public License as published by the Free Software 10 Foundation; either version 3 of the License, or (at your option) any later 11 version. 12 13 This program is distributed in the hope that it will be useful, but WITHOUT 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 16 details. 17 18 You should have received a copy of the GNU General Public License along with 19 this program. If not, see <http://www.gnu.org/licenses/>. 20 21 -------- 22 23 The results of inspecting a module are as follows: 24 25 Constants 26 --------- 27 28 All constants identified within the code shall be registered. 29 30 Classes 31 ------- 32 33 All global classes shall be registered; local classes (within functions) or 34 nested classes (within classes) are not currently registered. 35 36 Base classes must be detected and constant. 37 38 All classes without bases are made to inherit from __builtins__.object in order 39 to support some standard methods. 40 41 Functions 42 --------- 43 44 All functions and lambda definitions shall be registered. 45 46 Namespaces 47 ---------- 48 49 Modules define their own "global" namespace, within which classes, functions 50 and lambda definitions establish a hierarchy of namespaces. 51 52 Only local, global and built-in namespaces are recognised; closures are not 53 supported. 54 55 Assignments 56 ----------- 57 58 Name assignment and attribute assignment involving modules and classes cause 59 names to be associated with values within namespaces. 60 61 Any assignments within loops are considered to cause the targets of such 62 assignments to provide non-constant values. 63 64 Assignments to names are only really considered to cause the targets of such 65 assignments to provide constant values if the targets reside in class 66 namespaces, subject to the above conditions. 67 68 Assignments to names within functions are not generally considered to cause the 69 targets of such assignments to provide constant values since functions can be 70 invoked many times with different inputs. This affects particularly the 71 definition of functions or lambdas within functions. However, there may be 72 benefits in considering a local to be constant within a single invocation. 73 """ 74 75 from micropython.common import ASTVisitor, operator_functions, get_module_name 76 from micropython.data import * 77 from micropython.errors import * 78 from micropython.stdcompiler import compiler 79 import sys 80 81 class NullBranch(compiler.ast.AttributeUser): 82 83 "A class representing an attribute user for a non-existent branch." 84 85 pass 86 87 # Program visitors. 88 89 class InspectedModule(ASTVisitor, Module): 90 91 """ 92 An inspected module, providing core details via the Module superclass, but 93 capable of being used as an AST visitor. 94 95 A module can be inspected through the invocation of the following methods in 96 order: 97 98 1. parse 99 2. process 100 3. vacuum 101 4. finalise 102 103 A module importer can be expected to perform these invocations. 104 """ 105 106 def __init__(self, name, importer): 107 108 """ 109 Initialise this visitor with a module 'name' and an 'importer' which is 110 used to provide access to other modules when required. 111 """ 112 113 Module.__init__(self, name, importer) 114 self.visitor = self 115 self.filename = None 116 117 # Import machinery links. 118 119 self.builtins = self.importer.modules.get("__builtins__") 120 self.loaded = False 121 self.completed = False 122 123 # Current expression state. 124 125 self.expr = None 126 self.in_assignment = False # For slice and subscript handling. 127 128 # Namespace state. 129 130 self.in_method = False # Find instance attributes in all methods. 131 self.in_function = False # Note function presence, affecting definitions. 132 self.in_loop = False # Note loop "membership", affecting assignments. 133 self.namespaces = [] 134 self.functions = [] 135 136 def parse(self, filename): 137 138 "Parse the file having the given 'filename'." 139 140 self.filename = filename 141 self.astnode = module = compiler.parseFile(filename) 142 143 # Detect and record imports and globals declared in the module. 144 145 self.process_structure(module) 146 147 def complete(self): 148 if not self.completed: 149 self.completed = True 150 self.process() 151 if self.importer.verbose: 152 print >>sys.stderr, "Completed import of", self.full_name() 153 154 def process(self): 155 return self.process_module(self.astnode) 156 157 def process_module(self, module): 158 159 """ 160 Process the given 'module', visiting module-level code and function 161 code. 162 """ 163 164 # Add __name__ to the namespace. 165 166 self.store("__name__", self._visitConst(self.full_name())) 167 168 # Visit module-level code, also recording global names. 169 170 processed = self.dispatch(module) 171 172 self.finalise_attribute_usage() 173 174 # Visit functions. 175 176 self.process_functions() 177 178 # Add references to other modules declared using the __all__ global. 179 180 if self.has_key("__all__"): 181 all = self["__all__"] 182 if isinstance(all, compiler.ast.List): 183 for n in all.nodes: 184 self.store(n.value, self.importer.add_module(self.name + "." + n.value)) 185 186 return processed 187 188 def process_functions(self): 189 190 """ 191 Process all function bodies. Deferred imports may occur during this 192 process. 193 """ 194 195 # Then, visit each function, recording other names. This happens to 196 # work for lambda definitions inside functions since they are added to 197 # the end of self.functions and are thus visited as the iteration 198 # reaches the end of the original list. 199 200 for node, namespaces in self.functions: 201 self._visitFunctionBody(node, namespaces) 202 namespaces[-1].finalise_attribute_usage() 203 204 def process_structure(self, node): 205 206 """ 207 Within the given 'node', process global declarations, adjusting the 208 module namespace, and import statements, building a module dependency 209 hierarchy. 210 """ 211 212 for n in node.getChildNodes(): 213 214 # Module global detection. 215 216 if isinstance(n, compiler.ast.Global): 217 for name in n.names: 218 219 # Each name may potentially be assigned many times. 220 # We don't try and find out the specifics at this point and 221 # just indicate that the name cannot be relied upon for 222 # various observations. 223 224 self.modify_name(name) 225 226 # Module import declarations. 227 228 elif isinstance(n, compiler.ast.From): 229 modname, names = get_module_name(n, self) 230 231 # Perform whole module relative imports. 232 233 if not modname: 234 for name, alias in names: 235 self.record_import(name, n) 236 237 # Otherwise, perform normal "from" imports. 238 239 else: 240 # Load the mentioned module. 241 242 self.record_import(modname, n) 243 244 # Speculatively load modules for names beneath the module. 245 246 for name, alias in n.names: 247 subname = modname + "." + name 248 self.record_import(subname, n) 249 250 elif isinstance(n, compiler.ast.Import): 251 252 # Load the mentioned module. 253 254 for name, alias in n.names: 255 self.record_import(name, n) 256 257 # Nodes using operator module functions. 258 259 elif operator_functions.has_key(n.__class__.__name__) or \ 260 isinstance(n, (compiler.ast.AugAssign, compiler.ast.Compare)): 261 262 n._module = self.importer.load("operator") 263 264 else: 265 self.process_structure(n) 266 267 def get_module_paths(self, name): 268 269 """ 270 Return the paths of modules leading to the module having the given 271 'name'. 272 """ 273 274 names = [] 275 parts = [] 276 for part in name.split("."): 277 parts.append(part) 278 names.append(".".join(parts)) 279 return names 280 281 def record_import(self, name, node): 282 283 """ 284 Record an import of a module with the given 'name' occurring at the 285 given 'node'. 286 """ 287 288 module = self.importer.load(name, 1, importer=node) 289 if module and not module.loaded: 290 self.importer.circular_imports.add(module) 291 292 def complete_import(self, name, return_leaf): 293 294 """ 295 Complete the import of the module with the given 'name', returning the 296 module itself if 'return_leaf' is a true value, or returning the root of 297 the module hierarchy if 'return_leaf' is a false value. 298 """ 299 300 top = module = None 301 302 for modname in self.get_module_paths(name): 303 304 # Attempt to get the module, returning None for non-existent 305 # modules. 306 307 try: 308 module = self.importer.get_module(modname) 309 except KeyError: 310 return None 311 312 if module: 313 module.complete() 314 315 if top is None: 316 top = module 317 318 if return_leaf: 319 return module 320 else: 321 return top 322 323 def vacuum(self): 324 325 """ 326 Vacuum the module namespace, removing unreferenced objects and unused 327 names. 328 """ 329 330 self.vacuum_object(self) 331 332 all_objects = list(self.all_objects) 333 334 for obj in all_objects: 335 self.vacuum_object(obj) 336 337 def vacuum_object(self, obj, delete_all=0): 338 339 "Vacuum the given object 'obj'." 340 341 # Get all constant objects in apparent use. 342 343 if delete_all: 344 obj_objects = set() 345 else: 346 obj_objects = [] 347 for name, attr in obj.items_for_vacuum(): 348 349 # Get constant objects for attributes in use. 350 351 if self.importer.uses_attribute(obj.full_name(), name) and \ 352 attr is not None and attr.is_constant(): 353 354 value = attr.get_value() 355 obj_objects.append(value) 356 357 # Now vacuum unused attributes and objects not in use. 358 359 for name, attr in obj.items_for_vacuum(): 360 361 # Only consider deleting entire unused objects or things accessible 362 # via names which are never used. 363 364 if delete_all or not self.importer.uses_attribute(obj.full_name(), name): 365 obj.vacuum_item(name) 366 367 # Delete any unambiguous attribute value. Such values can only 368 # have been defined within the object and therefore are not 369 # redefined by other code regions. 370 371 if attr is not None and attr.is_constant(): 372 value = attr.get_value() 373 374 # The value must have this object as a parent. 375 # However, it must not be shared by several names. 376 377 if value is not obj and value.parent is obj and \ 378 value in self.all_objects and value not in obj_objects: 379 380 self.all_objects.remove(value) 381 382 # Delete class contents and lambdas from functions. 383 384 self.vacuum_object(value, 1) 385 386 def unfinalise(self): 387 388 "Reset finalised information for the module." 389 390 for obj in self.all_objects: 391 obj.unfinalise_attributes() 392 393 def finalise(self, objtable): 394 395 "Finalise the module." 396 397 for obj in self.all_objects: 398 obj.finalise(objtable) 399 400 self.finalise_users(objtable) 401 402 def add_object(self, obj, any_scope=0): 403 404 """ 405 Record 'obj' if non-local or if the optional 'any_scope' is set to a 406 true value. 407 """ 408 409 if any_scope or not (self.namespaces and isinstance(self.namespaces[-1], Function)): 410 self.all_objects.add(obj) 411 412 # Namespace methods. 413 414 def in_class(self, namespaces=None): 415 namespaces = namespaces or self.namespaces 416 return len(namespaces) > 1 and isinstance(namespaces[-2], Class) 417 418 def store(self, name, obj, static_def=False): 419 420 """ 421 Record attribute or local 'name', storing 'obj'. Where 'static_def' is 422 specified and set to a true value, the namespace will record a static 423 definition for the given name. 424 """ 425 426 # Store in the module. 427 428 if not self.namespaces: 429 if self.in_loop and self.used_in_scope(name, "builtins"): 430 raise InspectError("Name %r already used as a built-in." % name) 431 else: 432 ns = self 433 434 # Or store locally. 435 436 else: 437 locals = self.namespaces[-1] 438 439 if self.in_loop and locals.used_in_scope(name, "global") and not name in locals.globals: 440 raise InspectError("Name %r already used as global." % name) 441 elif self.in_loop and locals.used_in_scope(name, "builtins"): 442 raise InspectError("Name %r already used as a built-in." % name) 443 else: 444 ns = locals 445 446 ns.set(name, obj, not self.in_loop) 447 if static_def: 448 ns.get(name).static_assignments += 1 449 return ns.get(name) 450 451 def store_lambda(self, obj): 452 453 "Store a lambda function 'obj'." 454 455 self.add_object(obj) 456 self.get_namespace().add_lambda(obj) 457 458 def store_module_attr(self, name, module): 459 460 """ 461 Record module attribute 'name' in the given 'module' using the current 462 expression. 463 """ 464 465 module.set(name, self.expr, 0) 466 self.use_specific_attribute(module.full_name(), name) 467 468 def store_class_attr(self, name, cls): 469 470 """ 471 Record class attribute 'name' in the given class 'cls' using the current 472 expression. 473 """ 474 475 cls.set(name, self.expr, 0) 476 self.use_specific_attribute(cls.full_name(), name) 477 478 def store_instance_attr(self, name, tentative=False): 479 480 """ 481 Record instance attribute 'name' in the current class. If 'tentative' is 482 set to a true value, the instance attribute will be discarded if a class 483 attribute is observed. 484 """ 485 486 if self.in_method: 487 488 # Current namespace is the function. 489 # Previous namespace is the class. 490 491 cls = self.namespaces[-2] 492 cls.add_instance_attribute(name, tentative) 493 494 # NOTE: The instance attribute, although defined in a specific 495 # NOTE: class, obviously appears in all descendant classes. 496 497 self.use_specific_attribute(cls.full_name(), name) 498 499 def get_namespace(self): 500 501 "Return the parent (or most recent) namespace currently exposed." 502 503 return (self.namespaces[-1:] or [self])[0] 504 505 get_unit = get_namespace # compatibility method for error handling 506 507 def use_name(self, name, node=None, value=None, ns=None): 508 509 """ 510 Use the given 'name' within the current namespace/unit, either in 511 conjunction with a particular object (if 'node' is specified and not 512 None) or unconditionally. 513 """ 514 515 unit = self.get_namespace() 516 517 # Handle attribute usage situations within the current unit. 518 519 if node is not None and isinstance(node, compiler.ast.Name) and ns is unit: 520 self.use_attribute(node.name, name, value) 521 522 # For general name usage, declare usage of the given name from this 523 # particular unit. 524 525 else: 526 self.importer.use_name(name, unit.full_name(), value) 527 528 def use_constant(self, const): 529 530 "Use the given 'const' within the current namespace/unit." 531 532 unit = self.get_namespace() 533 self.importer.use_constant(const, unit.full_name()) 534 535 # Attribute usage methods. 536 # These are convenience methods which refer to the specific namespace's 537 # implementation of these operations. 538 539 def new_branchpoint(self, loop_node=None): 540 self.get_namespace()._new_branchpoint(loop_node) 541 542 def new_branch(self, node): 543 self.get_namespace()._new_branch(node) 544 545 def abandon_branch(self): 546 self.get_namespace()._abandon_branch() 547 548 def suspend_broken_branch(self): 549 self.get_namespace()._suspend_broken_branch() 550 551 def suspend_continuing_branch(self): 552 self.get_namespace()._suspend_continuing_branch() 553 554 def shelve_branch(self): 555 self.get_namespace()._shelve_branch() 556 557 def merge_branches(self): 558 self.get_namespace()._merge_branches() 559 560 def resume_broken_branches(self): 561 self.get_namespace()._resume_broken_branches() 562 563 def resume_continuing_branches(self): 564 self.get_namespace()._resume_continuing_branches() 565 566 def resume_abandoned_branches(self): 567 self.get_namespace()._resume_abandoned_branches() 568 569 def define_attribute_user(self, node): 570 571 """ 572 Define 'node' as the user of attributes, indicating the point where the 573 user is defined. 574 """ 575 576 self.get_namespace()._define_attribute_user(node) 577 578 def use_attribute(self, name, attrname, value=None): 579 580 """ 581 Note usage on the attribute user 'name' of the attribute 'attrname', 582 noting an assignment if 'value' is specified. 583 """ 584 585 return self.get_namespace()._use_attribute(name, attrname, value) 586 587 def use_specific_attribute(self, objname, attrname, from_name=None): 588 589 """ 590 Note usage on the object having the given 'objname' of the attribute 591 'attrname'. If 'objname' is None, the current namespace is chosen as the 592 object providing the attribute. 593 """ 594 595 return self.get_namespace()._use_specific_attribute(objname, attrname, from_name) 596 597 def define_attribute_accessor(self, name, attrname, node, value=None): 598 599 """ 600 Note applicable attribute users providing the given 'name' when 601 accessing the given 'attrname' on the specified 'node', with the 602 optional 'value' indicating an assignment. 603 """ 604 605 self.get_namespace()._define_attribute_accessor(name, attrname, node, value) 606 607 # Visitor methods. 608 609 def default(self, node, *args): 610 raise InspectError("Node class %r is not supported." % node.__class__) 611 612 def NOP(self, node): 613 for n in node.getChildNodes(): 614 self.dispatch(n) 615 616 def NOP_ABANDON(self, node): 617 self.NOP(node) 618 self.abandon_branch() 619 620 def TEST_NOP(self, node): 621 self.use_name("__bool__", node) 622 self.NOP(node) 623 624 def OP(self, node): 625 for n in node.getChildNodes(): 626 self.dispatch(n) 627 return make_instance() 628 629 def TEST_OP(self, node): 630 self.use_name("__bool__", node) 631 self.new_branchpoint() 632 633 # Propagate attribute usage to branches. 634 # Each node starts a new conditional region, effectively making a deeply 635 # nested collection of if-like statements. 636 637 for n in node.nodes: 638 self.new_branch(n) 639 self.dispatch(n) 640 641 # The nested regions must be terminated. 642 643 for n in node.nodes: 644 self.shelve_branch() 645 646 self.merge_branches() 647 return make_instance() 648 649 # Generic support for classes of operations. 650 651 def _ensureOperators(self, node): 652 attr, scope, namespace = self._get_with_scope("$operator") 653 if attr is None: 654 module = node._module 655 module.complete() 656 self["$operator"] = module 657 else: 658 module = attr.get_value() 659 return module 660 661 def _visitOperator(self, node, operator_name=None): 662 663 "Accounting method for the operator 'node'." 664 665 operator_module = self._ensureOperators(node) 666 operator_fn = operator_functions[operator_name or node.__class__.__name__] 667 self.use_specific_attribute(operator_module.full_name(), operator_fn) 668 return self.OP(node) 669 670 def _visitAttr(self, expr, attrname, node): 671 672 """ 673 Process the attribute provided by the given 'expr' with the given 674 'attrname' and involving the given 'node'. 675 """ 676 677 # Attempt to identify the nature of the attribute. 678 679 if isinstance(expr, BaseAttr): 680 if isinstance(expr, LocalAttr): 681 value = expr.attr.get_value() 682 else: 683 value = expr.get_value() 684 685 # Get the attribute and record its usage. 686 # NOTE: Need to provide concrete values for things like base classes 687 # NOTE: while also handling module attribute modification. 688 689 # Only specific class attributes are detected here since class 690 # attribute finalisation has not yet occurred. 691 692 if isinstance(value, (Class, Module)): 693 694 # Check for class.__class__. 695 696 if attrname == "__class__" and isinstance(value, Class): 697 attr = get_constant_class("type") 698 else: 699 attr = value.get(attrname) or make_instance() 700 self.use_specific_attribute(value.full_name(), attrname) 701 702 elif isinstance(value, UnresolvedName): 703 attr = UnresolvedName(attrname, value.full_name(), self) 704 705 # The actual attribute is not readily identifiable and is assumed 706 # to be an instance. 707 708 else: 709 710 # Record any instance attributes. 711 712 if expr.name == "self": 713 self.store_instance_attr(attrname, tentative=True) 714 715 attr = make_instance() 716 717 # Note usage of the attribute where a local is involved. 718 719 self._visitAttrUser(expr, attrname, node) 720 721 # Constants provide specific kinds of expressions. 722 # NOTE: If attributes are accessed on a pre-made, but not yet defined 723 # NOTE: class, no useful attribute will be available. 724 725 elif isinstance(expr, Const): 726 attr = get_constant_class(expr.get_class_name()).all_attributes().get(attrname) or make_instance() 727 728 # No particular attribute has been identified, thus a general instance 729 # is assumed. 730 731 else: 732 attr = make_instance() 733 self.use_name(attrname, node) 734 735 return attr 736 737 def _visitAttrUser(self, expr, attrname, node, value=None): 738 739 """ 740 Note usage of the attribute provided by 'expr' with the given 'attrname' 741 where a local is involved, annotating the given 'node'. If the optional 742 'value' is given, note an assignment for future effects on attributes 743 where such attributes are inferred from the usage. 744 """ 745 746 # Access to attributes via a local in functions, classes or modules. 747 # Since module-level locals are globals that can be modified 748 # independently of the namespace, any attribute usage observations made 749 # here may be revoked later if such modification is thought to occur. 750 751 if expr.parent is self.get_namespace(): 752 self.define_attribute_accessor(expr.name, attrname, node, value) 753 else: 754 self.use_name(attrname, node.expr, value, ns=expr.parent) 755 756 def _visitConst(self, value): 757 758 """ 759 Register the constant given by 'value', if necessary, returning the 760 resulting object. The type name is noted as being used, thus preserving 761 the class in any generated program. 762 """ 763 764 self.use_specific_attribute("__builtins__", self.importer.get_constant_type_name(value)) 765 const = self.importer.make_constant(value) 766 self.use_constant(const) 767 return const 768 769 def _visitFunction(self, node, name): 770 771 """ 772 Return a function object for the function defined by 'node' with the 773 given 'name'. If a lambda expression is being visited, 'name' should be 774 None. 775 """ 776 777 # Define the function object. 778 779 function = get_function( 780 name, 781 self.get_namespace(), 782 node.argnames, 783 node.defaults, 784 (node.flags & 4 != 0), 785 (node.flags & 8 != 0), 786 self.in_loop or self.in_function, 787 self, 788 node 789 ) 790 791 self.add_object(function, any_scope=1) 792 793 # Make a back reference from the node for code generation. 794 795 node.unit = function 796 797 # Process the defaults. 798 799 for n in node.defaults: 800 self.expr = self.dispatch(n) 801 function.store_default(self.expr) 802 803 # Note attribute usage where tuple parameters are involved. 804 805 if function.tuple_parameters(): 806 self.use_name("__getitem__", node) 807 808 # Record the namespace context of the function for later processing. 809 810 self.functions.append((node, self.namespaces + [function])) 811 812 # Store the function. 813 814 if name is not None: 815 self.define_attribute_user(compiler.ast.AssName(name, "OP_ASSIGN")) 816 self.store(name, function, static_def=True) 817 else: 818 self.store_lambda(function) 819 820 # Test the defaults and assess whether an dynamic object will result. 821 822 function.make_dynamic() 823 return function 824 825 def _visitFunctionBody(self, node, namespaces): 826 827 "Enter the function." 828 829 # Current namespace is the function. 830 # Previous namespace is the class. 831 832 if self.in_class(namespaces): 833 self.in_method = True 834 835 in_function = self.in_function 836 in_loop = self.in_loop 837 self.in_function = True 838 self.in_loop = False 839 840 self.namespaces = namespaces 841 self.dispatch(node.code) 842 843 self.in_loop = in_loop 844 self.in_function = in_function 845 self.in_method = False 846 847 # Specific handler methods. 848 849 visitAdd = _visitOperator 850 851 visitAnd = TEST_OP 852 853 visitAssert = NOP 854 855 def visitAssign(self, node): 856 self.expr = self.dispatch(node.expr) 857 self.in_assignment = True 858 for n in node.nodes: 859 self.dispatch(n) 860 self.in_assignment = False 861 862 def visitAssAttr(self, node): 863 expr = self.dispatch(node.expr) 864 attrname = node.attrname 865 866 # Record the attribute on the presumed target. 867 868 if isinstance(expr, BaseAttr): 869 if isinstance(expr, LocalAttr): 870 value = expr.attr.get_value() 871 else: 872 value = expr.get_value() 873 874 if expr.name == "self": 875 self.store_instance_attr(attrname) 876 self.use_attribute(expr.name, attrname, value) 877 self._visitAttrUser(expr, attrname, node, self.expr) 878 879 # No definite attribute can be identified, since the instance 880 # being accessed may be a subclass of the method's class. 881 882 attr = make_instance() 883 884 elif isinstance(value, Module): 885 self.store_module_attr(attrname, value) 886 attr = value.get(attrname) 887 888 elif isinstance(value, Class): 889 self.store_class_attr(attrname, value) 890 attr = value.get(attrname) 891 892 # Note usage of the attribute where a local is involved. 893 894 else: 895 self._visitAttrUser(expr, attrname, node, self.expr) 896 attr = make_instance() 897 898 else: 899 self.use_name(attrname, node) 900 attr = make_instance() 901 902 node._expr = expr 903 node._attr = attr 904 905 def visitAssList(self, node): 906 907 # Declare names which will be used by generated code. 908 909 self.use_name("__getitem__", node) 910 911 # Process the assignment. 912 913 expr = self.expr 914 self.expr = make_instance() # each element is a result of an item access 915 916 for i, n in enumerate(node.nodes): 917 self.dispatch(n) 918 self._visitConst(i) # for __getitem__(i) at run-time 919 920 self.expr = expr 921 922 def visitAssName(self, node): 923 if node.flags == "OP_DELETE": 924 print >>sys.stderr, "Warning: deletion of attribute %r in %r is not supported." % (node.name, self.full_name()) 925 #raise InspectError("Deletion of attribute %r is not supported." % node.name) 926 self._visitAssName(node) 927 928 def _visitAssName(self, node): 929 self.define_attribute_user(node) 930 self.store(node.name, self.expr) 931 932 # Ensure the presence of the given name in this namespace. 933 # NOTE: Consider not registering assignments involving methods, since 934 # NOTE: this is merely creating aliases for such methods. 935 936 if isinstance(self.get_namespace(), (Class, Module)): 937 if isinstance(self.expr, BaseAttr): 938 if isinstance(self.expr, LocalAttr): 939 value = self.expr.attr.get_value() 940 else: 941 value = self.expr.get_value() 942 else: 943 value = None 944 if not value or not isinstance(value, Function): 945 self.use_specific_attribute(None, node.name) 946 else: 947 fn = value 948 ns = self.get_namespace().full_name() 949 self.use_specific_attribute(fn.parent.full_name(), fn.name, "%s.%s" % (ns, node.name)) 950 951 visitAssTuple = visitAssList 952 953 def visitAugAssign(self, node): 954 955 # Accounting. 956 957 operator_fn = operator_functions.get(node.op) 958 operator_module = self._ensureOperators(node) 959 self.use_specific_attribute(operator_module.full_name(), operator_fn) 960 961 # Process the assignment. 962 963 self.expr = self.dispatch(node.expr) 964 self.dispatch(node.node) 965 966 # NOTE: Slices and subscripts are supported by __setitem__(slice) and 967 # NOTE: not __setslice__. 968 969 if isinstance(node.node, compiler.ast.Name): 970 self._visitAssName(node.node) 971 elif isinstance(node.node, compiler.ast.Getattr): 972 self.visitAssAttr(node.node) 973 else: 974 self.use_specific_attribute("__builtins__", "slice") 975 self.use_name("__setitem__", node) 976 977 visitBackquote = OP 978 979 visitBitand = _visitOperator 980 981 visitBitor = _visitOperator 982 983 visitBitxor = _visitOperator 984 985 def visitBreak(self, node): 986 self.NOP(node) 987 self.suspend_broken_branch() 988 989 visitCallFunc = OP 990 991 def visitClass(self, node): 992 993 """ 994 Register the class at the given 'node' subject to the restrictions 995 mentioned in the module docstring. 996 """ 997 998 if self.namespaces: 999 print >>sys.stderr, "Warning: class %r in %r is not global: ignored." % (node.name, self.namespaces[-1].full_name()) 1000 return 1001 else: 1002 if self.in_loop: 1003 print >>sys.stderr, "Warning: class %r in %r defined in a loop." % (node.name, self.full_name()) 1004 1005 cls = get_class(node.name, self.get_namespace(), self, node) 1006 1007 # Make a back reference from the node for code generation. 1008 1009 node.unit = cls 1010 1011 # Process base classes in the context of the class's namespace. 1012 # This confines references to such classes to the class instead of 1013 # the namespace in which it is defined. 1014 1015 self.namespaces.append(cls) 1016 1017 # Visit the base class expressions, attempting to find concrete 1018 # definitions of classes. 1019 1020 for base in node.bases: 1021 expr = self.dispatch(base) 1022 1023 # Each base class must be constant and known at compile-time. 1024 1025 if isinstance(expr, BaseAttr): 1026 if isinstance(expr, LocalAttr): 1027 value = expr.attr.get_value() 1028 else: 1029 value = expr.get_value() 1030 1031 if not value: 1032 raise InspectError("Base class %r for %r is not constant: %r" % (base, cls.full_name(), expr)) 1033 elif not isinstance(value, Class): 1034 raise InspectError("Base class %r for %r is not a class: %r" % (base, cls.full_name(), value)) 1035 else: 1036 cls.add_base(value) 1037 1038 # Where no expression value is available, the base class is 1039 # not identifiable. 1040 1041 else: 1042 raise InspectError("Base class %r for %r is not found: it may be hidden in some way." % (base, cls.full_name())) 1043 1044 # NOTE: Potentially dubious measure to permit __init__ availability. 1045 # If no bases exist, adopt the 'object' class. 1046 1047 if not node.bases and not (self.name == "__builtins__" and node.name == "object"): 1048 expr = self.dispatch(compiler.ast.Name("object")) 1049 cls.add_base(expr.get_value()) 1050 1051 # Make an entry for the class in the parent namespace. 1052 1053 self.namespaces.pop() 1054 self.define_attribute_user(compiler.ast.AssName(node.name, "OP_ASSIGN")) 1055 self.store(node.name, cls, static_def=True) 1056 self.add_object(cls) 1057 1058 # Process the class body in its own namespace. 1059 # Add __name__ to the namespace. 1060 1061 self.namespaces.append(cls) 1062 self.store("__name__", self._visitConst(node.name)) 1063 self.dispatch(node.code) 1064 self.namespaces.pop() 1065 1066 cls.finalise_attribute_usage() 1067 return cls 1068 1069 def visitCompare(self, node): 1070 1071 # Accounting. 1072 # NOTE: Replicates some code in micropython.ast.visitCompare. 1073 1074 self.use_name("__bool__", node) 1075 1076 this_node = node 1077 1078 for op in node.ops: 1079 op_name, next_node = op 1080 1081 # Define name/attribute usage. 1082 # Get the applicable operation. 1083 1084 operator_fn = operator_functions.get(op_name) 1085 1086 # For operators, reference the specific function involved. 1087 1088 if operator_fn is not None: 1089 operator_module = self._ensureOperators(node) 1090 self.use_specific_attribute(operator_module.full_name(), operator_fn) 1091 1092 # Define __contains__ usage on the next node. 1093 1094 elif op_name.endswith("in"): 1095 self.use_name("__contains__", next_node) 1096 1097 this_node = next_node 1098 1099 return self.OP(node) 1100 1101 def visitConst(self, node): 1102 return self._visitConst(node.value) 1103 1104 def visitContinue(self, node): 1105 self.NOP(node) 1106 self.suspend_continuing_branch() 1107 1108 visitDecorators = NOP 1109 1110 def visitDict(self, node): 1111 self.use_specific_attribute("__builtins__", "dict") 1112 return self.OP(node) 1113 1114 visitDiscard = NOP 1115 1116 visitDiv = _visitOperator 1117 1118 visitEllipsis = NOP 1119 1120 visitExec = NOP 1121 1122 visitExpression = OP 1123 1124 visitFloorDiv = _visitOperator 1125 1126 def visitFor(self, node): 1127 self.new_branchpoint(node) 1128 1129 # Declare names which will be used by generated code. 1130 1131 self.use_name("__iter__", node.list) 1132 self.use_name("next") 1133 self.use_name("StopIteration") 1134 1135 in_loop = self.in_loop 1136 self.in_loop = True 1137 self.dispatch(node.list) 1138 1139 # NOTE: Could generate AST nodes for the actual operations instead of 1140 # NOTE: manually generating code in micropython.ast. 1141 1142 self.expr = make_instance() # each element is a result of a function call 1143 self.dispatch(node.assign) 1144 1145 # Enter the loop. 1146 # Propagate attribute usage to branches. 1147 1148 self.new_branch(node) 1149 self.dispatch(node.body) 1150 1151 self.resume_continuing_branches() 1152 1153 self.shelve_branch() 1154 1155 self.in_loop = in_loop 1156 1157 # A null branch is used to record a path around the loop. 1158 1159 self.new_branch(node.else_ or NullBranch()) 1160 self.shelve_branch() 1161 1162 self.merge_branches() 1163 1164 # The else clause is evaluated outside any branch. 1165 1166 if node.else_ is not None: 1167 self.dispatch(node.else_) 1168 1169 # Any suspended branches from the loop can now be resumed. 1170 1171 self.resume_broken_branches() 1172 1173 def visitFrom(self, node): 1174 modname, names = get_module_name(node, self) 1175 1176 if not modname: 1177 return self._visitImport(names) 1178 1179 module = self.complete_import(modname, True) 1180 1181 for name, alias in node.names: 1182 1183 # For specific names, obtain and store referenced objects using 1184 # the name or any alias provided in the current namespace. 1185 1186 if name != "*": 1187 if module: 1188 1189 # Missing names may refer to submodules. 1190 1191 submodule = self.complete_import(modname + "." + name, True) 1192 if submodule: 1193 if not module.has_key(name): 1194 module.store(name, submodule) 1195 1196 # Complete the import if the name was found. 1197 1198 if module.has_key(name): 1199 attr = module[name] 1200 self.store(alias or name, attr) 1201 self.use_specific_attribute(module.full_name(), name) 1202 continue 1203 1204 # Support the import of names from missing modules. 1205 1206 self.store(alias or name, UnresolvedName(name, modname, self)) 1207 1208 # For wildcards, obtain and store all objects from a module in the 1209 # current namespace. 1210 1211 else: 1212 if module: 1213 for n in module.keys(): 1214 attr = module[n] 1215 self.store(n, attr) 1216 self.use_specific_attribute(module.full_name(), n) 1217 1218 def visitFunction(self, node): 1219 return self._visitFunction(node, node.name) 1220 1221 # NOTE: GenExpr support is very similar to ListComp support. 1222 1223 def visitGenExpr(self, node): 1224 self.dispatch(node.code) 1225 1226 def visitGenExprInner(self, node): 1227 1228 # Note that explicit dispatch is performed. 1229 1230 if node.quals: 1231 self.visitGenExprFor(node.quals[0], node.quals[1:], node.expr) 1232 return make_instance() 1233 1234 def visitGenExprFor(self, node, following_quals, expr): 1235 self.new_branchpoint() 1236 1237 # Declare names which will be used by generated code. 1238 1239 self.use_name("__iter__", node.iter) 1240 self.use_name("next") 1241 1242 in_loop = self.in_loop 1243 self.in_loop = True 1244 self.dispatch(node.iter) 1245 1246 # NOTE: Could generate AST nodes for the actual operations instead of 1247 # NOTE: manually generating code in micropython.ast. 1248 1249 self.expr = make_instance() # each element is a result of a function call 1250 self.dispatch(node.assign) 1251 1252 # Enter the loop. 1253 # Propagate attribute usage to branches. 1254 1255 self.new_branch(node) 1256 1257 # Note that explicit dispatch is performed. 1258 1259 if node.ifs: 1260 self.visitGenExprIf(node.ifs[0], node.ifs[1:], following_quals, expr) 1261 elif following_quals: 1262 self.visitGenExprFor(following_quals[0], following_quals[1:], expr) 1263 else: 1264 self.dispatch(expr) 1265 1266 self.shelve_branch() 1267 self.in_loop = in_loop 1268 1269 self.merge_branches() 1270 1271 def visitGenExprIf(self, node, following_ifs, following_quals, expr): 1272 self.use_name("__bool__", node) 1273 self.new_branchpoint() 1274 1275 # Propagate attribute usage to branches. 1276 1277 self.dispatch(node.test) 1278 1279 # Note that explicit dispatch is performed. 1280 1281 if following_ifs: 1282 self.visitGenExprIf(following_ifs[0], following_ifs[1:], following_quals, expr) 1283 elif following_quals: 1284 self.visitGenExprFor(following_quals[0], following_quals[1:], expr) 1285 else: 1286 self.new_branch(expr) 1287 self.dispatch(expr) 1288 self.shelve_branch() 1289 1290 # Maintain a branch for the else clause. 1291 1292 self.new_branch(NullBranch()) 1293 self.shelve_branch() 1294 1295 self.merge_branches() 1296 1297 def visitGetattr(self, node): 1298 node._expr = self.dispatch(node.expr) 1299 node._attr = self._visitAttr(node._expr, node.attrname, node) 1300 return node._attr 1301 1302 def visitGlobal(self, node): 1303 if self.namespaces: 1304 for name in node.names: 1305 ns = self.namespaces[-1] 1306 if not ns.make_global(name): 1307 raise InspectError("Name %r is global and local in %r" % (name, ns.full_name())) 1308 1309 # The name is recorded in an earlier process. 1310 1311 def visitIf(self, node): 1312 self.use_name("__bool__", node) 1313 self.new_branchpoint() 1314 1315 # Propagate attribute usage to branches. 1316 1317 for test, body in node.tests: 1318 self.dispatch(test) 1319 1320 self.new_branch(body) 1321 self.dispatch(body) 1322 self.shelve_branch() 1323 1324 # Maintain a branch for the else clause. 1325 1326 self.new_branch(node.else_ or NullBranch()) 1327 if node.else_ is not None: 1328 self.dispatch(node.else_) 1329 self.shelve_branch() 1330 1331 self.merge_branches() 1332 1333 def visitIfExp(self, node): 1334 self.use_name("__bool__", node) 1335 self.new_branchpoint() 1336 1337 # Propagate attribute usage to branches. 1338 1339 self.dispatch(node.test) 1340 1341 self.new_branch(node.then) 1342 self.dispatch(node.then) 1343 self.shelve_branch() 1344 1345 self.new_branch(node.else_) 1346 self.dispatch(node.else_) 1347 self.shelve_branch() 1348 1349 self.merge_branches() 1350 return make_instance() # either outcome is possible 1351 1352 def visitImport(self, node): 1353 self._visitImport(node.names) 1354 1355 def _visitImport(self, names): 1356 for name, alias in names: 1357 module = self.complete_import(name, alias) 1358 if alias is not None: 1359 self.store(alias, module or UnresolvedName(None, name, self)) 1360 else: 1361 name_used = name.split(".")[0] 1362 self.store(name_used, module or UnresolvedName(None, name_used, self)) 1363 1364 visitInvert = _visitOperator 1365 1366 def visitKeyword(self, node): 1367 self.dispatch(node.expr) 1368 self._visitConst(node.name) 1369 self.keyword_names.add(node.name) 1370 1371 def visitLambda(self, node): 1372 fn = self._visitFunction(node, None) 1373 self.use_specific_attribute(None, fn.name) 1374 return fn 1375 1376 visitLeftShift = _visitOperator 1377 1378 def visitList(self, node): 1379 self.use_specific_attribute("__builtins__", "list") 1380 return self.OP(node) 1381 1382 def visitListComp(self, node): 1383 1384 # Note that explicit dispatch is performed. 1385 1386 if node.quals: 1387 self.visitListCompFor(node.quals[0], node.quals[1:], node.expr) 1388 return make_instance() 1389 1390 def visitListCompFor(self, node, following_quals, expr): 1391 self.new_branchpoint() 1392 1393 # Declare names which will be used by generated code. 1394 1395 self.use_name("__iter__", node.list) 1396 self.use_name("next") 1397 1398 in_loop = self.in_loop 1399 self.in_loop = True 1400 self.dispatch(node.list) 1401 1402 # NOTE: Could generate AST nodes for the actual operations instead of 1403 # NOTE: manually generating code in micropython.ast. 1404 1405 self.expr = make_instance() # each element is a result of a function call 1406 self.dispatch(node.assign) 1407 1408 # Enter the loop. 1409 # Propagate attribute usage to branches. 1410 1411 self.new_branch(node) 1412 1413 # Note that explicit dispatch is performed. 1414 1415 if node.ifs: 1416 self.visitListCompIf(node.ifs[0], node.ifs[1:], following_quals, expr) 1417 elif following_quals: 1418 self.visitListCompFor(following_quals[0], following_quals[1:], expr) 1419 else: 1420 self.dispatch(expr) 1421 1422 self.shelve_branch() 1423 self.in_loop = in_loop 1424 1425 self.merge_branches() 1426 1427 def visitListCompIf(self, node, following_ifs, following_quals, expr): 1428 self.use_name("__bool__", node) 1429 self.new_branchpoint() 1430 1431 # Propagate attribute usage to branches. 1432 1433 self.dispatch(node.test) 1434 1435 # Note that explicit dispatch is performed. 1436 1437 if following_ifs: 1438 self.visitListCompIf(following_ifs[0], following_ifs[1:], following_quals, expr) 1439 elif following_quals: 1440 self.visitListCompFor(following_quals[0], following_quals[1:], expr) 1441 else: 1442 self.new_branch(expr) 1443 self.dispatch(expr) 1444 self.shelve_branch() 1445 1446 # Maintain a branch for the else clause. 1447 1448 self.new_branch(NullBranch()) 1449 self.shelve_branch() 1450 1451 self.merge_branches() 1452 1453 visitMod = _visitOperator 1454 1455 def visitModule(self, node): 1456 1457 # Make a back reference from the node for code generation. 1458 1459 node.unit = self 1460 return self.dispatch(node.node) 1461 1462 visitMul = _visitOperator 1463 1464 def visitName(self, node): 1465 attr = self.get_namespace().get_using_node(node.name, node) or make_instance() 1466 node._attr = self.get_namespace().get_for_local(node.name) or attr 1467 return node._attr 1468 1469 def visitNot(self, node): 1470 self.use_name("__bool__", node) 1471 self.dispatch(node.expr) 1472 return make_instance() 1473 1474 visitOr = TEST_OP 1475 1476 visitPass = NOP 1477 1478 visitPower = _visitOperator 1479 1480 def _visitPrint(self, node, function_name): 1481 self.NOP(node) 1482 self.use_specific_attribute("__builtins__", function_name) 1483 1484 def visitPrint(self, node): 1485 self._visitPrint(node, "_print") 1486 1487 def visitPrintnl(self, node): 1488 self._visitPrint(node, "_printnl") 1489 1490 visitRaise = NOP_ABANDON 1491 1492 visitReturn = NOP_ABANDON 1493 1494 visitRightShift = _visitOperator 1495 1496 def visitSet(self, node): 1497 self.use_specific_attribute("__builtins__", "set") 1498 return self.OP(node) 1499 1500 def visitSlice(self, node): 1501 return self._visitOperator(node, self.in_assignment and "AssSlice" or "Slice") 1502 1503 visitSliceobj = OP 1504 1505 def visitStmt(self, node): 1506 for n in node.nodes: 1507 self.dispatch(n) 1508 1509 visitSub = _visitOperator 1510 1511 def visitSubscript(self, node): 1512 return self._visitOperator(node, self.in_assignment and "AssSubscript" or "Subscript") 1513 1514 def visitTryExcept(self, node): 1515 self.new_branchpoint() 1516 self.dispatch(node.body) 1517 1518 for name, var, n in node.handlers: 1519 if name is not None: 1520 self.dispatch(name) 1521 1522 self.new_branch(n) 1523 1524 # Any abandoned branches from the body can now be resumed. 1525 1526 self.resume_abandoned_branches() 1527 1528 # Establish the local for the handler. 1529 1530 if var is not None: 1531 self.dispatch(var) 1532 if n is not None: 1533 self.dispatch(n) 1534 1535 self.shelve_branch() 1536 1537 # The else clause maintains the usage from the body but without the 1538 # abandoned branches since they would never lead to the else clause 1539 # being executed. 1540 1541 self.new_branch(node.else_ or NullBranch()) 1542 if node.else_ is not None: 1543 self.dispatch(node.else_) 1544 self.shelve_branch() 1545 1546 self.merge_branches() 1547 1548 visitTryFinally = NOP 1549 1550 visitTuple = OP 1551 1552 visitUnaryAdd = _visitOperator 1553 1554 visitUnarySub = _visitOperator 1555 1556 def visitWhile(self, node): 1557 self.use_name("__bool__", node) 1558 self.new_branchpoint(node) 1559 1560 # Propagate attribute usage to branches. 1561 1562 in_loop = self.in_loop 1563 self.in_loop = True 1564 1565 # The test is evaluated initially and again in the loop. 1566 1567 self.dispatch(node.test) 1568 1569 self.new_branch(node) 1570 self.dispatch(node.body) 1571 1572 self.resume_continuing_branches() 1573 1574 self.dispatch(node.test) 1575 self.shelve_branch() 1576 1577 self.in_loop = in_loop 1578 1579 # A null branch is used to record a path around the loop. 1580 1581 self.new_branch(node.else_ or NullBranch()) 1582 self.shelve_branch() 1583 1584 self.merge_branches() 1585 1586 # The else clause is evaluated outside any branch. 1587 1588 if node.else_ is not None: 1589 self.dispatch(node.else_) 1590 1591 # Any suspended branches from the loop can now be resumed. 1592 1593 self.resume_broken_branches() 1594 1595 visitWith = NOP 1596 1597 visitYield = NOP 1598 1599 # vim: tabstop=4 expandtab shiftwidth=4