diff options
| author | Darrell Anderson <humanreadable@yahoo.com> | 2014-03-02 20:05:33 +0100 |
|---|---|---|
| committer | Slávek Banko <slavek.banko@axis.cz> | 2014-03-02 20:05:33 +0100 |
| commit | 722ce1efbac31c61b1d4b13f7e075c9f311e3e73 (patch) | |
| tree | db1b6b28566e5fe9accb4a688f7257673cecb080 /languages/python/tde_pydoc.py | |
| parent | afb74575caf7dd8ccb6c235b1c8d788e320c19da (diff) | |
| download | tdevelop-722ce1efbac31c61b1d4b13f7e075c9f311e3e73.tar.gz tdevelop-722ce1efbac31c61b1d4b13f7e075c9f311e3e73.zip | |
Finish renaming tdevelop components
Diffstat (limited to 'languages/python/tde_pydoc.py')
| -rw-r--r-- | languages/python/tde_pydoc.py | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/languages/python/tde_pydoc.py b/languages/python/tde_pydoc.py new file mode 100644 index 00000000..0516f172 --- /dev/null +++ b/languages/python/tde_pydoc.py @@ -0,0 +1,131 @@ +#!/usr/bin/env python +""" +""" + +__author__ = "David Nolden<david.kde@art-master.de>, Ka-Ping Yee <ping@lfw.org>" +__version__ = "6 April 2006" + +import sys, imp, os, stat, re, types, cgi +from repr import Repr +from string import expandtabs, find, join, lower, split, strip, rstrip +import pydoc + + + + +def cleanlinks(string): + """Changes the links to work with the pydoc:-notation""" + finalstring = "" + string = str(string).replace(".html","") + pos = 0 + mark = "<a href=\"" + l = len(mark) + while(pos != -1): + opos = pos + pos = string.find(mark, pos) + if(pos == -1): + finalstring += string[opos:] + break + finalstring += string[opos:pos+l] + pos+=l + if(string[pos] == '#' or string.find(":/",pos, pos+10) != -1): #leave local jumps or external references untouched + continue + finalstring += "pydoc:" + if(string[pos] == "." and string[pos+1] == "\""): + pos += 1 + finalstring += "modules" + + return finalstring + + +#This maximum depth was introduced because the program needs a very long time to +#complete the task in big file-system-trees(like my home), and can be invoked by a simple pydoc:. +#and cannot be stopped through the browser(just by killing python) +__maxdepth = 4 + +def writedocs(path, pkgpath='', depth=0, notprocessed=[]): + if(path == "/."): + writedoc(path) + return + depth+=1 + + if os.path.isdir(path): + if(depth > __maxdepth): + notprocessed.append(path) + return + dir = path + for file in os.listdir(dir): + path = os.path.join(dir, file) + if os.path.isdir(path): + writedocs(path, file + '.' + pkgpath, depth) + if os.path.isfile(path): + writedocs(path, pkgpath, depth) + if os.path.isfile(path): + modname = pydoc.inspect.getmodulename(path) + if modname: + writedoc(pkgpath + modname) + + if(depth == 1): + if(len(notprocessed) != 0): + print "<br> the following paths were not processed because they are deeper than the maximum depth of " + str(__maxdepth) + ":<br>" + for x in notprocessed: + print cgi.escape(x) + " <br>" + +def writedoc(key,top=False): + """Write HTML documentation to a file in the current directory.""" + if(type(key) == str and (key == "modules" or key == "/.")): + heading = pydoc.html.heading( + '<br><big><big><strong> ' + 'Python: Index of Modules' + '</strong></big></big>', + '#ffffff', '#7799ee') + builtins = [] + for name in sys.builtin_module_names: + builtins.append('<a href="%s">%s</a>' % (cgi.escape(name,quote=True), cgi.escape(name))) + indices = ['<p>Built-in modules: ' + cgi.escape(join(builtins, ', '))] + seen = {} + for dir in pydoc.pathdirs(): + indices.append(pydoc.html.index(dir, seen)) + print cleanlinks(heading + join(indices)) + return + + if(type(key) != types.ModuleType): + object = pydoc.locate(key) + if(object == None and top): + print "could not locate module/object for key " + \ + cgi.escape(key) + "<br><a href=\"pydoc:modules\">go to index</a>"; + else: + object = key + + if object: + print cleanlinks(pydoc.html.page(pydoc.describe(object), pydoc.html.document(object))) + + + +if __name__ == '__main__': + import getopt + class BadUsage: pass + + try: + opts, args = getopt.getopt(sys.argv[1:], 'k:p:w') + + print "<html>" + print "<head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">" + print "</head><body>" + + if args: + for arg in args: + try: + if os.path.isdir(arg): writedocs(arg) + + if os.path.isfile(arg): + arg = pydoc.importfile(arg) + writedoc(arg, True) + except pydoc.ErrorDuringImport, value: + print 'problem in %s - %s' % ( + cgi.escape(value.filename), cgi.escape(value.exc)) + else: + raise BadUsage + + except (getopt.error, BadUsage): + print "need parameters\n" |