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