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, 787 node 788 ) 789 790 self.add_object(function, any_scope=1) 791 792 # Make a back reference from the node for code generation. 793 794 node.unit = function 795 796 # Process the defaults. 797 798 for n in node.defaults: 799 self.expr = self.dispatch(n) 800 function.store_default(self.expr) 801 802 # Note attribute usage where tuple parameters are involved. 803 804 if function.tuple_parameters(): 805 self.use_name("__getitem__", node) 806 807 # Record the namespace context of the function for later processing. 808 809 self.functions.append((node, self.namespaces + [function])) 810 811 # Store the function. 812 813 if name is not None: 814 self.define_attribute_user(compiler.ast.AssName(name, "OP_ASSIGN")) 815 self.store(name, function, static_def=True) 816 else: 817 self.store_lambda(function) 818 819 # Test the defaults and assess whether an dynamic object will result. 820 821 function.make_dynamic() 822 return function 823 824 def _visitFunctionBody(self, node, namespaces): 825 826 "Enter the function." 827 828 # Current namespace is the function. 829 # Previous namespace is the class. 830 831 if self.in_class(namespaces): 832 self.in_method = True 833 834 in_function = self.in_function 835 in_loop = self.in_loop 836 self.in_function = True 837 self.in_loop = False 838 839 self.namespaces = namespaces 840 self.dispatch(node.code) 841 842 self.in_loop = in_loop 843 self.in_function = in_function 844 self.in_method = False 845 846 # Specific handler methods. 847 848 visitAdd = _visitOperator 849 850 visitAnd = TEST_OP 851 852 visitAssert = NOP 853 854 def visitAssign(self, node): 855 self.expr = self.dispatch(node.expr) 856 self.in_assignment = True 857 for n in node.nodes: 858 self.dispatch(n) 859 self.in_assignment = False 860 861 def visitAssAttr(self, node): 862 expr = self.dispatch(node.expr) 863 attrname = node.attrname 864 865 # Record the attribute on the presumed target. 866 867 if isinstance(expr, BaseAttr): 868 if isinstance(expr, LocalAttr): 869 value = expr.attr.get_value() 870 else: 871 value = expr.get_value() 872 873 if expr.name == "self": 874 self.store_instance_attr(attrname) 875 self.use_attribute(expr.name, attrname, value) 876 self._visitAttrUser(expr, attrname, node, self.expr) 877 878 # No definite attribute can be identified, since the instance 879 # being accessed may be a subclass of the method's class. 880 881 attr = make_instance() 882 883 elif isinstance(value, Module): 884 self.store_module_attr(attrname, value) 885 attr = value.get(attrname) 886 887 elif isinstance(value, Class): 888 self.store_class_attr(attrname, value) 889 attr = value.get(attrname) 890 891 # Note usage of the attribute where a local is involved. 892 893 else: 894 self._visitAttrUser(expr, attrname, node, self.expr) 895 attr = make_instance() 896 897 else: 898 self.use_name(attrname, node) 899 attr = make_instance() 900 901 node._expr = expr 902 node._attr = attr 903 904 def visitAssList(self, node): 905 906 # Declare names which will be used by generated code. 907 908 self.use_name("__getitem__", node) 909 910 # Process the assignment. 911 912 expr = self.expr 913 self.expr = make_instance() # each element is a result of an item access 914 915 for i, n in enumerate(node.nodes): 916 self.dispatch(n) 917 self._visitConst(i) # for __getitem__(i) at run-time 918 919 self.expr = expr 920 921 def visitAssName(self, node): 922 if node.flags == "OP_DELETE": 923 print >>sys.stderr, "Warning: deletion of attribute %r in %r is not supported." % (node.name, self.full_name()) 924 #raise InspectError("Deletion of attribute %r is not supported." % node.name) 925 self._visitAssName(node) 926 927 def _visitAssName(self, node): 928 self.define_attribute_user(node) 929 self.store(node.name, self.expr) 930 931 # Ensure the presence of the given name in this namespace. 932 # NOTE: Consider not registering assignments involving methods, since 933 # NOTE: this is merely creating aliases for such methods. 934 935 if isinstance(self.get_namespace(), (Class, Module)): 936 if isinstance(self.expr, BaseAttr): 937 if isinstance(self.expr, LocalAttr): 938 value = self.expr.attr.get_value() 939 else: 940 value = self.expr.get_value() 941 else: 942 value = None 943 if not value or not isinstance(value, Function): 944 self.use_specific_attribute(None, node.name) 945 else: 946 fn = value 947 ns = self.get_namespace().full_name() 948 self.use_specific_attribute(fn.parent.full_name(), fn.name, "%s.%s" % (ns, node.name)) 949 950 visitAssTuple = visitAssList 951 952 def visitAugAssign(self, node): 953 954 # Accounting. 955 956 operator_fn = operator_functions.get(node.op) 957 operator_module = self._ensureOperators(node) 958 self.use_specific_attribute(operator_module.full_name(), operator_fn) 959 960 # Process the assignment. 961 962 self.expr = self.dispatch(node.expr) 963 self.dispatch(node.node) 964 965 # NOTE: Slices and subscripts are supported by __setitem__(slice) and 966 # NOTE: not __setslice__. 967 968 if isinstance(node.node, compiler.ast.Name): 969 self._visitAssName(node.node) 970 elif isinstance(node.node, compiler.ast.Getattr): 971 self.visitAssAttr(node.node) 972 else: 973 self.use_specific_attribute("__builtins__", "slice") 974 self.use_name("__setitem__", node) 975 976 visitBackquote = OP 977 978 visitBitand = _visitOperator 979 980 visitBitor = _visitOperator 981 982 visitBitxor = _visitOperator 983 984 def visitBreak(self, node): 985 self.NOP(node) 986 self.suspend_broken_branch() 987 988 visitCallFunc = OP 989 990 def visitClass(self, node): 991 992 """ 993 Register the class at the given 'node' subject to the restrictions 994 mentioned in the module docstring. 995 """ 996 997 if self.namespaces: 998 print >>sys.stderr, "Warning: class %r in %r is not global: ignored." % (node.name, self.namespaces[-1].full_name()) 999 return 1000 else: 1001 if self.in_loop: 1002 print >>sys.stderr, "Warning: class %r in %r defined in a loop." % (node.name, self.full_name()) 1003 1004 cls = get_class(node.name, self.get_namespace(), self, node) 1005 1006 # Make a back reference from the node for code generation. 1007 1008 node.unit = cls 1009 1010 # Process base classes in the context of the class's namespace. 1011 # This confines references to such classes to the class instead of 1012 # the namespace in which it is defined. 1013 1014 self.namespaces.append(cls) 1015 1016 # Visit the base class expressions, attempting to find concrete 1017 # definitions of classes. 1018 1019 for base in node.bases: 1020 expr = self.dispatch(base) 1021 1022 # Each base class must be constant and known at compile-time. 1023 1024 if isinstance(expr, BaseAttr): 1025 if isinstance(expr, LocalAttr): 1026 value = expr.attr.get_value() 1027 else: 1028 value = expr.get_value() 1029 1030 if not value: 1031 raise InspectError("Base class %r for %r is not constant: %r" % (base, cls.full_name(), expr)) 1032 elif not isinstance(value, Class): 1033 raise InspectError("Base class %r for %r is not a class: %r" % (base, cls.full_name(), value)) 1034 else: 1035 cls.add_base(value) 1036 1037 # Where no expression value is available, the base class is 1038 # not identifiable. 1039 1040 else: 1041 raise InspectError("Base class %r for %r is not found: it may be hidden in some way." % (base, cls.full_name())) 1042 1043 # NOTE: Potentially dubious measure to permit __init__ availability. 1044 # If no bases exist, adopt the 'object' class. 1045 1046 if not node.bases and not (self.name == "__builtins__" and node.name == "object"): 1047 expr = self.dispatch(compiler.ast.Name("object")) 1048 cls.add_base(expr.get_value()) 1049 1050 # Make an entry for the class in the parent namespace. 1051 1052 self.namespaces.pop() 1053 self.define_attribute_user(compiler.ast.AssName(node.name, "OP_ASSIGN")) 1054 self.store(node.name, cls, static_def=True) 1055 self.add_object(cls) 1056 1057 # Process the class body in its own namespace. 1058 # Add __name__ to the namespace. 1059 1060 self.namespaces.append(cls) 1061 self.store("__name__", self._visitConst(node.name)) 1062 self.dispatch(node.code) 1063 self.namespaces.pop() 1064 1065 cls.finalise_attribute_usage() 1066 return cls 1067 1068 def visitCompare(self, node): 1069 1070 # Accounting. 1071 # NOTE: Replicates some code in micropython.ast.visitCompare. 1072 1073 self.use_name("__bool__", node) 1074 1075 this_node = node 1076 1077 for op in node.ops: 1078 op_name, next_node = op 1079 1080 # Define name/attribute usage. 1081 # Get the applicable operation. 1082 1083 operator_fn = operator_functions.get(op_name) 1084 1085 # For operators, reference the specific function involved. 1086 1087 if operator_fn is not None: 1088 operator_module = self._ensureOperators(node) 1089 self.use_specific_attribute(operator_module.full_name(), operator_fn) 1090 1091 # Define __contains__ usage on the next node. 1092 1093 elif op_name.endswith("in"): 1094 self.use_name("__contains__", next_node) 1095 1096 this_node = next_node 1097 1098 return self.OP(node) 1099 1100 def visitConst(self, node): 1101 return self._visitConst(node.value) 1102 1103 def visitContinue(self, node): 1104 self.NOP(node) 1105 self.suspend_continuing_branch() 1106 1107 visitDecorators = NOP 1108 1109 def visitDict(self, node): 1110 self.use_specific_attribute("__builtins__", "dict") 1111 return self.OP(node) 1112 1113 visitDiscard = NOP 1114 1115 visitDiv = _visitOperator 1116 1117 visitEllipsis = NOP 1118 1119 visitExec = NOP 1120 1121 visitExpression = OP 1122 1123 visitFloorDiv = _visitOperator 1124 1125 def visitFor(self, node): 1126 self.new_branchpoint(node) 1127 1128 # Declare names which will be used by generated code. 1129 1130 self.use_name("__iter__", node.list) 1131 self.use_name("next") 1132 self.use_name("StopIteration") 1133 1134 in_loop = self.in_loop 1135 self.in_loop = True 1136 self.dispatch(node.list) 1137 1138 # NOTE: Could generate AST nodes for the actual operations instead of 1139 # NOTE: manually generating code in micropython.ast. 1140 1141 self.expr = make_instance() # each element is a result of a function call 1142 self.dispatch(node.assign) 1143 1144 # Enter the loop. 1145 # Propagate attribute usage to branches. 1146 1147 self.new_branch(node) 1148 self.dispatch(node.body) 1149 1150 self.resume_continuing_branches() 1151 1152 self.shelve_branch() 1153 1154 self.in_loop = in_loop 1155 1156 # A null branch is used to record a path around the loop. 1157 1158 self.new_branch(node.else_ or NullBranch()) 1159 self.shelve_branch() 1160 1161 self.merge_branches() 1162 1163 # The else clause is evaluated outside any branch. 1164 1165 if node.else_ is not None: 1166 self.dispatch(node.else_) 1167 1168 # Any suspended branches from the loop can now be resumed. 1169 1170 self.resume_broken_branches() 1171 1172 def visitFrom(self, node): 1173 modname, names = get_module_name(node, self) 1174 1175 if not modname: 1176 return self._visitImport(names) 1177 1178 module = self.complete_import(modname, True) 1179 1180 for name, alias in node.names: 1181 1182 # For specific names, obtain and store referenced objects using 1183 # the name or any alias provided in the current namespace. 1184 1185 if name != "*": 1186 if module: 1187 1188 # Missing names may refer to submodules. 1189 1190 submodule = self.complete_import(modname + "." + name, True) 1191 if submodule: 1192 if not module.has_key(name): 1193 module.store(name, submodule) 1194 1195 # Complete the import if the name was found. 1196 1197 if module.has_key(name): 1198 attr = module[name] 1199 self.store(alias or name, attr) 1200 self.use_specific_attribute(module.full_name(), name) 1201 continue 1202 1203 # Support the import of names from missing modules. 1204 1205 self.store(alias or name, UnresolvedName(name, modname, self)) 1206 1207 # For wildcards, obtain and store all objects from a module in the 1208 # current namespace. 1209 1210 else: 1211 if module: 1212 for n in module.keys(): 1213 attr = module[n] 1214 self.store(n, attr) 1215 self.use_specific_attribute(module.full_name(), n) 1216 1217 def visitFunction(self, node): 1218 return self._visitFunction(node, node.name) 1219 1220 # NOTE: GenExpr support is very similar to ListComp support. 1221 1222 def visitGenExpr(self, node): 1223 self.dispatch(node.code) 1224 1225 def visitGenExprInner(self, node): 1226 1227 # Note that explicit dispatch is performed. 1228 1229 if node.quals: 1230 self.visitGenExprFor(node.quals[0], node.quals[1:], node.expr) 1231 return make_instance() 1232 1233 def visitGenExprFor(self, node, following_quals, expr): 1234 self.new_branchpoint() 1235 1236 # Declare names which will be used by generated code. 1237 1238 self.use_name("__iter__", node.iter) 1239 self.use_name("next") 1240 1241 in_loop = self.in_loop 1242 self.in_loop = True 1243 self.dispatch(node.iter) 1244 1245 # NOTE: Could generate AST nodes for the actual operations instead of 1246 # NOTE: manually generating code in micropython.ast. 1247 1248 self.expr = make_instance() # each element is a result of a function call 1249 self.dispatch(node.assign) 1250 1251 # Enter the loop. 1252 # Propagate attribute usage to branches. 1253 1254 self.new_branch(node) 1255 1256 # Note that explicit dispatch is performed. 1257 1258 if node.ifs: 1259 self.visitGenExprIf(node.ifs[0], node.ifs[1:], following_quals, expr) 1260 elif following_quals: 1261 self.visitGenExprFor(following_quals[0], following_quals[1:], expr) 1262 else: 1263 self.dispatch(expr) 1264 1265 self.shelve_branch() 1266 self.in_loop = in_loop 1267 1268 self.merge_branches() 1269 1270 def visitGenExprIf(self, node, following_ifs, following_quals, expr): 1271 self.use_name("__bool__", node) 1272 self.new_branchpoint() 1273 1274 # Propagate attribute usage to branches. 1275 1276 self.dispatch(node.test) 1277 1278 # Note that explicit dispatch is performed. 1279 1280 if following_ifs: 1281 self.visitGenExprIf(following_ifs[0], following_ifs[1:], following_quals, expr) 1282 elif following_quals: 1283 self.visitGenExprFor(following_quals[0], following_quals[1:], expr) 1284 else: 1285 self.new_branch(expr) 1286 self.dispatch(expr) 1287 self.shelve_branch() 1288 1289 # Maintain a branch for the else clause. 1290 1291 self.new_branch(NullBranch()) 1292 self.shelve_branch() 1293 1294 self.merge_branches() 1295 1296 def visitGetattr(self, node): 1297 node._expr = self.dispatch(node.expr) 1298 node._attr = self._visitAttr(node._expr, node.attrname, node) 1299 return node._attr 1300 1301 def visitGlobal(self, node): 1302 if self.namespaces: 1303 for name in node.names: 1304 ns = self.namespaces[-1] 1305 if not ns.make_global(name): 1306 raise InspectError("Name %r is global and local in %r" % (name, ns.full_name())) 1307 1308 # The name is recorded in an earlier process. 1309 1310 def visitIf(self, node): 1311 self.use_name("__bool__", node) 1312 self.new_branchpoint() 1313 1314 # Propagate attribute usage to branches. 1315 1316 for test, body in node.tests: 1317 self.dispatch(test) 1318 1319 self.new_branch(body) 1320 self.dispatch(body) 1321 self.shelve_branch() 1322 1323 # Maintain a branch for the else clause. 1324 1325 self.new_branch(node.else_ or NullBranch()) 1326 if node.else_ is not None: 1327 self.dispatch(node.else_) 1328 self.shelve_branch() 1329 1330 self.merge_branches() 1331 1332 def visitIfExp(self, node): 1333 self.use_name("__bool__", node) 1334 self.new_branchpoint() 1335 1336 # Propagate attribute usage to branches. 1337 1338 self.dispatch(node.test) 1339 1340 self.new_branch(node.then) 1341 self.dispatch(node.then) 1342 self.shelve_branch() 1343 1344 self.new_branch(node.else_) 1345 self.dispatch(node.else_) 1346 self.shelve_branch() 1347 1348 self.merge_branches() 1349 return make_instance() # either outcome is possible 1350 1351 def visitImport(self, node): 1352 self._visitImport(node.names) 1353 1354 def _visitImport(self, names): 1355 for name, alias in names: 1356 module = self.complete_import(name, alias) 1357 if alias is not None: 1358 self.store(alias, module or UnresolvedName(None, name, self)) 1359 else: 1360 name_used = name.split(".")[0] 1361 self.store(name_used, module or UnresolvedName(None, name_used, self)) 1362 1363 visitInvert = _visitOperator 1364 1365 def visitKeyword(self, node): 1366 self.dispatch(node.expr) 1367 self._visitConst(node.name) 1368 self.keyword_names.add(node.name) 1369 1370 def visitLambda(self, node): 1371 fn = self._visitFunction(node, None) 1372 self.use_specific_attribute(None, fn.name) 1373 return fn 1374 1375 visitLeftShift = _visitOperator 1376 1377 def visitList(self, node): 1378 self.use_specific_attribute("__builtins__", "list") 1379 return self.OP(node) 1380 1381 def visitListComp(self, node): 1382 1383 # Note that explicit dispatch is performed. 1384 1385 if node.quals: 1386 self.visitListCompFor(node.quals[0], node.quals[1:], node.expr) 1387 return make_instance() 1388 1389 def visitListCompFor(self, node, following_quals, expr): 1390 self.new_branchpoint() 1391 1392 # Declare names which will be used by generated code. 1393 1394 self.use_name("__iter__", node.list) 1395 self.use_name("next") 1396 1397 in_loop = self.in_loop 1398 self.in_loop = True 1399 self.dispatch(node.list) 1400 1401 # NOTE: Could generate AST nodes for the actual operations instead of 1402 # NOTE: manually generating code in micropython.ast. 1403 1404 self.expr = make_instance() # each element is a result of a function call 1405 self.dispatch(node.assign) 1406 1407 # Enter the loop. 1408 # Propagate attribute usage to branches. 1409 1410 self.new_branch(node) 1411 1412 # Note that explicit dispatch is performed. 1413 1414 if node.ifs: 1415 self.visitListCompIf(node.ifs[0], node.ifs[1:], following_quals, expr) 1416 elif following_quals: 1417 self.visitListCompFor(following_quals[0], following_quals[1:], expr) 1418 else: 1419 self.dispatch(expr) 1420 1421 self.shelve_branch() 1422 self.in_loop = in_loop 1423 1424 self.merge_branches() 1425 1426 def visitListCompIf(self, node, following_ifs, following_quals, expr): 1427 self.use_name("__bool__", node) 1428 self.new_branchpoint() 1429 1430 # Propagate attribute usage to branches. 1431 1432 self.dispatch(node.test) 1433 1434 # Note that explicit dispatch is performed. 1435 1436 if following_ifs: 1437 self.visitListCompIf(following_ifs[0], following_ifs[1:], following_quals, expr) 1438 elif following_quals: 1439 self.visitListCompFor(following_quals[0], following_quals[1:], expr) 1440 else: 1441 self.new_branch(expr) 1442 self.dispatch(expr) 1443 self.shelve_branch() 1444 1445 # Maintain a branch for the else clause. 1446 1447 self.new_branch(NullBranch()) 1448 self.shelve_branch() 1449 1450 self.merge_branches() 1451 1452 visitMod = _visitOperator 1453 1454 def visitModule(self, node): 1455 1456 # Make a back reference from the node for code generation. 1457 1458 node.unit = self 1459 return self.dispatch(node.node) 1460 1461 visitMul = _visitOperator 1462 1463 def visitName(self, node): 1464 attr = self.get_namespace().get_using_node(node.name, node) or make_instance() 1465 node._attr = self.get_namespace().get_for_local(node.name) or attr 1466 return node._attr 1467 1468 def visitNot(self, node): 1469 self.use_name("__bool__", node) 1470 self.dispatch(node.expr) 1471 return make_instance() 1472 1473 visitOr = TEST_OP 1474 1475 visitPass = NOP 1476 1477 visitPower = _visitOperator 1478 1479 def _visitPrint(self, node, function_name): 1480 self.NOP(node) 1481 self.use_specific_attribute("__builtins__", function_name) 1482 1483 def visitPrint(self, node): 1484 self._visitPrint(node, "_print") 1485 1486 def visitPrintnl(self, node): 1487 self._visitPrint(node, "_printnl") 1488 1489 visitRaise = NOP_ABANDON 1490 1491 visitReturn = NOP_ABANDON 1492 1493 visitRightShift = _visitOperator 1494 1495 def visitSet(self, node): 1496 self.use_specific_attribute("__builtins__", "set") 1497 return self.OP(node) 1498 1499 def visitSlice(self, node): 1500 return self._visitOperator(node, self.in_assignment and "AssSlice" or "Slice") 1501 1502 visitSliceobj = OP 1503 1504 def visitStmt(self, node): 1505 for n in node.nodes: 1506 self.dispatch(n) 1507 1508 visitSub = _visitOperator 1509 1510 def visitSubscript(self, node): 1511 return self._visitOperator(node, self.in_assignment and "AssSubscript" or "Subscript") 1512 1513 def visitTryExcept(self, node): 1514 self.new_branchpoint() 1515 self.dispatch(node.body) 1516 1517 for name, var, n in node.handlers: 1518 if name is not None: 1519 self.dispatch(name) 1520 1521 self.new_branch(n) 1522 1523 # Any abandoned branches from the body can now be resumed. 1524 1525 self.resume_abandoned_branches() 1526 1527 # Establish the local for the handler. 1528 1529 if var is not None: 1530 self.dispatch(var) 1531 if n is not None: 1532 self.dispatch(n) 1533 1534 self.shelve_branch() 1535 1536 # The else clause maintains the usage from the body but without the 1537 # abandoned branches since they would never lead to the else clause 1538 # being executed. 1539 1540 self.new_branch(node.else_ or NullBranch()) 1541 if node.else_ is not None: 1542 self.dispatch(node.else_) 1543 self.shelve_branch() 1544 1545 self.merge_branches() 1546 1547 visitTryFinally = NOP 1548 1549 visitTuple = OP 1550 1551 visitUnaryAdd = _visitOperator 1552 1553 visitUnarySub = _visitOperator 1554 1555 def visitWhile(self, node): 1556 self.use_name("__bool__", node) 1557 self.new_branchpoint(node) 1558 1559 # Propagate attribute usage to branches. 1560 1561 in_loop = self.in_loop 1562 self.in_loop = True 1563 1564 # The test is evaluated initially and again in the loop. 1565 1566 self.dispatch(node.test) 1567 1568 self.new_branch(node) 1569 self.dispatch(node.body) 1570 1571 self.resume_continuing_branches() 1572 1573 self.dispatch(node.test) 1574 self.shelve_branch() 1575 1576 self.in_loop = in_loop 1577 1578 # A null branch is used to record a path around the loop. 1579 1580 self.new_branch(node.else_ or NullBranch()) 1581 self.shelve_branch() 1582 1583 self.merge_branches() 1584 1585 # The else clause is evaluated outside any branch. 1586 1587 if node.else_ is not None: 1588 self.dispatch(node.else_) 1589 1590 # Any suspended branches from the loop can now be resumed. 1591 1592 self.resume_broken_branches() 1593 1594 visitWith = NOP 1595 1596 visitYield = NOP 1597 1598 # vim: tabstop=4 expandtab shiftwidth=4