components/python/astroid/astroid.3
author Radhika Siravara<radhika.siravara@oracle.com>
Tue, 17 Nov 2015 09:12:59 -0800
changeset 5098 77b8086c6247
parent 4814 c673d998018a
permissions -rw-r--r--
22082287 stunnel's use of the syslog LOG_AUTHPRIV facility level needs looking into

'\" te
.\"
.\" Copyright (c) 2009, 2015, Oracle and/or its affiliates. All rights reserved.
.\"
.\" astroid.3
.\"
.TH astroid 3 "28 Apr 2015" "astroid 1.3.6"
.SH NAME
astroid \- Python Abstract Syntax Tree New Generation
.SH DESCRIPTION

The aim of this module is to provide a common base representation of 
python source code for projects such as pychecker, pyreverse, pylint.
It used to be called logilab-astng.

.LP
It provides a compatible representation which comes from the `_ast` module.
It rebuilds the tree generated by the builtin _ast module by recursively
walking down the AST and building an extended ast. The new node classes
have additional methods and attributes for different usages.
They include some support for static inference and local name scopes.
Furthermore, astroid builds partial trees by inspecting living objects.

.LP
Main modules are:
.LP

* `bases`, `node_classses` and `scoped_nodes` contain the classes for the different type of nodes of the tree.

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

.LP

.SH FILES
.TP 2.2i
.B /usr/lib/python2.7/vendor-packages/astroid
astroid python modules

.SH AUTHORS
Sylvain Thenault ([email protected])

.SH SUPPORT
If you have any questions, please mail the
[email protected] mailing list for support. See
http://mail.python.org/mailman/listinfo/code-quality for
subscription information and archives. You may find older archives at
http://lists.logilab.org/mailman/listinfo/python-projects .


.SH SEE ALSO
.IR logilab-common (3),
.IR pylint (1)