Summary of MiscUtils.pydoc

You can also browse the complete source file or the generated documentation.

def pathdirs()
def getdoc(object)
def splitdoc(doc)
def classname(object, modname)
def isdata(object)
def replace(text, *pairs)
def cram(text, maxlen)
def stripid(text)
def allmethods(cl)
def ispackage(path)
def synopsis(filename, cache={})


class ErrorDuringImport(Exception):
    def __init__(self, filename, (exc, value, tb)
    def __str__(self)
def importfile(path)
def safeimport(path, forceload=0, cache={})


class Doc:
    def document(self, object, name=None, *args)
    def fail(self, object, name=None, *args)


class HTMLRepr(Repr):
    def __init__(self)
    def escape(self, text)
    def repr(self, object)
    def repr1(self, x, level)
    def repr_string(self, x, level)
    def repr_instance(self, x, level)


class HTMLDoc(Doc):
    def page(self, title, contents)
    def heading(self, title, fgcol, bgcol, extras='')
    def section(self, title, fgcol, bgcol, contents, width=10,
    def bigsection(self, title, *args)
    def preformat(self, text)
    def multicolumn(self, list, format, cols=4)
    def small(self, text)
    def grey(self, text)
    def namelink(self, name, *dicts)
    def classlink(self, object, modname)
    def modulelink(self, object)
    def modpkglink(self, (name, path, ispackage, shadowed)
    def markup(self, text, escape=None, funcs={}, classes={}, methods={})
    def formattree(self, tree, modname, parent=None)
    def docmodule(self, object, name=None, mod=None)
    def docclass(self, object, name=None, mod=None, funcs={}, classes={})
    def formatvalue(self, object)
    def docroutine(self, object, name=None, mod=None,
    def docother(self, object, name=None, mod=None)
    def index(self, dir, shadowed=None)
        def found(name, ispackage,


class TextRepr(Repr):
    def __init__(self)
    def repr1(self, x, level)
    def repr_string(self, x, level)
    def repr_instance(self, x, level)


class TextDoc(Doc):
    def bold(self, text)
    def indent(self, text, prefix='    ')
    def section(self, title, contents)
    def formattree(self, tree, modname, parent=None, prefix='')
    def docmodule(self, object, name=None, mod=None)
    def docclass(self, object, name=None, mod=None)
            def makename(c, m=object.__module__)
    def formatvalue(self, object)
    def docroutine(self, object, name=None, mod=None, cl=None)
    def docother(self, object, name=None, mod=None, maxlen=None)
def pager(text)
def getpager()
def plain(text)
def pipepager(text, cmd)
def tempfilepager(text, cmd)
def ttypager(text)
def plainpager(text)
def describe(thing)
def locate(path, forceload=0)
def doc(thing, title='Python Library Documentation: %s', forceload=0)
def writedoc(key, forceload=0)
def writedocs(dir, pkgpath='', done=None)


class Helper:
    def __init__(self, input, output)
    def __repr__(self)
    def __call__(self, request=None)
    def interact(self)
    def help(self, request)
    def intro(self)
    def list(self, items, columns=4, width=80)
    def listkeywords(self)
    def listtopics(self)
    def showtopic(self, topic)
    def listmodules(self, key='')
            def callback(path, modname, desc, modules=modules)


class Scanner:
    def __init__(self, roots, children, descendp)
    def next(self)


class ModuleScanner(Scanner):
    def __init__(self)
    def submodules(self, (dir, package)
    def isnewpackage(self, (dir, package)
    def run(self, callback, key=None, completer=None)
def apropos(key)
def serve(port, callback=None, completer=None)

    class Message(mimetools.Message):
        def __init__(self, fp, seekable=1)

    class DocHandler(BaseHTTPServer.BaseHTTPRequestHandler):
        def send_document(self, title, contents)
        def do_GET(self)
        def log_message(self, *args)

    class DocServer(BaseHTTPServer.HTTPServer):
        def __init__(self, port, callback)
        def serve_until_quit(self)
        def server_activate(self)
def gui()

    class GUI:
        def __init__(self, window, port=7464)
        def ready(self, server)
        def open(self, event=None, url=None)
        def quit(self, event=None)
        def search(self, event=None)
        def update(self, path, modname, desc)
        def stop(self, event=None)
        def done(self)
        def select(self, event=None)
        def goto(self, event=None)
        def collapse(self)
        def expand(self)
        def hide(self, event=None)
def ispath(x)
def cli()
                def ready(server)