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