summaryrefslogtreecommitdiffstats
path: root/libraries/logilab-astng/README
diff options
context:
space:
mode:
author grissiom2010-05-12 23:30:48 +0200
committer David Somero2010-05-12 23:30:48 +0200
commita0144c7e726638f1023431afd3aaf2cf91577254 (patch)
tree14c5598dff377a3d7a31b748caac76cb54bc542f /libraries/logilab-astng/README
parentf4cd4156cf1cb6852fb889bef8a710ac048b8c92 (diff)
downloadslackbuilds-a0144c7e726638f1023431afd3aaf2cf91577254.tar.gz
libraries/logilab-astng: Added to 12.2 repository
Diffstat (limited to 'libraries/logilab-astng/README')
-rw-r--r--libraries/logilab-astng/README23
1 files changed, 23 insertions, 0 deletions
diff --git a/libraries/logilab-astng/README b/libraries/logilab-astng/README
new file mode 100644
index 0000000000..9312185de8
--- /dev/null
+++ b/libraries/logilab-astng/README
@@ -0,0 +1,23 @@
+The aim of this module is to provide a common base representation of
+python source code for projects such as pychecker, pyreverse,
+pylint... Well, actually the development of this library is essentially
+governed by pylint's needs.
+
+It extends class defined in the compiler.ast [1] module with some
+additional methods and attributes. Instance attributes are added by a
+builder object, which can either generate extended ast (let's call
+them astng ;) by visiting an existant ast tree or by inspecting living
+object. Methods are added by monkey patching ast classes.
+
+Main modules are:
+
+* nodes and scoped_nodes for more information about methods and
+ attributes added to different node classes
+
+* 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
+
+* builder contains the class responsible to build astng trees
+
+Dependences: logilab-common available at SlackBuilds.org \ No newline at end of file