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