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