paul@83 | 1 | #!/usr/bin/env python |
paul@83 | 2 | |
paul@83 | 3 | """ |
paul@83 | 4 | Data classes. |
paul@83 | 5 | |
paul@83 | 6 | Copyright (C) 2007, 2008 Paul Boddie <paul@boddie.org.uk> |
paul@83 | 7 | |
paul@83 | 8 | This program is free software; you can redistribute it and/or modify it under |
paul@83 | 9 | the terms of the GNU General Public License as published by the Free Software |
paul@83 | 10 | Foundation; either version 3 of the License, or (at your option) any later |
paul@83 | 11 | version. |
paul@83 | 12 | |
paul@83 | 13 | This program is distributed in the hope that it will be useful, but WITHOUT |
paul@83 | 14 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
paul@83 | 15 | FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
paul@83 | 16 | details. |
paul@83 | 17 | |
paul@83 | 18 | You should have received a copy of the GNU General Public License along with |
paul@83 | 19 | this program. If not, see <http://www.gnu.org/licenses/>. |
paul@83 | 20 | |
paul@83 | 21 | -------- |
paul@83 | 22 | |
paul@83 | 23 | The central classes in this module are the following: |
paul@83 | 24 | |
paul@83 | 25 | * Class |
paul@83 | 26 | * Function |
paul@83 | 27 | * Module |
paul@83 | 28 | * InspectedModule (derived from Module) |
paul@83 | 29 | |
paul@83 | 30 | All of the above support the Naming interface either explicitly or through |
paul@83 | 31 | general conformance, meaning that all can be asked to provide their 'full_name' |
paul@83 | 32 | using the method of that name. |
paul@83 | 33 | |
paul@83 | 34 | Additionally, all of the above also support a dictionary interface in order to |
paul@83 | 35 | access names within their defined scopes. Specific methods also exist in order |
paul@83 | 36 | to distinguish between certain kinds of attributes: |
paul@83 | 37 | |
paul@83 | 38 | * Class: (class|all_class|instance|all)_attributes |
paul@83 | 39 | * Function: parameters, locals, all_locals |
paul@83 | 40 | * Module: module_attributes |
paul@83 | 41 | |
paul@83 | 42 | These specific methods are useful in certain situations. |
paul@83 | 43 | |
paul@83 | 44 | The above classes also provide a 'node' attribute, indicating the AST node where |
paul@83 | 45 | each such object is defined. |
paul@83 | 46 | """ |
paul@83 | 47 | |
paul@83 | 48 | from micropython.common import * |
paul@83 | 49 | |
paul@83 | 50 | # Mix-ins and abstract classes. |
paul@83 | 51 | |
paul@83 | 52 | class NamespaceDict: |
paul@83 | 53 | |
paul@83 | 54 | "A mix-in providing dictionary methods." |
paul@83 | 55 | |
paul@83 | 56 | def __init__(self, global_namespace=None): |
paul@83 | 57 | self.namespace = {} |
paul@83 | 58 | self.globals = set() |
paul@83 | 59 | self.global_namespace = global_namespace |
paul@83 | 60 | |
paul@83 | 61 | def __getitem__(self, name): |
paul@83 | 62 | return self.namespace[name] |
paul@83 | 63 | |
paul@83 | 64 | def get(self, name, default=None): |
paul@83 | 65 | return self.namespace.get(name, default) |
paul@83 | 66 | |
paul@83 | 67 | def __setitem__(self, name, value): |
paul@83 | 68 | self.set(name, value) |
paul@83 | 69 | |
paul@83 | 70 | def set(self, name, value, single_assignment=1): |
paul@83 | 71 | |
paul@83 | 72 | """ |
paul@83 | 73 | A more powerful set operation, making 'name' refer to 'value' whilst |
paul@83 | 74 | indicating whether a 'single_assignment' (true by default) occurs in |
paul@83 | 75 | this operation (or whether the operation covers potentially many |
paul@83 | 76 | assignments in the lifetime of a program). |
paul@83 | 77 | """ |
paul@83 | 78 | |
paul@83 | 79 | if name in self.globals: |
paul@83 | 80 | self.global_namespace.set(name, value, 0) |
paul@83 | 81 | else: |
paul@83 | 82 | attr = self._set(name, value) |
paul@83 | 83 | |
paul@83 | 84 | # NOTE: Insist on assignments with known values. |
paul@83 | 85 | |
paul@83 | 86 | if value is not None: |
paul@83 | 87 | attr.update(value, single_assignment) |
paul@83 | 88 | |
paul@83 | 89 | def set_module(self, name, value): |
paul@83 | 90 | |
paul@83 | 91 | """ |
paul@83 | 92 | A specialised set operation, making 'name' refer to 'value' in the |
paul@83 | 93 | context of making a module reference available in association with |
paul@83 | 94 | 'name' as part of the import of that module or a submodule of that |
paul@83 | 95 | module. |
paul@83 | 96 | """ |
paul@83 | 97 | |
paul@83 | 98 | attr = self._set(name, value) |
paul@83 | 99 | if attr.assignments is None: |
paul@83 | 100 | attr.assignments = 1 |
paul@83 | 101 | attr.assignment_values.add(value) |
paul@83 | 102 | |
paul@83 | 103 | def _set(self, name, value): |
paul@83 | 104 | |
paul@83 | 105 | "The underlying set operation associating 'name' with 'value'." |
paul@83 | 106 | |
paul@83 | 107 | if not self.namespace.has_key(name): |
paul@83 | 108 | self.namespace[name] = Attr(None, self, name, value) |
paul@83 | 109 | return self.namespace[name] |
paul@83 | 110 | |
paul@83 | 111 | def __delitem__(self, name): |
paul@83 | 112 | del self.namespace[name] |
paul@83 | 113 | |
paul@83 | 114 | def has_key(self, name): |
paul@83 | 115 | return self.namespace.has_key(name) |
paul@83 | 116 | |
paul@83 | 117 | def keys(self): |
paul@83 | 118 | return self.namespace.keys() |
paul@83 | 119 | |
paul@83 | 120 | def values(self): |
paul@83 | 121 | return self.namespace.values() |
paul@83 | 122 | |
paul@83 | 123 | def items(self): |
paul@83 | 124 | return self.namespace.items() |
paul@83 | 125 | |
paul@83 | 126 | def make_global(self, name): |
paul@83 | 127 | if not self.namespace.has_key(name): |
paul@83 | 128 | self.globals.add(name) |
paul@83 | 129 | else: |
paul@83 | 130 | raise InspectError(self.full_name(), self.node, "Name %r is both global and local in %r" % (name, self.full_name())) |
paul@83 | 131 | |
paul@83 | 132 | def get_assignments(self, name): |
paul@83 | 133 | if self.assignments.has_key(name): |
paul@83 | 134 | return max(self.assignments[name], len(self.assignment_values[name])) |
paul@83 | 135 | else: |
paul@83 | 136 | return None |
paul@83 | 137 | |
paul@83 | 138 | def attributes_as_list(self): |
paul@83 | 139 | self.finalise_attributes() |
paul@83 | 140 | l = [None] * len(self.keys()) |
paul@83 | 141 | for attr in self.values(): |
paul@83 | 142 | l[attr.position] = attr |
paul@83 | 143 | return l |
paul@83 | 144 | |
paul@83 | 145 | def finalise_attributes(self): |
paul@83 | 146 | |
paul@83 | 147 | "Make sure all attributes are fully defined." |
paul@83 | 148 | |
paul@83 | 149 | # The default action is to assign attribute positions sequentially. |
paul@83 | 150 | |
paul@83 | 151 | for i, attr in enumerate(self.values()): |
paul@83 | 152 | attr.position = i |
paul@83 | 153 | |
paul@83 | 154 | # Program data structures. |
paul@83 | 155 | |
paul@83 | 156 | class Attr: |
paul@83 | 157 | |
paul@83 | 158 | "An attribute entry having a parent as context." |
paul@83 | 159 | |
paul@83 | 160 | def __init__(self, position, parent, name, value=None, assignments=None): |
paul@83 | 161 | self.position = position |
paul@83 | 162 | self.parent = parent |
paul@83 | 163 | self.name = name |
paul@83 | 164 | self.value = value |
paul@83 | 165 | |
paul@83 | 166 | # Number of assignments per name. |
paul@83 | 167 | |
paul@83 | 168 | self.assignments = assignments |
paul@83 | 169 | self.assignment_values = set() |
paul@83 | 170 | |
paul@83 | 171 | def update(self, value, single_assignment): |
paul@83 | 172 | |
paul@83 | 173 | """ |
paul@83 | 174 | Update the attribute, adding the 'value' provided to the known values |
paul@83 | 175 | associated with the attribute, changing the number of assignments |
paul@83 | 176 | according to the 'single_assignment' status of the operation, where |
paul@83 | 177 | a true value indicates that only one assignment is associated with the |
paul@83 | 178 | update, and a false value indicates that potentially many assignments |
paul@83 | 179 | may be involved. |
paul@83 | 180 | """ |
paul@83 | 181 | |
paul@83 | 182 | if self.assignments is None: |
paul@83 | 183 | if single_assignment: |
paul@83 | 184 | self.assignments = 1 |
paul@83 | 185 | else: |
paul@83 | 186 | self.assignments = AtLeast(1) |
paul@83 | 187 | else: |
paul@83 | 188 | if single_assignment: |
paul@83 | 189 | self.assignments += 1 |
paul@83 | 190 | else: |
paul@83 | 191 | self.assignments += AtLeast(1) |
paul@83 | 192 | self.assignment_values.add(value) |
paul@83 | 193 | |
paul@83 | 194 | def __repr__(self): |
paul@83 | 195 | return "Attr(%r, %r, %r, %r, %r)" % (self.position, self.parent, self.name, self.value, self.assignments) |
paul@83 | 196 | |
paul@83 | 197 | class Const: |
paul@83 | 198 | |
paul@83 | 199 | "A constant object with no context." |
paul@83 | 200 | |
paul@83 | 201 | def __init__(self, value): |
paul@83 | 202 | self.value = value |
paul@83 | 203 | |
paul@83 | 204 | # Image generation details. |
paul@83 | 205 | |
paul@83 | 206 | self.location = None |
paul@83 | 207 | |
paul@83 | 208 | def __repr__(self): |
paul@83 | 209 | if self.location is not None: |
paul@83 | 210 | return "Const(%r, location=%r)" % (self.value, self.location) |
paul@83 | 211 | else: |
paul@83 | 212 | return "Const(%r)" % self.value |
paul@83 | 213 | |
paul@83 | 214 | # Support constants as dictionary keys in order to build constant tables. |
paul@83 | 215 | |
paul@83 | 216 | def __eq__(self, other): |
paul@83 | 217 | return self.value == other.value |
paul@83 | 218 | |
paul@83 | 219 | def __hash__(self): |
paul@83 | 220 | return hash(self.value) |
paul@83 | 221 | |
paul@83 | 222 | def value_type_name(self): |
paul@83 | 223 | return "__builtins__." + self.value.__class__.__name__ |
paul@83 | 224 | |
paul@83 | 225 | class Class(NamespaceDict, Naming): |
paul@83 | 226 | |
paul@83 | 227 | "An inspected class." |
paul@83 | 228 | |
paul@83 | 229 | def __init__(self, name, parent, global_namespace=None, node=None): |
paul@83 | 230 | |
paul@83 | 231 | """ |
paul@83 | 232 | Initialise the class with the given 'name', 'parent' object, optional |
paul@83 | 233 | 'global_namespace' and optional AST 'node'. |
paul@83 | 234 | """ |
paul@83 | 235 | |
paul@83 | 236 | NamespaceDict.__init__(self, global_namespace) |
paul@83 | 237 | self.name = name |
paul@83 | 238 | self.parent = parent |
paul@83 | 239 | self.node = node |
paul@83 | 240 | |
paul@83 | 241 | # Superclasses, descendants and attributes. |
paul@83 | 242 | |
paul@83 | 243 | self.bases = [] |
paul@83 | 244 | self.descendants = set() |
paul@83 | 245 | self.instattr = set() # instance attributes |
paul@83 | 246 | self.relocated = set() # attributes which do not have the same |
paul@83 | 247 | # position as those of the same name in |
paul@83 | 248 | # some superclasses |
paul@83 | 249 | |
paul@83 | 250 | # Caches. |
paul@83 | 251 | |
paul@83 | 252 | self.all_instattr = None # cache for instance_attributes |
paul@83 | 253 | self.all_instattr_names = None # from all_instattr |
paul@83 | 254 | self.all_classattr = None # cache for all_class_attributes |
paul@83 | 255 | self.all_classattr_names = None # from all_classattr |
paul@83 | 256 | self.allattr = None # cache for all_attributes |
paul@83 | 257 | self.allattr_names = None # from allattr |
paul@83 | 258 | |
paul@83 | 259 | # Add this class to its attributes. |
paul@83 | 260 | |
paul@83 | 261 | self.set("__class__", self) |
paul@83 | 262 | |
paul@83 | 263 | # Image generation details. |
paul@83 | 264 | |
paul@83 | 265 | self.location = None |
paul@83 | 266 | self.code_location = None |
paul@83 | 267 | self.instantiator = None |
paul@83 | 268 | |
paul@83 | 269 | # Program-related details. |
paul@83 | 270 | |
paul@83 | 271 | self.stack_usage = 0 |
paul@83 | 272 | self.stack_temp_usage = 0 |
paul@83 | 273 | self.stack_local_usage = 0 |
paul@83 | 274 | |
paul@83 | 275 | def __repr__(self): |
paul@83 | 276 | if self.location is not None: |
paul@83 | 277 | return "Class(%r, %r, location=%r)" % (self.name, self.parent, self.location) |
paul@83 | 278 | else: |
paul@83 | 279 | return "Class(%r, %r)" % (self.name, self.parent) |
paul@83 | 280 | |
paul@83 | 281 | def finalise_attributes(self): |
paul@83 | 282 | |
paul@83 | 283 | "Make sure that all attributes are fully defined." |
paul@83 | 284 | |
paul@83 | 285 | self.finalise_class_attributes() |
paul@83 | 286 | self.finalise_instance_attributes() |
paul@83 | 287 | |
paul@83 | 288 | def get_instantiator(self): |
paul@83 | 289 | |
paul@83 | 290 | "Return a function which can be used to instantiate the class." |
paul@83 | 291 | |
paul@83 | 292 | if self.instantiator is None: |
paul@83 | 293 | init_method = self.all_class_attributes()["__init__"].value |
paul@83 | 294 | self.instantiator = init_method.function_from_method() |
paul@83 | 295 | return self.instantiator |
paul@83 | 296 | |
paul@83 | 297 | # Class-specific methods. |
paul@83 | 298 | |
paul@83 | 299 | def add_base(self, base): |
paul@83 | 300 | self.bases.append(base) |
paul@83 | 301 | base.add_descendant(self) |
paul@83 | 302 | |
paul@83 | 303 | def add_instance_attribute(self, name): |
paul@83 | 304 | self.instattr.add(name) |
paul@83 | 305 | |
paul@83 | 306 | def add_descendant(self, cls): |
paul@83 | 307 | self.descendants.add(cls) |
paul@83 | 308 | for base in self.bases: |
paul@83 | 309 | base.add_descendant(cls) |
paul@83 | 310 | |
paul@83 | 311 | "Return the attribute names provided by this class only." |
paul@83 | 312 | |
paul@83 | 313 | class_attribute_names = NamespaceDict.keys |
paul@83 | 314 | |
paul@83 | 315 | def class_attributes(self): |
paul@83 | 316 | |
paul@83 | 317 | "Return class attributes provided by this class only." |
paul@83 | 318 | |
paul@83 | 319 | self.finalise_class_attributes() |
paul@83 | 320 | return dict(self) |
paul@83 | 321 | |
paul@83 | 322 | def all_class_attribute_names(self): |
paul@83 | 323 | |
paul@83 | 324 | "Return the attribute names provided by classes in this hierarchy." |
paul@83 | 325 | |
paul@83 | 326 | if self.all_classattr_names is None: |
paul@83 | 327 | self.all_class_attributes() |
paul@83 | 328 | return self.all_classattr_names |
paul@83 | 329 | |
paul@83 | 330 | def all_class_attributes(self): |
paul@83 | 331 | |
paul@83 | 332 | "Return all class attributes, indicating the class which provides them." |
paul@83 | 333 | |
paul@83 | 334 | self.finalise_class_attributes() |
paul@83 | 335 | return self.all_classattr |
paul@83 | 336 | |
paul@83 | 337 | def finalise_class_attributes(self): |
paul@83 | 338 | |
paul@83 | 339 | "Make sure that the class attributes are fully defined." |
paul@83 | 340 | |
paul@83 | 341 | if self.all_classattr is None: |
paul@83 | 342 | self.all_classattr = {} |
paul@83 | 343 | clsattr = {} |
paul@83 | 344 | |
paul@83 | 345 | # Record provisional position information for attributes of this |
paul@83 | 346 | # class. |
paul@83 | 347 | |
paul@83 | 348 | for name in self.class_attributes().keys(): |
paul@83 | 349 | clsattr[name] = set() # position not yet defined |
paul@83 | 350 | |
paul@83 | 351 | reversed_bases = self.bases[:] |
paul@83 | 352 | reversed_bases.reverse() |
paul@83 | 353 | |
paul@83 | 354 | # For the bases in reverse order, acquire class attribute details. |
paul@83 | 355 | |
paul@83 | 356 | for cls in reversed_bases: |
paul@83 | 357 | for name, attr in cls.all_class_attributes().items(): |
paul@83 | 358 | self.all_classattr[name] = attr |
paul@83 | 359 | |
paul@83 | 360 | # Record previous attribute information. |
paul@83 | 361 | |
paul@83 | 362 | if clsattr.has_key(name): |
paul@83 | 363 | clsattr[name].add(attr.position) |
paul@83 | 364 | |
paul@83 | 365 | # Record class attributes provided by this class and its bases, |
paul@83 | 366 | # along with their positions. |
paul@83 | 367 | |
paul@83 | 368 | self.all_classattr.update(self.class_attributes()) |
paul@83 | 369 | |
paul@83 | 370 | if clsattr: |
paul@83 | 371 | for i, name in enumerate(self._get_position_list(clsattr)): |
paul@83 | 372 | self.all_classattr[name].position = i |
paul@83 | 373 | |
paul@83 | 374 | return self.all_classattr |
paul@83 | 375 | |
paul@83 | 376 | def instance_attribute_names(self): |
paul@83 | 377 | |
paul@83 | 378 | "Return the instance attribute names provided by the class." |
paul@83 | 379 | |
paul@83 | 380 | if self.all_instattr_names is None: |
paul@83 | 381 | self.instance_attributes() |
paul@83 | 382 | return self.all_instattr_names |
paul@83 | 383 | |
paul@83 | 384 | def instance_attributes(self): |
paul@83 | 385 | |
paul@83 | 386 | "Return instance-only attributes for instances of this class." |
paul@83 | 387 | |
paul@83 | 388 | self.finalise_instance_attributes() |
paul@83 | 389 | return self.all_instattr |
paul@83 | 390 | |
paul@83 | 391 | def finalise_instance_attributes(self): |
paul@83 | 392 | |
paul@83 | 393 | "Make sure that the instance attributes are fully defined." |
paul@83 | 394 | |
paul@83 | 395 | if self.all_instattr is None: |
paul@83 | 396 | self.all_instattr = {} |
paul@83 | 397 | instattr = {} |
paul@83 | 398 | |
paul@83 | 399 | # Record provisional position information for attributes of this |
paul@83 | 400 | # instance. |
paul@83 | 401 | |
paul@83 | 402 | for name in self.instattr: |
paul@83 | 403 | instattr[name] = set() # position not yet defined |
paul@83 | 404 | |
paul@83 | 405 | reversed_bases = self.bases[:] |
paul@83 | 406 | reversed_bases.reverse() |
paul@83 | 407 | |
paul@83 | 408 | # For the bases in reverse order, acquire instance attribute |
paul@83 | 409 | # details. |
paul@83 | 410 | |
paul@83 | 411 | for cls in reversed_bases: |
paul@83 | 412 | for name, attr in cls.instance_attributes().items(): |
paul@83 | 413 | |
paul@83 | 414 | # Record previous attribute information. |
paul@83 | 415 | |
paul@83 | 416 | if instattr.has_key(name): |
paul@83 | 417 | instattr[name].add(attr.position) |
paul@83 | 418 | |
paul@83 | 419 | # Cache the attributes by converting the positioned attributes into |
paul@83 | 420 | # a dictionary. |
paul@83 | 421 | |
paul@83 | 422 | if not instattr: |
paul@83 | 423 | self.all_instattr = {} |
paul@83 | 424 | else: |
paul@83 | 425 | self.all_instattr = self._get_attributes(instattr) |
paul@83 | 426 | |
paul@83 | 427 | self.all_instattr_names = self.all_instattr.keys() |
paul@83 | 428 | |
paul@83 | 429 | return self.all_instattr |
paul@83 | 430 | |
paul@83 | 431 | def _get_position_list(self, positions): |
paul@83 | 432 | |
paul@83 | 433 | """ |
paul@83 | 434 | Return a list of attribute names for the given 'positions' mapping from |
paul@83 | 435 | names to positions, indicating the positions of the attributes in the |
paul@83 | 436 | final instance structure. |
paul@83 | 437 | """ |
paul@83 | 438 | |
paul@83 | 439 | position_items = positions.items() |
paul@83 | 440 | namearray = [None] * len(position_items) |
paul@83 | 441 | |
paul@83 | 442 | # Get the positions in ascending order of list size, with lists |
paul@83 | 443 | # of the same size ordered according to their smallest position |
paul@83 | 444 | # value. |
paul@83 | 445 | |
paul@83 | 446 | position_items.sort(self._cmp_positions) |
paul@83 | 447 | |
paul@83 | 448 | # Get the names in position order. |
paul@83 | 449 | |
paul@83 | 450 | held = [] |
paul@83 | 451 | |
paul@83 | 452 | for name, pos in position_items: |
paul@83 | 453 | pos = list(pos) |
paul@83 | 454 | pos.sort() |
paul@83 | 455 | if pos and pos[0] < len(namearray) and namearray[pos[0]] is None: |
paul@83 | 456 | namearray[pos[0]] = name |
paul@83 | 457 | else: |
paul@83 | 458 | if pos: |
paul@83 | 459 | self.relocated.add(name) |
paul@83 | 460 | held.append((name, pos)) |
paul@83 | 461 | |
paul@83 | 462 | for i, attr in enumerate(namearray): |
paul@83 | 463 | if attr is None: |
paul@83 | 464 | name, pos = held.pop() |
paul@83 | 465 | namearray[i] = name |
paul@83 | 466 | |
paul@83 | 467 | #print self.name, positions |
paul@83 | 468 | #print "->", namearray |
paul@83 | 469 | return namearray |
paul@83 | 470 | |
paul@83 | 471 | def _get_attributes(self, positions): |
paul@83 | 472 | |
paul@83 | 473 | """ |
paul@83 | 474 | For the given 'positions' mapping from names to positions, return a |
paul@83 | 475 | dictionary mapping names to Attr instances incorporating information |
paul@83 | 476 | about their positions in the final instance structure. |
paul@83 | 477 | """ |
paul@83 | 478 | |
paul@83 | 479 | d = {} |
paul@83 | 480 | for i, name in enumerate(self._get_position_list(positions)): |
paul@83 | 481 | d[name] = Attr(i, Instance(), name, None) |
paul@83 | 482 | return d |
paul@83 | 483 | |
paul@83 | 484 | def _cmp_positions(self, a, b): |
paul@83 | 485 | |
paul@83 | 486 | "Compare name plus position list operands 'a' and 'b'." |
paul@83 | 487 | |
paul@83 | 488 | name_a, list_a = a |
paul@83 | 489 | name_b, list_b = b |
paul@83 | 490 | if len(list_a) < len(list_b): |
paul@83 | 491 | return -1 |
paul@83 | 492 | elif len(list_a) > len(list_b): |
paul@83 | 493 | return 1 |
paul@83 | 494 | elif not list_a: |
paul@83 | 495 | return 0 |
paul@83 | 496 | else: |
paul@83 | 497 | return cmp(min(list_a), min(list_b)) |
paul@83 | 498 | |
paul@83 | 499 | def all_attribute_names(self): |
paul@83 | 500 | |
paul@83 | 501 | """ |
paul@83 | 502 | Return the names of all attributes provided by instances of this class. |
paul@83 | 503 | """ |
paul@83 | 504 | |
paul@83 | 505 | self.allattr_names = self.allattr_names or self.all_attributes().keys() |
paul@83 | 506 | return self.allattr_names |
paul@83 | 507 | |
paul@83 | 508 | def all_attributes(self): |
paul@83 | 509 | |
paul@83 | 510 | """ |
paul@83 | 511 | Return all attributes for an instance, indicating either the class which |
paul@83 | 512 | provides them or that the instance itself provides them. |
paul@83 | 513 | """ |
paul@83 | 514 | |
paul@83 | 515 | if self.allattr is None: |
paul@83 | 516 | self.allattr = {} |
paul@83 | 517 | self.allattr.update(self.all_class_attributes()) |
paul@83 | 518 | for name, attr in self.instance_attributes().items(): |
paul@83 | 519 | if self.allattr.has_key(name): |
paul@83 | 520 | print "Instance attribute %r in %r overrides class attribute." % (name, self) |
paul@83 | 521 | self.allattr[name] = attr |
paul@83 | 522 | return self.allattr |
paul@83 | 523 | |
paul@83 | 524 | class Function(NamespaceDict, Naming): |
paul@83 | 525 | |
paul@83 | 526 | "An inspected function." |
paul@83 | 527 | |
paul@83 | 528 | def __init__(self, name, parent, argnames, defaults, has_star, has_dstar, global_namespace=None, node=None): |
paul@83 | 529 | |
paul@83 | 530 | """ |
paul@83 | 531 | Initialise the function with the given 'name', 'parent', list of |
paul@83 | 532 | 'argnames', list of 'defaults', the 'has_star' flag (indicating the |
paul@83 | 533 | presence of a * parameter), the 'has_dstar' flag (indicating the |
paul@83 | 534 | presence of a ** parameter), optional 'global_namespace', and optional |
paul@83 | 535 | AST 'node'. |
paul@83 | 536 | """ |
paul@83 | 537 | |
paul@83 | 538 | NamespaceDict.__init__(self, global_namespace) |
paul@83 | 539 | self.name = name |
paul@83 | 540 | self.parent = parent |
paul@83 | 541 | self.argnames = argnames |
paul@83 | 542 | self.defaults = defaults |
paul@83 | 543 | self.has_star = has_star |
paul@83 | 544 | self.has_dstar = has_dstar |
paul@83 | 545 | self.node = node |
paul@83 | 546 | |
paul@83 | 547 | # Initialise the positional names. |
paul@83 | 548 | |
paul@83 | 549 | self.positional_names = self.argnames[:] |
paul@83 | 550 | if has_dstar: |
paul@83 | 551 | self.dstar_name = self.positional_names[-1] |
paul@83 | 552 | del self.positional_names[-1] |
paul@83 | 553 | if has_star: |
paul@83 | 554 | self.star_name = self.positional_names[-1] |
paul@83 | 555 | del self.positional_names[-1] |
paul@83 | 556 | |
paul@83 | 557 | # Initialise default storage. |
paul@83 | 558 | # NOTE: This must be initialised separately due to the reliance on node |
paul@83 | 559 | # NOTE: visiting. |
paul@83 | 560 | |
paul@83 | 561 | self.default_attrs = [] |
paul@83 | 562 | |
paul@83 | 563 | # Caches. |
paul@83 | 564 | |
paul@83 | 565 | self.localnames = None # cache for locals |
paul@83 | 566 | |
paul@83 | 567 | # Add parameters to the namespace. |
paul@83 | 568 | |
paul@83 | 569 | self._add_parameters(argnames) |
paul@83 | 570 | |
paul@83 | 571 | # Image generation details. |
paul@83 | 572 | |
paul@83 | 573 | self.location = None |
paul@83 | 574 | self.code_location = None |
paul@83 | 575 | |
paul@83 | 576 | # Program-related details. |
paul@83 | 577 | |
paul@83 | 578 | self.stack_usage = 0 |
paul@83 | 579 | self.stack_temp_usage = 0 |
paul@83 | 580 | self.stack_local_usage = 0 |
paul@83 | 581 | |
paul@83 | 582 | def _add_parameters(self, argnames): |
paul@83 | 583 | for name in argnames: |
paul@83 | 584 | if isinstance(name, tuple): |
paul@83 | 585 | self._add_parameters(name) |
paul@83 | 586 | else: |
paul@83 | 587 | self.set(name, None) |
paul@83 | 588 | |
paul@83 | 589 | def __repr__(self): |
paul@83 | 590 | if self.location is not None: |
paul@83 | 591 | return "Function(%r, %r, %r, %r, %r, %r, location=%r)" % ( |
paul@83 | 592 | self.name, self.parent, self.argnames, self.defaults, self.has_star, self.has_dstar, self.location |
paul@83 | 593 | ) |
paul@83 | 594 | else: |
paul@83 | 595 | return "Function(%r, %r, %r, %r, %r, %r)" % ( |
paul@83 | 596 | self.name, self.parent, self.argnames, self.defaults, self.has_star, self.has_dstar |
paul@83 | 597 | ) |
paul@83 | 598 | |
paul@83 | 599 | def store_default(self, value): |
paul@83 | 600 | attr = Attr(None, self, None, value) |
paul@83 | 601 | attr.update(value, 1) |
paul@83 | 602 | self.default_attrs.append(attr) |
paul@83 | 603 | |
paul@83 | 604 | def make_global(self, name): |
paul@83 | 605 | if name not in self.argnames and not self.has_key(name): |
paul@83 | 606 | self.globals.add(name) |
paul@83 | 607 | else: |
paul@83 | 608 | raise InspectError(self.full_name(), self.node, "Name %r is global and local in %r" % (name, self.full_name())) |
paul@83 | 609 | |
paul@83 | 610 | def parameters(self): |
paul@83 | 611 | |
paul@83 | 612 | """ |
paul@83 | 613 | Return a dictionary mapping parameter names to their position in the |
paul@83 | 614 | parameter list. |
paul@83 | 615 | """ |
paul@83 | 616 | |
paul@83 | 617 | parameters = {} |
paul@83 | 618 | for i, name in enumerate(self.argnames): |
paul@83 | 619 | parameters[name] = i |
paul@83 | 620 | return parameters |
paul@83 | 621 | |
paul@83 | 622 | def all_locals(self): |
paul@83 | 623 | |
paul@83 | 624 | "Return a dictionary mapping names to local and parameter details." |
paul@83 | 625 | |
paul@83 | 626 | return dict(self) |
paul@83 | 627 | |
paul@83 | 628 | def locals(self): |
paul@83 | 629 | |
paul@83 | 630 | "Return a dictionary mapping names to local details." |
paul@83 | 631 | |
paul@83 | 632 | if self.localnames is None: |
paul@83 | 633 | self.localnames = {} |
paul@83 | 634 | self.localnames.update(self.all_locals()) |
paul@83 | 635 | for name in self.argnames: |
paul@83 | 636 | del self.localnames[name] |
paul@83 | 637 | return self.localnames |
paul@83 | 638 | |
paul@83 | 639 | def is_method(self): |
paul@83 | 640 | |
paul@83 | 641 | "Return whether this function is a method." |
paul@83 | 642 | |
paul@83 | 643 | return isinstance(self.parent, Class) |
paul@83 | 644 | |
paul@83 | 645 | def is_relocated(self, name): |
paul@83 | 646 | |
paul@83 | 647 | """ |
paul@83 | 648 | Determine whether the given attribute 'name' is relocated for instances |
paul@83 | 649 | having this function as a method. |
paul@83 | 650 | """ |
paul@83 | 651 | |
paul@83 | 652 | for cls in self.parent.descendants: |
paul@83 | 653 | if name in cls.relocated: |
paul@83 | 654 | return 1 |
paul@83 | 655 | return 0 |
paul@83 | 656 | |
paul@83 | 657 | def finalise_attributes(self): |
paul@83 | 658 | |
paul@83 | 659 | """ |
paul@83 | 660 | Make sure all attributes (locals) are fully defined. Note that locals |
paul@83 | 661 | are not attributes in the sense of class, module or instance attributes. |
paul@83 | 662 | Defaults are also finalised by this method. |
paul@83 | 663 | """ |
paul@83 | 664 | |
paul@83 | 665 | for i, default in enumerate(self.default_attrs): |
paul@83 | 666 | default.position = i |
paul@83 | 667 | |
paul@83 | 668 | i = None |
paul@83 | 669 | for i, name in enumerate(self.argnames): |
paul@83 | 670 | self[name].position = i |
paul@83 | 671 | |
paul@83 | 672 | if i is not None: |
paul@83 | 673 | j = i |
paul@83 | 674 | else: |
paul@83 | 675 | j = 0 |
paul@83 | 676 | |
paul@83 | 677 | i = -1 |
paul@83 | 678 | for i, attr in enumerate(self.locals().values()): |
paul@83 | 679 | attr.position = i + j |
paul@83 | 680 | |
paul@83 | 681 | self.stack_local_usage = i + 1 |
paul@83 | 682 | |
paul@83 | 683 | def function_from_method(self): |
paul@83 | 684 | |
paul@83 | 685 | "Make a function from a method." |
paul@83 | 686 | |
paul@83 | 687 | function = Function(self.name, self.parent, self.argnames[1:], self.defaults, |
paul@83 | 688 | self.has_star, self.has_dstar, self.global_namespace, self.node) |
paul@83 | 689 | function.default_attrs = self.default_attrs |
paul@83 | 690 | return function |
paul@83 | 691 | |
paul@83 | 692 | class UnresolvedName(NamespaceDict): |
paul@83 | 693 | |
paul@83 | 694 | "A module, class or function which was mentioned but could not be imported." |
paul@83 | 695 | |
paul@83 | 696 | def __init__(self, name, parent_name, global_namespace=None): |
paul@83 | 697 | NamespaceDict.__init__(self, global_namespace) |
paul@83 | 698 | self.name = name |
paul@83 | 699 | self.parent_name = parent_name |
paul@83 | 700 | |
paul@83 | 701 | def all_class_attributes(self): |
paul@83 | 702 | return {} |
paul@83 | 703 | |
paul@83 | 704 | def instance_attributes(self): |
paul@83 | 705 | return {} |
paul@83 | 706 | |
paul@83 | 707 | def __repr__(self): |
paul@83 | 708 | return "UnresolvedName(%r, %r)" % (self.name, self.parent_name) |
paul@83 | 709 | |
paul@83 | 710 | def full_name(self): |
paul@83 | 711 | if self.name is not None: |
paul@83 | 712 | return self.parent_name + "." + self.name |
paul@83 | 713 | else: |
paul@83 | 714 | return self.parent_name |
paul@83 | 715 | |
paul@83 | 716 | class Instance: |
paul@83 | 717 | |
paul@83 | 718 | "A placeholder indicating the involvement of an instance." |
paul@83 | 719 | |
paul@83 | 720 | def __repr__(self): |
paul@83 | 721 | return "Instance()" |
paul@83 | 722 | |
paul@83 | 723 | class Module(NamespaceDict): |
paul@83 | 724 | |
paul@83 | 725 | "An inspected module's core details." |
paul@83 | 726 | |
paul@83 | 727 | def __init__(self, name): |
paul@83 | 728 | NamespaceDict.__init__(self, self) |
paul@83 | 729 | self.name = name |
paul@83 | 730 | |
paul@83 | 731 | # Original location details. |
paul@83 | 732 | |
paul@83 | 733 | self.node = None |
paul@83 | 734 | |
paul@83 | 735 | # Complete lists of classes and functions. |
paul@83 | 736 | |
paul@83 | 737 | self.all_objects = set() |
paul@83 | 738 | |
paul@83 | 739 | # Keyword records. |
paul@83 | 740 | |
paul@83 | 741 | self.keyword_names = set() |
paul@83 | 742 | |
paul@83 | 743 | # Image generation details. |
paul@83 | 744 | |
paul@83 | 745 | self.location = None |
paul@83 | 746 | self.code_location = None |
paul@83 | 747 | |
paul@83 | 748 | # Program-related details. |
paul@83 | 749 | |
paul@83 | 750 | self.stack_usage = 0 |
paul@83 | 751 | self.stack_temp_usage = 0 |
paul@83 | 752 | self.stack_local_usage = 0 |
paul@83 | 753 | |
paul@83 | 754 | def full_name(self): |
paul@83 | 755 | return self.name |
paul@83 | 756 | |
paul@83 | 757 | def __repr__(self): |
paul@83 | 758 | if self.location is not None: |
paul@83 | 759 | return "Module(%r, location=%r)" % (self.name, self.location) |
paul@83 | 760 | else: |
paul@83 | 761 | return "Module(%r)" % self.name |
paul@83 | 762 | |
paul@83 | 763 | # Attribute methods. |
paul@83 | 764 | |
paul@83 | 765 | "Return the module attribute names provided by the module." |
paul@83 | 766 | |
paul@83 | 767 | module_attribute_names = NamespaceDict.keys |
paul@83 | 768 | |
paul@83 | 769 | def module_attributes(self): |
paul@83 | 770 | |
paul@83 | 771 | "Return a dictionary mapping names to module attributes." |
paul@83 | 772 | |
paul@83 | 773 | return dict(self) |
paul@83 | 774 | |
paul@83 | 775 | # vim: tabstop=4 expandtab shiftwidth=4 |