##// END OF EJS Templates
Tweak elision message
Thomas Kluyver -
Show More
@@ -1,1479 +1,1479 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """
2 """
3 Verbose and colourful traceback formatting.
3 Verbose and colourful traceback formatting.
4
4
5 **ColorTB**
5 **ColorTB**
6
6
7 I've always found it a bit hard to visually parse tracebacks in Python. The
7 I've always found it a bit hard to visually parse tracebacks in Python. The
8 ColorTB class is a solution to that problem. It colors the different parts of a
8 ColorTB class is a solution to that problem. It colors the different parts of a
9 traceback in a manner similar to what you would expect from a syntax-highlighting
9 traceback in a manner similar to what you would expect from a syntax-highlighting
10 text editor.
10 text editor.
11
11
12 Installation instructions for ColorTB::
12 Installation instructions for ColorTB::
13
13
14 import sys,ultratb
14 import sys,ultratb
15 sys.excepthook = ultratb.ColorTB()
15 sys.excepthook = ultratb.ColorTB()
16
16
17 **VerboseTB**
17 **VerboseTB**
18
18
19 I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds
19 I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds
20 of useful info when a traceback occurs. Ping originally had it spit out HTML
20 of useful info when a traceback occurs. Ping originally had it spit out HTML
21 and intended it for CGI programmers, but why should they have all the fun? I
21 and intended it for CGI programmers, but why should they have all the fun? I
22 altered it to spit out colored text to the terminal. It's a bit overwhelming,
22 altered it to spit out colored text to the terminal. It's a bit overwhelming,
23 but kind of neat, and maybe useful for long-running programs that you believe
23 but kind of neat, and maybe useful for long-running programs that you believe
24 are bug-free. If a crash *does* occur in that type of program you want details.
24 are bug-free. If a crash *does* occur in that type of program you want details.
25 Give it a shot--you'll love it or you'll hate it.
25 Give it a shot--you'll love it or you'll hate it.
26
26
27 .. note::
27 .. note::
28
28
29 The Verbose mode prints the variables currently visible where the exception
29 The Verbose mode prints the variables currently visible where the exception
30 happened (shortening their strings if too long). This can potentially be
30 happened (shortening their strings if too long). This can potentially be
31 very slow, if you happen to have a huge data structure whose string
31 very slow, if you happen to have a huge data structure whose string
32 representation is complex to compute. Your computer may appear to freeze for
32 representation is complex to compute. Your computer may appear to freeze for
33 a while with cpu usage at 100%. If this occurs, you can cancel the traceback
33 a while with cpu usage at 100%. If this occurs, you can cancel the traceback
34 with Ctrl-C (maybe hitting it more than once).
34 with Ctrl-C (maybe hitting it more than once).
35
35
36 If you encounter this kind of situation often, you may want to use the
36 If you encounter this kind of situation often, you may want to use the
37 Verbose_novars mode instead of the regular Verbose, which avoids formatting
37 Verbose_novars mode instead of the regular Verbose, which avoids formatting
38 variables (but otherwise includes the information and context given by
38 variables (but otherwise includes the information and context given by
39 Verbose).
39 Verbose).
40
40
41
41
42 Installation instructions for VerboseTB::
42 Installation instructions for VerboseTB::
43
43
44 import sys,ultratb
44 import sys,ultratb
45 sys.excepthook = ultratb.VerboseTB()
45 sys.excepthook = ultratb.VerboseTB()
46
46
47 Note: Much of the code in this module was lifted verbatim from the standard
47 Note: Much of the code in this module was lifted verbatim from the standard
48 library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'.
48 library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'.
49
49
50 Color schemes
50 Color schemes
51 -------------
51 -------------
52
52
53 The colors are defined in the class TBTools through the use of the
53 The colors are defined in the class TBTools through the use of the
54 ColorSchemeTable class. Currently the following exist:
54 ColorSchemeTable class. Currently the following exist:
55
55
56 - NoColor: allows all of this module to be used in any terminal (the color
56 - NoColor: allows all of this module to be used in any terminal (the color
57 escapes are just dummy blank strings).
57 escapes are just dummy blank strings).
58
58
59 - Linux: is meant to look good in a terminal like the Linux console (black
59 - Linux: is meant to look good in a terminal like the Linux console (black
60 or very dark background).
60 or very dark background).
61
61
62 - LightBG: similar to Linux but swaps dark/light colors to be more readable
62 - LightBG: similar to Linux but swaps dark/light colors to be more readable
63 in light background terminals.
63 in light background terminals.
64
64
65 You can implement other color schemes easily, the syntax is fairly
65 You can implement other color schemes easily, the syntax is fairly
66 self-explanatory. Please send back new schemes you develop to the author for
66 self-explanatory. Please send back new schemes you develop to the author for
67 possible inclusion in future releases.
67 possible inclusion in future releases.
68
68
69 Inheritance diagram:
69 Inheritance diagram:
70
70
71 .. inheritance-diagram:: IPython.core.ultratb
71 .. inheritance-diagram:: IPython.core.ultratb
72 :parts: 3
72 :parts: 3
73 """
73 """
74
74
75 #*****************************************************************************
75 #*****************************************************************************
76 # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu>
76 # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu>
77 # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu>
77 # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu>
78 #
78 #
79 # Distributed under the terms of the BSD License. The full license is in
79 # Distributed under the terms of the BSD License. The full license is in
80 # the file COPYING, distributed as part of this software.
80 # the file COPYING, distributed as part of this software.
81 #*****************************************************************************
81 #*****************************************************************************
82
82
83 from __future__ import unicode_literals
83 from __future__ import unicode_literals
84 from __future__ import print_function
84 from __future__ import print_function
85
85
86 import dis
86 import dis
87 import inspect
87 import inspect
88 import keyword
88 import keyword
89 import linecache
89 import linecache
90 import os
90 import os
91 import pydoc
91 import pydoc
92 import re
92 import re
93 import sys
93 import sys
94 import time
94 import time
95 import tokenize
95 import tokenize
96 import traceback
96 import traceback
97 import types
97 import types
98
98
99 try: # Python 2
99 try: # Python 2
100 generate_tokens = tokenize.generate_tokens
100 generate_tokens = tokenize.generate_tokens
101 except AttributeError: # Python 3
101 except AttributeError: # Python 3
102 generate_tokens = tokenize.tokenize
102 generate_tokens = tokenize.tokenize
103
103
104 # For purposes of monkeypatching inspect to fix a bug in it.
104 # For purposes of monkeypatching inspect to fix a bug in it.
105 from inspect import getsourcefile, getfile, getmodule, \
105 from inspect import getsourcefile, getfile, getmodule, \
106 ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode
106 ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode
107
107
108 # IPython's own modules
108 # IPython's own modules
109 # Modified pdb which doesn't damage IPython's readline handling
109 # Modified pdb which doesn't damage IPython's readline handling
110 from IPython import get_ipython
110 from IPython import get_ipython
111 from IPython.core import debugger
111 from IPython.core import debugger
112 from IPython.core.display_trap import DisplayTrap
112 from IPython.core.display_trap import DisplayTrap
113 from IPython.core.excolors import exception_colors
113 from IPython.core.excolors import exception_colors
114 from IPython.utils import PyColorize
114 from IPython.utils import PyColorize
115 from IPython.utils import io
115 from IPython.utils import io
116 from IPython.utils import openpy
116 from IPython.utils import openpy
117 from IPython.utils import path as util_path
117 from IPython.utils import path as util_path
118 from IPython.utils import py3compat
118 from IPython.utils import py3compat
119 from IPython.utils import ulinecache
119 from IPython.utils import ulinecache
120 from IPython.utils.data import uniq_stable
120 from IPython.utils.data import uniq_stable
121 from IPython.utils.warn import info, error
121 from IPython.utils.warn import info, error
122
122
123 # Globals
123 # Globals
124 # amount of space to put line numbers before verbose tracebacks
124 # amount of space to put line numbers before verbose tracebacks
125 INDENT_SIZE = 8
125 INDENT_SIZE = 8
126
126
127 # Default color scheme. This is used, for example, by the traceback
127 # Default color scheme. This is used, for example, by the traceback
128 # formatter. When running in an actual IPython instance, the user's rc.colors
128 # formatter. When running in an actual IPython instance, the user's rc.colors
129 # value is used, but having a module global makes this functionality available
129 # value is used, but having a module global makes this functionality available
130 # to users of ultratb who are NOT running inside ipython.
130 # to users of ultratb who are NOT running inside ipython.
131 DEFAULT_SCHEME = 'NoColor'
131 DEFAULT_SCHEME = 'NoColor'
132
132
133 # ---------------------------------------------------------------------------
133 # ---------------------------------------------------------------------------
134 # Code begins
134 # Code begins
135
135
136 # Utility functions
136 # Utility functions
137 def inspect_error():
137 def inspect_error():
138 """Print a message about internal inspect errors.
138 """Print a message about internal inspect errors.
139
139
140 These are unfortunately quite common."""
140 These are unfortunately quite common."""
141
141
142 error('Internal Python error in the inspect module.\n'
142 error('Internal Python error in the inspect module.\n'
143 'Below is the traceback from this internal error.\n')
143 'Below is the traceback from this internal error.\n')
144
144
145
145
146 # This function is a monkeypatch we apply to the Python inspect module. We have
146 # This function is a monkeypatch we apply to the Python inspect module. We have
147 # now found when it's needed (see discussion on issue gh-1456), and we have a
147 # now found when it's needed (see discussion on issue gh-1456), and we have a
148 # test case (IPython.core.tests.test_ultratb.ChangedPyFileTest) that fails if
148 # test case (IPython.core.tests.test_ultratb.ChangedPyFileTest) that fails if
149 # the monkeypatch is not applied. TK, Aug 2012.
149 # the monkeypatch is not applied. TK, Aug 2012.
150 def findsource(object):
150 def findsource(object):
151 """Return the entire source file and starting line number for an object.
151 """Return the entire source file and starting line number for an object.
152
152
153 The argument may be a module, class, method, function, traceback, frame,
153 The argument may be a module, class, method, function, traceback, frame,
154 or code object. The source code is returned as a list of all the lines
154 or code object. The source code is returned as a list of all the lines
155 in the file and the line number indexes a line in that list. An IOError
155 in the file and the line number indexes a line in that list. An IOError
156 is raised if the source code cannot be retrieved.
156 is raised if the source code cannot be retrieved.
157
157
158 FIXED version with which we monkeypatch the stdlib to work around a bug."""
158 FIXED version with which we monkeypatch the stdlib to work around a bug."""
159
159
160 file = getsourcefile(object) or getfile(object)
160 file = getsourcefile(object) or getfile(object)
161 # If the object is a frame, then trying to get the globals dict from its
161 # If the object is a frame, then trying to get the globals dict from its
162 # module won't work. Instead, the frame object itself has the globals
162 # module won't work. Instead, the frame object itself has the globals
163 # dictionary.
163 # dictionary.
164 globals_dict = None
164 globals_dict = None
165 if inspect.isframe(object):
165 if inspect.isframe(object):
166 # XXX: can this ever be false?
166 # XXX: can this ever be false?
167 globals_dict = object.f_globals
167 globals_dict = object.f_globals
168 else:
168 else:
169 module = getmodule(object, file)
169 module = getmodule(object, file)
170 if module:
170 if module:
171 globals_dict = module.__dict__
171 globals_dict = module.__dict__
172 lines = linecache.getlines(file, globals_dict)
172 lines = linecache.getlines(file, globals_dict)
173 if not lines:
173 if not lines:
174 raise IOError('could not get source code')
174 raise IOError('could not get source code')
175
175
176 if ismodule(object):
176 if ismodule(object):
177 return lines, 0
177 return lines, 0
178
178
179 if isclass(object):
179 if isclass(object):
180 name = object.__name__
180 name = object.__name__
181 pat = re.compile(r'^(\s*)class\s*' + name + r'\b')
181 pat = re.compile(r'^(\s*)class\s*' + name + r'\b')
182 # make some effort to find the best matching class definition:
182 # make some effort to find the best matching class definition:
183 # use the one with the least indentation, which is the one
183 # use the one with the least indentation, which is the one
184 # that's most probably not inside a function definition.
184 # that's most probably not inside a function definition.
185 candidates = []
185 candidates = []
186 for i in range(len(lines)):
186 for i in range(len(lines)):
187 match = pat.match(lines[i])
187 match = pat.match(lines[i])
188 if match:
188 if match:
189 # if it's at toplevel, it's already the best one
189 # if it's at toplevel, it's already the best one
190 if lines[i][0] == 'c':
190 if lines[i][0] == 'c':
191 return lines, i
191 return lines, i
192 # else add whitespace to candidate list
192 # else add whitespace to candidate list
193 candidates.append((match.group(1), i))
193 candidates.append((match.group(1), i))
194 if candidates:
194 if candidates:
195 # this will sort by whitespace, and by line number,
195 # this will sort by whitespace, and by line number,
196 # less whitespace first
196 # less whitespace first
197 candidates.sort()
197 candidates.sort()
198 return lines, candidates[0][1]
198 return lines, candidates[0][1]
199 else:
199 else:
200 raise IOError('could not find class definition')
200 raise IOError('could not find class definition')
201
201
202 if ismethod(object):
202 if ismethod(object):
203 object = object.__func__
203 object = object.__func__
204 if isfunction(object):
204 if isfunction(object):
205 object = object.__code__
205 object = object.__code__
206 if istraceback(object):
206 if istraceback(object):
207 object = object.tb_frame
207 object = object.tb_frame
208 if isframe(object):
208 if isframe(object):
209 object = object.f_code
209 object = object.f_code
210 if iscode(object):
210 if iscode(object):
211 if not hasattr(object, 'co_firstlineno'):
211 if not hasattr(object, 'co_firstlineno'):
212 raise IOError('could not find function definition')
212 raise IOError('could not find function definition')
213 pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)')
213 pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)')
214 pmatch = pat.match
214 pmatch = pat.match
215 # fperez - fix: sometimes, co_firstlineno can give a number larger than
215 # fperez - fix: sometimes, co_firstlineno can give a number larger than
216 # the length of lines, which causes an error. Safeguard against that.
216 # the length of lines, which causes an error. Safeguard against that.
217 lnum = min(object.co_firstlineno, len(lines)) - 1
217 lnum = min(object.co_firstlineno, len(lines)) - 1
218 while lnum > 0:
218 while lnum > 0:
219 if pmatch(lines[lnum]): break
219 if pmatch(lines[lnum]): break
220 lnum -= 1
220 lnum -= 1
221
221
222 return lines, lnum
222 return lines, lnum
223 raise IOError('could not find code object')
223 raise IOError('could not find code object')
224
224
225
225
226 # This is a patched version of inspect.getargs that applies the (unmerged)
226 # This is a patched version of inspect.getargs that applies the (unmerged)
227 # patch for http://bugs.python.org/issue14611 by Stefano Taschini. This fixes
227 # patch for http://bugs.python.org/issue14611 by Stefano Taschini. This fixes
228 # https://github.com/ipython/ipython/issues/8205 and
228 # https://github.com/ipython/ipython/issues/8205 and
229 # https://github.com/ipython/ipython/issues/8293
229 # https://github.com/ipython/ipython/issues/8293
230 def getargs(co):
230 def getargs(co):
231 """Get information about the arguments accepted by a code object.
231 """Get information about the arguments accepted by a code object.
232
232
233 Three things are returned: (args, varargs, varkw), where 'args' is
233 Three things are returned: (args, varargs, varkw), where 'args' is
234 a list of argument names (possibly containing nested lists), and
234 a list of argument names (possibly containing nested lists), and
235 'varargs' and 'varkw' are the names of the * and ** arguments or None."""
235 'varargs' and 'varkw' are the names of the * and ** arguments or None."""
236 if not iscode(co):
236 if not iscode(co):
237 raise TypeError('{!r} is not a code object'.format(co))
237 raise TypeError('{!r} is not a code object'.format(co))
238
238
239 nargs = co.co_argcount
239 nargs = co.co_argcount
240 names = co.co_varnames
240 names = co.co_varnames
241 args = list(names[:nargs])
241 args = list(names[:nargs])
242 step = 0
242 step = 0
243
243
244 # The following acrobatics are for anonymous (tuple) arguments.
244 # The following acrobatics are for anonymous (tuple) arguments.
245 for i in range(nargs):
245 for i in range(nargs):
246 if args[i][:1] in ('', '.'):
246 if args[i][:1] in ('', '.'):
247 stack, remain, count = [], [], []
247 stack, remain, count = [], [], []
248 while step < len(co.co_code):
248 while step < len(co.co_code):
249 op = ord(co.co_code[step])
249 op = ord(co.co_code[step])
250 step = step + 1
250 step = step + 1
251 if op >= dis.HAVE_ARGUMENT:
251 if op >= dis.HAVE_ARGUMENT:
252 opname = dis.opname[op]
252 opname = dis.opname[op]
253 value = ord(co.co_code[step]) + ord(co.co_code[step+1])*256
253 value = ord(co.co_code[step]) + ord(co.co_code[step+1])*256
254 step = step + 2
254 step = step + 2
255 if opname in ('UNPACK_TUPLE', 'UNPACK_SEQUENCE'):
255 if opname in ('UNPACK_TUPLE', 'UNPACK_SEQUENCE'):
256 remain.append(value)
256 remain.append(value)
257 count.append(value)
257 count.append(value)
258 elif opname in ('STORE_FAST', 'STORE_DEREF'):
258 elif opname in ('STORE_FAST', 'STORE_DEREF'):
259 if op in dis.haslocal:
259 if op in dis.haslocal:
260 stack.append(co.co_varnames[value])
260 stack.append(co.co_varnames[value])
261 elif op in dis.hasfree:
261 elif op in dis.hasfree:
262 stack.append((co.co_cellvars + co.co_freevars)[value])
262 stack.append((co.co_cellvars + co.co_freevars)[value])
263 # Special case for sublists of length 1: def foo((bar))
263 # Special case for sublists of length 1: def foo((bar))
264 # doesn't generate the UNPACK_TUPLE bytecode, so if
264 # doesn't generate the UNPACK_TUPLE bytecode, so if
265 # `remain` is empty here, we have such a sublist.
265 # `remain` is empty here, we have such a sublist.
266 if not remain:
266 if not remain:
267 stack[0] = [stack[0]]
267 stack[0] = [stack[0]]
268 break
268 break
269 else:
269 else:
270 remain[-1] = remain[-1] - 1
270 remain[-1] = remain[-1] - 1
271 while remain[-1] == 0:
271 while remain[-1] == 0:
272 remain.pop()
272 remain.pop()
273 size = count.pop()
273 size = count.pop()
274 stack[-size:] = [stack[-size:]]
274 stack[-size:] = [stack[-size:]]
275 if not remain: break
275 if not remain: break
276 remain[-1] = remain[-1] - 1
276 remain[-1] = remain[-1] - 1
277 if not remain: break
277 if not remain: break
278 args[i] = stack[0]
278 args[i] = stack[0]
279
279
280 varargs = None
280 varargs = None
281 if co.co_flags & inspect.CO_VARARGS:
281 if co.co_flags & inspect.CO_VARARGS:
282 varargs = co.co_varnames[nargs]
282 varargs = co.co_varnames[nargs]
283 nargs = nargs + 1
283 nargs = nargs + 1
284 varkw = None
284 varkw = None
285 if co.co_flags & inspect.CO_VARKEYWORDS:
285 if co.co_flags & inspect.CO_VARKEYWORDS:
286 varkw = co.co_varnames[nargs]
286 varkw = co.co_varnames[nargs]
287 return inspect.Arguments(args, varargs, varkw)
287 return inspect.Arguments(args, varargs, varkw)
288
288
289
289
290 # Monkeypatch inspect to apply our bugfix.
290 # Monkeypatch inspect to apply our bugfix.
291 def with_patch_inspect(f):
291 def with_patch_inspect(f):
292 """decorator for monkeypatching inspect.findsource"""
292 """decorator for monkeypatching inspect.findsource"""
293
293
294 def wrapped(*args, **kwargs):
294 def wrapped(*args, **kwargs):
295 save_findsource = inspect.findsource
295 save_findsource = inspect.findsource
296 save_getargs = inspect.getargs
296 save_getargs = inspect.getargs
297 inspect.findsource = findsource
297 inspect.findsource = findsource
298 inspect.getargs = getargs
298 inspect.getargs = getargs
299 try:
299 try:
300 return f(*args, **kwargs)
300 return f(*args, **kwargs)
301 finally:
301 finally:
302 inspect.findsource = save_findsource
302 inspect.findsource = save_findsource
303 inspect.getargs = save_getargs
303 inspect.getargs = save_getargs
304
304
305 return wrapped
305 return wrapped
306
306
307
307
308 if py3compat.PY3:
308 if py3compat.PY3:
309 fixed_getargvalues = inspect.getargvalues
309 fixed_getargvalues = inspect.getargvalues
310 else:
310 else:
311 # Fixes for https://github.com/ipython/ipython/issues/8293
311 # Fixes for https://github.com/ipython/ipython/issues/8293
312 # and https://github.com/ipython/ipython/issues/8205.
312 # and https://github.com/ipython/ipython/issues/8205.
313 # The relevant bug is caused by failure to correctly handle anonymous tuple
313 # The relevant bug is caused by failure to correctly handle anonymous tuple
314 # unpacking, which only exists in Python 2.
314 # unpacking, which only exists in Python 2.
315 fixed_getargvalues = with_patch_inspect(inspect.getargvalues)
315 fixed_getargvalues = with_patch_inspect(inspect.getargvalues)
316
316
317
317
318 def fix_frame_records_filenames(records):
318 def fix_frame_records_filenames(records):
319 """Try to fix the filenames in each record from inspect.getinnerframes().
319 """Try to fix the filenames in each record from inspect.getinnerframes().
320
320
321 Particularly, modules loaded from within zip files have useless filenames
321 Particularly, modules loaded from within zip files have useless filenames
322 attached to their code object, and inspect.getinnerframes() just uses it.
322 attached to their code object, and inspect.getinnerframes() just uses it.
323 """
323 """
324 fixed_records = []
324 fixed_records = []
325 for frame, filename, line_no, func_name, lines, index in records:
325 for frame, filename, line_no, func_name, lines, index in records:
326 # Look inside the frame's globals dictionary for __file__,
326 # Look inside the frame's globals dictionary for __file__,
327 # which should be better. However, keep Cython filenames since
327 # which should be better. However, keep Cython filenames since
328 # we prefer the source filenames over the compiled .so file.
328 # we prefer the source filenames over the compiled .so file.
329 filename = py3compat.cast_unicode_py2(filename, "utf-8")
329 filename = py3compat.cast_unicode_py2(filename, "utf-8")
330 if not filename.endswith(('.pyx', '.pxd', '.pxi')):
330 if not filename.endswith(('.pyx', '.pxd', '.pxi')):
331 better_fn = frame.f_globals.get('__file__', None)
331 better_fn = frame.f_globals.get('__file__', None)
332 if isinstance(better_fn, str):
332 if isinstance(better_fn, str):
333 # Check the type just in case someone did something weird with
333 # Check the type just in case someone did something weird with
334 # __file__. It might also be None if the error occurred during
334 # __file__. It might also be None if the error occurred during
335 # import.
335 # import.
336 filename = better_fn
336 filename = better_fn
337 fixed_records.append((frame, filename, line_no, func_name, lines, index))
337 fixed_records.append((frame, filename, line_no, func_name, lines, index))
338 return fixed_records
338 return fixed_records
339
339
340
340
341 @with_patch_inspect
341 @with_patch_inspect
342 def _fixed_getinnerframes(etb, context=1, tb_offset=0):
342 def _fixed_getinnerframes(etb, context=1, tb_offset=0):
343 LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5
343 LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5
344
344
345 records = fix_frame_records_filenames(inspect.getinnerframes(etb, context))
345 records = fix_frame_records_filenames(inspect.getinnerframes(etb, context))
346 # If the error is at the console, don't build any context, since it would
346 # If the error is at the console, don't build any context, since it would
347 # otherwise produce 5 blank lines printed out (there is no file at the
347 # otherwise produce 5 blank lines printed out (there is no file at the
348 # console)
348 # console)
349 rec_check = records[tb_offset:]
349 rec_check = records[tb_offset:]
350 try:
350 try:
351 rname = rec_check[0][1]
351 rname = rec_check[0][1]
352 if rname == '<ipython console>' or rname.endswith('<string>'):
352 if rname == '<ipython console>' or rname.endswith('<string>'):
353 return rec_check
353 return rec_check
354 except IndexError:
354 except IndexError:
355 pass
355 pass
356
356
357 aux = traceback.extract_tb(etb)
357 aux = traceback.extract_tb(etb)
358 assert len(records) == len(aux)
358 assert len(records) == len(aux)
359 for i, (file, lnum, _, _) in zip(range(len(records)), aux):
359 for i, (file, lnum, _, _) in zip(range(len(records)), aux):
360 maybeStart = lnum - 1 - context // 2
360 maybeStart = lnum - 1 - context // 2
361 start = max(maybeStart, 0)
361 start = max(maybeStart, 0)
362 end = start + context
362 end = start + context
363 lines = ulinecache.getlines(file)[start:end]
363 lines = ulinecache.getlines(file)[start:end]
364 buf = list(records[i])
364 buf = list(records[i])
365 buf[LNUM_POS] = lnum
365 buf[LNUM_POS] = lnum
366 buf[INDEX_POS] = lnum - 1 - start
366 buf[INDEX_POS] = lnum - 1 - start
367 buf[LINES_POS] = lines
367 buf[LINES_POS] = lines
368 records[i] = tuple(buf)
368 records[i] = tuple(buf)
369 return records[tb_offset:]
369 return records[tb_offset:]
370
370
371 # Helper function -- largely belongs to VerboseTB, but we need the same
371 # Helper function -- largely belongs to VerboseTB, but we need the same
372 # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they
372 # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they
373 # can be recognized properly by ipython.el's py-traceback-line-re
373 # can be recognized properly by ipython.el's py-traceback-line-re
374 # (SyntaxErrors have to be treated specially because they have no traceback)
374 # (SyntaxErrors have to be treated specially because they have no traceback)
375
375
376 _parser = PyColorize.Parser()
376 _parser = PyColorize.Parser()
377
377
378
378
379 def _format_traceback_lines(lnum, index, lines, Colors, lvals=None, scheme=None):
379 def _format_traceback_lines(lnum, index, lines, Colors, lvals=None, scheme=None):
380 numbers_width = INDENT_SIZE - 1
380 numbers_width = INDENT_SIZE - 1
381 res = []
381 res = []
382 i = lnum - index
382 i = lnum - index
383
383
384 # This lets us get fully syntax-highlighted tracebacks.
384 # This lets us get fully syntax-highlighted tracebacks.
385 if scheme is None:
385 if scheme is None:
386 ipinst = get_ipython()
386 ipinst = get_ipython()
387 if ipinst is not None:
387 if ipinst is not None:
388 scheme = ipinst.colors
388 scheme = ipinst.colors
389 else:
389 else:
390 scheme = DEFAULT_SCHEME
390 scheme = DEFAULT_SCHEME
391
391
392 _line_format = _parser.format2
392 _line_format = _parser.format2
393
393
394 for line in lines:
394 for line in lines:
395 line = py3compat.cast_unicode(line)
395 line = py3compat.cast_unicode(line)
396
396
397 new_line, err = _line_format(line, 'str', scheme)
397 new_line, err = _line_format(line, 'str', scheme)
398 if not err: line = new_line
398 if not err: line = new_line
399
399
400 if i == lnum:
400 if i == lnum:
401 # This is the line with the error
401 # This is the line with the error
402 pad = numbers_width - len(str(i))
402 pad = numbers_width - len(str(i))
403 if pad >= 3:
403 if pad >= 3:
404 marker = '-' * (pad - 3) + '-> '
404 marker = '-' * (pad - 3) + '-> '
405 elif pad == 2:
405 elif pad == 2:
406 marker = '> '
406 marker = '> '
407 elif pad == 1:
407 elif pad == 1:
408 marker = '>'
408 marker = '>'
409 else:
409 else:
410 marker = ''
410 marker = ''
411 num = marker + str(i)
411 num = marker + str(i)
412 line = '%s%s%s %s%s' % (Colors.linenoEm, num,
412 line = '%s%s%s %s%s' % (Colors.linenoEm, num,
413 Colors.line, line, Colors.Normal)
413 Colors.line, line, Colors.Normal)
414 else:
414 else:
415 num = '%*s' % (numbers_width, i)
415 num = '%*s' % (numbers_width, i)
416 line = '%s%s%s %s' % (Colors.lineno, num,
416 line = '%s%s%s %s' % (Colors.lineno, num,
417 Colors.Normal, line)
417 Colors.Normal, line)
418
418
419 res.append(line)
419 res.append(line)
420 if lvals and i == lnum:
420 if lvals and i == lnum:
421 res.append(lvals + '\n')
421 res.append(lvals + '\n')
422 i = i + 1
422 i = i + 1
423 return res
423 return res
424
424
425 def is_recursion_error(etype, value, records):
425 def is_recursion_error(etype, value, records):
426 try:
426 try:
427 # RecursionError is new in Python 3.5
427 # RecursionError is new in Python 3.5
428 recursion_error_type = RecursionError
428 recursion_error_type = RecursionError
429 except NameError:
429 except NameError:
430 recursion_error_type = RuntimeError
430 recursion_error_type = RuntimeError
431
431
432 # The default recursion limit is 1000, but some of that will be taken up
432 # The default recursion limit is 1000, but some of that will be taken up
433 # by stack frames in IPython itself. >500 frames probably indicates
433 # by stack frames in IPython itself. >500 frames probably indicates
434 # a recursion error.
434 # a recursion error.
435 return (etype is recursion_error_type) \
435 return (etype is recursion_error_type) \
436 and "recursion" in str(value).lower() \
436 and "recursion" in str(value).lower() \
437 and len(records) > 500
437 and len(records) > 500
438
438
439 def find_recursion(etype, value, records):
439 def find_recursion(etype, value, records):
440 """Identify the repeating stack frames from a RecursionError traceback
440 """Identify the repeating stack frames from a RecursionError traceback
441
441
442 'records' is a list as returned by VerboseTB.get_records()
442 'records' is a list as returned by VerboseTB.get_records()
443
443
444 Returns (last_unique, repeat_length)
444 Returns (last_unique, repeat_length)
445 """
445 """
446 # This involves a bit of guesswork - we want to show enough of the traceback
446 # This involves a bit of guesswork - we want to show enough of the traceback
447 # to indicate where the recursion is occurring. We guess that the innermost
447 # to indicate where the recursion is occurring. We guess that the innermost
448 # quarter of the traceback (250 frames by default) is repeats, and find the
448 # quarter of the traceback (250 frames by default) is repeats, and find the
449 # first frame (from in to out) that looks different.
449 # first frame (from in to out) that looks different.
450 if not is_recursion_error(etype, value, records):
450 if not is_recursion_error(etype, value, records):
451 return len(records), 0
451 return len(records), 0
452
452
453 # Select filename, lineno, func_name to track frames with
453 # Select filename, lineno, func_name to track frames with
454 records = [r[1:4] for r in records]
454 records = [r[1:4] for r in records]
455 inner_frames = records[-(len(records)//4):]
455 inner_frames = records[-(len(records)//4):]
456 frames_repeated = set(inner_frames)
456 frames_repeated = set(inner_frames)
457
457
458 last_seen_at = {}
458 last_seen_at = {}
459 longest_repeat = 0
459 longest_repeat = 0
460 i = len(records)
460 i = len(records)
461 for frame in reversed(records):
461 for frame in reversed(records):
462 i -= 1
462 i -= 1
463 if frame not in frames_repeated:
463 if frame not in frames_repeated:
464 last_unique = i
464 last_unique = i
465 break
465 break
466
466
467 if frame in last_seen_at:
467 if frame in last_seen_at:
468 distance = last_seen_at[frame] - i
468 distance = last_seen_at[frame] - i
469 longest_repeat = max(longest_repeat, distance)
469 longest_repeat = max(longest_repeat, distance)
470
470
471 last_seen_at[frame] = i
471 last_seen_at[frame] = i
472 else:
472 else:
473 last_unique = 0 # The whole traceback was recursion
473 last_unique = 0 # The whole traceback was recursion
474
474
475 return last_unique, longest_repeat
475 return last_unique, longest_repeat
476
476
477 #---------------------------------------------------------------------------
477 #---------------------------------------------------------------------------
478 # Module classes
478 # Module classes
479 class TBTools(object):
479 class TBTools(object):
480 """Basic tools used by all traceback printer classes."""
480 """Basic tools used by all traceback printer classes."""
481
481
482 # Number of frames to skip when reporting tracebacks
482 # Number of frames to skip when reporting tracebacks
483 tb_offset = 0
483 tb_offset = 0
484
484
485 def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None):
485 def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None):
486 # Whether to call the interactive pdb debugger after printing
486 # Whether to call the interactive pdb debugger after printing
487 # tracebacks or not
487 # tracebacks or not
488 self.call_pdb = call_pdb
488 self.call_pdb = call_pdb
489
489
490 # Output stream to write to. Note that we store the original value in
490 # Output stream to write to. Note that we store the original value in
491 # a private attribute and then make the public ostream a property, so
491 # a private attribute and then make the public ostream a property, so
492 # that we can delay accessing io.stdout until runtime. The way
492 # that we can delay accessing io.stdout until runtime. The way
493 # things are written now, the io.stdout object is dynamically managed
493 # things are written now, the io.stdout object is dynamically managed
494 # so a reference to it should NEVER be stored statically. This
494 # so a reference to it should NEVER be stored statically. This
495 # property approach confines this detail to a single location, and all
495 # property approach confines this detail to a single location, and all
496 # subclasses can simply access self.ostream for writing.
496 # subclasses can simply access self.ostream for writing.
497 self._ostream = ostream
497 self._ostream = ostream
498
498
499 # Create color table
499 # Create color table
500 self.color_scheme_table = exception_colors()
500 self.color_scheme_table = exception_colors()
501
501
502 self.set_colors(color_scheme)
502 self.set_colors(color_scheme)
503 self.old_scheme = color_scheme # save initial value for toggles
503 self.old_scheme = color_scheme # save initial value for toggles
504
504
505 if call_pdb:
505 if call_pdb:
506 self.pdb = debugger.Pdb(self.color_scheme_table.active_scheme_name)
506 self.pdb = debugger.Pdb(self.color_scheme_table.active_scheme_name)
507 else:
507 else:
508 self.pdb = None
508 self.pdb = None
509
509
510 def _get_ostream(self):
510 def _get_ostream(self):
511 """Output stream that exceptions are written to.
511 """Output stream that exceptions are written to.
512
512
513 Valid values are:
513 Valid values are:
514
514
515 - None: the default, which means that IPython will dynamically resolve
515 - None: the default, which means that IPython will dynamically resolve
516 to io.stdout. This ensures compatibility with most tools, including
516 to io.stdout. This ensures compatibility with most tools, including
517 Windows (where plain stdout doesn't recognize ANSI escapes).
517 Windows (where plain stdout doesn't recognize ANSI escapes).
518
518
519 - Any object with 'write' and 'flush' attributes.
519 - Any object with 'write' and 'flush' attributes.
520 """
520 """
521 return io.stdout if self._ostream is None else self._ostream
521 return io.stdout if self._ostream is None else self._ostream
522
522
523 def _set_ostream(self, val):
523 def _set_ostream(self, val):
524 assert val is None or (hasattr(val, 'write') and hasattr(val, 'flush'))
524 assert val is None or (hasattr(val, 'write') and hasattr(val, 'flush'))
525 self._ostream = val
525 self._ostream = val
526
526
527 ostream = property(_get_ostream, _set_ostream)
527 ostream = property(_get_ostream, _set_ostream)
528
528
529 def set_colors(self, *args, **kw):
529 def set_colors(self, *args, **kw):
530 """Shorthand access to the color table scheme selector method."""
530 """Shorthand access to the color table scheme selector method."""
531
531
532 # Set own color table
532 # Set own color table
533 self.color_scheme_table.set_active_scheme(*args, **kw)
533 self.color_scheme_table.set_active_scheme(*args, **kw)
534 # for convenience, set Colors to the active scheme
534 # for convenience, set Colors to the active scheme
535 self.Colors = self.color_scheme_table.active_colors
535 self.Colors = self.color_scheme_table.active_colors
536 # Also set colors of debugger
536 # Also set colors of debugger
537 if hasattr(self, 'pdb') and self.pdb is not None:
537 if hasattr(self, 'pdb') and self.pdb is not None:
538 self.pdb.set_colors(*args, **kw)
538 self.pdb.set_colors(*args, **kw)
539
539
540 def color_toggle(self):
540 def color_toggle(self):
541 """Toggle between the currently active color scheme and NoColor."""
541 """Toggle between the currently active color scheme and NoColor."""
542
542
543 if self.color_scheme_table.active_scheme_name == 'NoColor':
543 if self.color_scheme_table.active_scheme_name == 'NoColor':
544 self.color_scheme_table.set_active_scheme(self.old_scheme)
544 self.color_scheme_table.set_active_scheme(self.old_scheme)
545 self.Colors = self.color_scheme_table.active_colors
545 self.Colors = self.color_scheme_table.active_colors
546 else:
546 else:
547 self.old_scheme = self.color_scheme_table.active_scheme_name
547 self.old_scheme = self.color_scheme_table.active_scheme_name
548 self.color_scheme_table.set_active_scheme('NoColor')
548 self.color_scheme_table.set_active_scheme('NoColor')
549 self.Colors = self.color_scheme_table.active_colors
549 self.Colors = self.color_scheme_table.active_colors
550
550
551 def stb2text(self, stb):
551 def stb2text(self, stb):
552 """Convert a structured traceback (a list) to a string."""
552 """Convert a structured traceback (a list) to a string."""
553 return '\n'.join(stb)
553 return '\n'.join(stb)
554
554
555 def text(self, etype, value, tb, tb_offset=None, context=5):
555 def text(self, etype, value, tb, tb_offset=None, context=5):
556 """Return formatted traceback.
556 """Return formatted traceback.
557
557
558 Subclasses may override this if they add extra arguments.
558 Subclasses may override this if they add extra arguments.
559 """
559 """
560 tb_list = self.structured_traceback(etype, value, tb,
560 tb_list = self.structured_traceback(etype, value, tb,
561 tb_offset, context)
561 tb_offset, context)
562 return self.stb2text(tb_list)
562 return self.stb2text(tb_list)
563
563
564 def structured_traceback(self, etype, evalue, tb, tb_offset=None,
564 def structured_traceback(self, etype, evalue, tb, tb_offset=None,
565 context=5, mode=None):
565 context=5, mode=None):
566 """Return a list of traceback frames.
566 """Return a list of traceback frames.
567
567
568 Must be implemented by each class.
568 Must be implemented by each class.
569 """
569 """
570 raise NotImplementedError()
570 raise NotImplementedError()
571
571
572
572
573 #---------------------------------------------------------------------------
573 #---------------------------------------------------------------------------
574 class ListTB(TBTools):
574 class ListTB(TBTools):
575 """Print traceback information from a traceback list, with optional color.
575 """Print traceback information from a traceback list, with optional color.
576
576
577 Calling requires 3 arguments: (etype, evalue, elist)
577 Calling requires 3 arguments: (etype, evalue, elist)
578 as would be obtained by::
578 as would be obtained by::
579
579
580 etype, evalue, tb = sys.exc_info()
580 etype, evalue, tb = sys.exc_info()
581 if tb:
581 if tb:
582 elist = traceback.extract_tb(tb)
582 elist = traceback.extract_tb(tb)
583 else:
583 else:
584 elist = None
584 elist = None
585
585
586 It can thus be used by programs which need to process the traceback before
586 It can thus be used by programs which need to process the traceback before
587 printing (such as console replacements based on the code module from the
587 printing (such as console replacements based on the code module from the
588 standard library).
588 standard library).
589
589
590 Because they are meant to be called without a full traceback (only a
590 Because they are meant to be called without a full traceback (only a
591 list), instances of this class can't call the interactive pdb debugger."""
591 list), instances of this class can't call the interactive pdb debugger."""
592
592
593 def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None):
593 def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None):
594 TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb,
594 TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb,
595 ostream=ostream)
595 ostream=ostream)
596
596
597 def __call__(self, etype, value, elist):
597 def __call__(self, etype, value, elist):
598 self.ostream.flush()
598 self.ostream.flush()
599 self.ostream.write(self.text(etype, value, elist))
599 self.ostream.write(self.text(etype, value, elist))
600 self.ostream.write('\n')
600 self.ostream.write('\n')
601
601
602 def structured_traceback(self, etype, value, elist, tb_offset=None,
602 def structured_traceback(self, etype, value, elist, tb_offset=None,
603 context=5):
603 context=5):
604 """Return a color formatted string with the traceback info.
604 """Return a color formatted string with the traceback info.
605
605
606 Parameters
606 Parameters
607 ----------
607 ----------
608 etype : exception type
608 etype : exception type
609 Type of the exception raised.
609 Type of the exception raised.
610
610
611 value : object
611 value : object
612 Data stored in the exception
612 Data stored in the exception
613
613
614 elist : list
614 elist : list
615 List of frames, see class docstring for details.
615 List of frames, see class docstring for details.
616
616
617 tb_offset : int, optional
617 tb_offset : int, optional
618 Number of frames in the traceback to skip. If not given, the
618 Number of frames in the traceback to skip. If not given, the
619 instance value is used (set in constructor).
619 instance value is used (set in constructor).
620
620
621 context : int, optional
621 context : int, optional
622 Number of lines of context information to print.
622 Number of lines of context information to print.
623
623
624 Returns
624 Returns
625 -------
625 -------
626 String with formatted exception.
626 String with formatted exception.
627 """
627 """
628 tb_offset = self.tb_offset if tb_offset is None else tb_offset
628 tb_offset = self.tb_offset if tb_offset is None else tb_offset
629 Colors = self.Colors
629 Colors = self.Colors
630 out_list = []
630 out_list = []
631 if elist:
631 if elist:
632
632
633 if tb_offset and len(elist) > tb_offset:
633 if tb_offset and len(elist) > tb_offset:
634 elist = elist[tb_offset:]
634 elist = elist[tb_offset:]
635
635
636 out_list.append('Traceback %s(most recent call last)%s:' %
636 out_list.append('Traceback %s(most recent call last)%s:' %
637 (Colors.normalEm, Colors.Normal) + '\n')
637 (Colors.normalEm, Colors.Normal) + '\n')
638 out_list.extend(self._format_list(elist))
638 out_list.extend(self._format_list(elist))
639 # The exception info should be a single entry in the list.
639 # The exception info should be a single entry in the list.
640 lines = ''.join(self._format_exception_only(etype, value))
640 lines = ''.join(self._format_exception_only(etype, value))
641 out_list.append(lines)
641 out_list.append(lines)
642
642
643 # Note: this code originally read:
643 # Note: this code originally read:
644
644
645 ## for line in lines[:-1]:
645 ## for line in lines[:-1]:
646 ## out_list.append(" "+line)
646 ## out_list.append(" "+line)
647 ## out_list.append(lines[-1])
647 ## out_list.append(lines[-1])
648
648
649 # This means it was indenting everything but the last line by a little
649 # This means it was indenting everything but the last line by a little
650 # bit. I've disabled this for now, but if we see ugliness somewhere we
650 # bit. I've disabled this for now, but if we see ugliness somewhere we
651 # can restore it.
651 # can restore it.
652
652
653 return out_list
653 return out_list
654
654
655 def _format_list(self, extracted_list):
655 def _format_list(self, extracted_list):
656 """Format a list of traceback entry tuples for printing.
656 """Format a list of traceback entry tuples for printing.
657
657
658 Given a list of tuples as returned by extract_tb() or
658 Given a list of tuples as returned by extract_tb() or
659 extract_stack(), return a list of strings ready for printing.
659 extract_stack(), return a list of strings ready for printing.
660 Each string in the resulting list corresponds to the item with the
660 Each string in the resulting list corresponds to the item with the
661 same index in the argument list. Each string ends in a newline;
661 same index in the argument list. Each string ends in a newline;
662 the strings may contain internal newlines as well, for those items
662 the strings may contain internal newlines as well, for those items
663 whose source text line is not None.
663 whose source text line is not None.
664
664
665 Lifted almost verbatim from traceback.py
665 Lifted almost verbatim from traceback.py
666 """
666 """
667
667
668 Colors = self.Colors
668 Colors = self.Colors
669 list = []
669 list = []
670 for filename, lineno, name, line in extracted_list[:-1]:
670 for filename, lineno, name, line in extracted_list[:-1]:
671 item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \
671 item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \
672 (Colors.filename, py3compat.cast_unicode_py2(filename, "utf-8"), Colors.Normal,
672 (Colors.filename, py3compat.cast_unicode_py2(filename, "utf-8"), Colors.Normal,
673 Colors.lineno, lineno, Colors.Normal,
673 Colors.lineno, lineno, Colors.Normal,
674 Colors.name, py3compat.cast_unicode_py2(name, "utf-8"), Colors.Normal)
674 Colors.name, py3compat.cast_unicode_py2(name, "utf-8"), Colors.Normal)
675 if line:
675 if line:
676 item += ' %s\n' % line.strip()
676 item += ' %s\n' % line.strip()
677 list.append(item)
677 list.append(item)
678 # Emphasize the last entry
678 # Emphasize the last entry
679 filename, lineno, name, line = extracted_list[-1]
679 filename, lineno, name, line = extracted_list[-1]
680 item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \
680 item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \
681 (Colors.normalEm,
681 (Colors.normalEm,
682 Colors.filenameEm, py3compat.cast_unicode_py2(filename, "utf-8"), Colors.normalEm,
682 Colors.filenameEm, py3compat.cast_unicode_py2(filename, "utf-8"), Colors.normalEm,
683 Colors.linenoEm, lineno, Colors.normalEm,
683 Colors.linenoEm, lineno, Colors.normalEm,
684 Colors.nameEm, py3compat.cast_unicode_py2(name, "utf-8"), Colors.normalEm,
684 Colors.nameEm, py3compat.cast_unicode_py2(name, "utf-8"), Colors.normalEm,
685 Colors.Normal)
685 Colors.Normal)
686 if line:
686 if line:
687 item += '%s %s%s\n' % (Colors.line, line.strip(),
687 item += '%s %s%s\n' % (Colors.line, line.strip(),
688 Colors.Normal)
688 Colors.Normal)
689 list.append(item)
689 list.append(item)
690 return list
690 return list
691
691
692 def _format_exception_only(self, etype, value):
692 def _format_exception_only(self, etype, value):
693 """Format the exception part of a traceback.
693 """Format the exception part of a traceback.
694
694
695 The arguments are the exception type and value such as given by
695 The arguments are the exception type and value such as given by
696 sys.exc_info()[:2]. The return value is a list of strings, each ending
696 sys.exc_info()[:2]. The return value is a list of strings, each ending
697 in a newline. Normally, the list contains a single string; however,
697 in a newline. Normally, the list contains a single string; however,
698 for SyntaxError exceptions, it contains several lines that (when
698 for SyntaxError exceptions, it contains several lines that (when
699 printed) display detailed information about where the syntax error
699 printed) display detailed information about where the syntax error
700 occurred. The message indicating which exception occurred is the
700 occurred. The message indicating which exception occurred is the
701 always last string in the list.
701 always last string in the list.
702
702
703 Also lifted nearly verbatim from traceback.py
703 Also lifted nearly verbatim from traceback.py
704 """
704 """
705 have_filedata = False
705 have_filedata = False
706 Colors = self.Colors
706 Colors = self.Colors
707 list = []
707 list = []
708 stype = Colors.excName + etype.__name__ + Colors.Normal
708 stype = Colors.excName + etype.__name__ + Colors.Normal
709 if value is None:
709 if value is None:
710 # Not sure if this can still happen in Python 2.6 and above
710 # Not sure if this can still happen in Python 2.6 and above
711 list.append(py3compat.cast_unicode(stype) + '\n')
711 list.append(py3compat.cast_unicode(stype) + '\n')
712 else:
712 else:
713 if issubclass(etype, SyntaxError):
713 if issubclass(etype, SyntaxError):
714 have_filedata = True
714 have_filedata = True
715 if not value.filename: value.filename = "<string>"
715 if not value.filename: value.filename = "<string>"
716 if value.lineno:
716 if value.lineno:
717 lineno = value.lineno
717 lineno = value.lineno
718 textline = ulinecache.getline(value.filename, value.lineno)
718 textline = ulinecache.getline(value.filename, value.lineno)
719 else:
719 else:
720 lineno = 'unknown'
720 lineno = 'unknown'
721 textline = ''
721 textline = ''
722 list.append('%s File %s"%s"%s, line %s%s%s\n' % \
722 list.append('%s File %s"%s"%s, line %s%s%s\n' % \
723 (Colors.normalEm,
723 (Colors.normalEm,
724 Colors.filenameEm, py3compat.cast_unicode(value.filename), Colors.normalEm,
724 Colors.filenameEm, py3compat.cast_unicode(value.filename), Colors.normalEm,
725 Colors.linenoEm, lineno, Colors.Normal ))
725 Colors.linenoEm, lineno, Colors.Normal ))
726 if textline == '':
726 if textline == '':
727 textline = py3compat.cast_unicode(value.text, "utf-8")
727 textline = py3compat.cast_unicode(value.text, "utf-8")
728
728
729 if textline is not None:
729 if textline is not None:
730 i = 0
730 i = 0
731 while i < len(textline) and textline[i].isspace():
731 while i < len(textline) and textline[i].isspace():
732 i += 1
732 i += 1
733 list.append('%s %s%s\n' % (Colors.line,
733 list.append('%s %s%s\n' % (Colors.line,
734 textline.strip(),
734 textline.strip(),
735 Colors.Normal))
735 Colors.Normal))
736 if value.offset is not None:
736 if value.offset is not None:
737 s = ' '
737 s = ' '
738 for c in textline[i:value.offset - 1]:
738 for c in textline[i:value.offset - 1]:
739 if c.isspace():
739 if c.isspace():
740 s += c
740 s += c
741 else:
741 else:
742 s += ' '
742 s += ' '
743 list.append('%s%s^%s\n' % (Colors.caret, s,
743 list.append('%s%s^%s\n' % (Colors.caret, s,
744 Colors.Normal))
744 Colors.Normal))
745
745
746 try:
746 try:
747 s = value.msg
747 s = value.msg
748 except Exception:
748 except Exception:
749 s = self._some_str(value)
749 s = self._some_str(value)
750 if s:
750 if s:
751 list.append('%s%s:%s %s\n' % (str(stype), Colors.excName,
751 list.append('%s%s:%s %s\n' % (str(stype), Colors.excName,
752 Colors.Normal, s))
752 Colors.Normal, s))
753 else:
753 else:
754 list.append('%s\n' % str(stype))
754 list.append('%s\n' % str(stype))
755
755
756 # sync with user hooks
756 # sync with user hooks
757 if have_filedata:
757 if have_filedata:
758 ipinst = get_ipython()
758 ipinst = get_ipython()
759 if ipinst is not None:
759 if ipinst is not None:
760 ipinst.hooks.synchronize_with_editor(value.filename, value.lineno, 0)
760 ipinst.hooks.synchronize_with_editor(value.filename, value.lineno, 0)
761
761
762 return list
762 return list
763
763
764 def get_exception_only(self, etype, value):
764 def get_exception_only(self, etype, value):
765 """Only print the exception type and message, without a traceback.
765 """Only print the exception type and message, without a traceback.
766
766
767 Parameters
767 Parameters
768 ----------
768 ----------
769 etype : exception type
769 etype : exception type
770 value : exception value
770 value : exception value
771 """
771 """
772 return ListTB.structured_traceback(self, etype, value, [])
772 return ListTB.structured_traceback(self, etype, value, [])
773
773
774 def show_exception_only(self, etype, evalue):
774 def show_exception_only(self, etype, evalue):
775 """Only print the exception type and message, without a traceback.
775 """Only print the exception type and message, without a traceback.
776
776
777 Parameters
777 Parameters
778 ----------
778 ----------
779 etype : exception type
779 etype : exception type
780 value : exception value
780 value : exception value
781 """
781 """
782 # This method needs to use __call__ from *this* class, not the one from
782 # This method needs to use __call__ from *this* class, not the one from
783 # a subclass whose signature or behavior may be different
783 # a subclass whose signature or behavior may be different
784 ostream = self.ostream
784 ostream = self.ostream
785 ostream.flush()
785 ostream.flush()
786 ostream.write('\n'.join(self.get_exception_only(etype, evalue)))
786 ostream.write('\n'.join(self.get_exception_only(etype, evalue)))
787 ostream.flush()
787 ostream.flush()
788
788
789 def _some_str(self, value):
789 def _some_str(self, value):
790 # Lifted from traceback.py
790 # Lifted from traceback.py
791 try:
791 try:
792 return str(value)
792 return str(value)
793 except:
793 except:
794 return '<unprintable %s object>' % type(value).__name__
794 return '<unprintable %s object>' % type(value).__name__
795
795
796
796
797 #----------------------------------------------------------------------------
797 #----------------------------------------------------------------------------
798 class VerboseTB(TBTools):
798 class VerboseTB(TBTools):
799 """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead
799 """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead
800 of HTML. Requires inspect and pydoc. Crazy, man.
800 of HTML. Requires inspect and pydoc. Crazy, man.
801
801
802 Modified version which optionally strips the topmost entries from the
802 Modified version which optionally strips the topmost entries from the
803 traceback, to be used with alternate interpreters (because their own code
803 traceback, to be used with alternate interpreters (because their own code
804 would appear in the traceback)."""
804 would appear in the traceback)."""
805
805
806 def __init__(self, color_scheme='Linux', call_pdb=False, ostream=None,
806 def __init__(self, color_scheme='Linux', call_pdb=False, ostream=None,
807 tb_offset=0, long_header=False, include_vars=True,
807 tb_offset=0, long_header=False, include_vars=True,
808 check_cache=None):
808 check_cache=None):
809 """Specify traceback offset, headers and color scheme.
809 """Specify traceback offset, headers and color scheme.
810
810
811 Define how many frames to drop from the tracebacks. Calling it with
811 Define how many frames to drop from the tracebacks. Calling it with
812 tb_offset=1 allows use of this handler in interpreters which will have
812 tb_offset=1 allows use of this handler in interpreters which will have
813 their own code at the top of the traceback (VerboseTB will first
813 their own code at the top of the traceback (VerboseTB will first
814 remove that frame before printing the traceback info)."""
814 remove that frame before printing the traceback info)."""
815 TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb,
815 TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb,
816 ostream=ostream)
816 ostream=ostream)
817 self.tb_offset = tb_offset
817 self.tb_offset = tb_offset
818 self.long_header = long_header
818 self.long_header = long_header
819 self.include_vars = include_vars
819 self.include_vars = include_vars
820 # By default we use linecache.checkcache, but the user can provide a
820 # By default we use linecache.checkcache, but the user can provide a
821 # different check_cache implementation. This is used by the IPython
821 # different check_cache implementation. This is used by the IPython
822 # kernel to provide tracebacks for interactive code that is cached,
822 # kernel to provide tracebacks for interactive code that is cached,
823 # by a compiler instance that flushes the linecache but preserves its
823 # by a compiler instance that flushes the linecache but preserves its
824 # own code cache.
824 # own code cache.
825 if check_cache is None:
825 if check_cache is None:
826 check_cache = linecache.checkcache
826 check_cache = linecache.checkcache
827 self.check_cache = check_cache
827 self.check_cache = check_cache
828
828
829 def format_records(self, records, last_unique, recursion_repeat):
829 def format_records(self, records, last_unique, recursion_repeat):
830 """Format the stack frames of the traceback"""
830 """Format the stack frames of the traceback"""
831 frames = []
831 frames = []
832 for r in records[:last_unique+recursion_repeat+1]:
832 for r in records[:last_unique+recursion_repeat+1]:
833 #print '*** record:',file,lnum,func,lines,index # dbg
833 #print '*** record:',file,lnum,func,lines,index # dbg
834 frames.append(self.format_record(*r))
834 frames.append(self.format_record(*r))
835
835
836 if recursion_repeat:
836 if recursion_repeat:
837 frames.append('Last %d frames repeated, from:\n' % recursion_repeat)
837 frames.append('... last %d frames repeated, from the frame below ...\n' % recursion_repeat)
838 frames.append(self.format_record(*records[last_unique+recursion_repeat+1]))
838 frames.append(self.format_record(*records[last_unique+recursion_repeat+1]))
839
839
840 return frames
840 return frames
841
841
842 def format_record(self, frame, file, lnum, func, lines, index):
842 def format_record(self, frame, file, lnum, func, lines, index):
843 """Format a single stack frame"""
843 """Format a single stack frame"""
844 Colors = self.Colors # just a shorthand + quicker name lookup
844 Colors = self.Colors # just a shorthand + quicker name lookup
845 ColorsNormal = Colors.Normal # used a lot
845 ColorsNormal = Colors.Normal # used a lot
846 col_scheme = self.color_scheme_table.active_scheme_name
846 col_scheme = self.color_scheme_table.active_scheme_name
847 indent = ' ' * INDENT_SIZE
847 indent = ' ' * INDENT_SIZE
848 em_normal = '%s\n%s%s' % (Colors.valEm, indent, ColorsNormal)
848 em_normal = '%s\n%s%s' % (Colors.valEm, indent, ColorsNormal)
849 undefined = '%sundefined%s' % (Colors.em, ColorsNormal)
849 undefined = '%sundefined%s' % (Colors.em, ColorsNormal)
850 tpl_link = '%s%%s%s' % (Colors.filenameEm, ColorsNormal)
850 tpl_link = '%s%%s%s' % (Colors.filenameEm, ColorsNormal)
851 tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm,
851 tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm,
852 ColorsNormal)
852 ColorsNormal)
853 tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \
853 tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \
854 (Colors.vName, Colors.valEm, ColorsNormal)
854 (Colors.vName, Colors.valEm, ColorsNormal)
855 tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal)
855 tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal)
856 tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal,
856 tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal,
857 Colors.vName, ColorsNormal)
857 Colors.vName, ColorsNormal)
858 tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal)
858 tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal)
859
859
860 tpl_line = '%s%%s%s %%s' % (Colors.lineno, ColorsNormal)
860 tpl_line = '%s%%s%s %%s' % (Colors.lineno, ColorsNormal)
861 tpl_line_em = '%s%%s%s %%s%s' % (Colors.linenoEm, Colors.line,
861 tpl_line_em = '%s%%s%s %%s%s' % (Colors.linenoEm, Colors.line,
862 ColorsNormal)
862 ColorsNormal)
863
863
864 abspath = os.path.abspath
864 abspath = os.path.abspath
865
865
866
866
867 if not file:
867 if not file:
868 file = '?'
868 file = '?'
869 elif file.startswith(str("<")) and file.endswith(str(">")):
869 elif file.startswith(str("<")) and file.endswith(str(">")):
870 # Not a real filename, no problem...
870 # Not a real filename, no problem...
871 pass
871 pass
872 elif not os.path.isabs(file):
872 elif not os.path.isabs(file):
873 # Try to make the filename absolute by trying all
873 # Try to make the filename absolute by trying all
874 # sys.path entries (which is also what linecache does)
874 # sys.path entries (which is also what linecache does)
875 for dirname in sys.path:
875 for dirname in sys.path:
876 try:
876 try:
877 fullname = os.path.join(dirname, file)
877 fullname = os.path.join(dirname, file)
878 if os.path.isfile(fullname):
878 if os.path.isfile(fullname):
879 file = os.path.abspath(fullname)
879 file = os.path.abspath(fullname)
880 break
880 break
881 except Exception:
881 except Exception:
882 # Just in case that sys.path contains very
882 # Just in case that sys.path contains very
883 # strange entries...
883 # strange entries...
884 pass
884 pass
885
885
886 file = py3compat.cast_unicode(file, util_path.fs_encoding)
886 file = py3compat.cast_unicode(file, util_path.fs_encoding)
887 link = tpl_link % file
887 link = tpl_link % file
888 args, varargs, varkw, locals = fixed_getargvalues(frame)
888 args, varargs, varkw, locals = fixed_getargvalues(frame)
889
889
890 if func == '?':
890 if func == '?':
891 call = ''
891 call = ''
892 else:
892 else:
893 # Decide whether to include variable details or not
893 # Decide whether to include variable details or not
894 var_repr = self.include_vars and eqrepr or nullrepr
894 var_repr = self.include_vars and eqrepr or nullrepr
895 try:
895 try:
896 call = tpl_call % (func, inspect.formatargvalues(args,
896 call = tpl_call % (func, inspect.formatargvalues(args,
897 varargs, varkw,
897 varargs, varkw,
898 locals, formatvalue=var_repr))
898 locals, formatvalue=var_repr))
899 except KeyError:
899 except KeyError:
900 # This happens in situations like errors inside generator
900 # This happens in situations like errors inside generator
901 # expressions, where local variables are listed in the
901 # expressions, where local variables are listed in the
902 # line, but can't be extracted from the frame. I'm not
902 # line, but can't be extracted from the frame. I'm not
903 # 100% sure this isn't actually a bug in inspect itself,
903 # 100% sure this isn't actually a bug in inspect itself,
904 # but since there's no info for us to compute with, the
904 # but since there's no info for us to compute with, the
905 # best we can do is report the failure and move on. Here
905 # best we can do is report the failure and move on. Here
906 # we must *not* call any traceback construction again,
906 # we must *not* call any traceback construction again,
907 # because that would mess up use of %debug later on. So we
907 # because that would mess up use of %debug later on. So we
908 # simply report the failure and move on. The only
908 # simply report the failure and move on. The only
909 # limitation will be that this frame won't have locals
909 # limitation will be that this frame won't have locals
910 # listed in the call signature. Quite subtle problem...
910 # listed in the call signature. Quite subtle problem...
911 # I can't think of a good way to validate this in a unit
911 # I can't think of a good way to validate this in a unit
912 # test, but running a script consisting of:
912 # test, but running a script consisting of:
913 # dict( (k,v.strip()) for (k,v) in range(10) )
913 # dict( (k,v.strip()) for (k,v) in range(10) )
914 # will illustrate the error, if this exception catch is
914 # will illustrate the error, if this exception catch is
915 # disabled.
915 # disabled.
916 call = tpl_call_fail % func
916 call = tpl_call_fail % func
917
917
918 # Don't attempt to tokenize binary files.
918 # Don't attempt to tokenize binary files.
919 if file.endswith(('.so', '.pyd', '.dll')):
919 if file.endswith(('.so', '.pyd', '.dll')):
920 return '%s %s\n' % (link, call)
920 return '%s %s\n' % (link, call)
921
921
922 elif file.endswith(('.pyc', '.pyo')):
922 elif file.endswith(('.pyc', '.pyo')):
923 # Look up the corresponding source file.
923 # Look up the corresponding source file.
924 file = openpy.source_from_cache(file)
924 file = openpy.source_from_cache(file)
925
925
926 def linereader(file=file, lnum=[lnum], getline=ulinecache.getline):
926 def linereader(file=file, lnum=[lnum], getline=ulinecache.getline):
927 line = getline(file, lnum[0])
927 line = getline(file, lnum[0])
928 lnum[0] += 1
928 lnum[0] += 1
929 return line
929 return line
930
930
931 # Build the list of names on this line of code where the exception
931 # Build the list of names on this line of code where the exception
932 # occurred.
932 # occurred.
933 try:
933 try:
934 names = []
934 names = []
935 name_cont = False
935 name_cont = False
936
936
937 for token_type, token, start, end, line in generate_tokens(linereader):
937 for token_type, token, start, end, line in generate_tokens(linereader):
938 # build composite names
938 # build composite names
939 if token_type == tokenize.NAME and token not in keyword.kwlist:
939 if token_type == tokenize.NAME and token not in keyword.kwlist:
940 if name_cont:
940 if name_cont:
941 # Continuation of a dotted name
941 # Continuation of a dotted name
942 try:
942 try:
943 names[-1].append(token)
943 names[-1].append(token)
944 except IndexError:
944 except IndexError:
945 names.append([token])
945 names.append([token])
946 name_cont = False
946 name_cont = False
947 else:
947 else:
948 # Regular new names. We append everything, the caller
948 # Regular new names. We append everything, the caller
949 # will be responsible for pruning the list later. It's
949 # will be responsible for pruning the list later. It's
950 # very tricky to try to prune as we go, b/c composite
950 # very tricky to try to prune as we go, b/c composite
951 # names can fool us. The pruning at the end is easy
951 # names can fool us. The pruning at the end is easy
952 # to do (or the caller can print a list with repeated
952 # to do (or the caller can print a list with repeated
953 # names if so desired.
953 # names if so desired.
954 names.append([token])
954 names.append([token])
955 elif token == '.':
955 elif token == '.':
956 name_cont = True
956 name_cont = True
957 elif token_type == tokenize.NEWLINE:
957 elif token_type == tokenize.NEWLINE:
958 break
958 break
959
959
960 except (IndexError, UnicodeDecodeError, SyntaxError):
960 except (IndexError, UnicodeDecodeError, SyntaxError):
961 # signals exit of tokenizer
961 # signals exit of tokenizer
962 # SyntaxError can occur if the file is not actually Python
962 # SyntaxError can occur if the file is not actually Python
963 # - see gh-6300
963 # - see gh-6300
964 pass
964 pass
965 except tokenize.TokenError as msg:
965 except tokenize.TokenError as msg:
966 _m = ("An unexpected error occurred while tokenizing input\n"
966 _m = ("An unexpected error occurred while tokenizing input\n"
967 "The following traceback may be corrupted or invalid\n"
967 "The following traceback may be corrupted or invalid\n"
968 "The error message is: %s\n" % msg)
968 "The error message is: %s\n" % msg)
969 error(_m)
969 error(_m)
970
970
971 # Join composite names (e.g. "dict.fromkeys")
971 # Join composite names (e.g. "dict.fromkeys")
972 names = ['.'.join(n) for n in names]
972 names = ['.'.join(n) for n in names]
973 # prune names list of duplicates, but keep the right order
973 # prune names list of duplicates, but keep the right order
974 unique_names = uniq_stable(names)
974 unique_names = uniq_stable(names)
975
975
976 # Start loop over vars
976 # Start loop over vars
977 lvals = []
977 lvals = []
978 if self.include_vars:
978 if self.include_vars:
979 for name_full in unique_names:
979 for name_full in unique_names:
980 name_base = name_full.split('.', 1)[0]
980 name_base = name_full.split('.', 1)[0]
981 if name_base in frame.f_code.co_varnames:
981 if name_base in frame.f_code.co_varnames:
982 if name_base in locals:
982 if name_base in locals:
983 try:
983 try:
984 value = repr(eval(name_full, locals))
984 value = repr(eval(name_full, locals))
985 except:
985 except:
986 value = undefined
986 value = undefined
987 else:
987 else:
988 value = undefined
988 value = undefined
989 name = tpl_local_var % name_full
989 name = tpl_local_var % name_full
990 else:
990 else:
991 if name_base in frame.f_globals:
991 if name_base in frame.f_globals:
992 try:
992 try:
993 value = repr(eval(name_full, frame.f_globals))
993 value = repr(eval(name_full, frame.f_globals))
994 except:
994 except:
995 value = undefined
995 value = undefined
996 else:
996 else:
997 value = undefined
997 value = undefined
998 name = tpl_global_var % name_full
998 name = tpl_global_var % name_full
999 lvals.append(tpl_name_val % (name, value))
999 lvals.append(tpl_name_val % (name, value))
1000 if lvals:
1000 if lvals:
1001 lvals = '%s%s' % (indent, em_normal.join(lvals))
1001 lvals = '%s%s' % (indent, em_normal.join(lvals))
1002 else:
1002 else:
1003 lvals = ''
1003 lvals = ''
1004
1004
1005 level = '%s %s\n' % (link, call)
1005 level = '%s %s\n' % (link, call)
1006
1006
1007 if index is None:
1007 if index is None:
1008 return level
1008 return level
1009 else:
1009 else:
1010 return '%s%s' % (level, ''.join(
1010 return '%s%s' % (level, ''.join(
1011 _format_traceback_lines(lnum, index, lines, Colors, lvals,
1011 _format_traceback_lines(lnum, index, lines, Colors, lvals,
1012 col_scheme)))
1012 col_scheme)))
1013
1013
1014 def prepare_chained_exception_message(self, cause):
1014 def prepare_chained_exception_message(self, cause):
1015 direct_cause = "\nThe above exception was the direct cause of the following exception:\n"
1015 direct_cause = "\nThe above exception was the direct cause of the following exception:\n"
1016 exception_during_handling = "\nDuring handling of the above exception, another exception occurred:\n"
1016 exception_during_handling = "\nDuring handling of the above exception, another exception occurred:\n"
1017
1017
1018 if cause:
1018 if cause:
1019 message = [[direct_cause]]
1019 message = [[direct_cause]]
1020 else:
1020 else:
1021 message = [[exception_during_handling]]
1021 message = [[exception_during_handling]]
1022 return message
1022 return message
1023
1023
1024 def prepare_header(self, etype, long_version=False):
1024 def prepare_header(self, etype, long_version=False):
1025 colors = self.Colors # just a shorthand + quicker name lookup
1025 colors = self.Colors # just a shorthand + quicker name lookup
1026 colorsnormal = colors.Normal # used a lot
1026 colorsnormal = colors.Normal # used a lot
1027 exc = '%s%s%s' % (colors.excName, etype, colorsnormal)
1027 exc = '%s%s%s' % (colors.excName, etype, colorsnormal)
1028 if long_version:
1028 if long_version:
1029 # Header with the exception type, python version, and date
1029 # Header with the exception type, python version, and date
1030 pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable
1030 pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable
1031 date = time.ctime(time.time())
1031 date = time.ctime(time.time())
1032
1032
1033 head = '%s%s%s\n%s%s%s\n%s' % (colors.topline, '-' * 75, colorsnormal,
1033 head = '%s%s%s\n%s%s%s\n%s' % (colors.topline, '-' * 75, colorsnormal,
1034 exc, ' ' * (75 - len(str(etype)) - len(pyver)),
1034 exc, ' ' * (75 - len(str(etype)) - len(pyver)),
1035 pyver, date.rjust(75) )
1035 pyver, date.rjust(75) )
1036 head += "\nA problem occurred executing Python code. Here is the sequence of function" \
1036 head += "\nA problem occurred executing Python code. Here is the sequence of function" \
1037 "\ncalls leading up to the error, with the most recent (innermost) call last."
1037 "\ncalls leading up to the error, with the most recent (innermost) call last."
1038 else:
1038 else:
1039 # Simplified header
1039 # Simplified header
1040 head = '%s%s' % (exc, 'Traceback (most recent call last)'. \
1040 head = '%s%s' % (exc, 'Traceback (most recent call last)'. \
1041 rjust(75 - len(str(etype))) )
1041 rjust(75 - len(str(etype))) )
1042
1042
1043 return head
1043 return head
1044
1044
1045 def format_exception(self, etype, evalue):
1045 def format_exception(self, etype, evalue):
1046 colors = self.Colors # just a shorthand + quicker name lookup
1046 colors = self.Colors # just a shorthand + quicker name lookup
1047 colorsnormal = colors.Normal # used a lot
1047 colorsnormal = colors.Normal # used a lot
1048 indent = ' ' * INDENT_SIZE
1048 indent = ' ' * INDENT_SIZE
1049 # Get (safely) a string form of the exception info
1049 # Get (safely) a string form of the exception info
1050 try:
1050 try:
1051 etype_str, evalue_str = map(str, (etype, evalue))
1051 etype_str, evalue_str = map(str, (etype, evalue))
1052 except:
1052 except:
1053 # User exception is improperly defined.
1053 # User exception is improperly defined.
1054 etype, evalue = str, sys.exc_info()[:2]
1054 etype, evalue = str, sys.exc_info()[:2]
1055 etype_str, evalue_str = map(str, (etype, evalue))
1055 etype_str, evalue_str = map(str, (etype, evalue))
1056 # ... and format it
1056 # ... and format it
1057 exception = ['%s%s%s: %s' % (colors.excName, etype_str,
1057 exception = ['%s%s%s: %s' % (colors.excName, etype_str,
1058 colorsnormal, py3compat.cast_unicode(evalue_str))]
1058 colorsnormal, py3compat.cast_unicode(evalue_str))]
1059
1059
1060 if (not py3compat.PY3) and type(evalue) is types.InstanceType:
1060 if (not py3compat.PY3) and type(evalue) is types.InstanceType:
1061 try:
1061 try:
1062 names = [w for w in dir(evalue) if isinstance(w, py3compat.string_types)]
1062 names = [w for w in dir(evalue) if isinstance(w, py3compat.string_types)]
1063 except:
1063 except:
1064 # Every now and then, an object with funny internals blows up
1064 # Every now and then, an object with funny internals blows up
1065 # when dir() is called on it. We do the best we can to report
1065 # when dir() is called on it. We do the best we can to report
1066 # the problem and continue
1066 # the problem and continue
1067 _m = '%sException reporting error (object with broken dir())%s:'
1067 _m = '%sException reporting error (object with broken dir())%s:'
1068 exception.append(_m % (colors.excName, colorsnormal))
1068 exception.append(_m % (colors.excName, colorsnormal))
1069 etype_str, evalue_str = map(str, sys.exc_info()[:2])
1069 etype_str, evalue_str = map(str, sys.exc_info()[:2])
1070 exception.append('%s%s%s: %s' % (colors.excName, etype_str,
1070 exception.append('%s%s%s: %s' % (colors.excName, etype_str,
1071 colorsnormal, py3compat.cast_unicode(evalue_str)))
1071 colorsnormal, py3compat.cast_unicode(evalue_str)))
1072 names = []
1072 names = []
1073 for name in names:
1073 for name in names:
1074 value = text_repr(getattr(evalue, name))
1074 value = text_repr(getattr(evalue, name))
1075 exception.append('\n%s%s = %s' % (indent, name, value))
1075 exception.append('\n%s%s = %s' % (indent, name, value))
1076
1076
1077 return exception
1077 return exception
1078
1078
1079 def format_exception_as_a_whole(self, etype, evalue, etb, number_of_lines_of_context, tb_offset):
1079 def format_exception_as_a_whole(self, etype, evalue, etb, number_of_lines_of_context, tb_offset):
1080 """Formats the header, traceback and exception message for a single exception.
1080 """Formats the header, traceback and exception message for a single exception.
1081
1081
1082 This may be called multiple times by Python 3 exception chaining
1082 This may be called multiple times by Python 3 exception chaining
1083 (PEP 3134).
1083 (PEP 3134).
1084 """
1084 """
1085 # some locals
1085 # some locals
1086 orig_etype = etype
1086 orig_etype = etype
1087 try:
1087 try:
1088 etype = etype.__name__
1088 etype = etype.__name__
1089 except AttributeError:
1089 except AttributeError:
1090 pass
1090 pass
1091
1091
1092 tb_offset = self.tb_offset if tb_offset is None else tb_offset
1092 tb_offset = self.tb_offset if tb_offset is None else tb_offset
1093 head = self.prepare_header(etype, self.long_header)
1093 head = self.prepare_header(etype, self.long_header)
1094 records = self.get_records(etb, number_of_lines_of_context, tb_offset)
1094 records = self.get_records(etb, number_of_lines_of_context, tb_offset)
1095
1095
1096 if records is None:
1096 if records is None:
1097 return ""
1097 return ""
1098
1098
1099 last_unique, recursion_repeat = find_recursion(orig_etype, evalue, records)
1099 last_unique, recursion_repeat = find_recursion(orig_etype, evalue, records)
1100
1100
1101 frames = self.format_records(records, last_unique, recursion_repeat)
1101 frames = self.format_records(records, last_unique, recursion_repeat)
1102
1102
1103 formatted_exception = self.format_exception(etype, evalue)
1103 formatted_exception = self.format_exception(etype, evalue)
1104 if records:
1104 if records:
1105 filepath, lnum = records[-1][1:3]
1105 filepath, lnum = records[-1][1:3]
1106 filepath = os.path.abspath(filepath)
1106 filepath = os.path.abspath(filepath)
1107 ipinst = get_ipython()
1107 ipinst = get_ipython()
1108 if ipinst is not None:
1108 if ipinst is not None:
1109 ipinst.hooks.synchronize_with_editor(filepath, lnum, 0)
1109 ipinst.hooks.synchronize_with_editor(filepath, lnum, 0)
1110
1110
1111 return [[head] + frames + [''.join(formatted_exception[0])]]
1111 return [[head] + frames + [''.join(formatted_exception[0])]]
1112
1112
1113 def get_records(self, etb, number_of_lines_of_context, tb_offset):
1113 def get_records(self, etb, number_of_lines_of_context, tb_offset):
1114 try:
1114 try:
1115 # Try the default getinnerframes and Alex's: Alex's fixes some
1115 # Try the default getinnerframes and Alex's: Alex's fixes some
1116 # problems, but it generates empty tracebacks for console errors
1116 # problems, but it generates empty tracebacks for console errors
1117 # (5 blanks lines) where none should be returned.
1117 # (5 blanks lines) where none should be returned.
1118 return _fixed_getinnerframes(etb, number_of_lines_of_context, tb_offset)
1118 return _fixed_getinnerframes(etb, number_of_lines_of_context, tb_offset)
1119 except:
1119 except:
1120 # FIXME: I've been getting many crash reports from python 2.3
1120 # FIXME: I've been getting many crash reports from python 2.3
1121 # users, traceable to inspect.py. If I can find a small test-case
1121 # users, traceable to inspect.py. If I can find a small test-case
1122 # to reproduce this, I should either write a better workaround or
1122 # to reproduce this, I should either write a better workaround or
1123 # file a bug report against inspect (if that's the real problem).
1123 # file a bug report against inspect (if that's the real problem).
1124 # So far, I haven't been able to find an isolated example to
1124 # So far, I haven't been able to find an isolated example to
1125 # reproduce the problem.
1125 # reproduce the problem.
1126 inspect_error()
1126 inspect_error()
1127 traceback.print_exc(file=self.ostream)
1127 traceback.print_exc(file=self.ostream)
1128 info('\nUnfortunately, your original traceback can not be constructed.\n')
1128 info('\nUnfortunately, your original traceback can not be constructed.\n')
1129 return None
1129 return None
1130
1130
1131 def get_parts_of_chained_exception(self, evalue):
1131 def get_parts_of_chained_exception(self, evalue):
1132 def get_chained_exception(exception_value):
1132 def get_chained_exception(exception_value):
1133 cause = getattr(exception_value, '__cause__', None)
1133 cause = getattr(exception_value, '__cause__', None)
1134 if cause:
1134 if cause:
1135 return cause
1135 return cause
1136 if getattr(exception_value, '__suppress_context__', False):
1136 if getattr(exception_value, '__suppress_context__', False):
1137 return None
1137 return None
1138 return getattr(exception_value, '__context__', None)
1138 return getattr(exception_value, '__context__', None)
1139
1139
1140 chained_evalue = get_chained_exception(evalue)
1140 chained_evalue = get_chained_exception(evalue)
1141
1141
1142 if chained_evalue:
1142 if chained_evalue:
1143 return chained_evalue.__class__, chained_evalue, chained_evalue.__traceback__
1143 return chained_evalue.__class__, chained_evalue, chained_evalue.__traceback__
1144
1144
1145 def structured_traceback(self, etype, evalue, etb, tb_offset=None,
1145 def structured_traceback(self, etype, evalue, etb, tb_offset=None,
1146 number_of_lines_of_context=5):
1146 number_of_lines_of_context=5):
1147 """Return a nice text document describing the traceback."""
1147 """Return a nice text document describing the traceback."""
1148
1148
1149 formatted_exception = self.format_exception_as_a_whole(etype, evalue, etb, number_of_lines_of_context,
1149 formatted_exception = self.format_exception_as_a_whole(etype, evalue, etb, number_of_lines_of_context,
1150 tb_offset)
1150 tb_offset)
1151
1151
1152 colors = self.Colors # just a shorthand + quicker name lookup
1152 colors = self.Colors # just a shorthand + quicker name lookup
1153 colorsnormal = colors.Normal # used a lot
1153 colorsnormal = colors.Normal # used a lot
1154 head = '%s%s%s' % (colors.topline, '-' * 75, colorsnormal)
1154 head = '%s%s%s' % (colors.topline, '-' * 75, colorsnormal)
1155 structured_traceback_parts = [head]
1155 structured_traceback_parts = [head]
1156 if py3compat.PY3:
1156 if py3compat.PY3:
1157 chained_exceptions_tb_offset = 0
1157 chained_exceptions_tb_offset = 0
1158 lines_of_context = 3
1158 lines_of_context = 3
1159 formatted_exceptions = formatted_exception
1159 formatted_exceptions = formatted_exception
1160 exception = self.get_parts_of_chained_exception(evalue)
1160 exception = self.get_parts_of_chained_exception(evalue)
1161 if exception:
1161 if exception:
1162 formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__)
1162 formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__)
1163 etype, evalue, etb = exception
1163 etype, evalue, etb = exception
1164 else:
1164 else:
1165 evalue = None
1165 evalue = None
1166 chained_exc_ids = set()
1166 chained_exc_ids = set()
1167 while evalue:
1167 while evalue:
1168 formatted_exceptions += self.format_exception_as_a_whole(etype, evalue, etb, lines_of_context,
1168 formatted_exceptions += self.format_exception_as_a_whole(etype, evalue, etb, lines_of_context,
1169 chained_exceptions_tb_offset)
1169 chained_exceptions_tb_offset)
1170 exception = self.get_parts_of_chained_exception(evalue)
1170 exception = self.get_parts_of_chained_exception(evalue)
1171
1171
1172 if exception and not id(exception[1]) in chained_exc_ids:
1172 if exception and not id(exception[1]) in chained_exc_ids:
1173 chained_exc_ids.add(id(exception[1])) # trace exception to avoid infinite 'cause' loop
1173 chained_exc_ids.add(id(exception[1])) # trace exception to avoid infinite 'cause' loop
1174 formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__)
1174 formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__)
1175 etype, evalue, etb = exception
1175 etype, evalue, etb = exception
1176 else:
1176 else:
1177 evalue = None
1177 evalue = None
1178
1178
1179 # we want to see exceptions in a reversed order:
1179 # we want to see exceptions in a reversed order:
1180 # the first exception should be on top
1180 # the first exception should be on top
1181 for formatted_exception in reversed(formatted_exceptions):
1181 for formatted_exception in reversed(formatted_exceptions):
1182 structured_traceback_parts += formatted_exception
1182 structured_traceback_parts += formatted_exception
1183 else:
1183 else:
1184 structured_traceback_parts += formatted_exception[0]
1184 structured_traceback_parts += formatted_exception[0]
1185
1185
1186 return structured_traceback_parts
1186 return structured_traceback_parts
1187
1187
1188 def debugger(self, force=False):
1188 def debugger(self, force=False):
1189 """Call up the pdb debugger if desired, always clean up the tb
1189 """Call up the pdb debugger if desired, always clean up the tb
1190 reference.
1190 reference.
1191
1191
1192 Keywords:
1192 Keywords:
1193
1193
1194 - force(False): by default, this routine checks the instance call_pdb
1194 - force(False): by default, this routine checks the instance call_pdb
1195 flag and does not actually invoke the debugger if the flag is false.
1195 flag and does not actually invoke the debugger if the flag is false.
1196 The 'force' option forces the debugger to activate even if the flag
1196 The 'force' option forces the debugger to activate even if the flag
1197 is false.
1197 is false.
1198
1198
1199 If the call_pdb flag is set, the pdb interactive debugger is
1199 If the call_pdb flag is set, the pdb interactive debugger is
1200 invoked. In all cases, the self.tb reference to the current traceback
1200 invoked. In all cases, the self.tb reference to the current traceback
1201 is deleted to prevent lingering references which hamper memory
1201 is deleted to prevent lingering references which hamper memory
1202 management.
1202 management.
1203
1203
1204 Note that each call to pdb() does an 'import readline', so if your app
1204 Note that each call to pdb() does an 'import readline', so if your app
1205 requires a special setup for the readline completers, you'll have to
1205 requires a special setup for the readline completers, you'll have to
1206 fix that by hand after invoking the exception handler."""
1206 fix that by hand after invoking the exception handler."""
1207
1207
1208 if force or self.call_pdb:
1208 if force or self.call_pdb:
1209 if self.pdb is None:
1209 if self.pdb is None:
1210 self.pdb = debugger.Pdb(
1210 self.pdb = debugger.Pdb(
1211 self.color_scheme_table.active_scheme_name)
1211 self.color_scheme_table.active_scheme_name)
1212 # the system displayhook may have changed, restore the original
1212 # the system displayhook may have changed, restore the original
1213 # for pdb
1213 # for pdb
1214 display_trap = DisplayTrap(hook=sys.__displayhook__)
1214 display_trap = DisplayTrap(hook=sys.__displayhook__)
1215 with display_trap:
1215 with display_trap:
1216 self.pdb.reset()
1216 self.pdb.reset()
1217 # Find the right frame so we don't pop up inside ipython itself
1217 # Find the right frame so we don't pop up inside ipython itself
1218 if hasattr(self, 'tb') and self.tb is not None:
1218 if hasattr(self, 'tb') and self.tb is not None:
1219 etb = self.tb
1219 etb = self.tb
1220 else:
1220 else:
1221 etb = self.tb = sys.last_traceback
1221 etb = self.tb = sys.last_traceback
1222 while self.tb is not None and self.tb.tb_next is not None:
1222 while self.tb is not None and self.tb.tb_next is not None:
1223 self.tb = self.tb.tb_next
1223 self.tb = self.tb.tb_next
1224 if etb and etb.tb_next:
1224 if etb and etb.tb_next:
1225 etb = etb.tb_next
1225 etb = etb.tb_next
1226 self.pdb.botframe = etb.tb_frame
1226 self.pdb.botframe = etb.tb_frame
1227 self.pdb.interaction(self.tb.tb_frame, self.tb)
1227 self.pdb.interaction(self.tb.tb_frame, self.tb)
1228
1228
1229 if hasattr(self, 'tb'):
1229 if hasattr(self, 'tb'):
1230 del self.tb
1230 del self.tb
1231
1231
1232 def handler(self, info=None):
1232 def handler(self, info=None):
1233 (etype, evalue, etb) = info or sys.exc_info()
1233 (etype, evalue, etb) = info or sys.exc_info()
1234 self.tb = etb
1234 self.tb = etb
1235 ostream = self.ostream
1235 ostream = self.ostream
1236 ostream.flush()
1236 ostream.flush()
1237 ostream.write(self.text(etype, evalue, etb))
1237 ostream.write(self.text(etype, evalue, etb))
1238 ostream.write('\n')
1238 ostream.write('\n')
1239 ostream.flush()
1239 ostream.flush()
1240
1240
1241 # Changed so an instance can just be called as VerboseTB_inst() and print
1241 # Changed so an instance can just be called as VerboseTB_inst() and print
1242 # out the right info on its own.
1242 # out the right info on its own.
1243 def __call__(self, etype=None, evalue=None, etb=None):
1243 def __call__(self, etype=None, evalue=None, etb=None):
1244 """This hook can replace sys.excepthook (for Python 2.1 or higher)."""
1244 """This hook can replace sys.excepthook (for Python 2.1 or higher)."""
1245 if etb is None:
1245 if etb is None:
1246 self.handler()
1246 self.handler()
1247 else:
1247 else:
1248 self.handler((etype, evalue, etb))
1248 self.handler((etype, evalue, etb))
1249 try:
1249 try:
1250 self.debugger()
1250 self.debugger()
1251 except KeyboardInterrupt:
1251 except KeyboardInterrupt:
1252 print("\nKeyboardInterrupt")
1252 print("\nKeyboardInterrupt")
1253
1253
1254
1254
1255 #----------------------------------------------------------------------------
1255 #----------------------------------------------------------------------------
1256 class FormattedTB(VerboseTB, ListTB):
1256 class FormattedTB(VerboseTB, ListTB):
1257 """Subclass ListTB but allow calling with a traceback.
1257 """Subclass ListTB but allow calling with a traceback.
1258
1258
1259 It can thus be used as a sys.excepthook for Python > 2.1.
1259 It can thus be used as a sys.excepthook for Python > 2.1.
1260
1260
1261 Also adds 'Context' and 'Verbose' modes, not available in ListTB.
1261 Also adds 'Context' and 'Verbose' modes, not available in ListTB.
1262
1262
1263 Allows a tb_offset to be specified. This is useful for situations where
1263 Allows a tb_offset to be specified. This is useful for situations where
1264 one needs to remove a number of topmost frames from the traceback (such as
1264 one needs to remove a number of topmost frames from the traceback (such as
1265 occurs with python programs that themselves execute other python code,
1265 occurs with python programs that themselves execute other python code,
1266 like Python shells). """
1266 like Python shells). """
1267
1267
1268 def __init__(self, mode='Plain', color_scheme='Linux', call_pdb=False,
1268 def __init__(self, mode='Plain', color_scheme='Linux', call_pdb=False,
1269 ostream=None,
1269 ostream=None,
1270 tb_offset=0, long_header=False, include_vars=False,
1270 tb_offset=0, long_header=False, include_vars=False,
1271 check_cache=None):
1271 check_cache=None):
1272
1272
1273 # NEVER change the order of this list. Put new modes at the end:
1273 # NEVER change the order of this list. Put new modes at the end:
1274 self.valid_modes = ['Plain', 'Context', 'Verbose']
1274 self.valid_modes = ['Plain', 'Context', 'Verbose']
1275 self.verbose_modes = self.valid_modes[1:3]
1275 self.verbose_modes = self.valid_modes[1:3]
1276
1276
1277 VerboseTB.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb,
1277 VerboseTB.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb,
1278 ostream=ostream, tb_offset=tb_offset,
1278 ostream=ostream, tb_offset=tb_offset,
1279 long_header=long_header, include_vars=include_vars,
1279 long_header=long_header, include_vars=include_vars,
1280 check_cache=check_cache)
1280 check_cache=check_cache)
1281
1281
1282 # Different types of tracebacks are joined with different separators to
1282 # Different types of tracebacks are joined with different separators to
1283 # form a single string. They are taken from this dict
1283 # form a single string. They are taken from this dict
1284 self._join_chars = dict(Plain='', Context='\n', Verbose='\n')
1284 self._join_chars = dict(Plain='', Context='\n', Verbose='\n')
1285 # set_mode also sets the tb_join_char attribute
1285 # set_mode also sets the tb_join_char attribute
1286 self.set_mode(mode)
1286 self.set_mode(mode)
1287
1287
1288 def _extract_tb(self, tb):
1288 def _extract_tb(self, tb):
1289 if tb:
1289 if tb:
1290 return traceback.extract_tb(tb)
1290 return traceback.extract_tb(tb)
1291 else:
1291 else:
1292 return None
1292 return None
1293
1293
1294 def structured_traceback(self, etype, value, tb, tb_offset=None, number_of_lines_of_context=5):
1294 def structured_traceback(self, etype, value, tb, tb_offset=None, number_of_lines_of_context=5):
1295 tb_offset = self.tb_offset if tb_offset is None else tb_offset
1295 tb_offset = self.tb_offset if tb_offset is None else tb_offset
1296 mode = self.mode
1296 mode = self.mode
1297 if mode in self.verbose_modes:
1297 if mode in self.verbose_modes:
1298 # Verbose modes need a full traceback
1298 # Verbose modes need a full traceback
1299 return VerboseTB.structured_traceback(
1299 return VerboseTB.structured_traceback(
1300 self, etype, value, tb, tb_offset, number_of_lines_of_context
1300 self, etype, value, tb, tb_offset, number_of_lines_of_context
1301 )
1301 )
1302 else:
1302 else:
1303 # We must check the source cache because otherwise we can print
1303 # We must check the source cache because otherwise we can print
1304 # out-of-date source code.
1304 # out-of-date source code.
1305 self.check_cache()
1305 self.check_cache()
1306 # Now we can extract and format the exception
1306 # Now we can extract and format the exception
1307 elist = self._extract_tb(tb)
1307 elist = self._extract_tb(tb)
1308 return ListTB.structured_traceback(
1308 return ListTB.structured_traceback(
1309 self, etype, value, elist, tb_offset, number_of_lines_of_context
1309 self, etype, value, elist, tb_offset, number_of_lines_of_context
1310 )
1310 )
1311
1311
1312 def stb2text(self, stb):
1312 def stb2text(self, stb):
1313 """Convert a structured traceback (a list) to a string."""
1313 """Convert a structured traceback (a list) to a string."""
1314 return self.tb_join_char.join(stb)
1314 return self.tb_join_char.join(stb)
1315
1315
1316
1316
1317 def set_mode(self, mode=None):
1317 def set_mode(self, mode=None):
1318 """Switch to the desired mode.
1318 """Switch to the desired mode.
1319
1319
1320 If mode is not specified, cycles through the available modes."""
1320 If mode is not specified, cycles through the available modes."""
1321
1321
1322 if not mode:
1322 if not mode:
1323 new_idx = (self.valid_modes.index(self.mode) + 1 ) % \
1323 new_idx = (self.valid_modes.index(self.mode) + 1 ) % \
1324 len(self.valid_modes)
1324 len(self.valid_modes)
1325 self.mode = self.valid_modes[new_idx]
1325 self.mode = self.valid_modes[new_idx]
1326 elif mode not in self.valid_modes:
1326 elif mode not in self.valid_modes:
1327 raise ValueError('Unrecognized mode in FormattedTB: <' + mode + '>\n'
1327 raise ValueError('Unrecognized mode in FormattedTB: <' + mode + '>\n'
1328 'Valid modes: ' + str(self.valid_modes))
1328 'Valid modes: ' + str(self.valid_modes))
1329 else:
1329 else:
1330 self.mode = mode
1330 self.mode = mode
1331 # include variable details only in 'Verbose' mode
1331 # include variable details only in 'Verbose' mode
1332 self.include_vars = (self.mode == self.valid_modes[2])
1332 self.include_vars = (self.mode == self.valid_modes[2])
1333 # Set the join character for generating text tracebacks
1333 # Set the join character for generating text tracebacks
1334 self.tb_join_char = self._join_chars[self.mode]
1334 self.tb_join_char = self._join_chars[self.mode]
1335
1335
1336 # some convenient shortcuts
1336 # some convenient shortcuts
1337 def plain(self):
1337 def plain(self):
1338 self.set_mode(self.valid_modes[0])
1338 self.set_mode(self.valid_modes[0])
1339
1339
1340 def context(self):
1340 def context(self):
1341 self.set_mode(self.valid_modes[1])
1341 self.set_mode(self.valid_modes[1])
1342
1342
1343 def verbose(self):
1343 def verbose(self):
1344 self.set_mode(self.valid_modes[2])
1344 self.set_mode(self.valid_modes[2])
1345
1345
1346
1346
1347 #----------------------------------------------------------------------------
1347 #----------------------------------------------------------------------------
1348 class AutoFormattedTB(FormattedTB):
1348 class AutoFormattedTB(FormattedTB):
1349 """A traceback printer which can be called on the fly.
1349 """A traceback printer which can be called on the fly.
1350
1350
1351 It will find out about exceptions by itself.
1351 It will find out about exceptions by itself.
1352
1352
1353 A brief example::
1353 A brief example::
1354
1354
1355 AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux')
1355 AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux')
1356 try:
1356 try:
1357 ...
1357 ...
1358 except:
1358 except:
1359 AutoTB() # or AutoTB(out=logfile) where logfile is an open file object
1359 AutoTB() # or AutoTB(out=logfile) where logfile is an open file object
1360 """
1360 """
1361
1361
1362 def __call__(self, etype=None, evalue=None, etb=None,
1362 def __call__(self, etype=None, evalue=None, etb=None,
1363 out=None, tb_offset=None):
1363 out=None, tb_offset=None):
1364 """Print out a formatted exception traceback.
1364 """Print out a formatted exception traceback.
1365
1365
1366 Optional arguments:
1366 Optional arguments:
1367 - out: an open file-like object to direct output to.
1367 - out: an open file-like object to direct output to.
1368
1368
1369 - tb_offset: the number of frames to skip over in the stack, on a
1369 - tb_offset: the number of frames to skip over in the stack, on a
1370 per-call basis (this overrides temporarily the instance's tb_offset
1370 per-call basis (this overrides temporarily the instance's tb_offset
1371 given at initialization time. """
1371 given at initialization time. """
1372
1372
1373 if out is None:
1373 if out is None:
1374 out = self.ostream
1374 out = self.ostream
1375 out.flush()
1375 out.flush()
1376 out.write(self.text(etype, evalue, etb, tb_offset))
1376 out.write(self.text(etype, evalue, etb, tb_offset))
1377 out.write('\n')
1377 out.write('\n')
1378 out.flush()
1378 out.flush()
1379 # FIXME: we should remove the auto pdb behavior from here and leave
1379 # FIXME: we should remove the auto pdb behavior from here and leave
1380 # that to the clients.
1380 # that to the clients.
1381 try:
1381 try:
1382 self.debugger()
1382 self.debugger()
1383 except KeyboardInterrupt:
1383 except KeyboardInterrupt:
1384 print("\nKeyboardInterrupt")
1384 print("\nKeyboardInterrupt")
1385
1385
1386 def structured_traceback(self, etype=None, value=None, tb=None,
1386 def structured_traceback(self, etype=None, value=None, tb=None,
1387 tb_offset=None, number_of_lines_of_context=5):
1387 tb_offset=None, number_of_lines_of_context=5):
1388 if etype is None:
1388 if etype is None:
1389 etype, value, tb = sys.exc_info()
1389 etype, value, tb = sys.exc_info()
1390 self.tb = tb
1390 self.tb = tb
1391 return FormattedTB.structured_traceback(
1391 return FormattedTB.structured_traceback(
1392 self, etype, value, tb, tb_offset, number_of_lines_of_context)
1392 self, etype, value, tb, tb_offset, number_of_lines_of_context)
1393
1393
1394
1394
1395 #---------------------------------------------------------------------------
1395 #---------------------------------------------------------------------------
1396
1396
1397 # A simple class to preserve Nathan's original functionality.
1397 # A simple class to preserve Nathan's original functionality.
1398 class ColorTB(FormattedTB):
1398 class ColorTB(FormattedTB):
1399 """Shorthand to initialize a FormattedTB in Linux colors mode."""
1399 """Shorthand to initialize a FormattedTB in Linux colors mode."""
1400
1400
1401 def __init__(self, color_scheme='Linux', call_pdb=0, **kwargs):
1401 def __init__(self, color_scheme='Linux', call_pdb=0, **kwargs):
1402 FormattedTB.__init__(self, color_scheme=color_scheme,
1402 FormattedTB.__init__(self, color_scheme=color_scheme,
1403 call_pdb=call_pdb, **kwargs)
1403 call_pdb=call_pdb, **kwargs)
1404
1404
1405
1405
1406 class SyntaxTB(ListTB):
1406 class SyntaxTB(ListTB):
1407 """Extension which holds some state: the last exception value"""
1407 """Extension which holds some state: the last exception value"""
1408
1408
1409 def __init__(self, color_scheme='NoColor'):
1409 def __init__(self, color_scheme='NoColor'):
1410 ListTB.__init__(self, color_scheme)
1410 ListTB.__init__(self, color_scheme)
1411 self.last_syntax_error = None
1411 self.last_syntax_error = None
1412
1412
1413 def __call__(self, etype, value, elist):
1413 def __call__(self, etype, value, elist):
1414 self.last_syntax_error = value
1414 self.last_syntax_error = value
1415
1415
1416 ListTB.__call__(self, etype, value, elist)
1416 ListTB.__call__(self, etype, value, elist)
1417
1417
1418 def structured_traceback(self, etype, value, elist, tb_offset=None,
1418 def structured_traceback(self, etype, value, elist, tb_offset=None,
1419 context=5):
1419 context=5):
1420 # If the source file has been edited, the line in the syntax error can
1420 # If the source file has been edited, the line in the syntax error can
1421 # be wrong (retrieved from an outdated cache). This replaces it with
1421 # be wrong (retrieved from an outdated cache). This replaces it with
1422 # the current value.
1422 # the current value.
1423 if isinstance(value, SyntaxError) \
1423 if isinstance(value, SyntaxError) \
1424 and isinstance(value.filename, py3compat.string_types) \
1424 and isinstance(value.filename, py3compat.string_types) \
1425 and isinstance(value.lineno, int):
1425 and isinstance(value.lineno, int):
1426 linecache.checkcache(value.filename)
1426 linecache.checkcache(value.filename)
1427 newtext = ulinecache.getline(value.filename, value.lineno)
1427 newtext = ulinecache.getline(value.filename, value.lineno)
1428 if newtext:
1428 if newtext:
1429 value.text = newtext
1429 value.text = newtext
1430 return super(SyntaxTB, self).structured_traceback(etype, value, elist,
1430 return super(SyntaxTB, self).structured_traceback(etype, value, elist,
1431 tb_offset=tb_offset, context=context)
1431 tb_offset=tb_offset, context=context)
1432
1432
1433 def clear_err_state(self):
1433 def clear_err_state(self):
1434 """Return the current error state and clear it"""
1434 """Return the current error state and clear it"""
1435 e = self.last_syntax_error
1435 e = self.last_syntax_error
1436 self.last_syntax_error = None
1436 self.last_syntax_error = None
1437 return e
1437 return e
1438
1438
1439 def stb2text(self, stb):
1439 def stb2text(self, stb):
1440 """Convert a structured traceback (a list) to a string."""
1440 """Convert a structured traceback (a list) to a string."""
1441 return ''.join(stb)
1441 return ''.join(stb)
1442
1442
1443
1443
1444 # some internal-use functions
1444 # some internal-use functions
1445 def text_repr(value):
1445 def text_repr(value):
1446 """Hopefully pretty robust repr equivalent."""
1446 """Hopefully pretty robust repr equivalent."""
1447 # this is pretty horrible but should always return *something*
1447 # this is pretty horrible but should always return *something*
1448 try:
1448 try:
1449 return pydoc.text.repr(value)
1449 return pydoc.text.repr(value)
1450 except KeyboardInterrupt:
1450 except KeyboardInterrupt:
1451 raise
1451 raise
1452 except:
1452 except:
1453 try:
1453 try:
1454 return repr(value)
1454 return repr(value)
1455 except KeyboardInterrupt:
1455 except KeyboardInterrupt:
1456 raise
1456 raise
1457 except:
1457 except:
1458 try:
1458 try:
1459 # all still in an except block so we catch
1459 # all still in an except block so we catch
1460 # getattr raising
1460 # getattr raising
1461 name = getattr(value, '__name__', None)
1461 name = getattr(value, '__name__', None)
1462 if name:
1462 if name:
1463 # ick, recursion
1463 # ick, recursion
1464 return text_repr(name)
1464 return text_repr(name)
1465 klass = getattr(value, '__class__', None)
1465 klass = getattr(value, '__class__', None)
1466 if klass:
1466 if klass:
1467 return '%s instance' % text_repr(klass)
1467 return '%s instance' % text_repr(klass)
1468 except KeyboardInterrupt:
1468 except KeyboardInterrupt:
1469 raise
1469 raise
1470 except:
1470 except:
1471 return 'UNRECOVERABLE REPR FAILURE'
1471 return 'UNRECOVERABLE REPR FAILURE'
1472
1472
1473
1473
1474 def eqrepr(value, repr=text_repr):
1474 def eqrepr(value, repr=text_repr):
1475 return '=%s' % repr(value)
1475 return '=%s' % repr(value)
1476
1476
1477
1477
1478 def nullrepr(value, repr=text_repr):
1478 def nullrepr(value, repr=text_repr):
1479 return ''
1479 return ''
General Comments 0
You need to be logged in to leave comments. Login now