1 #!/usr/bin/env python 2 3 """ 4 Data classes. 5 6 Copyright (C) 2007, 2008, 2009 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 central data structure classes in this module are the following: 24 25 * Class 26 * Function 27 * Module 28 29 All of the above support the Naming interface either explicitly or through 30 general conformance, meaning that all can be asked to provide their 'full_name' 31 using the method of that name. 32 33 Additionally, all of the above also support a dictionary interface in order to 34 access names within their defined scopes. Specific methods also exist in order 35 to distinguish between certain kinds of attributes: 36 37 * Class: class_attributes, all_class_attributes, instance_attributes, all_attributes 38 * Function: parameters, locals, all_locals 39 * Module: module_attributes 40 41 These specific methods are useful in certain situations. 42 43 The above classes also provide an 'astnode' attribute, indicating the AST node 44 where each such object is defined. 45 """ 46 47 from micropython.program import DataObject 48 49 def shortrepr(obj): 50 if obj is None: 51 return repr(None) 52 else: 53 return obj.__shortrepr__() 54 55 # Special representations. 56 57 class AtLeast: 58 59 "A special representation for numbers of a given value or greater." 60 61 def __init__(self, count): 62 self.count = count 63 64 def __eq__(self, other): 65 return 0 66 67 __lt__ = __le__ = __eq__ 68 69 def __ne__(self, other): 70 return 1 71 72 def __gt__(self, other): 73 if isinstance(other, AtLeast): 74 return 0 75 else: 76 return self.count > other 77 78 def __ge__(self, other): 79 if isinstance(other, AtLeast): 80 return 0 81 else: 82 return self.count >= other 83 84 def __iadd__(self, other): 85 if isinstance(other, AtLeast): 86 self.count += other.count 87 else: 88 self.count += other 89 return self 90 91 def __radd__(self, other): 92 if isinstance(other, AtLeast): 93 return AtLeast(self.count + other.count) 94 else: 95 return AtLeast(self.count + other) 96 97 def __repr__(self): 98 return "AtLeast(%r)" % self.count 99 100 # Mix-ins and abstract classes. 101 102 class Naming: 103 104 "A mix-in providing naming conveniences." 105 106 def full_name(self): 107 if self.name is not None: 108 return self.parent.full_name() + "." + self.name 109 else: 110 return self.parent.full_name() 111 112 class NamespaceDict: 113 114 "A mix-in providing dictionary methods." 115 116 def __init__(self, module=None): 117 self.namespace = {} 118 self.globals = set() 119 self.module = module 120 self.finalised = 0 121 122 def __delitem__(self, name): 123 del self.namespace[name] 124 125 def has_key(self, name): 126 return self.namespace.has_key(name) 127 128 def keys(self): 129 return self.namespace.keys() 130 131 def values(self): 132 return self.namespace.values() 133 134 def items(self): 135 return self.namespace.items() 136 137 def __getitem__(self, name): 138 return self.namespace[name] 139 140 def get(self, name, default=None): 141 return self.namespace.get(name, default) 142 143 def __setitem__(self, name, value): 144 self.set(name, value) 145 146 def set(self, name, value, single_assignment=1): 147 148 """ 149 A more powerful set operation, making 'name' refer to 'value' whilst 150 indicating whether a 'single_assignment' (true by default) occurs in 151 this operation (or whether the operation covers potentially many 152 assignments in the lifetime of a program). 153 """ 154 155 if name in self.globals: 156 self.module.set(name, value, 0) 157 else: 158 self._set(name, value, single_assignment) 159 160 def set_module(self, name, value): 161 162 """ 163 A specialised set operation, making 'name' refer to 'value' in the 164 context of making a module reference available in association with 165 'name' as part of the import of that module or a submodule of that 166 module. 167 """ 168 169 self._set(name, value, 1) 170 171 def _set(self, name, attr_or_value, single_assignment=1): 172 173 """ 174 The underlying set operation associating 'name' with the given 175 'attr_or_value'. 176 See: docs/assignment.txt 177 """ 178 179 # Add and/or obtain the namespace entry. 180 181 if not self.namespace.has_key(name): 182 self.namespace[name] = Attr(None, self, name) 183 184 attr = self.namespace[name] 185 186 # Handle attribute assignment as well as assignment of basic objects. 187 188 if isinstance(attr_or_value, Attr): 189 190 # Attempt to fix the context if not explicitly defined. 191 192 context_values = self.get_updated_context_values(attr_or_value.context_values) 193 194 else: 195 context_values = self.get_updated_context_values([(None, attr_or_value)]) 196 197 attr.update(context_values, single_assignment) 198 199 def get_updated_context_values(self, context_values): 200 201 """ 202 Adapt the contexts found in the given 'context_values', returning a new 203 set. 204 See: docs/assignment.txt 205 """ 206 207 results = set() 208 209 for context, value in context_values: 210 211 # Set the context of instances to themselves. 212 213 if isinstance(value, Instance): 214 results.add((value, value)) 215 else: 216 results.add((context, value)) 217 218 return results 219 220 def make_global(self, name): 221 if not self.namespace.has_key(name): 222 self.globals.add(name) 223 return 1 224 else: 225 return 0 226 227 def attributes_as_list(self): 228 229 "Return the attributes in a list." 230 231 self.finalise_attributes() 232 l = [None] * len(self.keys()) 233 for attr in self.values(): 234 l[attr.position] = attr 235 return l 236 237 def finalise_attributes(self): 238 239 "Make sure all attributes are fully defined." 240 241 if self.finalised: 242 return 243 244 # The default action is to assign attribute positions sequentially. 245 246 for i, attr in enumerate(self.values()): 247 attr.position = i 248 249 self.finalised = 1 250 251 # Program data structures. There are two separate kinds of structures: those 252 # with context, which are the values manipulated by programs, and those without 253 # context, which are typically constant things which are stored alongside the 254 # program but which are wrapped in context-dependent structures in the running 255 # program. 256 257 class Attr: 258 259 "An attribute entry having a context." 260 261 def __init__(self, position, parent, name): 262 263 """ 264 Initialise the attribute with the given 'position' within the collection 265 of attributes of its 'parent', indicating its 'name'. 266 """ 267 268 self.position = position 269 self.parent = parent 270 self.name = name 271 272 self.context_values = set() 273 274 # Number of assignments per name. 275 276 self.assignments = None 277 278 def set_referenced(self): 279 280 "Indicate that the contents are referenced via a namespace." 281 282 for value in self.get_values(): 283 if value is not None: 284 value.set_referenced() 285 286 def get_contexts(self): 287 return [c for (c, v) in self.context_values] 288 289 def get_values(self): 290 return [v for (c, v) in self.context_values] 291 292 def get_context(self): 293 return len(self.context_values) == 1 and self.get_contexts()[0] or None 294 295 def get_value(self): 296 return len(self.context_values) == 1 and self.get_values()[0] or None 297 298 def update(self, context_values, single_assignment): 299 300 """ 301 Update the attribute, adding the 'context_values' provided to the 302 known details associated with the attribute, changing the number of 303 assignments according to the 'single_assignment' status of the 304 operation, where a true value indicates that only one assignment is 305 associated with the update, and a false value indicates that potentially 306 many assignments may be involved. 307 """ 308 309 if self.assignments is None: 310 if single_assignment: 311 self.assignments = 1 312 else: 313 self.assignments = AtLeast(1) 314 else: 315 if single_assignment: 316 self.assignments += 1 317 else: 318 self.assignments += AtLeast(1) 319 320 self.context_values.update(context_values) 321 322 def is_class_attribute(self): 323 return isinstance(self.parent, Class) 324 325 def defined_within_hierarchy(self): 326 327 """ 328 Return whether the parent and context of the attribute belong to the 329 same class hierarchy. 330 """ 331 332 # Must be defined within a class. 333 334 if isinstance(self.parent, Class): 335 336 # To be sure, all contexts must be classes and be the same as the 337 # parent, or be a superclass of the parent, or be a subclass of the 338 # parent. 339 340 for context in self.get_contexts(): 341 if not ( 342 isinstance(context, Class) and ( 343 context is self.parent or 344 context.has_subclass(self.parent) or 345 self.parent.has_subclass(context)) 346 ): 347 return 0 348 349 return 1 350 351 # Instance attributes are not defined within a hierarchy. 352 353 else: 354 return 0 355 356 def defined_outside_hierarchy(self): 357 358 """ 359 Return whether the parent and context of the attribute never belong to 360 the same class hierarchy. 361 """ 362 363 # Must be defined within a class. 364 365 if isinstance(self.parent, Class): 366 367 # To be sure, all contexts must be classes and be the same as the 368 # parent, or be a superclass of the parent, or be a subclass of the 369 # parent. 370 371 for context in self.get_contexts(): 372 if not ( 373 isinstance(context, Class) and not ( 374 context is self.parent or 375 context.has_subclass(self.parent) or 376 self.parent.has_subclass(context)) 377 ): 378 return 0 379 380 return 1 381 382 # Instance attributes are not defined within a hierarchy. 383 384 else: 385 return 0 386 387 def __repr__(self): 388 return "Attr(%r, %s, %r) # [%s], %r" % ( 389 self.position, shortrepr(self.parent), self.name, 390 self._context_values_str(), self.assignments 391 ) 392 393 def _context_values_str(self): 394 l = [] 395 for (c, v) in self.context_values: 396 l.append("(c=%s, v=%s)" % (shortrepr(c), shortrepr(v))) 397 return ", ".join(l) 398 399 def as_raw(self, objtable, paramtable): 400 return [ 401 ( 402 self.get_context() and self.get_context().location, 403 self.get_value() and self.get_value().location 404 ) 405 ] 406 407 # Instances are special in that they need to be wrapped together with context in 408 # a running program, but they are not generally constant. 409 410 class Instance: 411 412 "A placeholder indicating the involvement of an instance." 413 414 def __init__(self): 415 self.parent = None 416 self.referenced = 0 417 418 # Image generation details. 419 420 self.location = None 421 422 def set_referenced(self): 423 self.referenced = 1 424 425 def __repr__(self): 426 return "Instance()" 427 428 __shortrepr__ = __repr__ 429 430 class Constant: 431 432 "A superclass for all constant or context-free structures." 433 434 pass 435 436 # Data objects appearing in programs before run-time. 437 438 class Const(Constant, Instance): 439 440 "A constant object with no context." 441 442 def __init__(self, value): 443 Instance.__init__(self) 444 self.value = value 445 446 def get_value(self): 447 return value 448 449 def __repr__(self): 450 if self.location is not None: 451 return "Const(%r, location=%r)" % (self.value, self.location) 452 else: 453 return "Const(%r)" % self.value 454 455 __shortrepr__ = __repr__ 456 457 def as_raw(self, objtable, paramtable): 458 # NOTE: Need class details! 459 return [ 460 DataObject( 461 objtable.as_list().get_code(self.value_type_name()), 462 objtable.get_index(self.value_type_name()), # is instance 463 None, 464 None, 465 self.value_type_name(), 466 1 # size 467 ) 468 ] + self.raw_data() 469 470 def raw_data(self): 471 # NOTE: Start simple and use single entries for most types. 472 if self.value_type_name() in ("__builtins__.tuple", "__builtins__.list"): 473 return [len(self.value)] + list(self.value) 474 else: 475 return [self.value] 476 477 # Support constants as dictionary keys in order to build constant tables. 478 479 def __eq__(self, other): 480 return other is not None and self.value == other.value and self.value.__class__ is other.value.__class__ 481 482 def __hash__(self): 483 return hash(self.value) 484 485 def value_type_name(self): 486 return "__builtins__." + self.value.__class__.__name__ 487 488 class Class(NamespaceDict, Naming, Constant): 489 490 "An inspected class." 491 492 def __init__(self, name, parent, module=None, node=None): 493 494 """ 495 Initialise the class with the given 'name', 'parent' object, optional 496 'module' and optional AST 'node'. 497 """ 498 499 NamespaceDict.__init__(self, module) 500 self.name = name 501 self.parent = parent 502 self.astnode = node 503 self.referenced = 0 504 505 # Superclasses, descendants and attributes. 506 507 self.bases = [] 508 self.descendants = set() 509 self.instattr = set() # instance attributes 510 self.relocated = set() # attributes which do not have the same 511 # position as those of the same name in 512 # some superclasses 513 514 # Caches. 515 516 self.all_instattr = None # cache for instance_attributes 517 self.all_instattr_names = None # from all_instattr 518 self.all_classattr = None # cache for all_class_attributes 519 self.all_classattr_names = None # from all_classattr 520 self.allattr = None # cache for all_attributes 521 self.allattr_names = None # from allattr 522 523 # Image generation details. 524 525 self.location = None 526 self.code_location = None 527 self.instantiator = None 528 self.instance_template_location = None # for creating instances at run-time 529 530 # Program-related details. 531 532 self.blocks = None 533 self.temp_usage = 0 534 self.local_usage = 0 535 self.all_local_usage = 0 536 537 # Add this class to its attributes. 538 539 self.set("__class__", self) 540 541 def set_referenced(self): 542 self.referenced = 1 543 544 def __repr__(self): 545 if self.location is not None: 546 return "Class(%r, %s, location=%r)" % (self.name, shortrepr(self.parent), self.location) 547 else: 548 return "Class(%r, %s)" % (self.name, shortrepr(self.parent)) 549 550 def __shortrepr__(self): 551 return "Class(%r, %s)" % (self.name, shortrepr(self.parent)) 552 553 def as_raw(self, objtable, paramtable, with_instantiator=1): 554 classcode = objtable.as_list().get_code(self.full_name()) 555 attrcode = objtable.get_index(self.full_name()) 556 557 # Include a template of an instance for use when instantiating classes. 558 559 call_method = self.get("__call__") 560 call_method_value = call_method and call_method.get_value() 561 call_method_code_location = call_method_value and call_method_value.code_location 562 563 # NOTE: The instantiator code is the first block of the class. 564 565 if not with_instantiator: 566 instantiator_code_location = self.full_name() 567 else: 568 instantiator_code_location = self.get_instantiator().blocks[0].location 569 570 return [ 571 572 # Template instance... 573 574 DataObject( 575 classcode, 576 attrcode, # is instance 577 call_method_code_location, 578 ( 579 call_method_value and len(call_method_value.positional_names), 580 call_method_value and len(call_method_value.defaults) 581 ), 582 self.full_name(), 583 len(self.instance_attributes()) + 1 # size 584 ), 585 586 # Class... 587 588 DataObject( 589 classcode, 590 None, # is not instance 591 instantiator_code_location, 592 ( 593 len(self.get_instantiator().positional_names), 594 len(self.get_instantiator().defaults) 595 ), 596 self.full_name(), 597 len(self.class_attributes()) + 1 # size 598 ) 599 ] 600 601 # Namespace-related methods. 602 603 def get_updated_context_values(self, context_values): 604 605 """ 606 Adapt the contexts found in the given 'context_values', returning a new 607 set. 608 See: docs/assignment.txt 609 """ 610 611 results = set() 612 613 for context, value in context_values: 614 615 # Change the ownership of functions. 616 617 if context is None and value is not None and isinstance(value, Function): 618 results.add((self, value)) 619 else: 620 results.add((context, value)) 621 622 return NamespaceDict.get_updated_context_values(self, results) 623 624 def finalise_attributes(self): 625 626 "Make sure that all attributes are fully defined." 627 628 if self.finalised: 629 return 630 631 self.finalise_class_attributes() 632 self.finalise_instance_attributes() 633 self.finalised = 1 634 635 # Convenience methods for accessing functions and methods. 636 637 def get_instantiator(self): 638 639 "Return a function which can be used to instantiate the class." 640 641 if self.instantiator is None: 642 self.instantiator = self.get_init_method().function_from_method() 643 return self.instantiator 644 645 def get_init_method(self): 646 return self.all_class_attributes()["__init__"].get_value() 647 648 # Class-specific methods. 649 650 def add_base(self, base): 651 self.bases.append(base) 652 base.add_descendant(self) 653 654 def add_instance_attribute(self, name): 655 self.instattr.add(name) 656 657 def add_descendant(self, cls): 658 self.descendants.add(cls) 659 for base in self.bases: 660 base.add_descendant(cls) 661 662 def has_subclass(self, other): 663 return other in self.descendants 664 665 def all_descendants(self): 666 d = {} 667 for cls in self.descendants: 668 d[cls.full_name()] = cls 669 return d 670 671 "Return the attribute names provided by this class only." 672 673 class_attribute_names = NamespaceDict.keys 674 675 def class_attributes(self): 676 677 "Return class attributes provided by this class only." 678 679 return dict(self) 680 681 def all_class_attribute_names(self): 682 683 "Return the attribute names provided by classes in this hierarchy." 684 685 if self.all_classattr_names is None: 686 self.all_class_attributes() 687 return self.all_classattr_names 688 689 def all_class_attributes(self): 690 691 "Return all class attributes, indicating the class which provides them." 692 693 self.finalise_class_attributes() 694 return self.all_classattr 695 696 def finalise_class_attributes(self): 697 698 "Make sure that the class attributes are fully defined." 699 700 if self.all_classattr is None: 701 self.all_classattr = {} 702 clsattr = {} 703 704 # Record provisional position information for attributes of this 705 # class. 706 707 for name in self.class_attributes().keys(): 708 clsattr[name] = set() # position not yet defined 709 710 reversed_bases = self.bases[:] 711 reversed_bases.reverse() 712 713 # For the bases in reverse order, acquire class attribute details. 714 715 for cls in reversed_bases: 716 for name, attr in cls.all_class_attributes().items(): 717 self.all_classattr[name] = attr 718 719 # Record previous attribute information. 720 721 if clsattr.has_key(name): 722 clsattr[name].add(attr.position) 723 724 # Record class attributes provided by this class and its bases, 725 # along with their positions. 726 727 self.all_classattr.update(self.class_attributes()) 728 729 if clsattr: 730 for i, name in enumerate(self._get_position_list(clsattr)): 731 self.all_classattr[name].position = i 732 733 return self.all_classattr 734 735 def instance_attribute_names(self): 736 737 "Return the instance attribute names provided by the class." 738 739 if self.all_instattr_names is None: 740 self.instance_attributes() 741 return self.all_instattr_names 742 743 def instance_attributes(self): 744 745 "Return instance-only attributes for instances of this class." 746 747 self.finalise_instance_attributes() 748 return self.all_instattr 749 750 def finalise_instance_attributes(self): 751 752 "Make sure that the instance attributes are fully defined." 753 754 # Cache the attributes by converting the positioned attributes into a 755 # dictionary. 756 757 if self.all_instattr is None: 758 self.all_instattr = self._get_attributes() 759 self.all_instattr_names = self.all_instattr.keys() 760 761 return self.all_instattr 762 763 def _get_attributes(self): 764 765 """ 766 Return a dictionary mapping names to Attr instances incorporating 767 information about their positions in the final instance structure. 768 """ 769 770 instattr = {} 771 772 # Record provisional position information for attributes of this 773 # instance. 774 775 for name in self.instattr: 776 instattr[name] = set() # position not yet defined 777 778 reversed_bases = self.bases[:] 779 reversed_bases.reverse() 780 781 # For the bases in reverse order, acquire instance attribute 782 # details. 783 784 for cls in reversed_bases: 785 for name, attr in cls.instance_attributes().items(): 786 787 # Record previous attribute information. 788 789 if instattr.has_key(name): 790 instattr[name].add(attr.position) 791 792 # Build the dictionary of attributes using the existing positions known 793 # for each name. 794 795 d = {} 796 for i, name in enumerate(self._get_position_list(instattr)): 797 d[name] = Attr(i, Instance(), name) 798 return d 799 800 def _get_position_list(self, positions): 801 802 """ 803 Return a list of attribute names for the given 'positions' mapping from 804 names to positions, indicating the positions of the attributes in the 805 final instance structure. 806 """ 807 808 position_items = positions.items() 809 namearray = [None] * len(position_items) 810 811 # Get the positions in ascending order of list size, with lists 812 # of the same size ordered according to their smallest position 813 # value. 814 815 position_items.sort(self._cmp_positions) 816 817 # Get the names in position order. 818 819 held = [] 820 821 for name, pos in position_items: 822 pos = list(pos) 823 pos.sort() 824 if pos and pos[0] < len(namearray) and namearray[pos[0]] is None: 825 namearray[pos[0]] = name 826 else: 827 if pos: 828 self.relocated.add(name) 829 held.append((name, pos)) 830 831 for i, attr in enumerate(namearray): 832 if attr is None: 833 name, pos = held.pop() 834 namearray[i] = name 835 836 #print self.name, positions 837 #print "->", namearray 838 return namearray 839 840 def _cmp_positions(self, a, b): 841 842 "Compare name plus position list operands 'a' and 'b'." 843 844 name_a, list_a = a 845 name_b, list_b = b 846 if len(list_a) < len(list_b): 847 return -1 848 elif len(list_a) > len(list_b): 849 return 1 850 elif not list_a: 851 return 0 852 else: 853 return cmp(min(list_a), min(list_b)) 854 855 def all_attribute_names(self): 856 857 """ 858 Return the names of all attributes provided by instances of this class. 859 """ 860 861 self.allattr_names = self.allattr_names or self.all_attributes().keys() 862 return self.allattr_names 863 864 def all_attributes(self): 865 866 """ 867 Return all attributes for an instance, indicating either the class which 868 provides them or that the instance itself provides them. 869 """ 870 871 if self.allattr is None: 872 self.allattr = {} 873 self.allattr.update(self.all_class_attributes()) 874 for name, attr in self.instance_attributes().items(): 875 if self.allattr.has_key(name): 876 print "Instance attribute %r in %r overrides class attribute." % (name, self) 877 self.allattr[name] = attr 878 return self.allattr 879 880 class Function(NamespaceDict, Naming, Constant): 881 882 "An inspected function." 883 884 def __init__(self, name, parent, argnames, defaults, has_star, has_dstar, module=None, node=None): 885 886 """ 887 Initialise the function with the given 'name', 'parent', list of 888 'argnames', list of 'defaults', the 'has_star' flag (indicating the 889 presence of a * parameter), the 'has_dstar' flag (indicating the 890 presence of a ** parameter), optional 'module', and optional AST 'node'. 891 """ 892 893 NamespaceDict.__init__(self, module) 894 self.name = name 895 self.parent = parent 896 self.argnames = argnames 897 self.defaults = defaults 898 self.has_star = has_star 899 self.has_dstar = has_dstar 900 self.astnode = node 901 self.referenced = 0 902 903 # Initialise the positional names. 904 905 self.positional_names = self.argnames[:] 906 if has_dstar: 907 self.dstar_name = self.positional_names[-1] 908 del self.positional_names[-1] 909 if has_star: 910 self.star_name = self.positional_names[-1] 911 del self.positional_names[-1] 912 913 # Initialise default storage. 914 # NOTE: This must be initialised separately due to the reliance on node 915 # NOTE: visiting. 916 917 self.default_attrs = [] 918 919 # Caches. 920 921 self.localnames = None # cache for locals 922 923 # Add parameters to the namespace. 924 925 self._add_parameters(argnames) 926 927 # Image generation details. 928 929 self.location = None 930 self.code_location = None 931 932 # Program-related details. 933 934 self.blocks = None 935 self.temp_usage = 0 936 self.local_usage = 0 937 self.all_local_usage = 0 938 939 def set_referenced(self): 940 self.referenced = 1 941 942 def _add_parameters(self, argnames): 943 for name in argnames: 944 if isinstance(name, tuple): 945 self._add_parameters(name) 946 else: 947 self.set(name, None) 948 949 def __repr__(self): 950 if self.location is not None: 951 return "Function(%r, %s, %r, location=%r, code_location=%r)" % ( 952 self.name, shortrepr(self.parent), self.argnames, self.location, self.code_location 953 ) 954 else: 955 return "Function(%r, %s, %r)" % ( 956 self.name, shortrepr(self.parent), self.argnames 957 ) 958 959 def __shortrepr__(self): 960 return "Function(%r, %s)" % ( 961 self.name, shortrepr(self.parent) 962 ) 963 964 def as_raw(self, objtable, paramtable): 965 # NOTE: Need class and parameter details! Should arguably be an instance of types.FunctionType. 966 return [ 967 DataObject( 968 objtable.as_list().get_code("__builtins__.function"), 969 objtable.get_index("__builtins__.function"), # is instance 970 self.code_location, 971 ( 972 len(self.positional_names), 973 len(self.defaults) 974 ), 975 "__builtins__.function", 976 len(self.defaults) + 1, # size 977 paramtable.as_list().get_code(self.full_name()) 978 ) 979 ] 980 981 # Namespace-related methods. 982 983 def store_default(self, value): 984 attr = Attr(None, self, None) 985 attr.update([(None, value)], 1) 986 self.default_attrs.append(attr) 987 988 def make_global(self, name): 989 if name not in self.argnames and not self.has_key(name): 990 self.globals.add(name) 991 return 1 992 else: 993 return 0 994 995 def parameters(self): 996 997 """ 998 Return a dictionary mapping parameter names to their position in the 999 parameter list. 1000 """ 1001 1002 parameters = {} 1003 for i, name in enumerate(self.argnames): 1004 parameters[name] = i 1005 return parameters 1006 1007 def all_locals(self): 1008 1009 "Return a dictionary mapping names to local and parameter details." 1010 1011 return dict(self) 1012 1013 def locals(self): 1014 1015 "Return a dictionary mapping names to local details." 1016 1017 if self.localnames is None: 1018 self.localnames = {} 1019 self.localnames.update(self.all_locals()) 1020 for name in self.argnames: 1021 del self.localnames[name] 1022 return self.localnames 1023 1024 def is_method(self): 1025 1026 "Return whether this function is a method." 1027 1028 return isinstance(self.parent, Class) 1029 1030 def is_relocated(self, name): 1031 1032 """ 1033 Determine whether the given attribute 'name' is relocated for instances 1034 having this function as a method. 1035 """ 1036 1037 for cls in self.parent.descendants: 1038 if name in cls.relocated: 1039 return 1 1040 return 0 1041 1042 def finalise_attributes(self): 1043 1044 """ 1045 Make sure all attributes (locals) are fully defined. Note that locals 1046 are not attributes in the sense of class, module or instance attributes. 1047 Defaults are also finalised by this method. 1048 """ 1049 1050 if self.finalised: 1051 return 1052 1053 # Defaults. 1054 1055 for i, default in enumerate(self.default_attrs): 1056 default.position = i 1057 1058 # Locals. 1059 1060 i = None 1061 for i, name in enumerate(self.argnames): 1062 self[name].position = i 1063 1064 if i is not None: 1065 nparams = i + 1 1066 else: 1067 nparams = 0 1068 1069 i = None 1070 for i, attr in enumerate(self.locals().values()): 1071 attr.position = i + nparams 1072 1073 if i is not None: 1074 nothers = i + 1 1075 else: 1076 nothers = 0 1077 1078 self.local_usage = nothers 1079 self.all_local_usage = nparams + nothers 1080 self.finalised = 1 1081 1082 def function_from_method(self): 1083 1084 "Make a function from a method." 1085 1086 function = Function(self.name + " (function)", self.parent, self.argnames[1:], self.defaults, 1087 self.has_star, self.has_dstar, self.module, self.astnode) 1088 function.default_attrs = self.default_attrs 1089 return function 1090 1091 class UnresolvedName(NamespaceDict, Constant): 1092 1093 "A module, class or function which was mentioned but could not be imported." 1094 1095 def __init__(self, name, parent_name, module=None): 1096 NamespaceDict.__init__(self, module) 1097 self.name = name 1098 self.parent_name = parent_name 1099 self.parent = None 1100 self.referenced = 0 1101 1102 self.descendants = set() 1103 1104 def set_referenced(self): 1105 self.referenced = 1 1106 1107 def add_descendant(self, cls): 1108 self.descendants.add(cls) 1109 1110 def all_class_attributes(self): 1111 return {} 1112 1113 def instance_attributes(self): 1114 return {} 1115 1116 def __repr__(self): 1117 return "UnresolvedName(%r, %r)" % (self.name, self.parent_name) 1118 1119 __shortrepr__ = __repr__ 1120 1121 def full_name(self): 1122 if self.name is not None: 1123 return self.parent_name + "." + self.name 1124 else: 1125 return self.parent_name 1126 1127 class Module(NamespaceDict, Constant): 1128 1129 "An inspected module's core details." 1130 1131 def __init__(self, name): 1132 NamespaceDict.__init__(self, self) 1133 self.name = name 1134 self.parent = None 1135 self.referenced = 0 1136 1137 # Original location details. 1138 1139 self.astnode = None 1140 1141 # Complete lists of classes and functions. 1142 1143 self.all_objects = set() 1144 1145 # Keyword records. 1146 1147 self.keyword_names = set() 1148 1149 # Image generation details. 1150 1151 self.location = None 1152 self.code_location = None 1153 1154 # Program-related details. 1155 1156 self.blocks = None 1157 self.temp_usage = 0 1158 self.local_usage = 0 1159 self.all_local_usage = 0 1160 1161 def set_referenced(self): 1162 self.referenced = 1 1163 1164 def full_name(self): 1165 return self.name 1166 1167 def __repr__(self): 1168 if self.location is not None: 1169 return "Module(%r, location=%r)" % (self.name, self.location) 1170 else: 1171 return "Module(%r)" % self.name 1172 1173 def __shortrepr__(self): 1174 return "Module(%r)" % self.name 1175 1176 def as_raw(self, objtable, paramtable): 1177 return [ 1178 DataObject( 1179 objtable.as_list().get_code(self.full_name()), 1180 None, # NOTE: module name not used as an attribute, but should be instance 1181 None, 1182 None, 1183 self.full_name(), 1184 len(self.module_attributes()) + 1 # size 1185 ) 1186 ] 1187 1188 # Attribute methods. 1189 1190 "Return the module attribute names provided by the module." 1191 1192 module_attribute_names = NamespaceDict.keys 1193 1194 def module_attributes(self): 1195 1196 "Return a dictionary mapping names to module attributes." 1197 1198 return dict(self) 1199 1200 # vim: tabstop=4 expandtab shiftwidth=4