Skip to content

Split exception formatting into two phases #47

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Split exception formatting into two phases #47

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
145 changes: 74 additions & 71 deletions stackprinter/formatting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,89 +109,93 @@ def format_stack_from_frame(fr, add_summary=False, **kwargs):
return format_stack(stack, **kwargs)


def format_exc_info(etype, evalue, tb, style='plaintext', add_summary='auto',
reverse=False, suppressed_exceptions=[KeyboardInterrupt],
**kwargs):
"""
Format an exception traceback, including the exception message
def format_parts(etype, evalue, tb, style='plaintext', add_summary='auto',
reverse=False, suppressed_exceptions=[KeyboardInterrupt],
**kwargs):
""" Render this exception's traceback as a list of strings """

see stackprinter.format() for docs about the keyword arguments
"""
parts = []
if etype is None:
etype = type(None)

msg = ''
try:
# First, recursively format any chained exceptions (exceptions
# during whose handling the given one happened).
# TODO: refactor this whole messy function to return a
# more... structured datastructure before assembling a string,
# so that e.g. a summary of the whole chain can be shown at
# the end.
context = getattr(evalue, '__context__', None)
cause = getattr(evalue, '__cause__', None)
suppress_context = getattr(evalue, '__suppress_context__', False)
if cause:
chained_exc = cause
chain_hint = ("\n\nThe above exception was the direct cause "
"of the following exception:\n\n")
elif context and not suppress_context:
chained_exc = context
chain_hint = ("\n\nWhile handling the above exception, "
"another exception occurred:\n\n")
# First, recursively format any chained exceptions (exceptions
# during whose handling the given one happened).
# TODO: refactor this whole messy function to return a
# more... structured datastructure before assembling a string,
# so that e.g. a summary of the whole chain can be shown at
# the end.
context = getattr(evalue, '__context__', None)
cause = getattr(evalue, '__cause__', None)
suppress_context = getattr(evalue, '__suppress_context__', False)
if cause:
chained_exc = cause
chain_hint = ("\n\nThe above exception was the direct cause "
"of the following exception:\n\n")
elif context and not suppress_context:
chained_exc = context
chain_hint = ("\n\nWhile handling the above exception, "
"another exception occurred:\n\n")
else:
chained_exc = None

if chained_exc:
parts.extend(format_parts(chained_exc.__class__,
chained_exc,
chained_exc.__traceback__,
style=style,
add_summary=add_summary,
reverse=reverse,
**kwargs))
if style == 'plaintext':
parts.append(chain_hint)
else:
chained_exc = None

if chained_exc:
msg += format_exc_info(chained_exc.__class__,
chained_exc,
chained_exc.__traceback__,
style=style,
add_summary=add_summary,
reverse=reverse,
**kwargs)

if style == 'plaintext':
msg += chain_hint
else:
sc = getattr(colorschemes, style)
clr = get_ansi_tpl(*sc.colors['exception_type'])
msg += clr % chain_hint

# Now, actually do some formatting:
parts = []
if tb:
frameinfos = [ex.get_info(tb_) for tb_ in _walk_traceback(tb)]
if (suppressed_exceptions and
issubclass(etype, tuple(suppressed_exceptions))):
sc = getattr(colorschemes, style)
clr = get_ansi_tpl(*sc.colors['exception_type'])
parts.append(clr % chain_hint)

# Now, actually do some formatting:
if tb:
frameinfos = [ex.get_info(tb_) for tb_ in _walk_traceback(tb)]
if (suppressed_exceptions and
issubclass(etype, tuple(suppressed_exceptions))):
summary = format_summary(frameinfos, style=style,
reverse=reverse, **kwargs)
parts = [summary]
else:
whole_stack = format_stack(frameinfos, style=style,
reverse=reverse, **kwargs)
parts.append(whole_stack)

if add_summary == 'auto':
add_summary = whole_stack.count('\n') > 50

if add_summary:
summary = format_summary(frameinfos, style=style,
reverse=reverse, **kwargs)
parts = [summary]
else:
whole_stack = format_stack(frameinfos, style=style,
reverse=reverse, **kwargs)
parts.append(whole_stack)
summary += '\n'
parts.append('---- (full traceback below) ----\n\n' if reverse else
'---- (full traceback above) ----\n')
parts.append(summary)

if add_summary == 'auto':
add_summary = whole_stack.count('\n') > 50
exc = format_exception_message(etype, evalue, style=style)
parts.append('\n\n' if reverse else '')
parts.append(exc)

if add_summary:
summary = format_summary(frameinfos, style=style,
reverse=reverse, **kwargs)
summary += '\n'
parts.append('---- (full traceback below) ----\n\n' if reverse else
'---- (full traceback above) ----\n')
parts.append(summary)
if reverse:
parts = reversed(parts)

exc = format_exception_message(etype, evalue, style=style)
parts.append('\n\n' if reverse else '')
parts.append(exc)
return parts

if reverse:
parts = reversed(parts)

msg += ''.join(parts)
def format_exc_info(etype, evalue, tb, **kwargs):
"""
Format an exception traceback, including the exception message

see stackprinter.format() for docs about the keyword arguments
"""
try:
parts = format_parts(etype, evalue, tb, **kwargs)
msg = ''.join(parts)
except Exception as exc:
import os
if 'PY_STACKPRINTER_DEBUG' in os.environ:
Expand All @@ -207,7 +211,6 @@ def format_exc_info(etype, evalue, tb, style='plaintext', add_summary='auto',
msg += 'So here is your original traceback at least:\n\n'
msg += ''.join(traceback.format_exception(etype, evalue, tb))


return msg


Expand Down