1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
|
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation; either version 2 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc.,
# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
"""The ASTNGBuilder makes astng from living object and / or from compiler.ast
The builder is not thread safe and can't be used to parse different sources
at the same time.
TODO:
- more complet representation on inspect build
(imported modules ? use dis.dis ?)
:version: $Revision: 1.54 $
:author: Sylvain Thenault
:copyright: 2003-2005 LOGILAB S.A. (Paris, FRANCE)
:contact: http://www.logilab.fr/ -- mailto:python-projects@logilab.org
:copyright: 2003-2005 Sylvain Thenault
:contact: mailto:thenault@gmail.com
"""
__docformat__ = "restructuredtext en"
import sys
from os.path import splitext, basename, dirname, exists, abspath
from parser import ParserError
from compiler import parse
from inspect import isfunction, ismethod, ismethoddescriptor, isclass, \
isbuiltin
from inspect import isdatadescriptor
from logilab.common.fileutils import norm_read
from logilab.common.modutils import modpath_from_file
from logilab.astng import nodes
from logilab.astng.utils import ASTWalker
from logilab.astng._exceptions import ASTNGBuildingException
from logilab.astng.raw_building import *
from logilab.astng.astutils import cvrtr
import token
from compiler import transformer, consts
from types import TupleType
def fromto_lineno(asttuple):
"""return the minimum and maximum line number of the given ast tuple"""
return from_lineno(asttuple), to_lineno(asttuple)
def from_lineno(asttuple):
"""return the minimum line number of the given ast tuple"""
if type(asttuple[1]) is TupleType:
return from_lineno(asttuple[1])
return asttuple[2]
def to_lineno(asttuple):
"""return the maximum line number of the given ast tuple"""
if type(asttuple[-1]) is TupleType:
return to_lineno(asttuple[-1])
return asttuple[2]
def fix_lineno(node, fromast, toast=None):
if 'fromlineno' in node.__dict__:
return node
#print 'fixing', id(node), id(node.__dict__), node.__dict__.keys(), repr(node)
if isinstance(node, nodes.Stmt):
node.fromlineno = from_lineno(fromast)#node.nodes[0].fromlineno
node.tolineno = node.nodes[-1].tolineno
return node
if toast is None:
node.fromlineno, node.tolineno = fromto_lineno(fromast)
else:
node.fromlineno, node.tolineno = from_lineno(fromast), to_lineno(toast)
#print 'fixed', id(node)
return node
BaseTransformer = transformer.Transformer
COORD_MAP = {
# if: test ':' suite ('elif' test ':' suite)* ['else' ':' suite]
'if': (0, 0),
# 'while' test ':' suite ['else' ':' suite]
'while': (0, 1),
# 'for' exprlist 'in' exprlist ':' suite ['else' ':' suite]
'for': (0, 3),
# 'try' ':' suite (except_clause ':' suite)+ ['else' ':' suite]
'try': (0, 0),
# | 'try' ':' suite 'finally' ':' suite
}
def fixlineno_wrap(function, stype):
def fixlineno_wrapper(self, nodelist):
node = function(self, nodelist)
idx1, idx2 = COORD_MAP.get(stype, (0, -1))
return fix_lineno(node, nodelist[idx1], nodelist[idx2])
return fixlineno_wrapper
nodes.Module.fromlineno = 0
nodes.Module.tolineno = 0
class ASTNGTransformer(BaseTransformer):
"""ovverides transformer for a better source line number handling"""
def com_NEWLINE(self, *args):
# A ';' at the end of a line can make a NEWLINE token appear
# here, Render it harmless. (genc discards ('discard',
# ('const', xxxx)) Nodes)
lineno = args[0][1]
# don't put fromlineno/tolineno on Const None to mark it as dynamically
# added, without "physical" reference in the source
n = nodes.Discard(nodes.Const(None))
n.fromlineno = n.tolineno = lineno
return n
def com_node(self, node):
res = self._dispatch[node[0]](node[1:])
return fix_lineno(res, node)
def com_assign(self, node, assigning):
res = BaseTransformer.com_assign(self, node, assigning)
return fix_lineno(res, node)
def com_apply_trailer(self, primaryNode, nodelist):
node = BaseTransformer.com_apply_trailer(self, primaryNode, nodelist)
return fix_lineno(node, nodelist)
## def atom(self, nodelist):
## node = BaseTransformer.atom(self, nodelist)
## return fix_lineno(node, nodelist[0], nodelist[-1])
def funcdef(self, nodelist):
node = BaseTransformer.funcdef(self, nodelist)
# XXX decorators
return fix_lineno(node, nodelist[-5], nodelist[-3])
def classdef(self, nodelist):
node = BaseTransformer.classdef(self, nodelist)
return fix_lineno(node, nodelist[0], nodelist[-2])
# wrap *_stmt methods
for name in dir(BaseTransformer):
if name.endswith('_stmt') and not (name in ('com_stmt',
'com_append_stmt')
or name in ASTNGTransformer.__dict__):
setattr(BaseTransformer, name,
fixlineno_wrap(getattr(BaseTransformer, name), name[:-5]))
transformer.Transformer = ASTNGTransformer
# ast NG builder ##############################################################
class ASTNGBuilder:
"""provide astng building methods
"""
def __init__(self): # XXX _ was the manager, keep for bw compat
self._module = None
self._file = None
self._done = None
self._stack, self._par_stack = None, None
self._metaclass = None
self._walker = ASTWalker(self)
self._dyn_modname_map = {'gtk': 'gtk._gtk'}
def module_build(self, module, modname=None):
"""build an astng from a living module instance
"""
node = None
self._module = module
path = getattr(module, '__file__', None)
if path is not None:
path_, ext = splitext(module.__file__)
if ext in ('.py', '.pyc', '.pyo') and exists(path_ + '.py'):
node = self.file_build(path_ + '.py', modname)
if node is None:
# this is a built-in module
# get a partial representation by introspection
node = self.inspect_build(module, modname=modname, path=path)
return node
def inspect_build(self, module, modname=None, path=None):
"""build astng from a living module (i.e. using inspect)
this is used when there is no python source code available (either
because it's a built-in module or because the .py is not available)
"""
self._module = module
node = build_module(modname or module.__name__, module.__doc__)
node.file = node.path = path and abspath(path) or path
node.package = hasattr(module, '__path__')
attach___dict__(node)
self._done = {}
self.object_build(node, module)
return node
def file_build(self, path, modname=None):
"""build astng from a source code file (i.e. from an ast)
path is expected to be a python source file
"""
try:
data = norm_read(path)
except IOError, ex:
msg = 'Unable to load file %r (%s)' % (path, ex)
raise ASTNGBuildingException(msg)
self._file = path
# get module name if necessary, *before modifying sys.path*
if modname is None:
try:
modname = '.'.join(modpath_from_file(path))
except ImportError:
modname = splitext(basename(path))[0]
# build astng representation
try:
sys.path.insert(0, dirname(path))
node = self.string_build(data, modname, path)
node.file = abspath(path)
finally:
self._file = None
sys.path.pop(0)
return node
def string_build(self, data, modname='', path=None):
"""build astng from a source code stream (i.e. from an ast)"""
return self.ast_build(parse(data + '\n'), modname, path)
def ast_build(self, node, modname=None, path=None):
"""recurse on the ast (soon ng) to add some arguments et method
"""
if path is not None:
node.file = node.path = abspath(path)
else:
node.file = node.path = '<?>'
if modname.endswith('.__init__'):
modname = modname[:-9]
node.package = True
else:
node.package = path and path.find('__init__.py') > -1 or False
node.name = modname
node.pure_python = True
self._walker.walk(node)
return node
# callbacks to build from an existing compiler.ast tree ###################
def visit_module(self, node):
"""visit a stmt.Module node -> init node and push the corresponding
object or None on the top of the stack
"""
self._stack = [self._module]
self._par_stack = [node]
self._metaclass = ['']
self._global_names = []
node.parent = None
node.globals = node.locals = {}
for name, value in ( ('__name__', node.name),
('__file__', node.path),
('__doc__', node.doc) ):
const = nodes.Const(value)
const.parent = node
node.locals[name] = [const]
attach___dict__(node)
if node.package:
# FIXME: List(Const())
const = nodes.Const(dirname(node.path))
const.parent = node
node.locals['__path__'] = [const]
def leave_module(self, _):
"""leave a stmt.Module node -> pop the last item on the stack and check
the stack is empty
"""
self._stack.pop()
assert not self._stack, 'Stack is not empty : %s' % self._stack
self._par_stack.pop()
assert not self._par_stack, \
'Parent stack is not empty : %s' % self._par_stack
def visit_class(self, node):
"""visit a stmt.Class node -> init node and push the corresponding
object or None on the top of the stack
"""
self.visit_default(node)
node.instance_attrs = {}
node.basenames = [b_node.as_string() for b_node in node.bases]
self._push(node)
for name, value in ( ('__name__', node.name),
('__module__', node.root().name),
('__doc__', node.doc) ):
const = nodes.Const(value)
const.parent = node
node.locals[name] = [const]
attach___dict__(node)
self._metaclass.append(self._metaclass[-1])
def leave_class(self, node):
"""leave a stmt.Class node -> pop the last item on the stack
"""
self.leave_default(node)
self._stack.pop()
metaclass = self._metaclass.pop()
if not node.bases:
# no base classes, detect new / style old style according to
# current scope
node._newstyle = metaclass == 'type'
def visit_function(self, node):
"""visit a stmt.Function node -> init node and push the corresponding
object or None on the top of the stack
"""
self.visit_default(node)
self._global_names.append({})
node.argnames = list(node.argnames)
if isinstance(node.parent.frame(), nodes.Class):
node.type = 'method'
if node.name == '__new__':
node.type = 'classmethod'
self._push(node)
register_arguments(node, node.argnames)
def leave_function(self, node):
"""leave a stmt.Function node -> pop the last item on the stack
"""
self.leave_default(node)
self._stack.pop()
self._global_names.pop()
def visit_lambda(self, node):
"""visit a stmt.Lambda node -> init node locals
"""
self.visit_default(node)
node.argnames = list(node.argnames)
node.locals = {}
register_arguments(node, node.argnames)
def visit_genexpr(self, node):
"""visit a stmt.GenExpr node -> init node locals
"""
self.visit_default(node)
node.locals = {}
def visit_global(self, node):
"""visit a stmt.Global node -> add declared names to locals
"""
self.visit_default(node)
if not self._global_names: # global at the module level, no effect
return
for name in node.names:
self._global_names[-1].setdefault(name, []).append(node)
# node.parent.set_local(name, node)
# module = node.root()
# if module is not node.frame():
# for name in node.names:
# module.set_local(name, node)
def visit_import(self, node):
"""visit a stmt.Import node -> add imported names to locals
"""
self.visit_default(node)
for (name, asname) in node.names:
name = asname or name
node.parent.set_local(name.split('.')[0], node)
def visit_from(self, node):
"""visit a stmt.From node -> add imported names to locals
"""
self.visit_default(node)
# add names imported by the import to locals
for (name, asname) in node.names:
if name == '*':
try:
imported = node.root().import_module(node.modname)
except ASTNGBuildingException:
#import traceback
#traceback.print_exc()
continue
# FIXME: log error
#print >> sys.stderr, \
# 'Unable to get imported names for %r line %s"' % (
# node.modname, node.lineno)
for name in imported.wildcard_import_names():
node.parent.set_local(name, node)
else:
node.parent.set_local(asname or name, node)
def leave_decorators(self, node):
"""python >= 2.4
visit a stmt.Decorator node -> check for classmethod and staticmethod
"""
func = node.parent
for decorator_expr in node.nodes:
if isinstance(decorator_expr, nodes.Name) and \
decorator_expr.name in ('classmethod', 'staticmethod'):
func.type = decorator_expr.name
self.leave_default(node)
def visit_assign(self, node):
"""visit a stmt.Assign node -> check for classmethod and staticmethod
+ __metaclass__
"""
self.visit_default(node)
klass = node.parent.frame()
#print node
if isinstance(klass, nodes.Class) and \
isinstance(node.expr, nodes.CallFunc) and \
isinstance(node.expr.node, nodes.Name):
func_name = node.expr.node.name
if func_name in ('classmethod', 'staticmethod'):
for ass_node in node.nodes:
if isinstance(ass_node, nodes.AssName):
try:
meth = klass[ass_node.name]
if isinstance(meth, nodes.Function):
meth.type = func_name
#else:
# print >> sys.stderr, 'FIXME 1', meth
except KeyError:
#print >> sys.stderr, 'FIXME 2', ass_node.name
continue
elif (isinstance(node.nodes[0], nodes.AssName)
and node.nodes[0].name == '__metaclass__'): # XXX check more...
self._metaclass[-1] = 'type' # XXX get the actual metaclass
def visit_assname(self, node):
"""visit a stmt.AssName node -> add name to locals
"""
self.visit_default(node)
self._add_local(node, node.name)
def visit_augassign(self, node):
"""visit a stmt.AssName node -> add name to locals
"""
self.visit_default(node)
if not isinstance(node.node, nodes.Name):
return # XXX
self._add_local(node, node.node.name)
def _add_local(self, node, name):
if self._global_names and name in self._global_names[-1]:
node.root().set_local(name, node)
else:
node.parent.set_local(name, node)
def visit_assattr(self, node):
"""visit a stmt.AssAttr node -> add name to locals, handle members
definition
"""
self.visit_default(node)
frame = node.frame()
if isinstance(frame, nodes.Function) and frame.type != 'function':
klass = frame.parent.frame()
# are we assigning to a (new ?) instance attribute ?
try:
_self = frame.argnames[0]
except IndexError:
# first argument is missing !
return
if isinstance(node.expr, nodes.Name) and node.expr.name == _self:
# unittest_scoped_nodes.ClassNodeTC.test_classmethod_attributes
#
# if frame.type == 'classmethod': XXX at this point we may have
# not encountered the classmethod decorator, so we havn't yet
# the correct type
# hack according to the argument name
if _self == 'self':
iattrs = klass.instance_attrs
else:
iattrs = klass.locals
# assign if not yet existant in others
if not iattrs.has_key(node.attrname):
iattrs[node.attrname] = [node]
# but always assign in __init__, except if previous assigment
# already come from __init__
elif frame.name == '__init__' and not \
iattrs[node.attrname][0].frame().name == '__init__':
iattrs[node.attrname].insert(0, node)
else:
iattrs[node.attrname].append(node)
def visit_default(self, node):
"""default visit method, handle the parent attribute
"""
node.parent = self._par_stack[-1]
assert node.parent is not node
self._par_stack.append(node)
def leave_default(self, _):
"""default leave method, handle the parent attribute
"""
self._par_stack.pop()
def _push(self, node):
"""update the stack and init some parts of the Function or Class node
"""
obj = getattr(self._stack[-1], node.name, None)
self._stack.append(obj)
node.locals = {}
node.parent.frame().set_local(node.name, node)
# astng from living objects ###############################################
#
# this is actually a really minimal representation, including only Module,
# Function and Class nodes and some others as guessed
def object_build(self, node, obj):
"""recursive method which create a partial ast from real objects
(only function, class, and method are handled)
"""
if self._done.has_key(obj):
return self._done[obj]
self._done[obj] = node
modname = self._module.__name__
modfile = getattr(self._module, '__file__', None)
for name in dir(obj):
try:
member = getattr(obj, name)
except AttributeError:
# damned ExtensionClass.Base, I know you're there !
attach_dummy_node(node, name)
continue
if ismethod(member):
member = member.im_func
if isfunction(member):
# verify this is not an imported function
if member.func_code.co_filename != modfile:
attach_dummy_node(node, name)
continue
object_build_function(node, member)
elif isbuiltin(member):
# verify this is not an imported member
if self._member_module(member) != modname:
imported_member(node, member, name)
continue
object_build_methoddescriptor(node, member)
elif isclass(member):
# verify this is not an imported class
if self._member_module(member) != modname:
imported_member(node, member, name)
continue
if member in self._done:
class_node = self._done[member]
node.add_local_node(class_node)
else:
class_node = object_build_class(node, member)
# recursion
self.object_build(class_node, member)
elif ismethoddescriptor(member):
assert isinstance(member, object)
object_build_methoddescriptor(node, member)
elif isdatadescriptor(member):
assert isinstance(member, object)
object_build_datadescriptor(node, member, name)
elif isinstance(member, (int, long, float, str, unicode)) or member is None:
attach_const_node(node, name, member)
else:
# create an empty node so that the name is actually defined
attach_dummy_node(node, name)
def _member_module(self, member):
modname = getattr(member, '__module__', None)
return self._dyn_modname_map.get(modname, modname)
def imported_member(node, member, name):
"""consider a class/builtin member where __module__ != current module name
check if it's sound valid and then add an import node, else use a dummy node
"""
# /!\ some classes like ExtensionClass doesn't have a
# __module__ attribute !
member_module = getattr(member, '__module__', '__builtin__')
try:
getattr(sys.modules[member_module], name)
except (KeyError, AttributeError):
attach_dummy_node(node, name)
else:
attach_import_node(node, member_module, name)
# optimize the tokenize module
#from logilab.common.bind import optimize_module
#import tokenize
#optimize_module(sys.modules['tokenize'], tokenize.__dict__)
#optimize_module(sys.modules[__name__], sys.modules[__name__].__dict__)
|