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