cgitb

More comprehensive traceback formatting for Python scripts.

To enable this module, do:

import cgitb; cgitb.enable()

at the top of your script. The optional arguments to enable() are:

display - if true, tracebacks are displayed in the web browser logdir - if set, tracebacks are written to files in this directory context - number of lines of source code to show for each stack frame format - ‘text’ or ‘html’ controls the output format

By default, tracebacks are displayed but not saved, the context is 5 lines and the output format is ‘html’ (for backwards compatibility with the original use of this module)

Alternatively, if you have caught an exception and want cgitb to display it for you, call cgitb.handler(). The optional argument to handler() is a 3-item tuple (etype, evalue, etb) just like the value of sys.exc_info(). The default handler displays output as HTML.

Functions

enable([display, logdir, context, format]) Install an exception handler that formats tracebacks as HTML.
grey(text)
html(einfo[, context]) Return a nice HTML document describing a given traceback.
lookup(name, frame, locals) Find the value for a given name in the given environment.
reset() Return a string that resets the CGI and browser to a known state.
scanvars(reader, frame, locals) Scan one logical line of Python and look up values of variables used.
small(text)
strong(text)
text(einfo[, context]) Return a plain text document describing a given traceback.

Classes

Hook([display, logdir, context, file, format]) A hook to replace sys.excepthook that shows tracebacks in HTML.