1 #!/usr/bin/env python 2 3 """ 4 The micropython package for processing Python source code. The code originates 5 from the simplify package but has had various details related to that package 6 removed. 7 8 Copyright (C) 2006, 2007, 2008, 2009 Paul Boddie <paul@boddie.org.uk> 9 10 This program is free software; you can redistribute it and/or modify it under 11 the terms of the GNU General Public License as published by the Free Software 12 Foundation; either version 3 of the License, or (at your option) any later 13 version. 14 15 This program is distributed in the hope that it will be useful, but WITHOUT 16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 17 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 18 details. 19 20 You should have received a copy of the GNU General Public License along with 21 this program. If not, see <http://www.gnu.org/licenses/>. 22 23 -------- 24 25 To use this module, an importer should be constructed. Here, the standard path 26 for module searching is employed: 27 28 importer = Importer(sys.path) 29 30 To generate programs, the above importer should be supplied in the 31 initialisation of a program instance, and then various methods are called: 32 33 program = Program(importer) 34 image = program.get_raw_image() 35 36 Such importer and program objects are the most convenient mechanism through 37 which the functionality of the micropython package may be accessed. 38 """ 39 40 from micropython.common import ProcessingError, TableGenerationError 41 import micropython.ast 42 import micropython.data 43 import micropython.opt 44 import micropython.inspect 45 import micropython.table 46 import os 47 48 try: 49 set 50 except NameError: 51 from sets import Set as set 52 53 class Program: 54 55 "This class supports the generation of a program image." 56 57 supported_optimisations = micropython.opt.Optimiser.supported_optimisations 58 59 def __init__(self, importer, optimisations=None): 60 61 """ 62 Initialise the program representation with an 'importer' which is able 63 to locate and load Python modules. 64 65 The optional 'optimisations' cause certain techniques to be used in 66 reducing program size and improving program efficiency. 67 """ 68 69 self.importer = importer 70 self.optimisations = optimisations or set() 71 72 # Remember the tables once generated. 73 74 self.objtable = None 75 self.paramtable = None 76 77 # Main program information. 78 79 self.code = None 80 self.code_location = None 81 82 def get_importer(self): 83 return self.importer 84 85 # Access to finalised program information. 86 87 def get_image(self, with_builtins=0): 88 89 """ 90 Return the program image including built-in objects if 'with_builtins' 91 is specified and set to a true value. 92 """ 93 94 if self.code is not None: 95 return self.code 96 97 objtable = self.get_object_table() 98 paramtable = self.get_parameter_table() 99 100 # Optimise and regenerate the object table. 101 102 self.importer.vacuum(objtable) 103 self.importer.finalise() 104 105 objtable = self.get_object_table(reset=1) 106 paramtable = self.get_parameter_table(reset=1) 107 108 self.code = [] 109 110 # Append constants to the image. 111 112 for const in self.importer.constants(): 113 self.code.append(const) 114 115 last_module = self.importer.modules_ordered[-1] 116 117 for module in self.importer.modules_ordered: 118 suppress_builtins = not with_builtins and module.name == "__builtins__" 119 120 # Position the module in the image and make a translation. 121 122 trans = micropython.ast.Translation(module, self) 123 124 # Add header details. 125 126 self.code.append(module) 127 128 # Append module attributes to the image. 129 130 attributes = module.module_attributes() 131 self.code += module.attributes_as_list() 132 133 # Append classes and functions to the image. 134 135 for obj in module.all_objects: 136 if isinstance(obj, micropython.inspect.Class): 137 138 # Add header details. 139 140 self.code.append(obj) 141 142 # Append class attributes to the image. 143 144 attributes = obj.class_attributes() 145 self.code += obj.attributes_as_list() 146 147 # Omit built-in function code where requested. 148 149 if suppress_builtins and obj.astnode.doc is None: 150 continue 151 152 # Generate the instantiator/initialiser. 153 # Append the function code to the image. 154 155 instantiator = obj.get_instantiator() 156 code = trans.get_instantiator_code(obj) 157 self.code += code 158 159 # Class-level code is generated separately at the module 160 # level, and the code location is set within the code 161 # generation process for the module. 162 163 elif isinstance(obj, micropython.inspect.Function): 164 165 # Add header details. 166 167 self.code.append(obj) 168 169 # Append any default values to the image. 170 # Only do this for named functions (not lambdas). 171 172 if obj.name is not None: 173 self.code += obj.default_attrs 174 175 # Omit built-in function code where requested. 176 177 if suppress_builtins and obj.astnode.doc is None: 178 pass 179 180 # Append the function code to the image. 181 182 else: 183 code = trans.get_code(obj) 184 self.code += code 185 186 # Omit built-in module code where requested. 187 188 if suppress_builtins: 189 pass 190 191 # Append the module top-level code to the image. 192 193 else: 194 code = trans.get_module_code() 195 self.code += code 196 197 return self.code 198 199 def get_raw_image(self, architecture=None, with_builtins=0): 200 201 "Return the raw image representation of the program." 202 203 architecture = architecture or micropython.rsvp 204 205 self.get_image(with_builtins) 206 207 objtable = self.get_object_table() 208 paramtable = self.get_parameter_table() 209 210 # Position the objects. 211 212 pos = 0 213 214 for item in self.code: 215 arch_item = architecture.get_object(item) 216 217 # Get the raw version for the architecture. 218 219 if arch_item is not None: 220 pos = arch_item.set_location(pos, with_builtins) 221 else: 222 pos += 1 223 224 # Generate the raw code. 225 226 self.raw_code = [] 227 228 for item in self.code: 229 arch_item = architecture.get_object(item) 230 231 # Get the raw version for the architecture. 232 233 if arch_item is not None: 234 self.raw_code += arch_item.as_raw(objtable, paramtable, with_builtins) 235 arch_item.finalise_location(with_builtins) 236 else: 237 self.raw_code.append(item) 238 239 # Fix the module locations. 240 241 for module in self.importer.modules_ordered: 242 243 if not with_builtins and module.name == "__builtins__": 244 continue 245 246 module.code_location = module.blocks[0].location 247 248 self.code_location = self.importer.modules["__main__"].code_location 249 return self.raw_code 250 251 def get_object_table(self, reset=0): 252 253 "Return a table with details of attributes for classes and modules." 254 255 if self.objtable is None or reset: 256 257 t = self.objtable = micropython.table.ObjectTable() 258 for module in self.importer.get_modules(): 259 t.add(module.full_name(), module.module_attributes()) 260 261 # Add class and instance attributes for all classes, together 262 # with descendant information. 263 264 for obj in module.all_objects: 265 if isinstance(obj, micropython.inspect.Class): 266 267 # Prevent ambiguous classes. 268 269 full_name = obj.full_name() 270 name = obj.name 271 272 if module.has_key(name) and module[name].defines_ambiguous_class(): 273 raise TableGenerationError, "Class %r in module %r is ambiguously defined." % (name, module.full_name()) 274 275 # Define a table entry for the class. 276 277 attributes = {full_name : obj} 278 attributes.update(obj.all_attributes()) 279 attributes.update(obj.all_descendants()) 280 t.add(full_name, attributes) 281 282 return self.objtable 283 284 def get_parameter_table(self, reset=0): 285 286 "Return a table with details of parameters for functions and methods." 287 288 # Need the object table to get at class details. 289 290 if self.paramtable is None or reset: 291 t = self.paramtable = micropython.table.ParameterTable() 292 293 # Visit each module, getting function and method details. 294 295 for module in self.importer.get_modules(): 296 for obj in module.all_objects: 297 if isinstance(obj, micropython.inspect.Function): 298 t.add(obj.full_name(), obj.parameters()) 299 300 # Classes are callable, too. 301 # Take details of the appropriate __init__ method to make an 302 # entry for an instantiation function for the class. 303 304 elif isinstance(obj, micropython.inspect.Class): 305 t.add(obj.get_instantiator().full_name(), obj.get_instantiator().parameters()) 306 307 # Filter out all parameter table entries not referenced by keyword 308 # arguments. 309 310 keyword_names = set() 311 312 for module in self.importer.get_modules(): 313 keyword_names.update(module.keyword_names) 314 315 for function_name, parameters in t.table.items(): 316 for name in parameters.keys(): 317 if name in keyword_names: 318 break 319 else: 320 del t.table[function_name] 321 322 return self.paramtable 323 324 class Importer: 325 326 "An import machine, searching for and loading modules." 327 328 predefined_constants = { 329 "None" : None, 330 "True" : True, 331 "False" : False, 332 #"Ellipsis" : Ellipsis, 333 "NotImplemented" : NotImplemented 334 } 335 336 names_always_used = [ 337 "bool", "__init__", "__call__", "__bool__", "__builtins__", "__main__" 338 ] 339 340 def __init__(self, path=None, verbose=0, optimisations=None): 341 342 """ 343 Initialise the importer with the given search 'path' - a list of 344 directories to search for Python modules. 345 346 The optional 'verbose' parameter causes output concerning the activities 347 of the object to be produced if set to a true value (not the default). 348 349 The optional 'optimisations' cause certain techniques to be used in 350 reducing program size and improving program efficiency. 351 """ 352 353 self.path = path or [os.getcwd()] 354 self.verbose = verbose 355 self.optimisations = optimisations or set() 356 357 self.modules = {} 358 self.modules_ordered = [] 359 self.loading = set() 360 361 # Constant records. 362 363 self.constant_values = {} 364 self.constant_list = None # cache for constants 365 self.init_predefined_constants() 366 367 # Attribute usage. 368 369 self.attributes_used = {} 370 self.name_references = {} 371 self.specific_name_references = {} 372 373 # Status information. 374 375 self.vacuumed = 0 376 self.finalised = 0 377 378 def get_modules(self): 379 380 "Return all modules known to the importer." 381 382 return self.modules.values() 383 384 def get_module(self, name): 385 386 "Return the module with the given 'name'." 387 388 return self.modules[name] 389 390 # General maintenance. 391 392 def vacuum(self, objtable): 393 394 "Tidy up the modules." 395 396 if self.vacuumed: 397 return 398 399 # Complete the list of attribute names used in the program. 400 401 self.collect_attributes(objtable) 402 403 for name, module in self.modules.items(): 404 if module.loaded: 405 module.vacuum() 406 else: 407 del self.modules[name] 408 409 self.vacuumed = 1 410 411 def finalise(self): 412 413 "Finalise the program (which should have been vacuumed first)." 414 415 if self.finalised: 416 return 417 418 # Reset any previously compiled information. 419 420 for module in self.get_modules(): 421 module.unfinalise() 422 423 # Prepare module information again. 424 425 for module in self.get_modules(): 426 module.finalise() 427 428 self.finalised = 1 429 430 # Name accounting. 431 432 def use_name(self, name, from_name): 433 434 """ 435 Register the given 'name' as being used in the program from within an 436 object with the specified 'from_name'. 437 """ 438 439 if not self.name_references.has_key(from_name): 440 self.name_references[from_name] = set() 441 self.name_references[from_name].add((name,)) 442 443 def use_names(self, names, from_name): 444 445 """ 446 Register the given 'names' as being used in the program from within an 447 object with the specified 'from_name'. 448 """ 449 450 if not self.name_references.has_key(from_name): 451 self.name_references[from_name] = set() 452 self.name_references[from_name].add(names) 453 454 def use_specific_name(self, objname, attrname, from_name): 455 456 """ 457 Register the given 'objname' (for an object) whose 'attrname' is being 458 used in the program from within an object with the specified 459 'from_name'. 460 """ 461 462 if not self.specific_name_references.has_key(from_name): 463 self.specific_name_references[from_name] = set() 464 self.specific_name_references[from_name].add((objname, attrname)) 465 466 # Name accounting products. 467 468 def uses_attribute(self, obj, name): 469 470 """ 471 Return whether the attribute of object 'obj' having the given 'name' is 472 used as an attribute in the program. 473 """ 474 475 return name in self.attributes_used.get(obj.full_name(), []) 476 477 def use_attribute(self, objname, name): 478 479 """ 480 Indicate that in the object with the given 'objname', the attribute of 481 the given 'name' is used. 482 """ 483 484 if not self.attributes_used.has_key(objname): 485 self.attributes_used[objname] = set() 486 self.attributes_used[objname].add(name) 487 488 def collect_attributes(self, objtable): 489 490 "Collect attribute references for the entire program." 491 492 # Start with the "root" modules, finding referenced objects. 493 494 self._collect_attributes("__builtins__", objtable) 495 self._collect_attributes("__main__", objtable) 496 497 # Include names which may not be explicitly used in programs. 498 # NOTE: Potentially declare these when inspecting. 499 500 for name in self.names_always_used: 501 for objname in objtable.all_possible_objects([name]): 502 self.use_attribute(objname, name) 503 504 def _collect_attributes(self, from_name, objtable): 505 506 """ 507 Given an object called 'from_name', find all names referenced from such 508 an object according to the register of names. 509 """ 510 511 if self.attributes_used.has_key(from_name): 512 return 513 514 # Get name references and find possible objects which support such 515 # combinations of attribute names. 516 517 for names in self.name_references.get(from_name, []): 518 for objname in objtable.all_possible_objects(names): 519 for name in names: 520 self.use_attribute(objname, name) 521 self._collect_attributes(objname + "." + name, objtable) 522 523 # Get specific name references and visit the referenced objects. 524 525 for objname, attrname in self.specific_name_references.get(from_name, []): 526 self.use_attribute(objname, attrname) 527 self._collect_attributes(objname + "." + attrname, objtable) 528 529 # Constant accounting. 530 531 def init_predefined_constants(self): 532 533 "Ensure the predefined constants." 534 535 for name, value in self.predefined_constants.items(): 536 self.make_constant(value) 537 538 def get_predefined_constant(self, name): 539 540 "Return the predefined constant for the given 'name'." 541 542 return self.make_constant(self.predefined_constants[name]) 543 544 def get_constant(self, value): 545 546 "Return a constant for the given 'value'." 547 548 const = micropython.data.Const(value) 549 return self.constant_values[const] 550 551 def get_constant_type_name(self, value): 552 return value.__class__.__name__ 553 554 def make_constant(self, value): 555 556 "Make and return a constant for the given 'value'." 557 558 # Ensure the presence of the constant's type. 559 560 name = self.get_constant_type_name(value) 561 if self.modules.has_key("__builtins__"): 562 attr = self.modules["__builtins__"].get(name) 563 564 # Make a constant object and return it. 565 566 const = micropython.data.Const(value) 567 if not self.constant_values.has_key(const): 568 self.constant_values[const] = const 569 return self.constant_values[const] 570 571 def constants(self): 572 573 "Return a list of constants." 574 575 if self.constant_list is None: 576 self.constant_list = list(self.constant_values.values()) 577 578 return self.constant_list 579 580 # Import methods. 581 582 def find_in_path(self, name): 583 584 """ 585 Find the given module 'name' in the search path, returning None where no 586 such module could be found, or a 2-tuple from the 'find' method 587 otherwise. 588 """ 589 590 for d in self.path: 591 m = self.find(d, name) 592 if m: return m 593 return None 594 595 def find(self, d, name): 596 597 """ 598 In the directory 'd', find the given module 'name', where 'name' can 599 either refer to a single file module or to a package. Return None if the 600 'name' cannot be associated with either a file or a package directory, 601 or a 2-tuple from '_find_package' or '_find_module' otherwise. 602 """ 603 604 m = self._find_package(d, name) 605 if m: return m 606 m = self._find_module(d, name) 607 if m: return m 608 return None 609 610 def _find_module(self, d, name): 611 612 """ 613 In the directory 'd', find the given module 'name', returning None where 614 no suitable file exists in the directory, or a 2-tuple consisting of 615 None (indicating that no package directory is involved) and a filename 616 indicating the location of the module. 617 """ 618 619 name_py = name + os.extsep + "py" 620 filename = self._find_file(d, name_py) 621 if filename: 622 return None, filename 623 return None 624 625 def _find_package(self, d, name): 626 627 """ 628 In the directory 'd', find the given package 'name', returning None 629 where no suitable package directory exists, or a 2-tuple consisting of 630 a directory (indicating the location of the package directory itself) 631 and a filename indicating the location of the __init__.py module which 632 declares the package's top-level contents. 633 """ 634 635 filename = self._find_file(d, name) 636 if filename: 637 init_py = "__init__" + os.path.extsep + "py" 638 init_py_filename = self._find_file(filename, init_py) 639 if init_py_filename: 640 return filename, init_py_filename 641 return None 642 643 def _find_file(self, d, filename): 644 645 """ 646 Return the filename obtained when searching the directory 'd' for the 647 given 'filename', or None if no actual file exists for the filename. 648 """ 649 650 filename = os.path.join(d, filename) 651 if os.path.exists(filename): 652 return filename 653 else: 654 return None 655 656 def load(self, name, return_leaf=0): 657 658 """ 659 Load the module or package with the given 'name'. Return an object 660 referencing the loaded module or package, or None if no such module or 661 package exists. 662 """ 663 664 if self.modules.has_key(name) and self.modules[name].loaded: 665 #print "Cached (%s)" % name 666 return self.modules[name] 667 if self.verbose: 668 print "Loading", name 669 670 # Split the name into path components, and try to find the uppermost in 671 # the search path. 672 673 path = name.split(".") 674 m = self.find_in_path(path[0]) 675 if not m: 676 if self.verbose: 677 print "Not found (%s)" % path[0] 678 return None # NOTE: Import error. 679 d, filename = m 680 681 # Either acquire a reference to an already-imported module, or load the 682 # module from a file. 683 684 top = module = self.load_from_file(filename, path[0]) 685 686 # For hierarchical names, traverse each path component... 687 688 if len(path) > 1: 689 if not d: 690 if self.verbose: 691 print "No package (%s)" % filename 692 return None # NOTE: Import error (package not found). 693 else: 694 self.add_submodules(d, module) 695 696 path_so_far = path[:1] 697 for p in path[1:]: 698 path_so_far.append(p) 699 700 # Find the package or module concerned. 701 702 m = self.find(d, p) 703 if not m: 704 if self.verbose: 705 print "Not found (%s)" % p 706 return None # NOTE: Import error. 707 d, filename = m 708 module_name = ".".join(path_so_far) 709 710 # Either reference an imported module or load one from a file. 711 712 submodule = self.load_from_file(filename, module_name) 713 714 if d: 715 self.add_submodules(d, module) 716 717 # Store the submodule within its parent module. 718 719 module.set_module(p, submodule) 720 module = submodule 721 722 # Return either the deepest or the uppermost module. 723 724 if return_leaf: 725 return module 726 else: 727 return top 728 729 def load_from_file(self, name, module_name=None): 730 731 """ 732 Load the module with the given 'name' (which may be a full module path). 733 """ 734 735 if module_name is None: 736 module_name = "__main__" 737 738 module = self.add_module(module_name) 739 if not module.loaded and module not in self.loading: 740 self.loading.add(module) 741 #print "Parsing", name 742 module.parse(name) 743 #print "Done", name 744 self.loading.remove(module) 745 module.loaded = 1 746 747 # Record the module. 748 749 #print "Loaded", module_name, "with namespace", module.namespace.keys() 750 return module 751 752 def add_module(self, module_name): 753 754 """ 755 Return the module with the given 'module_name', adding a new module 756 object if one does not already exist. 757 """ 758 759 if not self.modules.has_key(module_name): 760 self.modules[module_name] = module = micropython.inspect.InspectedModule(module_name, self) 761 self.modules_ordered.append(module) 762 else: 763 module = self.modules[module_name] 764 return module 765 766 def add_submodules(self, pathname, module): 767 768 """ 769 Work around insufficient __all__ declarations and examine the directory 770 with the given 'pathname', adding submodules to the given 'module'. 771 """ 772 773 for filename in os.listdir(pathname): 774 submodule, ext = os.path.splitext(filename) 775 if ext not in ("", ".py"): 776 continue 777 module.set_module(submodule, self.add_module(module.name + "." + submodule)) 778 779 # vim: tabstop=4 expandtab shiftwidth=4