components/logilab-astng/logilab-astng.3
author April Chin <april.chin@oracle.com>
Mon, 22 Oct 2012 10:02:22 -0700
changeset 1023 d2db2bc970c3
parent 181 87e11e685b1f
permissions -rw-r--r--
7040357 update pylint to 0.25.2 7161180 update logilab-common to 0.58.2 or later 7161182 update logilab-astng to 0.24.0 or later
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
114
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
     1
.\"
1023
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
     2
.\" Copyright (c) 2009, 2012, 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
.\"
1023
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
     6
.TH logilab-astng 3 "18 Jul 2012" "logilab-astng 0.24.0"
114
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
1023
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    10
114
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    11
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
    12
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
    13
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    14
.LP
1023
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    15
It provides a compatible representation which comes from the `_ast` module.
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    16
It rebuilds the tree generated by the builtin _ast module by recursively
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    17
walking down the AST and building an extended ast (let's call it astng ;). The
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    18
new node classes have additional methods and attributes for different usages.
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    19
They include some support for static inference and local name scopes.
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    20
Furthermore, astng builds partial trees by inspecting living objects.
114
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
1023
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    26
* `bases`, `node_classses` and `scoped_nodes` contain the classes for the different type of nodes of the tree.
114
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    27
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    28
.LP
1023
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    29
* 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
114
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    30
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    31
.LP
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    32
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    33
.SH FILES
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    34
.TP 2.2i
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    35
.B /usr/lib/python2.6/vendor-packages/logilab/astng
1023
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    36
logilab-astng python modules
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    37
.TP
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    38
.B /usr/lib/python2.7/vendor-packages/logilab/astng
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    39
logilab-astng python modules
114
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    40
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    41
.SH AUTHORS
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    42
Sylvain Thenault ([email protected])
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    43
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    44
.SH SUPPORT
1023
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    45
If you have any questions, please mail the
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    46
[email protected] mailing list for support. See
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    47
http://lists.logilab.org/mailman/listinfo/python-projects for
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    48
subscription information and archives.
114
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    49
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    50
.SH SEE ALSO
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    51
.IR logilab-common (3),
1023
d2db2bc970c3 7040357 update pylint to 0.25.2
April Chin <april.chin@oracle.com>
parents: 181
diff changeset
    52
.IR pylint (1)