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