zope.exceptions API documentation

zope.exceptions.interfaces

ITracebackSupplement interface definition.

When zope.exceptionformatter generates a traceback, it looks for local variables named __traceback_info__ or __traceback_supplement__. It includes the information provided by those local variables in the traceback.

__traceback_info__ is for arbitrary information. repr(__traceback_info__) gets dumped to the traceback.

__traceback_supplement__ is more structured. It should be a tuple. The first item of the tuple is a callable that produces an object that implements ITracebackSupplement, and the rest of the tuple contains arguments to pass to the factory. The traceback formatter makes an effort to clearly present the information provided by the ITracebackSupplement.

ITracebackSupplement

interface zope.exceptions.interfaces.ITracebackSupplement

Provides valuable information to supplement an exception traceback.

The interface is geared toward providing meaningful feedback when exceptions occur in user code written in mini-languages like Zope page templates and restricted Python scripts.

source_url

Optional. Set to URL of the script where the exception occurred.

Normally this generates a URL in the traceback that the user can visit to manage the object. Set to None if unknown or not available.

line

Optional. Set to the line number (>=1) where the exception occurred.

Set to 0 or None if the line number is unknown.

column

Optional. Set to the column offset (>=0) where the exception occurred.

Set to None if the column number is unknown.

expression

Optional. Set to the expression that was being evaluated.

Set to None if not available or not applicable.

warnings

Optional. Set to a sequence of warning messages.

Set to None if not available, not applicable, or if the exception itself provides enough information.

getInfo()

Optional. Returns a string containing any other useful info.

zope.exceptions.exceptionformatter

An exception formatter that shows traceback supplements and traceback info, optionally in HTML.

format_exception()

zope.exceptions.exceptionformatter.format_exception(t, v, tb, limit=None, as_html=False, with_filenames=False)

Format a stack trace and the exception information.

Similar to ‘traceback.format_exception’, but adds supplemental information to the traceback and accepts two options, ‘as_html’ and ‘with_filenames’.

print_exception()

zope.exceptions.exceptionformatter.print_exception(t, v, tb, limit=None, file=None, as_html=False, with_filenames=True)

Print exception up to ‘limit’ stack trace entries from ‘tb’ to ‘file’.

Similar to ‘traceback.print_exception’, but adds supplemental information to the traceback and accepts two options, ‘as_html’ and ‘with_filenames’.

extract_stack()

zope.exceptions.exceptionformatter.extract_stack(f=None, limit=None, as_html=False, with_filenames=True)

Format a stack trace and the exception information.

Similar to ‘traceback.extract_stack’, but adds supplemental information to the traceback and accepts two options, ‘as_html’ and ‘with_filenames’.