[py-svn] r34820 - py/dist/py/documentation

[fijal at codespeak.net]

Author: fijal
Date: Tue Nov 21 13:25:20 2006
New Revision: 34820

Added:
   py/dist/py/documentation/source-viewer.txt   (contents, props changed)
Log:
Added random notes about source-viewer


Added: py/dist/py/documentation/source-viewer.txt
==============================================================================
--- (empty file)
+++ py/dist/py/documentation/source-viewer.txt	Tue Nov 21 13:25:20 2006
@@ -0,0 +1,37 @@
+=======================
+Source viewer for pylib
+=======================
+
+Random notes:
+-------------
+
+* We want to construct this using an AST. Introspection is somehow better in
+  many many places, but an AST is more sticked to source (which is by
+  conincidence what we actually want to see). Additional stuff like things
+  attached to the module might be nice if we want to document them, but
+  they do not appear in source.
+
+* We want to have rather free (without all AST hassle) access to basic
+  info about classess, functions variables etc. So we can get all the
+  necessary informations even if the module has changed a bit.
+
+* We want this access for both SVN and file based sources.
+
+* We want to have html backend of those - which means at least syntax
+  highlightning with possibility of linking to those items.
+
+* Some crosslinking might be cool, variables are resolved syntactically,
+  so in 95% cases we can crossling to at least module.function, module.class
+  etc.
+
+* First: We don't want to have *ANY* type inference there. Two: If at
+  any point we want such thing, we make it through introspection, but better
+  not at all.
+
+Implementation notes:
+---------------------
+
+Let's use compiler package and if at any point there will be sth better,
+like pypy's compiler package we'll move. We create out of AST stuff which
+can be accessed by dot. Like module.function.firstlineno, with interface
+to py.code.Source as well.