##// END OF EJS Templates
remove another py2 only test
remove another py2 only test

File last commit:

r22943:3e97b06a
r22962:c05c1799
Show More
ultratb.py
1491 lines | 59.2 KiB | text/x-python | PythonLexer
Ville M. Vainio
crlf -> lf
r1032 # -*- coding: utf-8 -*-
"""
Thomas Kluyver
Standardise some module docstring first lines
r13888 Verbose and colourful traceback formatting.
Ville M. Vainio
crlf -> lf
r1032
Thomas Kluyver
Miscellaneous docs fixes
r13597 **ColorTB**
Ville M. Vainio
crlf -> lf
r1032 I've always found it a bit hard to visually parse tracebacks in Python. The
ColorTB class is a solution to that problem. It colors the different parts of a
traceback in a manner similar to what you would expect from a syntax-highlighting
text editor.
Thomas Kluyver
Improvements to docs formatting.
r12553 Installation instructions for ColorTB::
Brian Granger
ultraTB.py => core/ultratb.py and imports updated.
r2048 import sys,ultratb
sys.excepthook = ultratb.ColorTB()
Ville M. Vainio
crlf -> lf
r1032
Thomas Kluyver
Miscellaneous docs fixes
r13597 **VerboseTB**
Ville M. Vainio
crlf -> lf
r1032 I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds
of useful info when a traceback occurs. Ping originally had it spit out HTML
and intended it for CGI programmers, but why should they have all the fun? I
altered it to spit out colored text to the terminal. It's a bit overwhelming,
but kind of neat, and maybe useful for long-running programs that you believe
are bug-free. If a crash *does* occur in that type of program you want details.
Give it a shot--you'll love it or you'll hate it.
Thomas Kluyver
Improvements to docs formatting.
r12553 .. note::
Ville M. Vainio
crlf -> lf
r1032
The Verbose mode prints the variables currently visible where the exception
happened (shortening their strings if too long). This can potentially be
very slow, if you happen to have a huge data structure whose string
representation is complex to compute. Your computer may appear to freeze for
a while with cpu usage at 100%. If this occurs, you can cancel the traceback
with Ctrl-C (maybe hitting it more than once).
If you encounter this kind of situation often, you may want to use the
Verbose_novars mode instead of the regular Verbose, which avoids formatting
variables (but otherwise includes the information and context given by
Verbose).
Bernardo B. Marques
remove all trailling spaces
r4872
Matthias Bussonnier
add docs and cleanup bad code style
r22096 .. note::
The verbose mode print all variables in the stack, which means it can
potentially leak sensitive information like access keys, or unencryted
password.
Ville M. Vainio
crlf -> lf
r1032
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 Installation instructions for VerboseTB::
Thomas Kluyver
Improvements to docs formatting.
r12553
Brian Granger
ultraTB.py => core/ultratb.py and imports updated.
r2048 import sys,ultratb
sys.excepthook = ultratb.VerboseTB()
Ville M. Vainio
crlf -> lf
r1032
Note: Much of the code in this module was lifted verbatim from the standard
library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'.
Thomas Kluyver
Improvements to docs formatting.
r12553 Color schemes
-------------
Ville M. Vainio
crlf -> lf
r1032 The colors are defined in the class TBTools through the use of the
ColorSchemeTable class. Currently the following exist:
- NoColor: allows all of this module to be used in any terminal (the color
Thomas Kluyver
Improvements to docs formatting.
r12553 escapes are just dummy blank strings).
Ville M. Vainio
crlf -> lf
r1032
- Linux: is meant to look good in a terminal like the Linux console (black
Thomas Kluyver
Improvements to docs formatting.
r12553 or very dark background).
Ville M. Vainio
crlf -> lf
r1032
- LightBG: similar to Linux but swaps dark/light colors to be more readable
Thomas Kluyver
Improvements to docs formatting.
r12553 in light background terminals.
Ville M. Vainio
crlf -> lf
r1032
Matthias Bussonnier
Make everyone happy with a neutral colortheme by default.
r22609 - Neutral: a neutral color scheme that should be readable on both light and
dark background
Ville M. Vainio
crlf -> lf
r1032 You can implement other color schemes easily, the syntax is fairly
self-explanatory. Please send back new schemes you develop to the author for
possible inclusion in future releases.
Thomas Kluyver
Only include inheritance diagram where it's useful.
r8795
Inheritance diagram:
.. inheritance-diagram:: IPython.core.ultratb
:parts: 3
Fernando Perez
Remove svn-style $Id marks from docstrings and Release imports....
r1853 """
Ville M. Vainio
crlf -> lf
r1032
Justyna Ilczuk
i1673 some DRY refactoring
r17158 #*****************************************************************************
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu>
Justyna Ilczuk
i1673 implementation of py3 proper error handling...
r17157 # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu>
Ville M. Vainio
crlf -> lf
r1032 #
Justyna Ilczuk
i1673 implementation of py3 proper error handling...
r17157 # Distributed under the terms of the BSD License. The full license is in
# the file COPYING, distributed as part of this software.
Ville M. Vainio
crlf -> lf
r1032 #*****************************************************************************
Matthias Bussonnier
Introduce some classes necessary fro Pygments refactor.
r22109 from __future__ import absolute_import
Jörgen Stenarson
Quick fix for #1688, traceback-unicode issue...
r8299 from __future__ import unicode_literals
Thomas Kluyver
Convert print statements to print function calls...
r13348 from __future__ import print_function
Brian Granger
sys.displayhook is now managed dynamically by display_trap.
r2231
Scott Sanderson
BUG: Fix getargvalues call with nested genexprs....
r21715 import dis
Ville M. Vainio
crlf -> lf
r1032 import inspect
import keyword
import linecache
import os
import pydoc
import re
import sys
import time
import tokenize
import traceback
import types
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 try: # Python 2
Thomas Kluyver
Fixes for UltraTB and PyColorize with Python 3
r4758 generate_tokens = tokenize.generate_tokens
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 except AttributeError: # Python 3
Thomas Kluyver
Fixes for UltraTB and PyColorize with Python 3
r4758 generate_tokens = tokenize.tokenize
Ville M. Vainio
crlf -> lf
r1032 # For purposes of monkeypatching inspect to fix a bug in it.
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 from inspect import getsourcefile, getfile, getmodule, \
ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode
Ville M. Vainio
crlf -> lf
r1032
# IPython's own modules
MinRK
don't use deprecated ipapi.get...
r10581 from IPython import get_ipython
from IPython.core import debugger
Brian Granger
sys.displayhook is now managed dynamically by display_trap.
r2231 from IPython.core.display_trap import DisplayTrap
Brian Granger
excolors.py => core/excolors.py and updated import statements.
r2021 from IPython.core.excolors import exception_colors
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 from IPython.utils import PyColorize
Thomas Kluyver
Consolidate utils.pyfile into utils.openpy
r9473 from IPython.utils import openpy
Jörgen Stenarson
Quick fix for #1688, traceback-unicode issue...
r8299 from IPython.utils import path as util_path
Thomas Kluyver
Fixes for UltraTB and PyColorize with Python 3
r4758 from IPython.utils import py3compat
Thomas Kluyver
Fixes for producing unicode tracebacks.
r8325 from IPython.utils import ulinecache
Brian Granger
Work to address the review comments on Fernando's branch....
r2498 from IPython.utils.data import uniq_stable
Vincent Woo
Use term width to determine header length
r22150 from IPython.utils.terminal import get_terminal_size
Pierre Gerold
Replace all import of IPython.utils.warn module
r22092 from logging import info, error
Ville M. Vainio
crlf -> lf
r1032
Matthias Bussonnier
Introduce some classes necessary fro Pygments refactor.
r22109 import IPython.utils.colorable as colorable
Ville M. Vainio
crlf -> lf
r1032 # Globals
# amount of space to put line numbers before verbose tracebacks
INDENT_SIZE = 8
# Default color scheme. This is used, for example, by the traceback
# formatter. When running in an actual IPython instance, the user's rc.colors
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 # value is used, but having a module global makes this functionality available
Brian Granger
ultraTB.py => core/ultratb.py and imports updated.
r2048 # to users of ultratb who are NOT running inside ipython.
Ville M. Vainio
crlf -> lf
r1032 DEFAULT_SCHEME = 'NoColor'
Justyna Ilczuk
i1673 some DRY refactoring
r17158 # ---------------------------------------------------------------------------
Ville M. Vainio
crlf -> lf
r1032 # Code begins
# Utility functions
def inspect_error():
"""Print a message about internal inspect errors.
These are unfortunately quite common."""
Bernardo B. Marques
remove all trailling spaces
r4872
Ville M. Vainio
crlf -> lf
r1032 error('Internal Python error in the inspect module.\n'
'Below is the traceback from this internal error.\n')
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156
Thomas Kluyver
Reapply our monkeypatch to inspect.findsource()....
r8100 # This function is a monkeypatch we apply to the Python inspect module. We have
# now found when it's needed (see discussion on issue gh-1456), and we have a
# test case (IPython.core.tests.test_ultratb.ChangedPyFileTest) that fails if
# the monkeypatch is not applied. TK, Aug 2012.
Ville M. Vainio
crlf -> lf
r1032 def findsource(object):
"""Return the entire source file and starting line number for an object.
The argument may be a module, class, method, function, traceback, frame,
or code object. The source code is returned as a list of all the lines
in the file and the line number indexes a line in that list. An IOError
is raised if the source code cannot be retrieved.
FIXED version with which we monkeypatch the stdlib to work around a bug."""
file = getsourcefile(object) or getfile(object)
# If the object is a frame, then trying to get the globals dict from its
# module won't work. Instead, the frame object itself has the globals
# dictionary.
globals_dict = None
if inspect.isframe(object):
# XXX: can this ever be false?
globals_dict = object.f_globals
else:
module = getmodule(object, file)
if module:
globals_dict = module.__dict__
lines = linecache.getlines(file, globals_dict)
if not lines:
raise IOError('could not get source code')
if ismodule(object):
return lines, 0
if isclass(object):
name = object.__name__
pat = re.compile(r'^(\s*)class\s*' + name + r'\b')
# make some effort to find the best matching class definition:
# use the one with the least indentation, which is the one
# that's most probably not inside a function definition.
candidates = []
for i in range(len(lines)):
match = pat.match(lines[i])
if match:
# if it's at toplevel, it's already the best one
if lines[i][0] == 'c':
return lines, i
# else add whitespace to candidate list
candidates.append((match.group(1), i))
if candidates:
# this will sort by whitespace, and by line number,
# less whitespace first
candidates.sort()
return lines, candidates[0][1]
else:
raise IOError('could not find class definition')
if ismethod(object):
Thomas Kluyver
Fix method special attributes...
r13370 object = object.__func__
Ville M. Vainio
crlf -> lf
r1032 if isfunction(object):
Thomas Kluyver
Update function attribute names...
r13362 object = object.__code__
Ville M. Vainio
crlf -> lf
r1032 if istraceback(object):
object = object.tb_frame
if isframe(object):
object = object.f_code
if iscode(object):
if not hasattr(object, 'co_firstlineno'):
raise IOError('could not find function definition')
pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)')
pmatch = pat.match
# fperez - fix: sometimes, co_firstlineno can give a number larger than
# the length of lines, which causes an error. Safeguard against that.
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 lnum = min(object.co_firstlineno, len(lines)) - 1
Ville M. Vainio
crlf -> lf
r1032 while lnum > 0:
Matthias Bussonnier
add docs and cleanup bad code style
r22096 if pmatch(lines[lnum]):
break
Ville M. Vainio
crlf -> lf
r1032 lnum -= 1
Bernardo B. Marques
remove all trailling spaces
r4872
Ville M. Vainio
crlf -> lf
r1032 return lines, lnum
raise IOError('could not find code object')
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156
Scott Sanderson
BUG: Fix getargvalues call with nested genexprs....
r21715 # This is a patched version of inspect.getargs that applies the (unmerged)
Scott Sanderson
DOC: Better attribution to bugfix author.
r21716 # patch for http://bugs.python.org/issue14611 by Stefano Taschini. This fixes
Scott Sanderson
BUG: Fix getargvalues call with nested genexprs....
r21715 # https://github.com/ipython/ipython/issues/8205 and
# https://github.com/ipython/ipython/issues/8293
def getargs(co):
"""Get information about the arguments accepted by a code object.
Three things are returned: (args, varargs, varkw), where 'args' is
a list of argument names (possibly containing nested lists), and
'varargs' and 'varkw' are the names of the * and ** arguments or None."""
if not iscode(co):
raise TypeError('{!r} is not a code object'.format(co))
nargs = co.co_argcount
names = co.co_varnames
args = list(names[:nargs])
step = 0
# The following acrobatics are for anonymous (tuple) arguments.
for i in range(nargs):
if args[i][:1] in ('', '.'):
stack, remain, count = [], [], []
while step < len(co.co_code):
op = ord(co.co_code[step])
step = step + 1
if op >= dis.HAVE_ARGUMENT:
opname = dis.opname[op]
value = ord(co.co_code[step]) + ord(co.co_code[step+1])*256
step = step + 2
if opname in ('UNPACK_TUPLE', 'UNPACK_SEQUENCE'):
remain.append(value)
count.append(value)
elif opname in ('STORE_FAST', 'STORE_DEREF'):
if op in dis.haslocal:
stack.append(co.co_varnames[value])
elif op in dis.hasfree:
stack.append((co.co_cellvars + co.co_freevars)[value])
# Special case for sublists of length 1: def foo((bar))
# doesn't generate the UNPACK_TUPLE bytecode, so if
# `remain` is empty here, we have such a sublist.
if not remain:
stack[0] = [stack[0]]
break
else:
remain[-1] = remain[-1] - 1
while remain[-1] == 0:
remain.pop()
size = count.pop()
stack[-size:] = [stack[-size:]]
Matthias Bussonnier
add docs and cleanup bad code style
r22096 if not remain:
break
Scott Sanderson
BUG: Fix getargvalues call with nested genexprs....
r21715 remain[-1] = remain[-1] - 1
Matthias Bussonnier
add docs and cleanup bad code style
r22096 if not remain:
break
Scott Sanderson
BUG: Fix getargvalues call with nested genexprs....
r21715 args[i] = stack[0]
varargs = None
if co.co_flags & inspect.CO_VARARGS:
varargs = co.co_varnames[nargs]
nargs = nargs + 1
varkw = None
if co.co_flags & inspect.CO_VARKEYWORDS:
varkw = co.co_varnames[nargs]
return inspect.Arguments(args, varargs, varkw)
MinRK
monkeypatch inspect.findsource in a context manager...
r16441 # Monkeypatch inspect to apply our bugfix.
def with_patch_inspect(f):
"""decorator for monkeypatching inspect.findsource"""
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156
MinRK
monkeypatch inspect.findsource in a context manager...
r16441 def wrapped(*args, **kwargs):
MinRK
get rid of redundant context manager
r16461 save_findsource = inspect.findsource
Scott Sanderson
BUG: Fix getargvalues call with nested genexprs....
r21715 save_getargs = inspect.getargs
MinRK
get rid of redundant context manager
r16461 inspect.findsource = findsource
Scott Sanderson
BUG: Fix getargvalues call with nested genexprs....
r21715 inspect.getargs = getargs
MinRK
get rid of redundant context manager
r16461 try:
MinRK
monkeypatch inspect.findsource in a context manager...
r16441 return f(*args, **kwargs)
MinRK
get rid of redundant context manager
r16461 finally:
inspect.findsource = save_findsource
Scott Sanderson
BUG: Fix getargvalues call with nested genexprs....
r21715 inspect.getargs = save_getargs
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156
MinRK
monkeypatch inspect.findsource in a context manager...
r16441 return wrapped
Ville M. Vainio
crlf -> lf
r1032
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156
Scott Sanderson
BUG: Fix getargvalues call with nested genexprs....
r21715 if py3compat.PY3:
fixed_getargvalues = inspect.getargvalues
else:
# Fixes for https://github.com/ipython/ipython/issues/8293
# and https://github.com/ipython/ipython/issues/8205.
# The relevant bug is caused by failure to correctly handle anonymous tuple
# unpacking, which only exists in Python 2.
fixed_getargvalues = with_patch_inspect(inspect.getargvalues)
Ville M. Vainio
crlf -> lf
r1032 def fix_frame_records_filenames(records):
"""Try to fix the filenames in each record from inspect.getinnerframes().
Particularly, modules loaded from within zip files have useless filenames
attached to their code object, and inspect.getinnerframes() just uses it.
"""
fixed_records = []
for frame, filename, line_no, func_name, lines, index in records:
Jeroen Demeyer
Keep Cython filenames in tracebacks
r19239 # Look inside the frame's globals dictionary for __file__,
# which should be better. However, keep Cython filenames since
# we prefer the source filenames over the compiled .so file.
Carlos Cordoba
Replace cast_unicode calls with cast_unicode_py2 ones...
r19866 filename = py3compat.cast_unicode_py2(filename, "utf-8")
Jeroen Demeyer
Keep Cython filenames in tracebacks
r19239 if not filename.endswith(('.pyx', '.pxd', '.pxi')):
better_fn = frame.f_globals.get('__file__', None)
if isinstance(better_fn, str):
# Check the type just in case someone did something weird with
# __file__. It might also be None if the error occurred during
# import.
filename = better_fn
Ville M. Vainio
crlf -> lf
r1032 fixed_records.append((frame, filename, line_no, func_name, lines, index))
return fixed_records
MinRK
monkeypatch inspect.findsource in a context manager...
r16441 @with_patch_inspect
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 def _fixed_getinnerframes(etb, context=1, tb_offset=0):
LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5
Ville M. Vainio
crlf -> lf
r1032
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 records = fix_frame_records_filenames(inspect.getinnerframes(etb, context))
Ville M. Vainio
crlf -> lf
r1032 # If the error is at the console, don't build any context, since it would
# otherwise produce 5 blank lines printed out (there is no file at the
# console)
rec_check = records[tb_offset:]
try:
rname = rec_check[0][1]
if rname == '<ipython console>' or rname.endswith('<string>'):
return rec_check
except IndexError:
pass
aux = traceback.extract_tb(etb)
assert len(records) == len(aux)
for i, (file, lnum, _, _) in zip(range(len(records)), aux):
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 maybeStart = lnum - 1 - context // 2
start = max(maybeStart, 0)
end = start + context
Thomas Kluyver
Fixes for producing unicode tracebacks.
r8325 lines = ulinecache.getlines(file)[start:end]
Ville M. Vainio
crlf -> lf
r1032 buf = list(records[i])
buf[LNUM_POS] = lnum
buf[INDEX_POS] = lnum - 1 - start
buf[LINES_POS] = lines
records[i] = tuple(buf)
return records[tb_offset:]
# Helper function -- largely belongs to VerboseTB, but we need the same
# functionality to produce a pseudo verbose TB for SyntaxErrors, so that they
# can be recognized properly by ipython.el's py-traceback-line-re
# (SyntaxErrors have to be treated specially because they have no traceback)
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156
Matthias Bussonnier
Pass parent to child for configuration to propagate
r22943 def _format_traceback_lines(lnum, index, lines, Colors, lvals=None, _line_format=(lambda x,_:x,None)):
Ville M. Vainio
crlf -> lf
r1032 numbers_width = INDENT_SIZE - 1
res = []
i = lnum - index
for line in lines:
Jörgen Stenarson
Quick fix for #1688, traceback-unicode issue...
r8299 line = py3compat.cast_unicode(line)
Bernardo B. Marques
remove all trailling spaces
r4872
Matthias Bussonnier
Start refactoring handling of color....
r22911 new_line, err = _line_format(line, 'str')
Ville M. Vainio
crlf -> lf
r1032 if not err: line = new_line
Bernardo B. Marques
remove all trailling spaces
r4872
Ville M. Vainio
crlf -> lf
r1032 if i == lnum:
# This is the line with the error
pad = numbers_width - len(str(i))
Matthias Bussonnier
Refactor simplify and share common function.
r22083 num = '%s%s' % (debugger.make_arrow(pad), str(lnum))
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 line = '%s%s%s %s%s' % (Colors.linenoEm, num,
Colors.line, line, Colors.Normal)
Ville M. Vainio
crlf -> lf
r1032 else:
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 num = '%*s' % (numbers_width, i)
line = '%s%s%s %s' % (Colors.lineno, num,
Colors.Normal, line)
Ville M. Vainio
crlf -> lf
r1032
res.append(line)
if lvals and i == lnum:
res.append(lvals + '\n')
i = i + 1
return res
Thomas Kluyver
Truncate tracebacks on recursion error...
r21983 def is_recursion_error(etype, value, records):
try:
# RecursionError is new in Python 3.5
recursion_error_type = RecursionError
except NameError:
recursion_error_type = RuntimeError
# The default recursion limit is 1000, but some of that will be taken up
# by stack frames in IPython itself. >500 frames probably indicates
# a recursion error.
return (etype is recursion_error_type) \
and "recursion" in str(value).lower() \
and len(records) > 500
def find_recursion(etype, value, records):
"""Identify the repeating stack frames from a RecursionError traceback
'records' is a list as returned by VerboseTB.get_records()
Returns (last_unique, repeat_length)
"""
# This involves a bit of guesswork - we want to show enough of the traceback
# to indicate where the recursion is occurring. We guess that the innermost
# quarter of the traceback (250 frames by default) is repeats, and find the
# first frame (from in to out) that looks different.
if not is_recursion_error(etype, value, records):
return len(records), 0
# Select filename, lineno, func_name to track frames with
records = [r[1:4] for r in records]
inner_frames = records[-(len(records)//4):]
frames_repeated = set(inner_frames)
last_seen_at = {}
longest_repeat = 0
i = len(records)
for frame in reversed(records):
i -= 1
if frame not in frames_repeated:
last_unique = i
break
if frame in last_seen_at:
distance = last_seen_at[frame] - i
longest_repeat = max(longest_repeat, distance)
last_seen_at[frame] = i
else:
last_unique = 0 # The whole traceback was recursion
return last_unique, longest_repeat
Ville M. Vainio
crlf -> lf
r1032
#---------------------------------------------------------------------------
# Module classes
Matthias Bussonnier
Introduce some classes necessary fro Pygments refactor.
r22109 class TBTools(colorable.Colorable):
Ville M. Vainio
crlf -> lf
r1032 """Basic tools used by all traceback printer classes."""
Fernando Perez
Fix exception color problems in win32....
r2459
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 # Number of frames to skip when reporting tracebacks
tb_offset = 0
Matthias Bussonnier
Introduce some classes necessary fro Pygments refactor.
r22109 def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None, parent=None, config=None):
Ville M. Vainio
crlf -> lf
r1032 # Whether to call the interactive pdb debugger after printing
# tracebacks or not
Matthias Bussonnier
Introduce some classes necessary fro Pygments refactor.
r22109 super(TBTools, self).__init__(parent=parent, config=config)
Ville M. Vainio
crlf -> lf
r1032 self.call_pdb = call_pdb
Fernando Perez
Simplified output stream management in ultratb....
r2852 # Output stream to write to. Note that we store the original value in
# a private attribute and then make the public ostream a property, so
Min RK
fix some deprecations...
r22742 # that we can delay accessing sys.stdout until runtime. The way
# things are written now, the sys.stdout object is dynamically managed
Fernando Perez
Simplified output stream management in ultratb....
r2852 # so a reference to it should NEVER be stored statically. This
# property approach confines this detail to a single location, and all
# subclasses can simply access self.ostream for writing.
self._ostream = ostream
Ville M. Vainio
crlf -> lf
r1032 # Create color table
Fernando Perez
Update exception colors API to PEP8, various small fixes in related files....
r1845 self.color_scheme_table = exception_colors()
Ville M. Vainio
crlf -> lf
r1032
self.set_colors(color_scheme)
self.old_scheme = color_scheme # save initial value for toggles
if call_pdb:
Min RK
fix some deprecations...
r22742 self.pdb = debugger.Pdb()
Ville M. Vainio
crlf -> lf
r1032 else:
self.pdb = None
Fernando Perez
Simplified output stream management in ultratb....
r2852 def _get_ostream(self):
"""Output stream that exceptions are written to.
Valid values are:
Bernardo B. Marques
remove all trailling spaces
r4872
Fernando Perez
Simplified output stream management in ultratb....
r2852 - None: the default, which means that IPython will dynamically resolve
Min RK
fix some deprecations...
r22742 to sys.stdout. This ensures compatibility with most tools, including
Thomas Kluyver
Improvements to docs formatting.
r12553 Windows (where plain stdout doesn't recognize ANSI escapes).
Fernando Perez
Simplified output stream management in ultratb....
r2852
- Any object with 'write' and 'flush' attributes.
"""
Thomas Kluyver
Deprecate io.{stdout,stderr} and shell.{write,write_err}...
r22192 return sys.stdout if self._ostream is None else self._ostream
Fernando Perez
Simplified output stream management in ultratb....
r2852
def _set_ostream(self, val):
assert val is None or (hasattr(val, 'write') and hasattr(val, 'flush'))
self._ostream = val
Bernardo B. Marques
remove all trailling spaces
r4872
Fernando Perez
Simplified output stream management in ultratb....
r2852 ostream = property(_get_ostream, _set_ostream)
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 def set_colors(self, *args, **kw):
Ville M. Vainio
crlf -> lf
r1032 """Shorthand access to the color table scheme selector method."""
# Set own color table
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 self.color_scheme_table.set_active_scheme(*args, **kw)
Ville M. Vainio
crlf -> lf
r1032 # for convenience, set Colors to the active scheme
self.Colors = self.color_scheme_table.active_colors
# Also set colors of debugger
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 if hasattr(self, 'pdb') and self.pdb is not None:
self.pdb.set_colors(*args, **kw)
Ville M. Vainio
crlf -> lf
r1032
def color_toggle(self):
"""Toggle between the currently active color scheme and NoColor."""
Bernardo B. Marques
remove all trailling spaces
r4872
Ville M. Vainio
crlf -> lf
r1032 if self.color_scheme_table.active_scheme_name == 'NoColor':
self.color_scheme_table.set_active_scheme(self.old_scheme)
self.Colors = self.color_scheme_table.active_colors
else:
self.old_scheme = self.color_scheme_table.active_scheme_name
self.color_scheme_table.set_active_scheme('NoColor')
self.Colors = self.color_scheme_table.active_colors
Fernando Perez
Multiple improvements to tab completion....
r2839 def stb2text(self, stb):
"""Convert a structured traceback (a list) to a string."""
return '\n'.join(stb)
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 def text(self, etype, value, tb, tb_offset=None, context=5):
"""Return formatted traceback.
Subclasses may override this if they add extra arguments.
"""
tb_list = self.structured_traceback(etype, value, tb,
tb_offset, context)
Fernando Perez
Multiple improvements to tab completion....
r2839 return self.stb2text(tb_list)
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838
def structured_traceback(self, etype, evalue, tb, tb_offset=None,
context=5, mode=None):
"""Return a list of traceback frames.
Must be implemented by each class.
"""
raise NotImplementedError()
Ville M. Vainio
crlf -> lf
r1032 #---------------------------------------------------------------------------
class ListTB(TBTools):
"""Print traceback information from a traceback list, with optional color.
Bernardo B. Marques
remove all trailling spaces
r4872
Thomas Kluyver
Miscellaneous docs fixes
r9244 Calling requires 3 arguments: (etype, evalue, elist)
as would be obtained by::
Ville M. Vainio
crlf -> lf
r1032 etype, evalue, tb = sys.exc_info()
if tb:
elist = traceback.extract_tb(tb)
else:
elist = None
It can thus be used by programs which need to process the traceback before
printing (such as console replacements based on the code module from the
standard library).
Because they are meant to be called without a full traceback (only a
list), instances of this class can't call the interactive pdb debugger."""
Matthias Bussonnier
Pass parent to child for configuration to propagate
r22943 def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None, parent=None, config=None):
Fernando Perez
Simplified output stream management in ultratb....
r2852 TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb,
Matthias Bussonnier
Pass parent to child for configuration to propagate
r22943 ostream=ostream, parent=parent,config=config)
Bernardo B. Marques
remove all trailling spaces
r4872
Ville M. Vainio
crlf -> lf
r1032 def __call__(self, etype, value, elist):
Fernando Perez
Clean up small leftover uses of raw streams in exception handling.
r2860 self.ostream.flush()
self.ostream.write(self.text(etype, value, elist))
self.ostream.write('\n')
Ville M. Vainio
crlf -> lf
r1032
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 def structured_traceback(self, etype, value, elist, tb_offset=None,
context=5):
Fernando Perez
Lots of work on exception handling, including tests for traceback printing....
r2440 """Return a color formatted string with the traceback info.
Parameters
----------
etype : exception type
Type of the exception raised.
value : object
Data stored in the exception
elist : list
List of frames, see class docstring for details.
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 tb_offset : int, optional
Number of frames in the traceback to skip. If not given, the
instance value is used (set in constructor).
Bernardo B. Marques
remove all trailling spaces
r4872
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 context : int, optional
Number of lines of context information to print.
Fernando Perez
Lots of work on exception handling, including tests for traceback printing....
r2440 Returns
-------
String with formatted exception.
"""
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 tb_offset = self.tb_offset if tb_offset is None else tb_offset
Ville M. Vainio
crlf -> lf
r1032 Colors = self.Colors
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 out_list = []
Ville M. Vainio
crlf -> lf
r1032 if elist:
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838
if tb_offset and len(elist) > tb_offset:
elist = elist[tb_offset:]
Bernardo B. Marques
remove all trailling spaces
r4872
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 out_list.append('Traceback %s(most recent call last)%s:' %
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 (Colors.normalEm, Colors.Normal) + '\n')
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 out_list.extend(self._format_list(elist))
# The exception info should be a single entry in the list.
lines = ''.join(self._format_exception_only(etype, value))
out_list.append(lines)
# Note: this code originally read:
Bernardo B. Marques
remove all trailling spaces
r4872
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 ## for line in lines[:-1]:
## out_list.append(" "+line)
## out_list.append(lines[-1])
# This means it was indenting everything but the last line by a little
Justyna Ilczuk
i1673 implementation of py3 proper error handling...
r17157 # bit. I've disabled this for now, but if we see ugliness somewhere we
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 # can restore it.
Bernardo B. Marques
remove all trailling spaces
r4872
Fernando Perez
Improvements to exception handling to transport structured tracebacks....
r2838 return out_list
Ville M. Vainio
crlf -> lf
r1032
def _format_list(self, extracted_list):
"""Format a list of traceback entry tuples for printing.
Given a list of tuples as returned by extract_tb() or
extract_stack(), return a list of strings ready for printing.
Each string in the resulting list corresponds to the item with the
same index in the argument list. Each string ends in a newline;
the strings may contain internal newlines as well, for those items
whose source text line is not None.
Bernardo B. Marques
remove all trailling spaces
r4872
Ville M. Vainio
crlf -> lf
r1032 Lifted almost verbatim from traceback.py
"""
Colors = self.Colors
list = []
for filename, lineno, name, line in extracted_list[:-1]:
item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \
Carlos Cordoba
Replace cast_unicode calls with cast_unicode_py2 ones...
r19866 (Colors.filename, py3compat.cast_unicode_py2(filename, "utf-8"), Colors.Normal,
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 Colors.lineno, lineno, Colors.Normal,
Carlos Cordoba
Replace cast_unicode calls with cast_unicode_py2 ones...
r19866 Colors.name, py3compat.cast_unicode_py2(name, "utf-8"), Colors.Normal)
Ville M. Vainio
crlf -> lf
r1032 if line:
Thomas Kluyver
Use inplace addition in ultratb.
r5831 item += ' %s\n' % line.strip()
Ville M. Vainio
crlf -> lf
r1032 list.append(item)
# Emphasize the last entry
filename, lineno, name, line = extracted_list[-1]
item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 (Colors.normalEm,
Carlos Cordoba
Replace cast_unicode calls with cast_unicode_py2 ones...
r19866 Colors.filenameEm, py3compat.cast_unicode_py2(filename, "utf-8"), Colors.normalEm,
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 Colors.linenoEm, lineno, Colors.normalEm,
Carlos Cordoba
Replace cast_unicode calls with cast_unicode_py2 ones...
r19866 Colors.nameEm, py3compat.cast_unicode_py2(name, "utf-8"), Colors.normalEm,
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 Colors.Normal)
Ville M. Vainio
crlf -> lf
r1032 if line:
Thomas Kluyver
Use inplace addition in ultratb.
r5831 item += '%s %s%s\n' % (Colors.line, line.strip(),
Justyna Ilczuk
i1673 PEP8 formatting in `ultratab.py`
r17156 Colors.Normal)
Ville M. Vainio
crlf -> lf
r1032 list.append(item)
return list
Bernardo B. Marques
remove all trailling spaces
r4872
Ville M. Vainio
crlf -> lf
r1032 def _format_exception_only(self, etype, value):
"""Format the exception part of a traceback.