components/python/logilab-astng/logilab-astng.3

   1 .\"
   2 .\" Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved.
   3 .\"
   4 .\" logilab-astng.3
   5 .\"
   6 .TH logilab-astng 3 "18 Jul 2012" "logilab-astng 0.24.0"
   7 .SH NAME
   8 logilab-astng \- Python Abstract Syntax Tree New Generation
   9 .SH DESCRIPTION
  10
  11 The aim of this module is to provide a common base representation of
  12 python source code for projects such as pychecker, pyreverse, pylint.
  13
  14 .LP
  15 It provides a compatible representation which comes from the `_ast` module.
  16 It rebuilds the tree generated by the builtin _ast module by recursively
  17 walking down the AST and building an extended ast (let's call it astng ;). The
  18 new node classes have additional methods and attributes for different usages.
  19 They include some support for static inference and local name scopes.
  20 Furthermore, astng builds partial trees by inspecting living objects.
  21
  22 .LP
  23 Main modules are:
  24 .LP
  25
  26 * `bases`, `node_classses` and `scoped_nodes` contain the classes for the different type of nodes of the tree.
  27
  28 .LP
  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
  30
  31 .LP
  32
  33 .SH FILES
  34 .TP 2.2i
  35 .B /usr/lib/python2.6/vendor-packages/logilab/astng
  36 logilab-astng python modules
  37 .TP
  38 .B /usr/lib/python2.7/vendor-packages/logilab/astng
  39 logilab-astng python modules
  40
  41 .SH AUTHORS
  42 Sylvain Thenault (sylvain.thenault@logilab.fr)
  43
  44 .SH SUPPORT
  45 If you have any questions, please mail the
  46 python-project@lists.logilab.org mailing list for support. See
  47 http://lists.logilab.org/mailman/listinfo/python-projects for
  48 subscription information and archives.
  49
  50 .SH SEE ALSO
  51 .IR logilab-common (3),
  52 .IR pylint (1)