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.all_class_attributes().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 call_method_funccode = call_method_value and paramtable.as_list().get_code(call_method_value.full_name()) 563 564 instantiator_funccode = paramtable.as_list().get_code(self.get_instantiator().full_name()) 565 566 # NOTE: The instantiator code is the first block of the class. 567 568 if not with_instantiator: 569 instantiator_code_location = self.full_name() 570 else: 571 instantiator_code_location = self.get_instantiator().blocks[0].location 572 573 return [ 574 575 # Template instance... 576 577 DataObject( 578 classcode, 579 attrcode, # is instance 580 call_method_code_location, 581 ( 582 call_method_value and len(call_method_value.positional_names), 583 call_method_value and len(call_method_value.defaults) 584 # NOTE: Add * parameter availability. 585 ), 586 self.full_name(), 587 len(self.instance_attributes()) + 1, # size 588 call_method_funccode # funccode 589 ), 590 591 # Class... 592 593 DataObject( 594 classcode, 595 None, # is not instance 596 instantiator_code_location, 597 ( 598 len(self.get_instantiator().positional_names), 599 len(self.get_instantiator().defaults) 600 # NOTE: Add * parameter availability. 601 ), 602 self.full_name(), 603 len(self.class_attributes()) + 1, # size 604 instantiator_funccode # funccode 605 ) 606 ] 607 608 # Namespace-related methods. 609 610 def get_updated_context_values(self, context_values): 611 612 """ 613 Adapt the contexts found in the given 'context_values', returning a new 614 set. 615 See: docs/assignment.txt 616 """ 617 618 results = set() 619 620 for context, value in context_values: 621 622 # Change the ownership of functions. 623 624 if context is None and value is not None and isinstance(value, Function): 625 results.add((self, value)) 626 else: 627 results.add((context, value)) 628 629 return NamespaceDict.get_updated_context_values(self, results) 630 631 def finalise_attributes(self): 632 633 "Make sure that all attributes are fully defined." 634 635 if self.finalised: 636 return 637 638 self.finalise_class_attributes() 639 self.finalise_instance_attributes() 640 self.finalised = 1 641 642 # Convenience methods for accessing functions and methods. 643 644 def get_instantiator(self): 645 646 "Return a function which can be used to instantiate the class." 647 648 if self.instantiator is None: 649 self.instantiator = self.get_init_method().as_instantiator() 650 return self.instantiator 651 652 def get_init_method(self): 653 return self.all_class_attributes()["__init__"].get_value() 654 655 # Class-specific methods. 656 657 def add_base(self, base): 658 self.bases.append(base) 659 base.add_descendant(self) 660 661 def add_instance_attribute(self, name): 662 self.instattr.add(name) 663 664 def add_descendant(self, cls): 665 self.descendants.add(cls) 666 for base in self.bases: 667 base.add_descendant(cls) 668 669 def has_subclass(self, other): 670 return other in self.descendants 671 672 def all_descendants(self): 673 d = {} 674 for cls in self.descendants: 675 d[cls.full_name()] = cls 676 return d 677 678 "Return the attribute names provided by this class only." 679 680 class_attribute_names = NamespaceDict.keys 681 682 def class_attributes(self): 683 684 "Return class attributes provided by this class only." 685 686 return dict(self) 687 688 def all_class_attribute_names(self): 689 690 "Return the attribute names provided by classes in this hierarchy." 691 692 if self.all_classattr_names is None: 693 self.all_class_attributes() 694 return self.all_classattr_names 695 696 def all_class_attributes(self): 697 698 "Return all class attributes, indicating the class which provides them." 699 700 self.finalise_class_attributes() 701 return self.all_classattr 702 703 def finalise_class_attributes(self): 704 705 "Make sure that the class attributes are fully defined." 706 707 if self.all_classattr is None: 708 self.all_classattr = {} 709 clsattr = {} 710 711 # Record provisional position information for attributes of this 712 # class. 713 714 for name in self.class_attributes().keys(): 715 clsattr[name] = set() # position not yet defined 716 717 reversed_bases = self.bases[:] 718 reversed_bases.reverse() 719 720 # For the bases in reverse order, acquire class attribute details. 721 722 for cls in reversed_bases: 723 for name, attr in cls.all_class_attributes().items(): 724 self.all_classattr[name] = attr 725 726 # Record previous attribute information. 727 728 if clsattr.has_key(name): 729 clsattr[name].add(attr.position) 730 731 # Record class attributes provided by this class and its bases, 732 # along with their positions. 733 734 self.all_classattr.update(self.class_attributes()) 735 736 if clsattr: 737 for i, name in enumerate(self._get_position_list(clsattr)): 738 self.all_classattr[name].position = i 739 740 return self.all_classattr 741 742 def instance_attribute_names(self): 743 744 "Return the instance attribute names provided by the class." 745 746 if self.all_instattr_names is None: 747 self.instance_attributes() 748 return self.all_instattr_names 749 750 def instance_attributes(self): 751 752 "Return instance-only attributes for instances of this class." 753 754 self.finalise_instance_attributes() 755 return self.all_instattr 756 757 def finalise_instance_attributes(self): 758 759 "Make sure that the instance attributes are fully defined." 760 761 # Cache the attributes by converting the positioned attributes into a 762 # dictionary. 763 764 if self.all_instattr is None: 765 self.all_instattr = self._get_attributes() 766 self.all_instattr_names = self.all_instattr.keys() 767 768 return self.all_instattr 769 770 def _get_attributes(self): 771 772 """ 773 Return a dictionary mapping names to Attr instances incorporating 774 information about their positions in the final instance structure. 775 """ 776 777 instattr = {} 778 779 # Record provisional position information for attributes of this 780 # instance. 781 782 for name in self.instattr: 783 instattr[name] = set() # position not yet defined 784 785 reversed_bases = self.bases[:] 786 reversed_bases.reverse() 787 788 # For the bases in reverse order, acquire instance attribute 789 # details. 790 791 for cls in reversed_bases: 792 for name, attr in cls.instance_attributes().items(): 793 794 # Record previous attribute information. 795 796 if instattr.has_key(name): 797 instattr[name].add(attr.position) 798 799 # Build the dictionary of attributes using the existing positions known 800 # for each name. 801 802 d = {} 803 for i, name in enumerate(self._get_position_list(instattr)): 804 d[name] = Attr(i, Instance(), name) 805 return d 806 807 def _get_position_list(self, positions): 808 809 """ 810 Return a list of attribute names for the given 'positions' mapping from 811 names to positions, indicating the positions of the attributes in the 812 final instance structure. 813 """ 814 815 position_items = positions.items() 816 namearray = [None] * len(position_items) 817 818 # Get the positions in ascending order of list size, with lists 819 # of the same size ordered according to their smallest position 820 # value. 821 822 position_items.sort(self._cmp_positions) 823 824 # Get the names in position order. 825 826 held = [] 827 828 for name, pos in position_items: 829 pos = list(pos) 830 pos.sort() 831 if pos and pos[0] < len(namearray) and namearray[pos[0]] is None: 832 namearray[pos[0]] = name 833 else: 834 if pos: 835 self.relocated.add(name) 836 held.append((name, pos)) 837 838 for i, attr in enumerate(namearray): 839 if attr is None: 840 name, pos = held.pop() 841 namearray[i] = name 842 843 #print self.name, positions 844 #print "->", namearray 845 return namearray 846 847 def _cmp_positions(self, a, b): 848 849 "Compare name plus position list operands 'a' and 'b'." 850 851 name_a, list_a = a 852 name_b, list_b = b 853 if len(list_a) < len(list_b): 854 return -1 855 elif len(list_a) > len(list_b): 856 return 1 857 elif not list_a: 858 return 0 859 else: 860 return cmp(min(list_a), min(list_b)) 861 862 def all_attribute_names(self): 863 864 """ 865 Return the names of all attributes provided by instances of this class. 866 """ 867 868 self.allattr_names = self.allattr_names or self.all_attributes().keys() 869 return self.allattr_names 870 871 def all_attributes(self): 872 873 """ 874 Return all attributes for an instance, indicating either the class which 875 provides them or that the instance itself provides them. 876 """ 877 878 if self.allattr is None: 879 self.allattr = {} 880 self.allattr.update(self.all_class_attributes()) 881 for name, attr in self.instance_attributes().items(): 882 if self.allattr.has_key(name): 883 print "Instance attribute %r in %r overrides class attribute." % (name, self) 884 self.allattr[name] = attr 885 return self.allattr 886 887 class Function(NamespaceDict, Naming, Constant): 888 889 "An inspected function." 890 891 def __init__(self, name, parent, argnames, defaults, has_star, has_dstar, module=None, node=None): 892 893 """ 894 Initialise the function with the given 'name', 'parent', list of 895 'argnames', list of 'defaults', the 'has_star' flag (indicating the 896 presence of a * parameter), the 'has_dstar' flag (indicating the 897 presence of a ** parameter), optional 'module', and optional AST 'node'. 898 """ 899 900 NamespaceDict.__init__(self, module) 901 self.name = name 902 self.parent = parent 903 self.argnames = argnames 904 self.defaults = defaults 905 self.has_star = has_star 906 self.has_dstar = has_dstar 907 self.astnode = node 908 self.referenced = 0 909 910 # Initialise the positional names. 911 912 self.positional_names = self.argnames[:] 913 if has_dstar: 914 self.dstar_name = self.positional_names[-1] 915 del self.positional_names[-1] 916 if has_star: 917 self.star_name = self.positional_names[-1] 918 del self.positional_names[-1] 919 920 # Initialise default storage. 921 # NOTE: This must be initialised separately due to the reliance on node 922 # NOTE: visiting. 923 924 self.default_attrs = [] 925 926 # Caches. 927 928 self.localnames = None # cache for locals 929 930 # Add parameters to the namespace. 931 932 self._add_parameters(argnames) 933 934 # Image generation details. 935 936 self.location = None 937 self.code_location = None 938 939 # Program-related details. 940 941 self.blocks = None 942 self.temp_usage = 0 943 self.local_usage = 0 944 self.all_local_usage = 0 945 946 def set_referenced(self): 947 self.referenced = 1 948 949 def _add_parameters(self, argnames): 950 for name in argnames: 951 if isinstance(name, tuple): 952 self._add_parameters(name) 953 else: 954 self.set(name, None) 955 956 def __repr__(self): 957 if self.location is not None: 958 return "Function(%r, %s, %r, location=%r, code_location=%r)" % ( 959 self.name, shortrepr(self.parent), self.argnames, self.location, self.code_location 960 ) 961 else: 962 return "Function(%r, %s, %r)" % ( 963 self.name, shortrepr(self.parent), self.argnames 964 ) 965 966 def __shortrepr__(self): 967 return "Function(%r, %s)" % ( 968 self.name, shortrepr(self.parent) 969 ) 970 971 def as_raw(self, objtable, paramtable): 972 # NOTE: Need class and parameter details! Should arguably be an instance of types.FunctionType. 973 return [ 974 DataObject( 975 objtable.as_list().get_code("__builtins__.function"), 976 objtable.get_index("__builtins__.function"), # is instance 977 self.code_location, 978 ( 979 len(self.positional_names), 980 len(self.defaults) 981 # NOTE: Add * parameter availability. 982 ), 983 "__builtins__.function", 984 len(self.defaults) + 1, # size 985 paramtable.as_list().get_code(self.full_name()) # funccode 986 ) 987 ] 988 989 # Namespace-related methods. 990 991 def store_default(self, value): 992 attr = Attr(None, self, None) 993 attr.update([(None, value)], 1) 994 self.default_attrs.append(attr) 995 996 def make_global(self, name): 997 if name not in self.argnames and not self.has_key(name): 998 self.globals.add(name) 999 return 1 1000 else: 1001 return 0 1002 1003 def parameters(self): 1004 1005 """ 1006 Return a dictionary mapping parameter names to their position in the 1007 parameter list. 1008 """ 1009 1010 parameters = {} 1011 for i, name in enumerate(self.argnames): 1012 parameters[name] = i 1013 return parameters 1014 1015 def all_locals(self): 1016 1017 "Return a dictionary mapping names to local and parameter details." 1018 1019 return dict(self) 1020 1021 def locals(self): 1022 1023 "Return a dictionary mapping names to local details." 1024 1025 if self.localnames is None: 1026 self.localnames = {} 1027 self.localnames.update(self.all_locals()) 1028 for name in self.argnames: 1029 del self.localnames[name] 1030 return self.localnames 1031 1032 def is_method(self): 1033 1034 "Return whether this function is a method." 1035 1036 return isinstance(self.parent, Class) 1037 1038 def is_relocated(self, name): 1039 1040 """ 1041 Determine whether the given attribute 'name' is relocated for instances 1042 having this function as a method. 1043 """ 1044 1045 for cls in self.parent.descendants: 1046 if name in cls.relocated: 1047 return 1 1048 return 0 1049 1050 def finalise_attributes(self): 1051 1052 """ 1053 Make sure all attributes (locals) are fully defined. Note that locals 1054 are not attributes in the sense of class, module or instance attributes. 1055 Defaults are also finalised by this method. 1056 """ 1057 1058 if self.finalised: 1059 return 1060 1061 # Defaults. 1062 1063 for i, default in enumerate(self.default_attrs): 1064 default.position = i 1065 1066 # Locals. 1067 1068 i = None 1069 for i, name in enumerate(self.argnames): 1070 self[name].position = i 1071 1072 if i is not None: 1073 nparams = i + 1 1074 else: 1075 nparams = 0 1076 1077 i = None 1078 for i, attr in enumerate(self.locals().values()): 1079 attr.position = i + nparams 1080 1081 if i is not None: 1082 nothers = i + 1 1083 else: 1084 nothers = 0 1085 1086 self.local_usage = nothers 1087 self.all_local_usage = nparams + nothers 1088 self.finalised = 1 1089 1090 def as_instantiator(self): 1091 1092 "Make an instantiator function from a method." 1093 1094 function = Function(self.parent.name, self.parent.parent, self.argnames[1:], self.defaults, 1095 self.has_star, self.has_dstar, self.module, self.astnode) 1096 function.default_attrs = self.default_attrs 1097 return function 1098 1099 class UnresolvedName(NamespaceDict, Constant): 1100 1101 "A module, class or function which was mentioned but could not be imported." 1102 1103 def __init__(self, name, parent_name, module=None): 1104 NamespaceDict.__init__(self, module) 1105 self.name = name 1106 self.parent_name = parent_name 1107 self.parent = None 1108 self.referenced = 0 1109 1110 self.descendants = set() 1111 1112 def set_referenced(self): 1113 self.referenced = 1 1114 1115 def add_descendant(self, cls): 1116 self.descendants.add(cls) 1117 1118 def all_class_attributes(self): 1119 return {} 1120 1121 def instance_attributes(self): 1122 return {} 1123 1124 def __repr__(self): 1125 return "UnresolvedName(%r, %r)" % (self.name, self.parent_name) 1126 1127 __shortrepr__ = __repr__ 1128 1129 def full_name(self): 1130 if self.name is not None: 1131 return self.parent_name + "." + self.name 1132 else: 1133 return self.parent_name 1134 1135 class Module(NamespaceDict, Constant): 1136 1137 "An inspected module's core details." 1138 1139 def __init__(self, name): 1140 NamespaceDict.__init__(self, self) 1141 self.name = name 1142 self.parent = None 1143 self.referenced = 0 1144 1145 # Original location details. 1146 1147 self.astnode = None 1148 1149 # Complete lists of classes and functions. 1150 1151 self.all_objects = set() 1152 1153 # Keyword records. 1154 1155 self.keyword_names = set() 1156 1157 # Image generation details. 1158 1159 self.location = None 1160 self.code_location = None 1161 1162 # Program-related details. 1163 1164 self.blocks = None 1165 self.temp_usage = 0 1166 self.local_usage = 0 1167 self.all_local_usage = 0 1168 1169 def set_referenced(self): 1170 self.referenced = 1 1171 1172 def full_name(self): 1173 return self.name 1174 1175 def __repr__(self): 1176 if self.location is not None: 1177 return "Module(%r, location=%r)" % (self.name, self.location) 1178 else: 1179 return "Module(%r)" % self.name 1180 1181 def __shortrepr__(self): 1182 return "Module(%r)" % self.name 1183 1184 def as_raw(self, objtable, paramtable): 1185 return [ 1186 DataObject( 1187 objtable.as_list().get_code(self.full_name()), 1188 None, # NOTE: module name not used as an attribute, but should be instance 1189 None, 1190 None, 1191 self.full_name(), 1192 len(self.module_attributes()) + 1 # size 1193 ) 1194 ] 1195 1196 # Attribute methods. 1197 1198 "Return the module attribute names provided by the module." 1199 1200 module_attribute_names = NamespaceDict.keys 1201 1202 def module_attributes(self): 1203 1204 "Return a dictionary mapping names to module attributes." 1205 1206 return dict(self) 1207 1208 # vim: tabstop=4 expandtab shiftwidth=4