components/logilab-astng/logilab-astng.3
changeset 114 6cc95ec7b1bb
child 181 87e11e685b1f
equal deleted inserted replaced
113:974574539e7b 114:6cc95ec7b1bb
       
     1 '\" te
       
     2 .\"
       
     3 .\" Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
       
     4 .\"
       
     5 .\" logilab-astng.3
       
     6 .\"
       
     7 .TH logilab-astng 3 "30 Apr 2009"
       
     8 .SH NAME
       
     9 logilab-astng \- Python Abstract Syntax Tree New Generation
       
    10 .SH DESCRIPTION
       
    11 The
       
    12 .I logilab-astng
       
    13 The aim of this module is to provide a common base representation of 
       
    14 python source code for projects such as pychecker, pyreverse, pylint.
       
    15 
       
    16 .LP
       
    17 It is governed by pylint's needs.  It extends class defined in the 
       
    18 compiler.ast [1] module with some additional methods and attributes. 
       
    19 Instance attributes are added by a builder object, which can either 
       
    20 generate extended ast by visiting an existant ast tree or by inspecting 
       
    21 living object. Methods are added by monkey patching ast classes.
       
    22 
       
    23 .LP
       
    24 Main modules are:
       
    25 .LP
       
    26 
       
    27 * nodes and scoped_nodes for more information about methods 
       
    28 and attributes added to different node classes
       
    29 
       
    30 .LP
       
    31 * the manager contains a high level object to get astng trees 
       
    32 from source files and living objects. It maintains a cache of 
       
    33 previously constructed tree for quick access
       
    34 
       
    35 .LP
       
    36 * builder contains the class responsible to build astng trees
       
    37 
       
    38 
       
    39 .LP
       
    40 
       
    41 .SH FILES
       
    42 .TP 2.2i
       
    43 .B /usr/lib/python2.6/vendor-packages/logilab/astng
       
    44 shared object library files
       
    45 
       
    46 .SH AUTHORS
       
    47 Sylvain Thenault ([email protected])
       
    48 
       
    49 .SH SUPPORT
       
    50 [email protected]
       
    51 
       
    52 .SH ATTRIBUTES
       
    53 See
       
    54 .BR attributes (5)
       
    55 for descriptions of the following attributes:
       
    56 .sp
       
    57 .TS
       
    58 box;
       
    59 cbp-1 | cbp-1
       
    60 l | l .
       
    61 ATTRIBUTE TYPE	ATTRIBUTE VALUE
       
    62 =
       
    63 Availability	library/python-2/logilab-astng
       
    64 =
       
    65 Interface Stability	Uncommitted
       
    66 .TE
       
    67 .SH SEE ALSO
       
    68 .IR logilab-common (3),
       
    69 .IR pylint (1),
       
    70 .SH NOTES
       
    71 
       
    72 Documentation for logilab-astng is available on-line at http://www.logilab.org/project/logilab-astng
       
    73 
       
    74 Source for logilab-astng is available on http://opensolaris.org.