pydoc (version 1.15, 26 February 2001)
index
pydoc.py
 

Generate Python documentation in HTML or text for interactive use.
 
In the Python interpreter, do "from pydoc import help" to provide online
help.  Calling help(thing) on a Python object documents the object.
 
At the shell command line outside of Python:
    Run "pydoc <name>" to show documentation on something.  <name> may be
    the name of a function, module, package, or a dotted reference to a
    class or function within a module or module in a package.  If the
    argument contains a path segment delimiter (e.g. slash on Unix,
    backslash on Windows) it is treated as the path to a Python source file.
 
    Run "pydoc -k <keyword>" to search for a keyword in the synopsis lines
    of all available modules.
 
    Run "pydoc -p <port>" to start an HTTP server on a given port on the
    local machine to generate documentation web pages.
 
    For platforms without a command line, "pydoc -g" starts the HTTP server
    and also pops up a little window for controlling it.
 
    Run "pydoc -w <name>" to write out the HTML documentation for a module
    to a file named "<name>.html".

   
Modules
                        
imp
inspect
os
re
stat
sys
types

   
Classes
                        
Doc
HTMLDoc
TextDoc
exceptions.Exception
DocImportError
Helper
repr.Repr
HTMLRepr
TextRepr
Scanner
ModuleScanner

   
class Doc
              
document(self, object, *args)
Generate documentation for an object.

   
class DocImportError(exceptions.Exception)
            Class for errors while trying to import something to document it.
              
__init__(self, filename, etype, evalue)

   
class HTMLDoc(Doc)
            Formatter class for HTML documentation.
              
bigsection(self, title, *args)
Format a section with a big heading.
classlink(self, object, modname, *dicts)
Make a link for a class.
docclass(self, object, funcs={}, classes={})
Produce HTML documentation for a class object.
docmodule(self, object)
Produce HTML documentation for a module object.
docroutine(self, object, funcs={}, classes={}, methods={}, clname='')
Produce HTML documentation for a function or method object.
doctree(self, tree, modname, classes={}, parent=None)
Produce HTML for a class tree as given by inspect.getclasstree().
escape(self, text)
formatvalue(self, object)
Format an argument default value as text.
heading(self, title, fgcol, bgcol, extras='')
Format a page heading.
index(self, dir, shadowed=None)
Generate an HTML index for a directory of modules.
markup(self, text, escape=None, funcs={}, classes={}, methods={})
Mark up some plain text, given a context of symbols to look for.
Each context dictionary maps object names to anchor names.
modpkglink(self, (name, path, ispackage, shadowed))
Make a link for a module or package to display in an index.
modulelink(self, object)
Make a link for a module.
multicolumn(self, list, format, cols=4)
Format a list of items into a multi-column list.
namelink(self, name, *dicts)
Make a link for an identifier, given name-to-URL mappings.
page(self, object)
Produce a complete HTML page of documentation for an object.
preformat(self, text)
Format literal preformatted text.
repr(self, object)
section(self, title, fgcol, bgcol, contents, width=20, prelude='', marginalia=None, gap='&nbsp;&nbsp;&nbsp;')
Format a section with a heading.

   
class HTMLRepr(repr.Repr)
            Class for safely making an HTML representation of a Python object.
              
__init__(self)
escape(self, text)
repr(self, object)
repr1(self, x, level)
repr_instance(self, x, level)
repr_string(self, x, level)
repr_string(self, x, level)

   
class Helper
              
__call__(self, *args)
__repr__(self)

   
class ModuleScanner(Scanner)
            An interruptible scanner that searches module synopses.
              
__init__(self)
ispackage(self, (dir, package))
run(self, key, callback, completer=None)
submodules(self, (dir, package))

   
class Scanner
            A generic tree iterator.
              
__init__(self, roots, children, recurse)
next(self)

   
class TextDoc(Doc)
            Formatter class for text documentation.
              
bold(self, text)
Format a string in bold by overstriking.
docclass(self, object)
Produce text documentation for a given class object.
docmodule(self, object)
Produce text documentation for a given module object.
docroutine(self, object)
Produce text documentation for a function or method object.
doctree(self, tree, modname, parent=None, prefix='')
Render in text a class tree as returned by inspect.getclasstree().
formatvalue(self, object)
Format an argument default value as text.
indent(self, text, prefix=' ')
Indent text by prepending a given prefix to each line.
repr(self, x)
section(self, title, contents)
Format a section with a given heading.

   
class TextRepr(repr.Repr)
            Class for safely making a text representation of a Python object.
              
__init__(self)
repr1(self, x, level)
repr_instance(self, x, level)
repr_string(self, x, level)

   
Functions
                        
apropos(key)
Print all the one-line module summaries that contain a substring.
classname(object, modname)
Get a class name and qualify it with a module name if necessary.
cli()
Command-line interface (looks at sys.argv to decide what to do).
cram(text, maxlen)
Omit part of a string if needed to make it fit in a maximum length.
describe(thing)
Produce a short description of the given kind of thing.
doc(thing)
Display documentation on an object (for interactive use).
getdoc(object)
Get the doc string or comments for an object.
getpager()
Decide what method to use for paging through text.
gui()
Graphical interface (starts web server and pops up a control window).
importfile(path)
Import a Python source file or compiled file given its path.
isconstant(object)
Check if an object is of a type that probably means it's a constant.
ispackage(path)
Guess whether a path refers to a package directory.
locate(path)
Locate an object by name (or dotted path), importing as necessary.
man(key)
Display documentation on an object in a form similar to man(1).
modulename(path)
Return the Python module name for a given path, or None.
pager(text)
The first time this is called, determine what kind of pager to use.
pathdirs()
Convert sys.path into a list of absolute, existing, unique paths.
pipepager(text, cmd)
Page through text by feeding it to another program.
plain(text)
Remove boldface formatting from text.
plainpager(text)
Simply print unformatted text.  This is the ultimate fallback.
replace(text, *pairs)
Do a series of global replacements on a string.
serve(port, callback=None)
stripid(text)
Remove the hexadecimal id from a Python object representation.
synopsis(filename, cache={})
Get the one-line summary out of a module file.
tempfilepager(text, cmd)
Page through text by invoking a program on a temporary file.
ttypager(text)
Page through text on a text terminal.
writedoc(key)
Write HTML documentation to a file in the current directory.

   
Author
                         Ka-Ping Yee <ping@lfw.org>

   
Credits
                         Guido van Rossum, for an excellent programming language.
Tommy Burnette, the original creator of manpy.
Paul Prescod, for all his work on onlinehelp.
Richard Chamberlain, for the first implementation of textdoc.
 
Mynd you, mse bites Kan be pretty nasti...