Skip to content

[3.6] bpo-29920: Document cgitb.text() and cgitb.html() functions (GH-849) #1527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
berkerpeksag wants to merge 1 commit into from
Closed

[3.6] bpo-29920: Document cgitb.text() and cgitb.html() functions (GH-849) #1527

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions Doc/library/cgitb.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,24 @@ analysis.
value forces plain text output. The default value is ``"html"``.


.. function:: text(info, context=5)

This function handles the exception described by *info* (a 3-tuple containing
the result of :func:`sys.exc_info`), formatting its traceback as text and
returning the result as a string. The optional argument *context* is the
number of lines of context to display around the current line of source code
in the traceback; this defaults to ``5``.


.. function:: html(info, context=5)

This function handles the exception described by *info* (a 3-tuple containing
the result of :func:`sys.exc_info`), formatting its traceback as HTML and
returning the result as a string. The optional argument *context* is the
number of lines of context to display around the current line of source code
in the traceback; this defaults to ``5``.


.. function:: handler(info=None)

This function handles an exception using the default settings (that is, show a
Expand Down