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