1 #!/usr/bin/env python 2 3 """ 4 Deduce types for usage observations. 5 6 Copyright (C) 2014, 2015, 2016, 2017 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 from common import first, get_assigned_attributes, \ 23 get_attrname_from_location, get_attrnames, \ 24 get_invoked_attributes, get_name_path, init_item, \ 25 sorted_output, CommonOutput 26 from encoders import encode_access_location, encode_constrained, \ 27 encode_instruction, encode_location, encode_usage, \ 28 get_kinds, test_label_for_kind, test_label_for_type 29 from errors import DeduceError 30 from os.path import join 31 from referencing import combine_types, is_single_class_type, separate_types, \ 32 Reference 33 34 class Deducer(CommonOutput): 35 36 "Deduce types in a program." 37 38 root_class_type = "__builtins__.object" 39 40 def __init__(self, importer, output): 41 42 """ 43 Initialise an instance using the given 'importer' that will perform 44 deductions on the program information, writing the results to the given 45 'output' directory. 46 """ 47 48 self.importer = importer 49 self.output = output 50 51 # Descendants of classes. 52 53 self.descendants = {} 54 self.init_descendants() 55 self.init_special_attributes() 56 57 # Map locations to usage in order to determine specific types. 58 59 self.location_index = {} 60 61 # Map access locations to definition locations. 62 63 self.access_index = {} 64 65 # Map aliases to accesses that define them. 66 67 self.alias_index = {} 68 69 # Map constant accesses to redefined accesses. 70 71 self.const_accesses = {} 72 self.const_accesses_rev = {} 73 74 # Map usage observations to assigned attributes. 75 76 self.assigned_attrs = {} 77 78 # Map usage observations to objects. 79 80 self.attr_class_types = {} 81 self.attr_instance_types = {} 82 self.attr_module_types = {} 83 84 # All known attribute names. 85 86 self.all_attrnames = set() 87 88 # Modified attributes from usage observations. 89 90 self.modified_attributes = {} 91 92 # Accesses that are assignments or invocations. 93 94 self.reference_assignments = set() 95 self.reference_invocations = {} 96 self.reference_invocations_unsuitable = {} 97 98 # Map locations to types, constrained indicators and attributes. 99 100 self.accessor_class_types = {} 101 self.accessor_instance_types = {} 102 self.accessor_module_types = {} 103 self.provider_class_types = {} 104 self.provider_instance_types = {} 105 self.provider_module_types = {} 106 self.accessor_constrained = set() 107 self.access_constrained = set() 108 self.referenced_attrs = {} 109 self.referenced_objects = {} 110 111 # Details of access operations. 112 113 self.access_plans = {} 114 115 # Specific attribute access information. 116 117 self.access_instructions = {} 118 self.accessor_kinds = {} 119 120 # Accumulated information about accessors and providers. 121 122 self.accessor_general_class_types = {} 123 self.accessor_general_instance_types = {} 124 self.accessor_general_module_types = {} 125 self.accessor_all_types = {} 126 self.accessor_all_general_types = {} 127 self.provider_all_types = {} 128 self.accessor_guard_tests = {} 129 130 # Accumulated information about accessed attributes and 131 # access/attribute-specific accessor tests. 132 133 self.reference_all_attrs = {} 134 self.reference_all_providers = {} 135 self.reference_all_provider_kinds = {} 136 self.reference_all_accessor_types = {} 137 self.reference_all_accessor_general_types = {} 138 self.reference_test_types = {} 139 self.reference_test_accessor_type = {} 140 141 # The processing workflow itself. 142 143 self.init_usage_index() 144 self.init_attr_type_indexes() 145 self.init_combined_attribute_index() 146 self.init_accessors() 147 self.init_accesses() 148 self.init_aliases() 149 self.modify_mutated_attributes() 150 self.identify_references() 151 self.classify_accessors() 152 self.classify_accesses() 153 self.initialise_access_plans() 154 self.initialise_access_instructions() 155 self.identify_dependencies() 156 157 def to_output(self): 158 159 "Write the output files using deduction information." 160 161 self.check_output() 162 163 self.write_mutations() 164 self.write_accessors() 165 self.write_accesses() 166 self.write_access_plans() 167 168 def write_mutations(self): 169 170 """ 171 Write mutation-related output in the following format: 172 173 qualified name " " original object type 174 175 Object type can be "<class>", "<function>" or "<var>". 176 """ 177 178 f = open(join(self.output, "mutations"), "w") 179 try: 180 attrs = self.modified_attributes.items() 181 attrs.sort() 182 183 for attr, value in attrs: 184 print >>f, attr, value 185 finally: 186 f.close() 187 188 def write_accessors(self): 189 190 """ 191 Write reference-related output in the following format for types: 192 193 location " " ( "constrained" | "deduced" ) " " attribute type " " most general type names " " number of specific types 194 195 Note that multiple lines can be given for each location, one for each 196 attribute type. 197 198 Locations have the following format: 199 200 qualified name of scope "." local name ":" name version 201 202 The attribute type can be "<class>", "<instance>", "<module>" or "<>", 203 where the latter indicates an absence of suitable references. 204 205 Type names indicate the type providing the attributes, being either a 206 class or module qualified name. 207 208 ---- 209 210 A summary of accessor types is formatted as follows: 211 212 location " " ( "constrained" | "deduced" ) " " ( "specific" | "common" | "unguarded" ) " " most general type names " " number of specific types 213 214 This summary groups all attribute types (class, instance, module) into a 215 single line in order to determine the complexity of identifying an 216 accessor. 217 218 ---- 219 220 References that cannot be supported by any types are written to a 221 warnings file in the following format: 222 223 location 224 225 ---- 226 227 For each location where a guard would be asserted to guarantee the 228 nature of an object, the following format is employed: 229 230 location " " ( "specific" | "common" ) " " object kind " " object types 231 232 Object kind can be "<class>", "<instance>" or "<module>". 233 """ 234 235 f_type_summary = open(join(self.output, "type_summary"), "w") 236 f_types = open(join(self.output, "types"), "w") 237 f_warnings = open(join(self.output, "type_warnings"), "w") 238 f_guards = open(join(self.output, "guards"), "w") 239 240 try: 241 locations = self.accessor_class_types.keys() 242 locations.sort() 243 244 for location in locations: 245 constrained = location in self.accessor_constrained 246 247 # Accessor information. 248 249 class_types = self.accessor_class_types[location] 250 instance_types = self.accessor_instance_types[location] 251 module_types = self.accessor_module_types[location] 252 253 general_class_types = self.accessor_general_class_types[location] 254 general_instance_types = self.accessor_general_instance_types[location] 255 general_module_types = self.accessor_general_module_types[location] 256 257 all_types = self.accessor_all_types[location] 258 all_general_types = self.accessor_all_general_types[location] 259 260 if class_types: 261 print >>f_types, encode_location(location), encode_constrained(constrained), "<class>", \ 262 sorted_output(general_class_types), len(class_types) 263 264 if instance_types: 265 print >>f_types, encode_location(location), encode_constrained(constrained), "<instance>", \ 266 sorted_output(general_instance_types), len(instance_types) 267 268 if module_types: 269 print >>f_types, encode_location(location), encode_constrained(constrained), "<module>", \ 270 sorted_output(general_module_types), len(module_types) 271 272 if not all_types: 273 print >>f_types, encode_location(location), "deduced", "<>", 0 274 attrnames = list(self.location_index[location]) 275 attrnames.sort() 276 print >>f_warnings, encode_location(location), "; ".join(map(encode_usage, attrnames)) 277 278 guard_test = self.accessor_guard_tests.get(location) 279 if guard_test: 280 guard_test_type, guard_test_arg = guard_test 281 282 # Write specific type guard details. 283 284 if guard_test and guard_test_type == "specific": 285 print >>f_guards, encode_location(location), "-".join(guard_test), \ 286 first(get_kinds(all_types)), \ 287 sorted_output(all_types) 288 289 # Write common type guard details. 290 291 elif guard_test and guard_test_type == "common": 292 print >>f_guards, encode_location(location), "-".join(guard_test), \ 293 first(get_kinds(all_general_types)), \ 294 sorted_output(all_general_types) 295 296 print >>f_type_summary, encode_location(location), encode_constrained(constrained), \ 297 guard_test and "-".join(guard_test) or "unguarded", sorted_output(all_general_types), len(all_types) 298 299 finally: 300 f_type_summary.close() 301 f_types.close() 302 f_warnings.close() 303 f_guards.close() 304 305 def write_accesses(self): 306 307 """ 308 Specific attribute output is produced in the following format: 309 310 location " " ( "constrained" | "deduced" ) " " attribute type " " attribute references 311 312 Note that multiple lines can be given for each location and attribute 313 name, one for each attribute type. 314 315 Locations have the following format: 316 317 qualified name of scope "." local name " " attribute name ":" access number 318 319 The attribute type can be "<class>", "<instance>", "<module>" or "<>", 320 where the latter indicates an absence of suitable references. 321 322 Attribute references have the following format: 323 324 object type ":" qualified name 325 326 Object type can be "<class>", "<function>" or "<var>". 327 328 ---- 329 330 A summary of attributes is formatted as follows: 331 332 location " " attribute name " " ( "constrained" | "deduced" ) " " test " " attribute references 333 334 This summary groups all attribute types (class, instance, module) into a 335 single line in order to determine the complexity of each access. 336 337 Tests can be "validate", "specific", "untested", "guarded-validate" or "guarded-specific". 338 339 ---- 340 341 For each access where a test would be asserted to guarantee the 342 nature of an attribute, the following formats are employed: 343 344 location " " attribute name " " "validate" 345 location " " attribute name " " "specific" " " attribute type " " object type 346 347 ---- 348 349 References that cannot be supported by any types are written to a 350 warnings file in the following format: 351 352 location 353 """ 354 355 f_attr_summary = open(join(self.output, "attribute_summary"), "w") 356 f_attrs = open(join(self.output, "attributes"), "w") 357 f_tests = open(join(self.output, "tests"), "w") 358 f_warnings = open(join(self.output, "attribute_warnings"), "w") 359 f_unsuitable = open(join(self.output, "invocation_warnings"), "w") 360 361 try: 362 locations = self.referenced_attrs.keys() 363 locations.sort() 364 365 for location in locations: 366 constrained = location in self.access_constrained 367 368 # Attribute information, both name-based and anonymous. 369 370 referenced_attrs = self.referenced_attrs[location] 371 372 if referenced_attrs: 373 attrname = get_attrname_from_location(location) 374 375 all_accessed_attrs = self.reference_all_attrs[location] 376 377 for attrtype, attrs in self.get_referenced_attrs(location): 378 print >>f_attrs, encode_access_location(location), encode_constrained(constrained), attrtype, sorted_output(attrs) 379 380 test_type = self.reference_test_types.get(location) 381 382 # Write the need to test at run time. 383 384 if test_type[0] == "validate": 385 print >>f_tests, encode_access_location(location), "-".join(test_type) 386 387 # Write any type checks for anonymous accesses. 388 389 elif test_type and self.reference_test_accessor_type.get(location): 390 print >>f_tests, encode_access_location(location), "-".join(test_type), \ 391 sorted_output(all_accessed_attrs), \ 392 self.reference_test_accessor_type[location] 393 394 print >>f_attr_summary, encode_access_location(location), encode_constrained(constrained), \ 395 test_type and "-".join(test_type) or "untested", sorted_output(all_accessed_attrs) 396 397 # Write details of potentially unsuitable invocation 398 # occurrences. 399 400 unsuitable = self.reference_invocations_unsuitable.get(location) 401 if unsuitable: 402 unsuitable = map(str, unsuitable) 403 unsuitable.sort() 404 print >>f_unsuitable, encode_access_location(location), ", ".join(unsuitable) 405 406 else: 407 print >>f_warnings, encode_access_location(location) 408 409 finally: 410 f_attr_summary.close() 411 f_attrs.close() 412 f_tests.close() 413 f_warnings.close() 414 f_unsuitable.close() 415 416 def write_access_plans(self): 417 418 """ 419 Write access and instruction plans. 420 421 Each attribute access is written out as a plan of the following form: 422 423 location " " name " " test " " test type " " base " " traversed attributes 424 " " traversal access modes " " attributes to traverse 425 " " context " " context test " " first access method 426 " " final access method " " static attribute " " accessor kinds 427 428 Locations have the following format: 429 430 qualified name of scope "." local name ":" name version 431 432 Traversal access modes are either "class" (obtain accessor class to 433 access attribute) or "object" (obtain attribute directly from accessor). 434 """ 435 436 f_attrs = open(join(self.output, "attribute_plans"), "w") 437 438 try: 439 locations = self.access_plans.keys() 440 locations.sort() 441 442 for location in locations: 443 name, test, test_type, base, \ 444 traversed, traversal_modes, attrnames, \ 445 context, context_test, \ 446 first_method, final_method, \ 447 attr, accessor_kinds = self.access_plans[location] 448 449 print >>f_attrs, encode_access_location(location), \ 450 name or "{}", \ 451 test and "-".join(test) or "{}", \ 452 test_type or "{}", \ 453 base or "{}", \ 454 ".".join(traversed) or "{}", \ 455 ".".join(traversal_modes) or "{}", \ 456 ".".join(attrnames) or "{}", \ 457 context, context_test, \ 458 first_method, final_method, attr or "{}", \ 459 ",".join(accessor_kinds) 460 461 finally: 462 f_attrs.close() 463 464 f = open(join(self.output, "instruction_plans"), "w") 465 try: 466 access_instructions = self.access_instructions.items() 467 access_instructions.sort() 468 469 for location, instructions in access_instructions: 470 print >>f, encode_access_location(location), "..." 471 for instruction in instructions: 472 print >>f, encode_instruction(instruction) 473 print >>f 474 475 finally: 476 f.close() 477 478 def classify_accessors(self): 479 480 "For each program location, classify accessors." 481 482 # Where instance and module types are defined, class types are also 483 # defined. See: init_definition_details 484 485 locations = self.accessor_class_types.keys() 486 487 for location in locations: 488 constrained = location in self.accessor_constrained 489 490 # Provider information. 491 492 class_types = self.provider_class_types[location] 493 instance_types = self.provider_instance_types[location] 494 module_types = self.provider_module_types[location] 495 496 # Collect specific and general type information. 497 498 self.provider_all_types[location] = \ 499 combine_types(class_types, instance_types, module_types) 500 501 # Accessor information. 502 503 class_types = self.accessor_class_types[location] 504 self.accessor_general_class_types[location] = \ 505 general_class_types = self.get_most_general_class_types(class_types) 506 507 instance_types = self.accessor_instance_types[location] 508 self.accessor_general_instance_types[location] = \ 509 general_instance_types = self.get_most_general_class_types(instance_types) 510 511 module_types = self.accessor_module_types[location] 512 self.accessor_general_module_types[location] = \ 513 general_module_types = self.get_most_general_module_types(module_types) 514 515 # Collect specific and general type information. 516 517 self.accessor_all_types[location] = all_types = \ 518 combine_types(class_types, instance_types, module_types) 519 520 self.accessor_all_general_types[location] = all_general_types = \ 521 combine_types(general_class_types, general_instance_types, general_module_types) 522 523 # Record guard information. 524 525 if not constrained: 526 527 # Record specific type guard details. 528 529 if len(all_types) == 1: 530 self.accessor_guard_tests[location] = ("specific", test_label_for_type(first(all_types))) 531 elif is_single_class_type(all_types): 532 self.accessor_guard_tests[location] = ("specific", "object") 533 534 # Record common type guard details. 535 536 elif len(all_general_types) == 1: 537 self.accessor_guard_tests[location] = ("common", test_label_for_type(first(all_types))) 538 elif is_single_class_type(all_general_types): 539 self.accessor_guard_tests[location] = ("common", "object") 540 541 # Otherwise, no convenient guard can be defined. 542 543 def classify_accesses(self): 544 545 "For each program location, classify accesses." 546 547 # Attribute accesses use potentially different locations to those of 548 # accessors. 549 550 locations = self.referenced_attrs.keys() 551 552 for location in locations: 553 constrained = location in self.access_constrained 554 555 # Combine type information from all accessors supplying the access. 556 557 accessor_locations = self.get_accessors_for_access(location) 558 559 all_provider_types = set() 560 all_accessor_types = set() 561 all_accessor_general_types = set() 562 563 for accessor_location in accessor_locations: 564 565 # Obtain the provider types for guard-related attribute access 566 # checks. 567 568 all_provider_types.update(self.provider_all_types.get(accessor_location)) 569 570 # Obtain the accessor guard types (specific and general). 571 572 all_accessor_types.update(self.accessor_all_types.get(accessor_location)) 573 all_accessor_general_types.update(self.accessor_all_general_types.get(accessor_location)) 574 575 # Obtain basic properties of the types involved in the access. 576 577 single_accessor_type = len(all_accessor_types) == 1 578 single_accessor_class_type = is_single_class_type(all_accessor_types) 579 single_accessor_general_type = len(all_accessor_general_types) == 1 580 single_accessor_general_class_type = is_single_class_type(all_accessor_general_types) 581 582 # Determine whether the attribute access is guarded or not. 583 584 guarded = ( 585 single_accessor_type or single_accessor_class_type or 586 single_accessor_general_type or single_accessor_general_class_type 587 ) 588 589 if guarded: 590 (guard_class_types, guard_instance_types, guard_module_types, 591 _function_types, _var_types) = separate_types(all_provider_types) 592 593 self.reference_all_accessor_types[location] = all_accessor_types 594 self.reference_all_accessor_general_types[location] = all_accessor_general_types 595 596 # Attribute information, both name-based and anonymous. 597 598 referenced_attrs = self.referenced_attrs[location] 599 600 if not referenced_attrs: 601 raise DeduceError("In %s, access via %s to attribute %s (occurrence %d) cannot be identified." % location) 602 603 # Record attribute information for each name used on the 604 # accessor. 605 606 attrname = get_attrname_from_location(location) 607 608 self.reference_all_attrs[location] = all_accessed_attrs = [] 609 self.reference_all_providers[location] = all_providers = [] 610 self.reference_all_provider_kinds[location] = all_provider_kinds = set() 611 612 # Obtain provider and attribute details for this kind of 613 # object. 614 615 for attrtype, object_type, attr in referenced_attrs: 616 all_accessed_attrs.append(attr) 617 all_providers.append(object_type) 618 all_provider_kinds.add(attrtype) 619 620 # Obtain reference and provider information as sets for the 621 # operations below, retaining the list forms for use with 622 # instruction plan preparation. 623 624 all_accessed_attrs = set(all_accessed_attrs) 625 all_providers = set(all_providers) 626 all_general_providers = self.get_most_general_types(all_providers) 627 628 # Determine which attributes would be provided by the 629 # accessor types upheld by a guard. 630 631 if guarded: 632 guard_attrs = set() 633 634 for _attrtype, object_type, attr in \ 635 self._identify_reference_attribute(location, attrname, guard_class_types, guard_instance_types, guard_module_types): 636 637 guard_attrs.add(attr) 638 else: 639 guard_attrs = None 640 641 # Constrained accesses guarantee the nature of the accessor. 642 # However, there may still be many types involved. 643 644 if constrained: 645 if single_accessor_type: 646 self.reference_test_types[location] = ("constrained", "specific", test_label_for_type(first(all_accessor_types))) 647 elif single_accessor_class_type: 648 self.reference_test_types[location] = ("constrained", "specific", "object") 649 elif single_accessor_general_type: 650 self.reference_test_types[location] = ("constrained", "common", test_label_for_type(first(all_accessor_general_types))) 651 elif single_accessor_general_class_type: 652 self.reference_test_types[location] = ("constrained", "common", "object") 653 else: 654 self.reference_test_types[location] = ("constrained", "many") 655 656 # Suitably guarded accesses, where the nature of the 657 # accessor can be guaranteed, do not require the attribute 658 # involved to be validated. Otherwise, for unguarded 659 # accesses, access-level tests are required. 660 661 elif guarded and all_accessed_attrs.issubset(guard_attrs): 662 if single_accessor_type: 663 self.reference_test_types[location] = ("guarded", "specific", test_label_for_type(first(all_accessor_types))) 664 elif single_accessor_class_type: 665 self.reference_test_types[location] = ("guarded", "specific", "object") 666 elif single_accessor_general_type: 667 self.reference_test_types[location] = ("guarded", "common", test_label_for_type(first(all_accessor_general_types))) 668 elif single_accessor_general_class_type: 669 self.reference_test_types[location] = ("guarded", "common", "object") 670 671 # Record the need to test the type of anonymous and 672 # unconstrained accessors. 673 674 elif len(all_providers) == 1: 675 provider = first(all_providers) 676 if provider != self.root_class_type: 677 all_accessor_kinds = set(get_kinds(all_accessor_types)) 678 if len(all_accessor_kinds) == 1: 679 test_type = ("test", "specific", test_label_for_kind(first(all_accessor_kinds))) 680 else: 681 test_type = ("test", "specific", "object") 682 self.reference_test_types[location] = test_type 683 self.reference_test_accessor_type[location] = provider 684 685 elif len(all_general_providers) == 1: 686 provider = first(all_general_providers) 687 if provider != self.root_class_type: 688 all_accessor_kinds = set(get_kinds(all_accessor_general_types)) 689 if len(all_accessor_kinds) == 1: 690 test_type = ("test", "common", test_label_for_kind(first(all_accessor_kinds))) 691 else: 692 test_type = ("test", "common", "object") 693 self.reference_test_types[location] = test_type 694 self.reference_test_accessor_type[location] = provider 695 696 # Record the need to test the identity of the attribute. 697 698 else: 699 self.reference_test_types[location] = ("validate",) 700 701 def initialise_access_plans(self): 702 703 "Define attribute access plans." 704 705 for location in self.referenced_attrs.keys(): 706 original_location = self.const_accesses_rev.get(location) 707 self.access_plans[original_location or location] = self.get_access_plan(location) 708 709 def identify_dependencies(self): 710 711 "Introduce more module dependencies to the importer." 712 713 for location, referenced_attrs in self.referenced_attrs.items(): 714 path, name, attrnames, version = location 715 716 # Identify module-level paths. 717 718 if self.importer.modules.has_key(path): 719 module_name = path 720 721 # Identify the module containing other paths. 722 723 else: 724 ref = self.importer.identify(path) 725 for objpath in ref.ancestors(): 726 if self.importer.modules.has_key(objpath): 727 module_name = objpath 728 break 729 else: 730 raise DeduceError("Cannot find module for path %s." % path) 731 732 # Identify references providing dependencies. 733 734 for attrtype, objtype, attr in referenced_attrs: 735 self.importer.add_dependency(path, attr.get_origin()) 736 737 def get_referenced_attrs(self, location): 738 739 """ 740 Return attributes referenced at the given access 'location' by the given 741 'attrname' as a list of (attribute type, attribute set) tuples. 742 """ 743 744 d = {} 745 for attrtype, objtype, attr in self.referenced_attrs[location]: 746 init_item(d, attrtype, set) 747 d[attrtype].add(attr.unaliased()) 748 l = d.items() 749 l.sort() # class, module, instance 750 return l 751 752 # Initialisation methods. 753 754 def init_descendants(self): 755 756 "Identify descendants of each class." 757 758 for name in self.importer.classes.keys(): 759 self.get_descendants_for_class(name) 760 761 def get_descendants_for_class(self, name): 762 763 """ 764 Use subclass information to deduce the descendants for the class of the 765 given 'name'. 766 """ 767 768 if not self.descendants.has_key(name): 769 descendants = set() 770 771 for subclass in self.importer.subclasses[name]: 772 descendants.update(self.get_descendants_for_class(subclass)) 773 descendants.add(subclass) 774 775 self.descendants[name] = descendants 776 777 return self.descendants[name] 778 779 def init_special_attributes(self): 780 781 "Add special attributes to the classes for inheritance-related tests." 782 783 all_class_attrs = self.importer.all_class_attrs 784 785 for name, descendants in self.descendants.items(): 786 for descendant in descendants: 787 all_class_attrs[descendant]["#%s" % name] = name 788 789 for name in all_class_attrs.keys(): 790 all_class_attrs[name]["#%s" % name] = name 791 792 def init_usage_index(self): 793 794 """ 795 Create indexes for module and function attribute usage and for anonymous 796 accesses. 797 """ 798 799 for module in self.importer.get_modules(): 800 for path, assignments in module.attr_usage.items(): 801 self.add_usage(assignments, path) 802 803 for location, all_attrnames in self.importer.all_attr_accesses.items(): 804 for attrnames in all_attrnames: 805 attrname = get_attrnames(attrnames)[-1] 806 access_location = (location, None, attrnames, 0) 807 self.add_usage_term(access_location, ((attrname, False, False),)) 808 809 def add_usage(self, assignments, path): 810 811 """ 812 Collect usage from the given 'assignments', adding 'path' details to 813 each record if specified. Add the usage to an index mapping to location 814 information, as well as to an index mapping locations to usages. 815 """ 816 817 for name, versions in assignments.items(): 818 for i, usages in enumerate(versions): 819 location = (path, name, None, i) 820 821 for usage in usages: 822 self.add_usage_term(location, usage) 823 824 def add_usage_term(self, location, usage): 825 826 """ 827 For 'location' and using 'usage' as a description of usage, record 828 in the usage index a mapping from the usage to 'location', and record in 829 the location index a mapping from 'location' to the usage. 830 """ 831 832 init_item(self.location_index, location, set) 833 self.location_index[location].add(usage) 834 835 def init_accessors(self): 836 837 "Create indexes for module and function accessor information." 838 839 for module in self.importer.get_modules(): 840 for path, all_accesses in module.attr_accessors.items(): 841 self.add_accessors(all_accesses, path) 842 843 def add_accessors(self, all_accesses, path): 844 845 """ 846 For attribute accesses described by the mapping of 'all_accesses' from 847 name details to accessor details, record the locations of the accessors 848 for each access. 849 """ 850 851 # Get details for each access combining the given name and attribute. 852 853 for (name, attrnames), accesses in all_accesses.items(): 854 855 # Obtain the usage details using the access information. 856 857 for access_number, versions in enumerate(accesses): 858 access_location = (path, name, attrnames, access_number) 859 locations = [] 860 861 for version in versions: 862 location = (path, name, None, version) 863 locations.append(location) 864 865 self.access_index[access_location] = locations 866 867 def get_accessors_for_access(self, access_location): 868 869 "Find a definition providing accessor details, if necessary." 870 871 try: 872 return self.access_index[access_location] 873 except KeyError: 874 return [access_location] 875 876 def init_accesses(self): 877 878 """ 879 Check that attributes used in accesses are actually defined on some 880 object. This can be overlooked if unknown attributes are employed in 881 attribute chains. 882 883 Initialise collections for accesses involving assignments. 884 """ 885 886 # For each scope, obtain access details. 887 888 for path, all_accesses in self.importer.all_attr_access_modifiers.items(): 889 890 # For each combination of name and attribute names, obtain 891 # applicable modifiers. 892 893 for (name, attrname_str), modifiers in all_accesses.items(): 894 895 # For each access, determine the name versions affected by 896 # assignments. 897 898 for access_number, (assignment, invocation) in enumerate(modifiers): 899 900 if name: 901 access_location = (path, name, attrname_str, access_number) 902 else: 903 access_location = (path, None, attrname_str, 0) 904 905 # Plain name accesses do not employ attributes and are 906 # ignored. Whether they are invoked is of interest, however. 907 908 if not attrname_str: 909 if invocation: 910 self.reference_invocations[access_location] = invocation 911 continue 912 913 attrnames = get_attrnames(attrname_str) 914 915 # Check the attribute names. 916 917 for attrname in attrnames: 918 if not attrname in self.all_attrnames: 919 raise DeduceError("In %s, attribute %s is not defined in the program." % (path, attrname)) 920 921 # Now only process assignments and invocations. 922 923 if invocation: 924 self.reference_invocations[access_location] = invocation 925 continue 926 elif not assignment: 927 continue 928 929 # Associate assignments with usage. 930 931 self.reference_assignments.add(access_location) 932 933 # Assignment occurs for the only attribute. 934 935 if len(attrnames) == 1: 936 accessor_locations = self.get_accessors_for_access(access_location) 937 938 for location in accessor_locations: 939 for usage in self.location_index[location]: 940 init_item(self.assigned_attrs, usage, set) 941 self.assigned_attrs[usage].add((path, name, attrnames[0])) 942 943 # Assignment occurs for the final attribute. 944 945 else: 946 usage = ((attrnames[-1], False, False),) 947 init_item(self.assigned_attrs, usage, set) 948 self.assigned_attrs[usage].add((path, name, attrnames[-1])) 949 950 def init_aliases(self): 951 952 "Expand aliases so that alias-based accesses can be resolved." 953 954 # Get aliased names with details of their accesses. 955 956 for (path, name), all_aliases in self.importer.all_aliased_names.items(): 957 958 # For each version of the name, obtain the access location. 959 960 for version, (original_path, original_name, attrnames, access_number) in all_aliases.items(): 961 accessor_location = (path, name, None, version) 962 access_location = (original_path, original_name, attrnames, access_number) 963 init_item(self.alias_index, accessor_location, list) 964 self.alias_index[accessor_location].append(access_location) 965 966 # Get aliases in terms of non-aliases and accesses. 967 968 for accessor_location, access_locations in self.alias_index.items(): 969 self.update_aliases(accessor_location, access_locations) 970 971 def update_aliases(self, accessor_location, access_locations, visited=None): 972 973 """ 974 Update the given 'accessor_location' defining an alias, update 975 'access_locations' to refer to non-aliases, following name references 976 via the access index. 977 978 If 'visited' is specified, it contains a set of accessor locations (and 979 thus keys to the alias index) that are currently being defined. 980 """ 981 982 if visited is None: 983 visited = set() 984 985 updated_locations = set() 986 987 for access_location in access_locations: 988 (path, original_name, attrnames, access_number) = access_location 989 990 # Where an alias refers to a name access, obtain the original name 991 # version details. 992 993 if attrnames is None: 994 995 # For each name version, attempt to determine any accesses that 996 # initialise the name. 997 998 for name_accessor_location in self.access_index[access_location]: 999 1000 # Already-visited aliases do not contribute details. 1001 1002 if name_accessor_location in visited: 1003 continue 1004 1005 visited.add(name_accessor_location) 1006 1007 name_access_locations = self.alias_index.get(name_accessor_location) 1008 if name_access_locations: 1009 updated_locations.update(self.update_aliases(name_accessor_location, name_access_locations, visited)) 1010 else: 1011 updated_locations.add(name_accessor_location) 1012 1013 # Otherwise, record the access details. 1014 1015 else: 1016 updated_locations.add(access_location) 1017 1018 self.alias_index[accessor_location] = updated_locations 1019 return updated_locations 1020 1021 # Attribute mutation for types. 1022 1023 def modify_mutated_attributes(self): 1024 1025 "Identify known, mutated attributes and change their state." 1026 1027 # Usage-based accesses. 1028 1029 for usage, all_attrnames in self.assigned_attrs.items(): 1030 if not usage: 1031 continue 1032 1033 for path, name, attrname in all_attrnames: 1034 class_types = self.get_class_types_for_usage(usage) 1035 only_instance_types = set(self.get_instance_types_for_usage(usage)).difference(class_types) 1036 module_types = self.get_module_types_for_usage(usage) 1037 1038 # Detect self usage within methods in order to narrow the scope 1039 # of the mutation. 1040 1041 t = name == "self" and self.constrain_self_reference(path, class_types, only_instance_types) 1042 if t: 1043 class_types, only_instance_types, module_types, constrained = t 1044 objects = set(class_types).union(only_instance_types).union(module_types) 1045 1046 self.mutate_attribute(objects, attrname) 1047 1048 def mutate_attribute(self, objects, attrname): 1049 1050 "Mutate static 'objects' with the given 'attrname'." 1051 1052 for name in objects: 1053 attr = "%s.%s" % (name, attrname) 1054 value = self.importer.get_object(attr) 1055 1056 # If the value is None, the attribute is 1057 # inherited and need not be set explicitly on 1058 # the class concerned. 1059 1060 if value: 1061 self.modified_attributes[attr] = value 1062 self.importer.set_object(attr, value.as_var()) 1063 1064 # Simplification of types. 1065 1066 def get_most_general_types(self, types): 1067 1068 "Return the most general types for the given 'types'." 1069 1070 module_types = set() 1071 class_types = set() 1072 1073 for type in types: 1074 ref = self.importer.identify(type) 1075 if ref.has_kind("<module>"): 1076 module_types.add(type) 1077 else: 1078 class_types.add(type) 1079 1080 types = set(self.get_most_general_module_types(module_types)) 1081 types.update(self.get_most_general_class_types(class_types)) 1082 return types 1083 1084 def get_most_general_class_types(self, class_types): 1085 1086 "Return the most general types for the given 'class_types'." 1087 1088 class_types = set(class_types) 1089 to_remove = set() 1090 1091 for class_type in class_types: 1092 for base in self.importer.classes[class_type]: 1093 base = base.get_origin() 1094 descendants = self.descendants[base] 1095 if base in class_types and descendants.issubset(class_types): 1096 to_remove.update(descendants) 1097 1098 class_types.difference_update(to_remove) 1099 return class_types 1100 1101 def get_most_general_module_types(self, module_types): 1102 1103 "Return the most general type for the given 'module_types'." 1104 1105 # Where all modules are provided, an object would provide the same 1106 # attributes. 1107 1108 if len(module_types) == len(self.importer.modules): 1109 return [self.root_class_type] 1110 else: 1111 return module_types 1112 1113 # More efficient usage-to-type indexing and retrieval. 1114 1115 def init_attr_type_indexes(self): 1116 1117 "Identify the types that can support each attribute name." 1118 1119 self._init_attr_type_index(self.attr_class_types, self.importer.all_class_attrs) 1120 self._init_attr_type_index(self.attr_instance_types, self.importer.all_instance_attrs, True) 1121 self._init_attr_type_index(self.attr_instance_types, self.importer.all_combined_attrs, False) 1122 self._init_attr_type_index(self.attr_module_types, self.importer.all_module_attrs) 1123 1124 def _init_attr_type_index(self, attr_types, attrs, assignment=None): 1125 1126 """ 1127 Initialise the 'attr_types' attribute-to-types mapping using the given 1128 'attrs' type-to-attributes mapping. 1129 """ 1130 1131 for name, attrnames in attrs.items(): 1132 for attrname in attrnames: 1133 1134 # Permit general access for certain kinds of object. 1135 1136 if assignment is None: 1137 init_item(attr_types, (attrname, False), set) 1138 init_item(attr_types, (attrname, True), set) 1139 attr_types[(attrname, False)].add(name) 1140 attr_types[(attrname, True)].add(name) 1141 1142 # Restrict attribute assignment for instances. 1143 1144 else: 1145 init_item(attr_types, (attrname, assignment), set) 1146 attr_types[(attrname, assignment)].add(name) 1147 1148 def get_class_types_for_usage(self, usage): 1149 1150 "Return names of classes supporting the given 'usage'." 1151 1152 return self._get_types_for_usage(usage, self.attr_class_types, self.importer.all_class_attrs) 1153 1154 def get_instance_types_for_usage(self, usage): 1155 1156 """ 1157 Return names of classes whose instances support the given 'usage' 1158 (as either class or instance attributes). 1159 """ 1160 1161 return self._get_types_for_usage(usage, self.attr_instance_types, self.importer.all_combined_attrs) 1162 1163 def get_module_types_for_usage(self, usage): 1164 1165 "Return names of modules supporting the given 'usage'." 1166 1167 return self._get_types_for_usage(usage, self.attr_module_types, self.importer.all_module_attrs) 1168 1169 def _get_types_for_usage(self, usage, attr_types, attrs): 1170 1171 """ 1172 For the given 'usage' representing attribute usage, return types 1173 recorded in the 'attr_types' attribute-to-types mapping that support 1174 such usage, with the given 'attrs' type-to-attributes mapping used to 1175 quickly assess whether a type supports all of the stated attributes. 1176 """ 1177 1178 # Where no attributes are used, any type would be acceptable. 1179 1180 if not usage: 1181 return attrs.keys() 1182 1183 keys = [] 1184 for attrname, invocation, assignment in usage: 1185 keys.append((attrname, assignment)) 1186 1187 # Obtain types supporting the first (attribute name, assignment) key... 1188 1189 types = set(attr_types.get(keys[0]) or []) 1190 1191 for key in keys[1:]: 1192 1193 # Record types that support all of the other attributes as well. 1194 1195 types.intersection_update(attr_types.get(key) or []) 1196 1197 return types 1198 1199 def init_combined_attribute_index(self): 1200 1201 "Initialise a combined index for the detection of invalid attributes." 1202 1203 self.all_attrnames = set() 1204 for attrs in (self.importer.all_combined_attrs, self.importer.all_module_attrs): 1205 for name, attrnames in attrs.items(): 1206 self.all_attrnames.update(attrnames) 1207 1208 # Reference identification. 1209 1210 def identify_references(self): 1211 1212 "Identify references using usage and name reference information." 1213 1214 # Names with associated attribute usage. 1215 1216 for location, usages in self.location_index.items(): 1217 1218 # Obtain attribute usage associated with a name, deducing the nature 1219 # of the name. Obtain types only for branches involving attribute 1220 # usage. (In the absence of usage, any type could be involved, but 1221 # then no accesses exist to require knowledge of the type.) 1222 1223 have_usage = False 1224 have_no_usage_branch = False 1225 1226 for usage in usages: 1227 if not usage: 1228 have_no_usage_branch = True 1229 continue 1230 elif not have_usage: 1231 self.init_definition_details(location) 1232 have_usage = True 1233 self.record_types_for_usage(location, usage) 1234 1235 # Where some usage occurs, but where branches without usage also 1236 # occur, record the types for those branches anyway. 1237 1238 if have_usage and have_no_usage_branch: 1239 self.init_definition_details(location) 1240 self.record_types_for_usage(location, None) 1241 1242 # Specific name-based attribute accesses. 1243 1244 alias_accesses = set() 1245 1246 for access_location, accessor_locations in self.access_index.items(): 1247 self.record_types_for_access(access_location, accessor_locations, alias_accesses) 1248 1249 # Anonymous references with attribute chains. 1250 1251 for location, accesses in self.importer.all_attr_accesses.items(): 1252 1253 # Get distinct attribute names. 1254 1255 all_attrnames = set() 1256 1257 for attrnames in accesses: 1258 all_attrnames.update(get_attrnames(attrnames)) 1259 1260 # Get attribute and accessor details for each attribute name. 1261 1262 for attrname in all_attrnames: 1263 access_location = (location, None, attrname, 0) 1264 self.record_types_for_attribute(access_location, attrname) 1265 1266 # References via constant/identified objects. 1267 1268 for location, name_accesses in self.importer.all_const_accesses.items(): 1269 1270 # A mapping from the original name and attributes to resolved access 1271 # details. 1272 1273 for original_access, access in name_accesses.items(): 1274 original_name, original_attrnames = original_access 1275 objpath, ref, attrnames = access 1276 1277 # Build an accessor combining the name and attribute names used. 1278 1279 original_accessor = tuple([original_name] + original_attrnames.split(".")) 1280 1281 # Direct accesses to attributes. 1282 1283 if not attrnames: 1284 1285 # Build a descriptive location based on the original 1286 # details, exposing the final attribute name. 1287 1288 oa, attrname = original_accessor[:-1], original_accessor[-1] 1289 oa = ".".join(oa) 1290 1291 access_location = (location, oa, attrname, 0) 1292 accessor_location = (location, oa, None, 0) 1293 self.access_index[access_location] = [accessor_location] 1294 1295 self.init_access_details(access_location) 1296 self.init_definition_details(accessor_location) 1297 1298 # Obtain a reference for the accessor in order to properly 1299 # determine its type. 1300 1301 if ref.get_kind() != "<instance>": 1302 objpath = ref.get_origin() 1303 1304 objpath = objpath.rsplit(".", 1)[0] 1305 1306 # Where the object name conflicts with the module 1307 # providing it, obtain the module details. 1308 1309 if objpath in self.importer.modules: 1310 accessor = Reference("<module>", objpath) 1311 else: 1312 accessor = self.importer.get_object(objpath) 1313 1314 self.referenced_attrs[access_location] = [(accessor.get_kind(), accessor.get_origin(), ref)] 1315 self.access_constrained.add(access_location) 1316 1317 class_types, instance_types, module_types = accessor.get_types() 1318 self.record_reference_types(accessor_location, class_types, instance_types, module_types, True, True) 1319 1320 else: 1321 1322 # Build a descriptive location based on the original 1323 # details, employing the first remaining attribute name. 1324 1325 l = get_attrnames(attrnames) 1326 attrname = l[0] 1327 1328 oa = original_accessor[:-len(l)] 1329 oa = ".".join(oa) 1330 1331 access_location = (location, oa, attrnames, 0) 1332 accessor_location = (location, oa, None, 0) 1333 self.access_index[access_location] = [accessor_location] 1334 1335 self.init_access_details(access_location) 1336 self.init_definition_details(accessor_location) 1337 1338 class_types, instance_types, module_types = ref.get_types() 1339 1340 self.identify_reference_attributes(access_location, attrname, class_types, instance_types, module_types, True) 1341 self.record_reference_types(accessor_location, class_types, instance_types, module_types, True, True) 1342 1343 # Define mappings between the original and access locations 1344 # so that translation can work from the source details. 1345 1346 original_location = (location, original_name, original_attrnames, 0) 1347 1348 if original_location != access_location: 1349 self.const_accesses[original_location] = access_location 1350 self.const_accesses_rev[access_location] = original_location 1351 1352 # Aliased name definitions. All aliases with usage will have been 1353 # defined, but they may be refined according to referenced accesses. 1354 1355 for accessor_location in self.alias_index.keys(): 1356 self.record_types_for_alias(accessor_location) 1357 1358 # Update accesses employing aliases. 1359 1360 for access_location in alias_accesses: 1361 self.record_types_for_access(access_location, self.access_index[access_location]) 1362 1363 def constrain_types(self, path, class_types, instance_types, module_types): 1364 1365 """ 1366 Using the given 'path' to an object, constrain the given 'class_types', 1367 'instance_types' and 'module_types'. 1368 1369 Return the class, instance, module types plus whether the types are 1370 constrained to a specific kind of type. 1371 """ 1372 1373 ref = self.importer.identify(path) 1374 if ref: 1375 1376 # Constrain usage suggestions using the identified object. 1377 1378 if ref.has_kind("<class>"): 1379 return ( 1380 set(class_types).intersection([ref.get_origin()]), [], [], True 1381 ) 1382 elif ref.has_kind("<module>"): 1383 return ( 1384 [], [], set(module_types).intersection([ref.get_origin()]), True 1385 ) 1386 1387 return class_types, instance_types, module_types, False 1388 1389 def get_target_types(self, location, usage): 1390 1391 """ 1392 Return the class, instance and module types constrained for the name at 1393 the given 'location' exhibiting the given 'usage'. Whether the types 1394 have been constrained using contextual information is also indicated, 1395 plus whether the types have been constrained to a specific kind of type. 1396 """ 1397 1398 unit_path, name, attrnames, version = location 1399 have_assignments = get_assigned_attributes(usage) 1400 1401 # Detect any initialised name for the location. 1402 1403 if name: 1404 ref = self.get_initialised_name(location) 1405 if ref: 1406 (class_types, only_instance_types, module_types, 1407 _function_types, _var_types) = separate_types([ref]) 1408 return class_types, only_instance_types, module_types, True, have_assignments 1409 1410 # Retrieve the recorded types for the usage. 1411 1412 class_types = self.get_class_types_for_usage(usage) 1413 only_instance_types = set(self.get_instance_types_for_usage(usage)).difference(class_types) 1414 module_types = self.get_module_types_for_usage(usage) 1415 1416 # Merge usage deductions with observations to obtain reference types 1417 # for names involved with attribute accesses. 1418 1419 if not name: 1420 return class_types, only_instance_types, module_types, False, have_assignments 1421 1422 # Obtain references to known objects. 1423 1424 path = get_name_path(unit_path, name) 1425 1426 class_types, only_instance_types, module_types, constrained_specific = \ 1427 self.constrain_types(path, class_types, only_instance_types, module_types) 1428 1429 if constrained_specific: 1430 return class_types, only_instance_types, module_types, constrained_specific, \ 1431 constrained_specific or have_assignments 1432 1433 # Constrain "self" references. 1434 1435 if name == "self": 1436 1437 # Test for the class of the method in the deduced types. 1438 1439 class_name = self.in_method(unit_path) 1440 1441 if class_name and class_name not in class_types and class_name not in only_instance_types: 1442 raise DeduceError("In %s, usage {%s} is not directly supported by class %s or its instances." % 1443 (unit_path, encode_usage(usage), class_name)) 1444 1445 # Constrain the types to the class's hierarchy. 1446 1447 t = self.constrain_self_reference(unit_path, class_types, only_instance_types) 1448 if t: 1449 class_types, only_instance_types, module_types, constrained = t 1450 return class_types, only_instance_types, module_types, constrained, have_assignments 1451 1452 return class_types, only_instance_types, module_types, False, have_assignments 1453 1454 def constrain_self_reference(self, unit_path, class_types, only_instance_types): 1455 1456 """ 1457 Where the name "self" appears in a method, attempt to constrain the 1458 classes involved. 1459 1460 Return the class, instance, module types plus whether the types are 1461 constrained. 1462 """ 1463 1464 class_name = self.in_method(unit_path) 1465 1466 if not class_name: 1467 return None 1468 1469 classes = set([class_name]) 1470 classes.update(self.get_descendants_for_class(class_name)) 1471 1472 # Note that only instances will be expected for these references but 1473 # either classes or instances may provide the attributes. 1474 1475 return ( 1476 set(class_types).intersection(classes), 1477 set(only_instance_types).intersection(classes), 1478 [], True 1479 ) 1480 1481 def in_method(self, path): 1482 1483 "Return whether 'path' refers to a method." 1484 1485 class_name, method_name = path.rsplit(".", 1) 1486 return class_name != "__builtins__.core.type" and self.importer.classes.has_key(class_name) and class_name 1487 1488 def init_reference_details(self, location): 1489 1490 "Initialise reference-related details for 'location'." 1491 1492 self.init_definition_details(location) 1493 self.init_access_details(location) 1494 1495 def init_definition_details(self, location): 1496 1497 "Initialise name definition details for 'location'." 1498 1499 self.accessor_class_types[location] = set() 1500 self.accessor_instance_types[location] = set() 1501 self.accessor_module_types[location] = set() 1502 self.provider_class_types[location] = set() 1503 self.provider_instance_types[location] = set() 1504 self.provider_module_types[location] = set() 1505 1506 def init_access_details(self, location): 1507 1508 "Initialise access details at 'location'." 1509 1510 self.referenced_attrs[location] = {} 1511 1512 def record_types_for_access(self, access_location, accessor_locations, alias_accesses=None): 1513 1514 """ 1515 Define types for the 'access_location' associated with the given 1516 'accessor_locations'. 1517 """ 1518 1519 attrname = get_attrname_from_location(access_location) 1520 if not attrname: 1521 return 1522 1523 invocation = access_location in self.reference_invocations 1524 assignment = access_location in self.reference_assignments 1525 1526 # Collect all suggested types for the accessors. Accesses may 1527 # require accessors from of a subset of the complete set of types. 1528 1529 class_types = set() 1530 module_types = set() 1531 instance_types = set() 1532 1533 constrained = True 1534 1535 for location in accessor_locations: 1536 1537 # Remember accesses employing aliases. 1538 1539 if alias_accesses is not None and self.alias_index.has_key(location): 1540 alias_accesses.add(access_location) 1541 1542 # Use the type information deduced for names from above. 1543 1544 if self.accessor_class_types.has_key(location): 1545 class_types.update(self.accessor_class_types[location]) 1546 module_types.update(self.accessor_module_types[location]) 1547 instance_types.update(self.accessor_instance_types[location]) 1548 1549 # Where accesses are associated with assignments but where no 1550 # attribute usage observations have caused such an association, 1551 # the attribute name is considered by itself. 1552 1553 else: 1554 self.init_definition_details(location) 1555 self.record_types_for_usage(location, [(attrname, invocation, assignment)]) 1556 1557 constrained = location in self.accessor_constrained and constrained 1558 1559 self.init_access_details(access_location) 1560 self.identify_reference_attributes(access_location, attrname, class_types, instance_types, module_types, constrained) 1561 1562 def record_types_for_usage(self, accessor_location, usage): 1563 1564 """ 1565 Record types for the given 'accessor_location' according to the given 1566 'usage' observations which may be None to indicate an absence of usage. 1567 """ 1568 1569 (class_types, 1570 instance_types, 1571 module_types, 1572 constrained, 1573 constrained_specific) = self.get_target_types(accessor_location, usage) 1574 1575 invocations = get_invoked_attributes(usage) 1576 1577 self.record_reference_types(accessor_location, class_types, instance_types, 1578 module_types, constrained, constrained_specific, invocations) 1579 1580 def record_types_for_attribute(self, access_location, attrname): 1581 1582 """ 1583 Record types for the 'access_location' employing only the given 1584 'attrname' for type deduction. 1585 """ 1586 1587 (class_types, 1588 only_instance_types, 1589 module_types) = self.get_types_for_attribute(attrname) 1590 1591 self.init_reference_details(access_location) 1592 1593 self.identify_reference_attributes(access_location, attrname, class_types, only_instance_types, module_types, False) 1594 self.record_reference_types(access_location, class_types, only_instance_types, module_types, False) 1595 1596 def get_types_for_attribute(self, attrname): 1597 1598 "Return class, instance-only and module types supporting 'attrname'." 1599 1600 usage = ((attrname, False, False),) 1601 1602 class_types = self.get_class_types_for_usage(usage) 1603 only_instance_types = set(self.get_instance_types_for_usage(usage)).difference(class_types) 1604 module_types = self.get_module_types_for_usage(usage) 1605 1606 return class_types, only_instance_types, module_types 1607 1608 def record_types_for_alias(self, accessor_location): 1609 1610 """ 1611 Define types for the 'accessor_location' not having associated usage. 1612 """ 1613 1614 have_access = self.provider_class_types.has_key(accessor_location) 1615 1616 # With an access, attempt to narrow the existing selection of provider 1617 # types. Invocations attempt to find return value information, with 1618 # instance return values also yielding class providers (since attributes 1619 # on instances could be provided by classes). 1620 1621 if have_access: 1622 provider_class_types = self.provider_class_types[accessor_location] 1623 provider_instance_types = self.provider_instance_types[accessor_location] 1624 provider_module_types = self.provider_module_types[accessor_location] 1625 1626 # Find details for any corresponding access. 1627 1628 all_class_types = set() 1629 all_instance_types = set() 1630 all_module_types = set() 1631 1632 for access_location in self.alias_index[accessor_location]: 1633 location, name, attrnames, access_number = access_location 1634 invocation = self.reference_invocations.get(access_location) 1635 1636 attrnames = attrnames and attrnames.split(".") 1637 remaining = attrnames and len(attrnames) > 1 1638 1639 # Alias has remaining attributes: reference details do not 1640 # correspond to the accessor; the remaining attributes would 1641 # need to be traversed first. 1642 1643 if remaining: 1644 return 1645 1646 # Alias references an attribute access. 1647 1648 if attrnames: 1649 1650 # Obtain references and attribute types for the access. 1651 1652 attrs = self.get_references_for_access(access_location) 1653 attrs = self.convert_invocation_providers(attrs, invocation) 1654 1655 (class_types, instance_types, module_types, function_types, 1656 var_types) = separate_types(attrs) 1657 1658 # Where non-accessor types are found, do not attempt to refine 1659 # the defined accessor types. 1660 1661 if function_types or var_types: 1662 return 1663 1664 # Invocations converting class accessors to instances do not 1665 # change the nature of class providers. 1666 1667 class_types = set(provider_class_types).intersection(class_types) 1668 instance_types = set(provider_instance_types).intersection(instance_types) 1669 module_types = set(provider_module_types).intersection(module_types) 1670 1671 # Alias references a name, not an access. 1672 1673 else: 1674 # Attempt to refine the types using initialised names. 1675 1676 attr = self.get_initialised_name(access_location) 1677 if attr: 1678 attrs = self.convert_invocation_providers([attr], invocation) 1679 1680 (class_types, instance_types, module_types, function_types, 1681 var_types) = separate_types(attrs) 1682 1683 # Where no further information is found, do not attempt to 1684 # refine the defined accessor types. 1685 1686 else: 1687 return 1688 1689 all_class_types.update(class_types) 1690 all_instance_types.update(instance_types) 1691 all_module_types.update(module_types) 1692 1693 # Record refined type details for the alias as an accessor. 1694 1695 self.init_definition_details(accessor_location) 1696 self.record_reference_types(accessor_location, all_class_types, all_instance_types, all_module_types, False) 1697 1698 # Without an access, attempt to identify references for the alias. 1699 # Invocations convert classes to instances and also attempt to find 1700 # return value information. 1701 1702 else: 1703 refs = set() 1704 1705 for access_location in self.alias_index[accessor_location]: 1706 1707 # Obtain any redefined constant access location. 1708 1709 if self.const_accesses.has_key(access_location): 1710 access_location = self.const_accesses[access_location] 1711 1712 location, name, attrnames, access_number = access_location 1713 invocation = self.reference_invocations.get(access_location) 1714 1715 attrnames = attrnames and attrnames.split(".") 1716 remaining = attrnames and len(attrnames) > 1 1717 1718 # Alias has remaining attributes: reference details do not 1719 # correspond to the accessor; the remaining attributes would 1720 # need to be traversed first. 1721 1722 if remaining: 1723 return 1724 1725 # Alias references an attribute access. 1726 1727 attrname = attrnames and attrnames[0] 1728 1729 if attrname: 1730 1731 # Obtain references and attribute types for the access. 1732 1733 attrs = self.get_references_for_access(access_location) 1734 attrs = self.convert_invocations(attrs, invocation) 1735 refs.update(attrs) 1736 1737 # Alias references a name, not an access. 1738 1739 else: 1740 1741 # Obtain initialiser information. 1742 1743 attr = self.get_initialised_name(access_location) 1744 if attr: 1745 refs.update(self.convert_invocations([attr], invocation)) 1746 1747 # Obtain provider information. 1748 1749 elif self.provider_class_types.has_key(access_location): 1750 class_types = self.provider_class_types[access_location] 1751 instance_types = self.provider_instance_types[access_location] 1752 module_types = self.provider_module_types[access_location] 1753 1754 refs.update(combine_types(class_types, instance_types, module_types)) 1755 1756 # Record reference details for the alias separately from accessors. 1757 1758 self.referenced_objects[accessor_location] = refs 1759 1760 def get_references_for_access(self, access_location): 1761 1762 "Return the references identified for 'access_location'." 1763 1764 attrs = [] 1765 for attrtype, object_type, attr in self.referenced_attrs[access_location]: 1766 attrs.append(attr) 1767 return attrs 1768 1769 def convert_invocation_providers(self, refs, invocation): 1770 1771 """ 1772 Convert 'refs' to providers corresponding to the results of invoking 1773 each of the given references, if 'invocation' is set to a true value. 1774 """ 1775 1776 if not invocation: 1777 return refs 1778 1779 providers = set() 1780 1781 for ref in refs: 1782 ref = self.convert_invocation_provider(ref) 1783 if ref.has_kind("<instance>"): 1784 providers.add(Reference("<class>", ref.get_origin())) 1785 providers.add(ref) 1786 1787 return providers 1788 1789 def convert_invocation_provider(self, ref): 1790 1791 "Convert 'ref' to a provider appropriate to its invocation result." 1792 1793 if ref and ref.has_kind("<class>"): 1794 return ref 1795 1796 return Reference("<var>") 1797 1798 def convert_invocations(self, refs, invocation): 1799 1800 """ 1801 Convert 'refs' to invocation results if 'invocation' is set to a true 1802 value. 1803 """ 1804 1805 return invocation and map(self.convert_invocation, refs) or refs 1806 1807 def convert_invocation(self, ref): 1808 1809 "Convert 'ref' to its invocation result." 1810 1811 if ref and ref.has_kind("<class>"): 1812 return ref.instance_of() 1813 1814 return Reference("<var>") 1815 1816 def get_initialised_name(self, access_location): 1817 1818 """ 1819 Return references for any initialised names at 'access_location', or 1820 None if no such references exist. 1821 """ 1822 1823 path, name, attrnames, version = access_location 1824 1825 # Use initialiser information, if available. 1826 1827 refs = self.importer.all_initialised_names.get((path, name)) 1828 if refs and refs.has_key(version): 1829 return refs[version] 1830 else: 1831 return None 1832 1833 def record_reference_types(self, location, class_types, instance_types, 1834 module_types, constrained, constrained_specific=False, invocations=None): 1835 1836 """ 1837 Associate attribute provider types with the given 'location', consisting 1838 of the given 'class_types', 'instance_types' and 'module_types'. 1839 1840 If 'constrained' is indicated, the constrained nature of the accessor is 1841 recorded for the location. 1842 1843 If 'constrained_specific' is indicated using a true value, instance types 1844 will not be added to class types to permit access via instances at the 1845 given location. This is only useful where a specific accessor is known 1846 to be a class. 1847 1848 If 'invocations' is given, the given attribute names indicate those 1849 which are involved in invocations. Such invocations, if involving 1850 functions, will employ those functions as bound methods and will 1851 therefore not support classes as accessors, only instances of such 1852 classes. 1853 1854 Note that the specified types only indicate the provider types for 1855 attributes, whereas the recorded accessor types indicate the possible 1856 types of the actual objects used to access attributes. 1857 """ 1858 1859 # Update the type details for the location. 1860 1861 self.provider_class_types[location].update(class_types) 1862 self.provider_instance_types[location].update(instance_types) 1863 self.provider_module_types[location].update(module_types) 1864 1865 # Class types support classes and instances as accessors. 1866 # Instance-only and module types support only their own kinds as 1867 # accessors. 1868 1869 path, name, version, attrnames = location 1870 1871 if invocations: 1872 class_only_types = self.filter_for_invocations(class_types, invocations) 1873 else: 1874 class_only_types = class_types 1875 1876 # However, the nature of accessors can be further determined. 1877 # Any self variable may only refer to an instance. 1878 1879 if name != "self" or not self.in_method(path): 1880 self.accessor_class_types[location].update(class_only_types) 1881 1882 if not constrained_specific: 1883 self.accessor_instance_types[location].update(class_types) 1884 1885 self.accessor_instance_types[location].update(instance_types) 1886 1887 if name != "self" or not self.in_method(path): 1888 self.accessor_module_types[location].update(module_types) 1889 1890 if constrained: 1891 self.accessor_constrained.add(location) 1892 1893 def filter_for_invocations(self, class_types, attrnames): 1894 1895 """ 1896 From the given 'class_types', identify methods for the given 1897 'attrnames' that are being invoked, returning a filtered collection of 1898 class types. 1899 1900 This method may be used to remove class types from consideration where 1901 their attributes are methods that are directly invoked: method 1902 invocations must involve instance accessors. 1903 """ 1904 1905 to_filter = set() 1906 1907 for class_type in class_types: 1908 for attrname in attrnames: 1909 1910 # Attempt to obtain a class attribute of the given name. This 1911 # may return an attribute provided by an ancestor class. 1912 1913 ref = self.importer.get_class_attribute(class_type, attrname) 1914 parent_class = ref and ref.parent() 1915 1916 # If such an attribute is a method and would be available on 1917 # the given class, record the class for filtering. 1918 1919 if ref and ref.has_kind("<function>") and ( 1920 parent_class == class_type or 1921 class_type in self.descendants[parent_class]): 1922 1923 to_filter.add(class_type) 1924 break 1925 1926 return set(class_types).difference(to_filter) 1927 1928 def identify_reference_attributes(self, location, attrname, class_types, instance_types, module_types, constrained): 1929 1930 """ 1931 Identify reference attributes, associating them with the given 1932 'location', identifying the given 'attrname', employing the given 1933 'class_types', 'instance_types' and 'module_types'. 1934 1935 If 'constrained' is indicated, the constrained nature of the access is 1936 recorded for the location. 1937 """ 1938 1939 # Record the referenced objects. 1940 1941 self.referenced_attrs[location] = \ 1942 self._identify_reference_attribute(location, attrname, class_types, instance_types, module_types) 1943 1944 if constrained: 1945 self.access_constrained.add(location) 1946 1947 def _identify_reference_attribute(self, location, attrname, class_types, instance_types, module_types): 1948 1949 """ 1950 Identify the reference attribute at the given access 'location', using 1951 the given 'attrname', and employing the given 'class_types', 1952 'instance_types' and 'module_types'. 1953 """ 1954 1955 attrs = set() 1956 1957 # The class types expose class attributes either directly or via 1958 # instances. 1959 1960 for object_type in class_types: 1961 ref = self.importer.get_class_attribute(object_type, attrname) 1962 if ref and self.is_compatible_callable(location, object_type, ref): 1963 attrs.add(("<class>", object_type, ref)) 1964 1965 # Add any distinct instance attributes that would be provided 1966 # by instances also providing indirect class attribute access. 1967 1968 for ref in self.importer.get_instance_attributes(object_type, attrname): 1969 if self.is_compatible_callable(location, object_type, ref): 1970 attrs.add(("<instance>", object_type, ref)) 1971 1972 # The instance-only types expose instance attributes, but although 1973 # classes are excluded as potential accessors (since they do not provide 1974 # the instance attributes), the class types may still provide some 1975 # attributes. 1976 1977 for object_type in instance_types: 1978 instance_attrs = self.importer.get_instance_attributes(object_type, attrname) 1979 1980 if instance_attrs: 1981 for ref in instance_attrs: 1982 if self.is_compatible_callable(location, object_type, ref): 1983 attrs.add(("<instance>", object_type, ref)) 1984 else: 1985 ref = self.importer.get_class_attribute(object_type, attrname) 1986 if ref and self.is_compatible_callable(location, object_type, ref): 1987 attrs.add(("<class>", object_type, ref)) 1988 1989 # Module types expose module attributes for module accessors. 1990 1991 for object_type in module_types: 1992 ref = self.importer.get_module_attribute(object_type, attrname) 1993 if ref and self.is_compatible_callable(location, object_type, ref): 1994 attrs.add(("<module>", object_type, ref)) 1995 1996 return attrs 1997 1998 def is_compatible_callable(self, location, object_type, ref): 1999 2000 """ 2001 Return whether any invocation at 'location' involving an attribute of 2002 'object_type' identified by 'ref' is compatible with any arguments used. 2003 """ 2004 2005 invocation = self.reference_invocations.get(location) 2006 if invocation is None: 2007 return True 2008 2009 objpath = ref.get_origin() 2010 if not objpath: 2011 return True 2012 2013 parameters = self.importer.function_parameters.get(objpath) 2014 if not parameters: 2015 return True 2016 2017 defaults = self.importer.function_defaults.get(objpath) 2018 arguments, keywords = invocation 2019 names = set(parameters) 2020 2021 # Determine whether the specified arguments are 2022 # compatible with the callable signature. 2023 2024 if arguments >= len(parameters) - len(defaults) and \ 2025 arguments <= len(parameters) and \ 2026 names.issuperset(keywords): 2027 2028 return True 2029 else: 2030 init_item(self.reference_invocations_unsuitable, location, set) 2031 self.reference_invocations_unsuitable[location].add(ref) 2032 return False 2033 2034 # Attribute access plan formulation. 2035 2036 class_tests = ( 2037 ("guarded", "specific", "type"), 2038 ("guarded", "common", "type"), 2039 ("test", "specific", "type"), 2040 ("test", "common", "type"), 2041 ) 2042 2043 def get_access_plan(self, location): 2044 2045 """ 2046 Return details of the access at the given 'location'. The details are as 2047 follows: 2048 2049 * the initial accessor (from which accesses will be performed if no 2050 computed static accessor is found) 2051 * details of any test required on the initial accessor 2052 * details of any type employed by the test 2053 * any static accessor (from which accesses will be performed in 2054 preference to the initial accessor) 2055 * attributes needing to be traversed from the base that yield 2056 unambiguous objects 2057 * access modes for each of the unambiguously-traversed attributes 2058 * remaining attributes needing to be tested and traversed 2059 * details of the context 2060 * any test to apply to the context 2061 * the method of obtaining the first attribute 2062 * the method of obtaining the final attribute 2063 * any static final attribute 2064 * the kinds of objects providing the final attribute 2065 """ 2066 2067 const_access = self.const_accesses_rev.get(location) 2068 2069 path, name, attrnames, version = location 2070 remaining = attrnames.split(".") 2071 attrname = remaining[0] 2072 2073 # Obtain reference, provider and provider kind information. 2074 2075 attrs = self.reference_all_attrs[location] 2076 provider_types = self.reference_all_providers[location] 2077 provider_kinds = self.reference_all_provider_kinds[location] 2078 2079 # Obtain accessor type and kind information. 2080 2081 accessor_types = self.reference_all_accessor_types[location] 2082 accessor_general_types = self.reference_all_accessor_general_types[location] 2083 accessor_kinds = get_kinds(accessor_general_types) 2084 2085 # Determine any guard or test requirements. 2086 2087 constrained = location in self.access_constrained 2088 test = self.reference_test_types[location] 2089 test_type = self.reference_test_accessor_type.get(location) 2090 2091 # Determine the accessor and provider properties. 2092 2093 class_accessor = "<class>" in accessor_kinds 2094 module_accessor = "<module>" in accessor_kinds 2095 instance_accessor = "<instance>" in accessor_kinds 2096 provided_by_class = "<class>" in provider_kinds 2097 provided_by_instance = "<instance>" in provider_kinds 2098 2099 # Determine how attributes may be accessed relative to the accessor. 2100 2101 object_relative = class_accessor or module_accessor or provided_by_instance 2102 class_relative = instance_accessor and provided_by_class 2103 2104 # Identify the last static attribute for context acquisition. 2105 2106 base = None 2107 dynamic_base = None 2108 2109 # Constant accesses have static providers. 2110 2111 if const_access: 2112 base = len(provider_types) == 1 and first(provider_types) 2113 2114 # Name-based accesses. 2115 2116 elif name: 2117 ref = self.importer.identify("%s.%s" % (path, name)) 2118 2119 # Constant accessors are static. 2120 2121 if ref and ref.static(): 2122 base = ref.get_origin() 2123 2124 # Usage of previously-generated guard and test details. 2125 2126 elif test[:2] == ("constrained", "specific"): 2127 ref = first(accessor_types) 2128 2129 elif test[:2] == ("constrained", "common"): 2130 ref = first(accessor_general_types) 2131 2132 elif test[:2] == ("guarded", "specific"): 2133 ref = first(accessor_types) 2134 2135 elif test[:2] == ("guarded", "common"): 2136 ref = first(accessor_general_types) 2137 2138 # For attribute-based tests, tentatively identify a dynamic base. 2139 # Such tests allow single or multiple kinds of a type. 2140 2141 elif test[0] == "test" and test[1] in ("common", "specific"): 2142 dynamic_base = test_type 2143 2144 # Static accessors. 2145 2146 if not base and test in self.class_tests: 2147 base = ref and ref.get_origin() or dynamic_base 2148 2149 # Accessors that are not static but whose nature is determined. 2150 2151 elif not base and ref: 2152 dynamic_base = ref.get_origin() 2153 2154 # Determine initial accessor details. 2155 2156 accessor = base or dynamic_base 2157 accessor_kind = len(accessor_kinds) == 1 and first(accessor_kinds) or None 2158 provider_kind = len(provider_kinds) == 1 and first(provider_kinds) or None 2159 2160 # Traverse remaining attributes. 2161 2162 traversed = [] 2163 traversal_modes = [] 2164 2165 while len(attrs) == 1 and not first(attrs).has_kind("<var>"): 2166 attr = first(attrs) 2167 2168 traversed.append(attrname) 2169 traversal_modes.append(accessor_kind == provider_kind and "object" or "class") 2170 2171 # Consume attribute names providing unambiguous attributes. 2172 2173 del remaining[0] 2174 2175 if not remaining: 2176 break 2177 2178 # Update the last static attribute. 2179 2180 if attr.static(): 2181 base = attr.get_origin() 2182 traversed = [] 2183 traversal_modes = [] 2184 2185 # Get the access details. 2186 2187 attrname = remaining[0] 2188 accessor = attr.get_origin() 2189 accessor_kind = attr.get_kind() 2190 provider_kind = self.importer.get_attribute_provider(attr, attrname) 2191 accessor_kinds = [accessor_kind] 2192 provider_kinds = [provider_kind] 2193 2194 # Get the next attribute. 2195 2196 attrs = self.importer.get_attributes(attr, attrname) 2197 2198 # Where many attributes are suggested, no single attribute identity can 2199 # be loaded. 2200 2201 else: 2202 attr = None 2203 2204 # Determine the method of access. 2205 2206 is_assignment = location in self.reference_assignments or const_access in self.reference_assignments 2207 is_invocation = location in self.reference_invocations or const_access in self.reference_invocations 2208 2209 # Identified attribute that must be accessed via its parent. 2210 2211 if attr and attr.get_name() and is_assignment: 2212 final_method = "static-assign"; origin = attr.get_name() 2213 2214 # Static, identified attribute. 2215 2216 elif attr and attr.static(): 2217 final_method = is_assignment and "static-assign" or \ 2218 is_invocation and "static-invoke" or \ 2219 "static" 2220 origin = attr.final() 2221 2222 # All other methods of access involve traversal. 2223 2224 else: 2225 final_method = is_assignment and "assign" or \ 2226 is_invocation and "access-invoke" or \ 2227 "access" 2228 origin = None 2229 2230 # First attribute accessed at a known position via the accessor. 2231 2232 # Static bases support object-relative accesses only. 2233 2234 if base: 2235 first_method = "relative-object" 2236 2237 # Dynamic bases support either object- or class-relative accesses. 2238 2239 elif dynamic_base: 2240 first_method = "relative" + (object_relative and "-object" or "") + \ 2241 (class_relative and "-class" or "") 2242 2243 # The fallback case is always run-time testing and access. 2244 2245 else: 2246 first_method = "check" + (object_relative and "-object" or "") + \ 2247 (class_relative and "-class" or "") 2248 2249 # Determine whether an unbound method is being accessed via an instance, 2250 # requiring a context test. 2251 2252 context_test = "ignore" 2253 2254 # Assignments do not employ the context. 2255 2256 if is_assignment: 2257 pass 2258 2259 # Obtain a selection of possible attributes if no unambiguous attribute 2260 # was identified. 2261 2262 elif not attr: 2263 2264 # Use previously-deduced attributes for a simple ambiguous access. 2265 # Otherwise, use the final attribute name to obtain possible 2266 # attributes. 2267 2268 if len(remaining) > 1: 2269 attrname = remaining[-1] 2270 2271 (class_types, 2272 only_instance_types, 2273 module_types) = self.get_types_for_attribute(attrname) 2274 2275 accessor_kinds = set() 2276 provider_kinds = set() 2277 2278 if class_types: 2279 accessor_kinds.add("<class>") 2280 accessor_kinds.add("<instance>") 2281 provider_kinds.add("<class>") 2282 if only_instance_types: 2283 accessor_kinds.add("<instance>") 2284 provider_kinds.add("<instance>") 2285 if module_types: 2286 accessor_kinds.add("<module>") 2287 provider_kinds.add("<module>") 2288 2289 attrs = set() 2290 for type in combine_types(class_types, only_instance_types, module_types): 2291 attrs.update(self.importer.get_attributes(type, attrname)) 2292 2293 always_unbound = True 2294 have_function = False 2295 have_var = False 2296 2297 # Determine whether all attributes are unbound methods and whether 2298 # functions or unidentified attributes occur. 2299 2300 for attr in attrs: 2301 always_unbound = always_unbound and attr.has_kind("<function>") and attr.name_parent() == attr.parent() 2302 have_function = have_function or attr.has_kind("<function>") 2303 have_var = have_var or attr.has_kind("<var>") 2304 2305 # Test for class-via-instance accesses. 2306 2307 if accessor_kind == "<instance>" and \ 2308 provider_kind == "<class>": 2309 2310 if always_unbound: 2311 context_test = "replace" 2312 else: 2313 context_test = "test" 2314 2315 # Test for the presence of class-via-instance accesses. 2316 2317 elif "<instance>" in accessor_kinds and \ 2318 "<class>" in provider_kinds and \ 2319 (have_function or have_var): 2320 2321 context_test = "test" 2322 2323 # With an unambiguous attribute, determine whether a test is needed. 2324 2325 elif accessor_kind == "<instance>" and \ 2326 provider_kind == "<class>" and \ 2327 (attr.has_kind("<var>") or 2328 attr.has_kind("<function>") and 2329 attr.name_parent() == attr.parent()): 2330 2331 if attr.has_kind("<var>"): 2332 context_test = "test" 2333 else: 2334 context_test = "replace" 2335 2336 # With an unambiguous attribute with ambiguity in the access method, 2337 # generate a test. 2338 2339 elif "<instance>" in accessor_kinds and \ 2340 "<class>" in provider_kinds and \ 2341 (attr.has_kind("<var>") or 2342 attr.has_kind("<function>") and 2343 attr.name_parent() == attr.parent()): 2344 2345 context_test = "test" 2346 2347 # Determine the nature of the context. 2348 2349 context = context_test == "ignore" and "unset" or \ 2350 len(traversed + remaining) == 1 and \ 2351 (base and "base" or "original-accessor") or \ 2352 "final-accessor" 2353 2354 return name, test, test_type, base, \ 2355 traversed, traversal_modes, remaining, \ 2356 context, context_test, \ 2357 first_method, final_method, \ 2358 origin, accessor_kinds 2359 2360 def initialise_access_instructions(self): 2361 2362 "Expand access plans into instruction sequences." 2363 2364 for access_location, access_plan in self.access_plans.items(): 2365 2366 # Obtain the access details. 2367 2368 name, test, test_type, base, \ 2369 traversed, traversal_modes, attrnames, \ 2370 context, context_test, \ 2371 first_method, final_method, \ 2372 origin, accessor_kinds = access_plan 2373 2374 # Emit instructions by appending them to a list. 2375 2376 instructions = [] 2377 emit = instructions.append 2378 2379 # Identify any static original accessor. 2380 2381 if base: 2382 original_accessor = base 2383 2384 # Employ names as contexts unless the context needs testing and 2385 # potentially updating. In such cases, temporary context storage is 2386 # used instead. 2387 2388 elif name and not (context_test == "test" and 2389 final_method in ("access-invoke", "static-invoke")): 2390 original_accessor = "<name>" # refers to the name 2391 2392 # Use a generic placeholder representing the access expression in 2393 # the general case. 2394 2395 else: 2396 original_accessor = "<expr>" 2397 2398 # Prepare for any first attribute access. 2399 2400 if traversed: 2401 attrname = traversed[0] 2402 del traversed[0] 2403 elif attrnames: 2404 attrname = attrnames[0] 2405 del attrnames[0] 2406 2407 # Perform the first access explicitly if at least one operation 2408 # requires it. 2409 2410 access_first_attribute = final_method in ("access", "access-invoke", "assign") or traversed or attrnames 2411 2412 # Determine whether the first access involves assignment. 2413 2414 assigning = not traversed and not attrnames and final_method == "assign" 2415 set_accessor = assigning and "<set_target_accessor>" or "<set_accessor>" 2416 stored_accessor = assigning and "<target_accessor>" or "<accessor>" 2417 2418 # Set the context if already available. 2419 2420 context_var = None 2421 2422 if context == "base": 2423 accessor = context_var = (base,) 2424 elif context == "original-accessor": 2425 2426 # Prevent re-evaluation of any dynamic expression by storing it. 2427 2428 if original_accessor == "<expr>": 2429 if final_method in ("access-invoke", "static-invoke"): 2430 emit(("<set_context>", original_accessor)) 2431 accessor = context_var = ("<context>",) 2432 else: 2433 emit((set_accessor, original_accessor)) 2434 accessor = context_var = (stored_accessor,) 2435 else: 2436 accessor = context_var = (original_accessor,) 2437 2438 # Assigning does not set the context. 2439 2440 elif context in ("final-accessor", "unset") and access_first_attribute: 2441 2442 # Prevent re-evaluation of any dynamic expression by storing it. 2443 2444 if original_accessor == "<expr>": 2445 emit((set_accessor, original_accessor)) 2446 accessor = (stored_accessor,) 2447 else: 2448 accessor = (original_accessor,) 2449 2450 # Apply any test. 2451 2452 if test[0] == "test": 2453 accessor = ("__%s_%s_%s" % test, accessor, test_type) 2454 2455 # Perform the first or final access. 2456 # The access only needs performing if the resulting accessor is used. 2457 2458 remaining = len(traversed + attrnames) 2459 2460 if access_first_attribute: 2461 2462 if first_method == "relative-class": 2463 if assigning: 2464 emit(("__store_via_class", accessor, attrname, "<assexpr>")) 2465 else: 2466 accessor = ("__load_via_class", accessor, attrname) 2467 2468 elif first_method == "relative-object": 2469 if assigning: 2470 emit(("__store_via_object", accessor, attrname, "<assexpr>")) 2471 else: 2472 accessor = ("__load_via_object", accessor, attrname) 2473 2474 elif first_method == "relative-object-class": 2475 if assigning: 2476 emit(("__get_class_and_store", accessor, attrname, "<assexpr>")) 2477 else: 2478 accessor = ("__get_class_and_load", accessor, attrname) 2479 2480 elif first_method == "check-class": 2481 if assigning: 2482 emit(("__check_and_store_via_class", accessor, attrname, "<assexpr>")) 2483 else: 2484 accessor = ("__check_and_load_via_class", accessor, attrname) 2485 2486 elif first_method == "check-object": 2487 if assigning: 2488 emit(("__check_and_store_via_object", accessor, attrname, "<assexpr>")) 2489 else: 2490 accessor = ("__check_and_load_via_object", accessor, attrname) 2491 2492 elif first_method == "check-object-class": 2493 if assigning: 2494 emit(("__check_and_store_via_any", accessor, attrname, "<assexpr>")) 2495 else: 2496 accessor = ("__check_and_load_via_any", accessor, attrname) 2497 2498 # Traverse attributes using the accessor. 2499 2500 if traversed: 2501 for attrname, traversal_mode in zip(traversed, traversal_modes): 2502 assigning = remaining == 1 and final_method == "assign" 2503 2504 # Set the context, if appropriate. 2505 2506 if remaining == 1 and final_method != "assign" and context == "final-accessor": 2507 2508 # Invoked attributes employ a separate context accessed 2509 # during invocation. 2510 2511 if final_method in ("access-invoke", "static-invoke"): 2512 emit(("<set_context>", accessor)) 2513 accessor = context_var = "<context>" 2514 2515 # A private context within the access is otherwise 2516 # retained. 2517 2518 else: 2519 emit(("<set_private_context>", accessor)) 2520 accessor = context_var = "<private_context>" 2521 2522 # Perform the access only if not achieved directly. 2523 2524 if remaining > 1 or final_method in ("access", "access-invoke", "assign"): 2525 2526 if traversal_mode == "class": 2527 if assigning: 2528 emit(("__store_via_class", accessor, attrname, "<assexpr>")) 2529 else: 2530 accessor = ("__load_via_class", accessor, attrname) 2531 else: 2532 if assigning: 2533 emit(("__store_via_object", accessor, attrname, "<assexpr>")) 2534 else: 2535 accessor = ("__load_via_object", accessor, attrname) 2536 2537 remaining -= 1 2538 2539 if attrnames: 2540 for attrname in attrnames: 2541 assigning = remaining == 1 and final_method == "assign" 2542 2543 # Set the context, if appropriate. 2544 2545 if remaining == 1 and final_method != "assign" and context == "final-accessor": 2546 2547 # Invoked attributes employ a separate context accessed 2548 # during invocation. 2549 2550 if final_method in ("access-invoke", "static-invoke"): 2551 emit(("<set_context>", accessor)) 2552 accessor = context_var = "<context>" 2553 2554 # A private context within the access is otherwise 2555 # retained. 2556 2557 else: 2558 emit(("<set_private_context>", accessor)) 2559 accessor = context_var = "<private_context>" 2560 2561 # Perform the access only if not achieved directly. 2562 2563 if remaining > 1 or final_method in ("access", "access-invoke", "assign"): 2564 2565 # Constrain instructions involving certain special 2566 # attribute names. 2567 2568 to_search = attrname == "__data__" and "object" or "any" 2569 2570 if assigning: 2571 emit(("__check_and_store_via_%s" % to_search, accessor, attrname, "<assexpr>")) 2572 else: 2573 accessor = ("__check_and_load_via_%s" % to_search, accessor, attrname) 2574 2575 remaining -= 1 2576 2577 # Define or emit the means of accessing the actual target. 2578 2579 # Assignments to known attributes. 2580 2581 if final_method == "static-assign": 2582 parent, attrname = origin.rsplit(".", 1) 2583 emit(("__store_via_object", parent, attrname, "<assexpr>")) 2584 2585 # Invoked attributes employ a separate context. 2586 2587 elif final_method in ("static", "static-invoke"): 2588 accessor = ("__load_static_ignore", origin) 2589 2590 # Wrap accesses in context operations. 2591 2592 if context_test == "test": 2593 2594 # Test and combine the context with static attribute details. 2595 2596 if final_method == "static": 2597 emit(("__load_static_test", context_var, origin)) 2598 2599 # Test the context, storing it separately if required for the 2600 # immediately invoked static attribute. 2601 2602 elif final_method == "static-invoke": 2603 emit(("<test_context_static>", context_var, origin)) 2604 2605 # Test the context, storing it separately if required for an 2606 # immediately invoked attribute. 2607 2608 elif final_method == "access-invoke": 2609 emit(("<test_context_revert>", context_var, accessor)) 2610 2611 # Test the context and update the attribute details if 2612 # appropriate. 2613 2614 else: 2615 emit(("__test_context", context_var, accessor)) 2616 2617 elif context_test == "replace": 2618 2619 # Produce an object with updated context. 2620 2621 if final_method == "static": 2622 emit(("__load_static_replace", context_var, origin)) 2623 2624 # Omit the context update operation where the target is static 2625 # and the context is recorded separately. 2626 2627 elif final_method == "static-invoke": 2628 pass 2629 2630 # If a separate context is used for an immediate invocation, 2631 # produce the attribute details unchanged. 2632 2633 elif final_method == "access-invoke": 2634 emit(accessor) 2635 2636 # Update the context in the attribute details. 2637 2638 else: 2639 emit(("__update_context", context_var, accessor)) 2640 2641 # Omit the accessor for assignments and for invocations of static 2642 # targets. 2643 2644 elif final_method not in ("assign", "static-assign", "static-invoke"): 2645 emit(accessor) 2646 2647 # Produce an advisory instruction regarding the context. 2648 2649 if context_var: 2650 emit(("<context_identity>", context_var)) 2651 2652 self.access_instructions[access_location] = instructions 2653 self.accessor_kinds[access_location] = accessor_kinds 2654 2655 # vim: tabstop=4 expandtab shiftwidth=4