README


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

ASTNG
=====

What's this ?
-------------

The aim of this module is to provide a common base representation of
python source code for projects such as pychecker, pyreverse,
pylint... Well, actually the development of this library is essentially
governed by pylint's needs.

Since 0.18, it provides a compatible representation which may come
from the `compiler` module (for python <= 2.4) pr the `_ast` module
(for python >= 2.5).

It extends bare node classes with some additional methods and
attributes. Instance attributes are added by a builder object, which
can generate extended ast (let's call them astng ;) by visiting either
an existent ast tree or by inspecting living object. Methods are added
by monkey patching ast classes. Finally some support for static
inference is provided.

Main modules are:

* `nodes` and `scoped_nodes` for more information about methods and
  attributes added to different node classes

* the `manager` contains a high level object to get astng trees from
  source files and living objects. It maintains a cache of previously
  constructed tree for quick access


Installation
------------

Extract the tarball, jump into the created directory and run ::

	python setup.py install

For installation options, see ::

	python setup.py install --help


If you have any questions, please mail the
python-project@lists.logilab.org mailing list for support. See
http://lists.logilab.org/mailman/listinfo/python-projects for
subscription information and archives.

Sylvain Thénault
Oct 21, 2005, updated on Aug 26 2009.