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