💾 Archived View for tris.fyi › pydoc › cgitb captured on 2023-04-26 at 13:27:30. Gemini links have been rewritten to link to archived content

-=-=-=-=-=-=-

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.

Classes

Hook

A hook to replace sys.excepthook that shows tracebacks in HTML.

handle(self, info=None)

Functions

enable

enable(display=1, logdir=None, context=5, format='html')

  Install an exception handler that formats tracebacks as HTML.

      The optional argument 'display' can be set to 0 to suppress sending the
      traceback to the browser, and 'logdir' can be set to a directory to cause
      tracebacks to be written to files there.

grey

grey(text)

handler

handle(info=None)

html

html(einfo, context=5)

  Return a nice HTML document describing a given traceback.

lookup

lookup(name, frame, locals)

  Find the value for a given name in the given environment.

reset

reset()

  Return a string that resets the CGI and browser to a known state.

scanvars

scanvars(reader, frame, locals)

  Scan one logical line of Python and look up values of variables used.

small

small(text)

strong

strong(text)

text

text(einfo, context=5)

  Return a plain text document describing a given traceback.

Modules