author | Melynda Hunter <melynda.hunter@oracle.com> |
Thu, 01 Nov 2012 10:01:23 -0700 | |
branch | s11u1-sru |
changeset 2415 | db591cab6e24 |
parent 181 | 87e11e685b1f |
child 1023 | d2db2bc970c3 |
permissions | -rw-r--r-- |
114
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
1 |
.\" |
181
87e11e685b1f
7003927 userland should postprocess packaged files
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents:
114
diff
changeset
|
2 |
.\" Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved. |
114
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
3 |
.\" |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
4 |
.\" logilab-astng.3 |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
5 |
.\" |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
6 |
.TH logilab-astng 3 "30 Apr 2009" |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
7 |
.SH NAME |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
8 |
logilab-astng \- Python Abstract Syntax Tree New Generation |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
9 |
.SH DESCRIPTION |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
10 |
The |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
11 |
.I logilab-astng |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
12 |
The aim of this module is to provide a common base representation of |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
13 |
python source code for projects such as pychecker, pyreverse, pylint. |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
14 |
|
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
15 |
.LP |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
16 |
It is governed by pylint's needs. It extends class defined in the |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
17 |
compiler.ast [1] module with some additional methods and attributes. |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
18 |
Instance attributes are added by a builder object, which can either |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
19 |
generate extended ast by visiting an existant ast tree or by inspecting |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
20 |
living object. Methods are added by monkey patching ast classes. |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
21 |
|
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
22 |
.LP |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
23 |
Main modules are: |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
24 |
.LP |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
25 |
|
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
26 |
* nodes and scoped_nodes for more information about methods |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
27 |
and attributes added to different node classes |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
28 |
|
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
29 |
.LP |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
30 |
* the manager contains a high level object to get astng trees |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
31 |
from source files and living objects. It maintains a cache of |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
32 |
previously constructed tree for quick access |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
33 |
|
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
34 |
.LP |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
35 |
* builder contains the class responsible to build astng trees |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
36 |
|
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
37 |
|
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
38 |
.LP |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
39 |
|
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
40 |
.SH FILES |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
41 |
.TP 2.2i |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
42 |
.B /usr/lib/python2.6/vendor-packages/logilab/astng |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
43 |
shared object library files |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
44 |
|
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
45 |
.SH AUTHORS |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
46 |
Sylvain Thenault ([email protected]) |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
47 |
|
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
48 |
.SH SUPPORT |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
49 |
[email protected] |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
50 |
|
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
51 |
.SH SEE ALSO |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
52 |
.IR logilab-common (3), |
6cc95ec7b1bb
7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff
changeset
|
53 |
.IR pylint (1), |