components/logilab-astng/logilab-astng.3
author April Chin <april.chin@oracle.com>
Tue, 01 Mar 2011 11:29:05 -0800
changeset 114 6cc95ec7b1bb
child 181 87e11e685b1f
permissions -rw-r--r--
7020818 move logilab-astng to userland
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
'\" te
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
     2
.\"
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
     3
.\" Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
     4
.\"
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
     5
.\" logilab-astng.3
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
     6
.\"
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
     7
.TH logilab-astng 3 "30 Apr 2009"
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
     8
.SH NAME
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
     9
logilab-astng \- Python Abstract Syntax Tree New Generation
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    10
.SH DESCRIPTION
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    11
The
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    12
.I logilab-astng
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    13
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
    14
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
    15
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    16
.LP
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    17
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
    18
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
    19
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
    20
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
    21
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
    22
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    23
.LP
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    24
Main modules are:
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    25
.LP
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    26
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    27
* 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
    28
and attributes added to different node classes
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    29
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    30
.LP
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    31
* 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
    32
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
    33
previously constructed tree for quick access
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    34
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    35
.LP
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    36
* 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
    37
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    38
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    39
.LP
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 FILES
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    42
.TP 2.2i
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    43
.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
    44
shared object library files
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    45
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    46
.SH AUTHORS
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    47
Sylvain Thenault ([email protected])
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    48
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    49
.SH SUPPORT
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    50
[email protected]
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    51
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    52
.SH ATTRIBUTES
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    53
See
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    54
.BR attributes (5)
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    55
for descriptions of the following attributes:
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    56
.sp
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    57
.TS
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    58
box;
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    59
cbp-1 | cbp-1
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    60
l | l .
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    61
ATTRIBUTE TYPE	ATTRIBUTE VALUE
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    62
=
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    63
Availability	library/python-2/logilab-astng
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    64
=
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    65
Interface Stability	Uncommitted
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    66
.TE
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    67
.SH SEE ALSO
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    68
.IR logilab-common (3),
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    69
.IR pylint (1),
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    70
.SH NOTES
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    71
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    72
Documentation for logilab-astng is available on-line at http://www.logilab.org/project/logilab-astng
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    73
6cc95ec7b1bb 7020818 move logilab-astng to userland
April Chin <april.chin@oracle.com>
parents:
diff changeset
    74
Source for logilab-astng is available on http://opensolaris.org.