##// END OF EJS Templates
Merge pull request #12445 from impact27/patch-4...
Matthias Bussonnier -
r25900:3aba68de merge
parent child Browse files
Show More
@@ -1,802 +1,809 b''
1 1 # -*- coding: utf-8 -*-
2 2 """
3 3 Pdb debugger class.
4 4
5 5 Modified from the standard pdb.Pdb class to avoid including readline, so that
6 6 the command line completion of other programs which include this isn't
7 7 damaged.
8 8
9 9 In the future, this class will be expanded with improvements over the standard
10 10 pdb.
11 11
12 12 The code in this file is mainly lifted out of cmd.py in Python 2.2, with minor
13 13 changes. Licensing should therefore be under the standard Python terms. For
14 14 details on the PSF (Python Software Foundation) standard license, see:
15 15
16 16 https://docs.python.org/2/license.html
17 17 """
18 18
19 19 #*****************************************************************************
20 20 #
21 21 # This file is licensed under the PSF license.
22 22 #
23 23 # Copyright (C) 2001 Python Software Foundation, www.python.org
24 24 # Copyright (C) 2005-2006 Fernando Perez. <fperez@colorado.edu>
25 25 #
26 26 #
27 27 #*****************************************************************************
28 28
29 29 import bdb
30 30 import functools
31 31 import inspect
32 32 import linecache
33 33 import sys
34 34 import warnings
35 35 import re
36 36
37 37 from IPython import get_ipython
38 38 from IPython.utils import PyColorize
39 39 from IPython.utils import coloransi, py3compat
40 40 from IPython.core.excolors import exception_colors
41 41 from IPython.testing.skipdoctest import skip_doctest
42 42
43 43
44 44 prompt = 'ipdb> '
45 45
46 46 #We have to check this directly from sys.argv, config struct not yet available
47 47 from pdb import Pdb as OldPdb
48 48
49 49 # Allow the set_trace code to operate outside of an ipython instance, even if
50 50 # it does so with some limitations. The rest of this support is implemented in
51 51 # the Tracer constructor.
52 52
53 53 def make_arrow(pad):
54 54 """generate the leading arrow in front of traceback or debugger"""
55 55 if pad >= 2:
56 56 return '-'*(pad-2) + '> '
57 57 elif pad == 1:
58 58 return '>'
59 59 return ''
60 60
61 61
62 62 def BdbQuit_excepthook(et, ev, tb, excepthook=None):
63 63 """Exception hook which handles `BdbQuit` exceptions.
64 64
65 65 All other exceptions are processed using the `excepthook`
66 66 parameter.
67 67 """
68 68 warnings.warn("`BdbQuit_excepthook` is deprecated since version 5.1",
69 69 DeprecationWarning, stacklevel=2)
70 70 if et==bdb.BdbQuit:
71 71 print('Exiting Debugger.')
72 72 elif excepthook is not None:
73 73 excepthook(et, ev, tb)
74 74 else:
75 75 # Backwards compatibility. Raise deprecation warning?
76 76 BdbQuit_excepthook.excepthook_ori(et,ev,tb)
77 77
78 78
79 79 def BdbQuit_IPython_excepthook(self,et,ev,tb,tb_offset=None):
80 80 warnings.warn(
81 81 "`BdbQuit_IPython_excepthook` is deprecated since version 5.1",
82 82 DeprecationWarning, stacklevel=2)
83 83 print('Exiting Debugger.')
84 84
85 85
86 86 class Tracer(object):
87 87 """
88 88 DEPRECATED
89 89
90 90 Class for local debugging, similar to pdb.set_trace.
91 91
92 92 Instances of this class, when called, behave like pdb.set_trace, but
93 93 providing IPython's enhanced capabilities.
94 94
95 95 This is implemented as a class which must be initialized in your own code
96 96 and not as a standalone function because we need to detect at runtime
97 97 whether IPython is already active or not. That detection is done in the
98 98 constructor, ensuring that this code plays nicely with a running IPython,
99 99 while functioning acceptably (though with limitations) if outside of it.
100 100 """
101 101
102 102 @skip_doctest
103 103 def __init__(self, colors=None):
104 104 """
105 105 DEPRECATED
106 106
107 107 Create a local debugger instance.
108 108
109 109 Parameters
110 110 ----------
111 111
112 112 colors : str, optional
113 113 The name of the color scheme to use, it must be one of IPython's
114 114 valid color schemes. If not given, the function will default to
115 115 the current IPython scheme when running inside IPython, and to
116 116 'NoColor' otherwise.
117 117
118 118 Examples
119 119 --------
120 120 ::
121 121
122 122 from IPython.core.debugger import Tracer; debug_here = Tracer()
123 123
124 124 Later in your code::
125 125
126 126 debug_here() # -> will open up the debugger at that point.
127 127
128 128 Once the debugger activates, you can use all of its regular commands to
129 129 step through code, set breakpoints, etc. See the pdb documentation
130 130 from the Python standard library for usage details.
131 131 """
132 132 warnings.warn("`Tracer` is deprecated since version 5.1, directly use "
133 133 "`IPython.core.debugger.Pdb.set_trace()`",
134 134 DeprecationWarning, stacklevel=2)
135 135
136 136 ip = get_ipython()
137 137 if ip is None:
138 138 # Outside of ipython, we set our own exception hook manually
139 139 sys.excepthook = functools.partial(BdbQuit_excepthook,
140 140 excepthook=sys.excepthook)
141 141 def_colors = 'NoColor'
142 142 else:
143 143 # In ipython, we use its custom exception handler mechanism
144 144 def_colors = ip.colors
145 145 ip.set_custom_exc((bdb.BdbQuit,), BdbQuit_IPython_excepthook)
146 146
147 147 if colors is None:
148 148 colors = def_colors
149 149
150 150 # The stdlib debugger internally uses a modified repr from the `repr`
151 151 # module, that limits the length of printed strings to a hardcoded
152 152 # limit of 30 characters. That much trimming is too aggressive, let's
153 153 # at least raise that limit to 80 chars, which should be enough for
154 154 # most interactive uses.
155 155 try:
156 156 from reprlib import aRepr
157 157 aRepr.maxstring = 80
158 158 except:
159 159 # This is only a user-facing convenience, so any error we encounter
160 160 # here can be warned about but can be otherwise ignored. These
161 161 # printouts will tell us about problems if this API changes
162 162 import traceback
163 163 traceback.print_exc()
164 164
165 165 self.debugger = Pdb(colors)
166 166
167 167 def __call__(self):
168 168 """Starts an interactive debugger at the point where called.
169 169
170 170 This is similar to the pdb.set_trace() function from the std lib, but
171 171 using IPython's enhanced debugger."""
172 172
173 173 self.debugger.set_trace(sys._getframe().f_back)
174 174
175 175
176 176 RGX_EXTRA_INDENT = re.compile(r'(?<=\n)\s+')
177 177
178 178
179 179 def strip_indentation(multiline_string):
180 180 return RGX_EXTRA_INDENT.sub('', multiline_string)
181 181
182 182
183 183 def decorate_fn_with_doc(new_fn, old_fn, additional_text=""):
184 184 """Make new_fn have old_fn's doc string. This is particularly useful
185 185 for the ``do_...`` commands that hook into the help system.
186 186 Adapted from from a comp.lang.python posting
187 187 by Duncan Booth."""
188 188 def wrapper(*args, **kw):
189 189 return new_fn(*args, **kw)
190 190 if old_fn.__doc__:
191 191 wrapper.__doc__ = strip_indentation(old_fn.__doc__) + additional_text
192 192 return wrapper
193 193
194 194
195 195 class Pdb(OldPdb):
196 196 """Modified Pdb class, does not load readline.
197 197
198 198 for a standalone version that uses prompt_toolkit, see
199 199 `IPython.terminal.debugger.TerminalPdb` and
200 200 `IPython.terminal.debugger.set_trace()`
201 201 """
202 202
203 203 def __init__(self, color_scheme=None, completekey=None,
204 204 stdin=None, stdout=None, context=5, **kwargs):
205 205 """Create a new IPython debugger.
206 206
207 207 :param color_scheme: Deprecated, do not use.
208 208 :param completekey: Passed to pdb.Pdb.
209 209 :param stdin: Passed to pdb.Pdb.
210 210 :param stdout: Passed to pdb.Pdb.
211 211 :param context: Number of lines of source code context to show when
212 212 displaying stacktrace information.
213 213 :param kwargs: Passed to pdb.Pdb.
214 214 The possibilities are python version dependent, see the python
215 215 docs for more info.
216 216 """
217 217
218 218 # Parent constructor:
219 219 try:
220 220 self.context = int(context)
221 221 if self.context <= 0:
222 222 raise ValueError("Context must be a positive integer")
223 223 except (TypeError, ValueError) as e:
224 224 raise ValueError("Context must be a positive integer") from e
225 225
226 226 # `kwargs` ensures full compatibility with stdlib's `pdb.Pdb`.
227 227 OldPdb.__init__(self, completekey, stdin, stdout, **kwargs)
228 228
229 229 # IPython changes...
230 230 self.shell = get_ipython()
231 231
232 232 if self.shell is None:
233 233 save_main = sys.modules['__main__']
234 234 # No IPython instance running, we must create one
235 235 from IPython.terminal.interactiveshell import \
236 236 TerminalInteractiveShell
237 237 self.shell = TerminalInteractiveShell.instance()
238 238 # needed by any code which calls __import__("__main__") after
239 239 # the debugger was entered. See also #9941.
240 240 sys.modules['__main__'] = save_main
241 241
242 242 if color_scheme is not None:
243 243 warnings.warn(
244 244 "The `color_scheme` argument is deprecated since version 5.1",
245 245 DeprecationWarning, stacklevel=2)
246 246 else:
247 247 color_scheme = self.shell.colors
248 248
249 249 self.aliases = {}
250 250
251 251 # Create color table: we copy the default one from the traceback
252 252 # module and add a few attributes needed for debugging
253 253 self.color_scheme_table = exception_colors()
254 254
255 255 # shorthands
256 256 C = coloransi.TermColors
257 257 cst = self.color_scheme_table
258 258
259 259 cst['NoColor'].colors.prompt = C.NoColor
260 260 cst['NoColor'].colors.breakpoint_enabled = C.NoColor
261 261 cst['NoColor'].colors.breakpoint_disabled = C.NoColor
262 262
263 263 cst['Linux'].colors.prompt = C.Green
264 264 cst['Linux'].colors.breakpoint_enabled = C.LightRed
265 265 cst['Linux'].colors.breakpoint_disabled = C.Red
266 266
267 267 cst['LightBG'].colors.prompt = C.Blue
268 268 cst['LightBG'].colors.breakpoint_enabled = C.LightRed
269 269 cst['LightBG'].colors.breakpoint_disabled = C.Red
270 270
271 271 cst['Neutral'].colors.prompt = C.Blue
272 272 cst['Neutral'].colors.breakpoint_enabled = C.LightRed
273 273 cst['Neutral'].colors.breakpoint_disabled = C.Red
274 274
275 275
276 276 # Add a python parser so we can syntax highlight source while
277 277 # debugging.
278 278 self.parser = PyColorize.Parser(style=color_scheme)
279 279 self.set_colors(color_scheme)
280 280
281 281 # Set the prompt - the default prompt is '(Pdb)'
282 282 self.prompt = prompt
283 283 self.skip_hidden = True
284 284
285 285 def set_colors(self, scheme):
286 286 """Shorthand access to the color table scheme selector method."""
287 287 self.color_scheme_table.set_active_scheme(scheme)
288 288 self.parser.style = scheme
289 289
290 290
291 291 def hidden_frames(self, stack):
292 292 """
293 293 Given an index in the stack return wether it should be skipped.
294 294
295 295 This is used in up/down and where to skip frames.
296 296 """
297 ip_hide = [s[0].f_locals.get("__tracebackhide__", False) for s in stack]
297 # The f_locals dictionary is updated from the actual frame
298 # locals whenever the .f_locals accessor is called, so we
299 # avoid calling it here to preserve self.curframe_locals.
300 # Futhermore, there is no good reason to hide the current frame.
301 ip_hide = [
302 False if s[0] is self.curframe else s[0].f_locals.get(
303 "__tracebackhide__", False)
304 for s in stack]
298 305 ip_start = [i for i, s in enumerate(ip_hide) if s == "__ipython_bottom__"]
299 306 if ip_start:
300 307 ip_hide = [h if i > ip_start[0] else True for (i, h) in enumerate(ip_hide)]
301 308 return ip_hide
302 309
303 310 def interaction(self, frame, traceback):
304 311 try:
305 312 OldPdb.interaction(self, frame, traceback)
306 313 except KeyboardInterrupt:
307 314 self.stdout.write("\n" + self.shell.get_exception_only())
308 315
309 316 def new_do_frame(self, arg):
310 317 OldPdb.do_frame(self, arg)
311 318
312 319 def new_do_quit(self, arg):
313 320
314 321 if hasattr(self, 'old_all_completions'):
315 322 self.shell.Completer.all_completions=self.old_all_completions
316 323
317 324 return OldPdb.do_quit(self, arg)
318 325
319 326 do_q = do_quit = decorate_fn_with_doc(new_do_quit, OldPdb.do_quit)
320 327
321 328 def new_do_restart(self, arg):
322 329 """Restart command. In the context of ipython this is exactly the same
323 330 thing as 'quit'."""
324 331 self.msg("Restart doesn't make sense here. Using 'quit' instead.")
325 332 return self.do_quit(arg)
326 333
327 334 def print_stack_trace(self, context=None):
328 335 Colors = self.color_scheme_table.active_colors
329 336 ColorsNormal = Colors.Normal
330 337 if context is None:
331 338 context = self.context
332 339 try:
333 340 context=int(context)
334 341 if context <= 0:
335 342 raise ValueError("Context must be a positive integer")
336 343 except (TypeError, ValueError) as e:
337 344 raise ValueError("Context must be a positive integer") from e
338 345 try:
339 346 skipped = 0
340 347 for hidden, frame_lineno in zip(self.hidden_frames(self.stack), self.stack):
341 348 if hidden and self.skip_hidden:
342 349 skipped += 1
343 350 continue
344 351 if skipped:
345 352 print(
346 353 f"{Colors.excName} [... skipping {skipped} hidden frame(s)]{ColorsNormal}\n"
347 354 )
348 355 skipped = 0
349 356 self.print_stack_entry(frame_lineno, context=context)
350 357 if skipped:
351 358 print(
352 359 f"{Colors.excName} [... skipping {skipped} hidden frame(s)]{ColorsNormal}\n"
353 360 )
354 361 except KeyboardInterrupt:
355 362 pass
356 363
357 364 def print_stack_entry(self, frame_lineno, prompt_prefix='\n-> ',
358 365 context=None):
359 366 if context is None:
360 367 context = self.context
361 368 try:
362 369 context=int(context)
363 370 if context <= 0:
364 371 raise ValueError("Context must be a positive integer")
365 372 except (TypeError, ValueError) as e:
366 373 raise ValueError("Context must be a positive integer") from e
367 374 print(self.format_stack_entry(frame_lineno, '', context), file=self.stdout)
368 375
369 376 # vds: >>
370 377 frame, lineno = frame_lineno
371 378 filename = frame.f_code.co_filename
372 379 self.shell.hooks.synchronize_with_editor(filename, lineno, 0)
373 380 # vds: <<
374 381
375 382 def format_stack_entry(self, frame_lineno, lprefix=': ', context=None):
376 383 if context is None:
377 384 context = self.context
378 385 try:
379 386 context=int(context)
380 387 if context <= 0:
381 388 print("Context must be a positive integer", file=self.stdout)
382 389 except (TypeError, ValueError):
383 390 print("Context must be a positive integer", file=self.stdout)
384 391
385 392 import reprlib
386 393
387 394 ret = []
388 395
389 396 Colors = self.color_scheme_table.active_colors
390 397 ColorsNormal = Colors.Normal
391 398 tpl_link = u'%s%%s%s' % (Colors.filenameEm, ColorsNormal)
392 399 tpl_call = u'%s%%s%s%%s%s' % (Colors.vName, Colors.valEm, ColorsNormal)
393 400 tpl_line = u'%%s%s%%s %s%%s' % (Colors.lineno, ColorsNormal)
394 401 tpl_line_em = u'%%s%s%%s %s%%s%s' % (Colors.linenoEm, Colors.line,
395 402 ColorsNormal)
396 403
397 404 frame, lineno = frame_lineno
398 405
399 406 return_value = ''
400 407 if '__return__' in frame.f_locals:
401 408 rv = frame.f_locals['__return__']
402 409 #return_value += '->'
403 410 return_value += reprlib.repr(rv) + '\n'
404 411 ret.append(return_value)
405 412
406 413 #s = filename + '(' + `lineno` + ')'
407 414 filename = self.canonic(frame.f_code.co_filename)
408 415 link = tpl_link % py3compat.cast_unicode(filename)
409 416
410 417 if frame.f_code.co_name:
411 418 func = frame.f_code.co_name
412 419 else:
413 420 func = "<lambda>"
414 421
415 422 call = ''
416 423 if func != '?':
417 424 if '__args__' in frame.f_locals:
418 425 args = reprlib.repr(frame.f_locals['__args__'])
419 426 else:
420 427 args = '()'
421 428 call = tpl_call % (func, args)
422 429
423 430 # The level info should be generated in the same format pdb uses, to
424 431 # avoid breaking the pdbtrack functionality of python-mode in *emacs.
425 432 if frame is self.curframe:
426 433 ret.append('> ')
427 434 else:
428 435 ret.append(' ')
429 436 ret.append(u'%s(%s)%s\n' % (link,lineno,call))
430 437
431 438 start = lineno - 1 - context//2
432 439 lines = linecache.getlines(filename)
433 440 start = min(start, len(lines) - context)
434 441 start = max(start, 0)
435 442 lines = lines[start : start + context]
436 443
437 444 for i,line in enumerate(lines):
438 445 show_arrow = (start + 1 + i == lineno)
439 446 linetpl = (frame is self.curframe or show_arrow) \
440 447 and tpl_line_em \
441 448 or tpl_line
442 449 ret.append(self.__format_line(linetpl, filename,
443 450 start + 1 + i, line,
444 451 arrow = show_arrow) )
445 452 return ''.join(ret)
446 453
447 454 def __format_line(self, tpl_line, filename, lineno, line, arrow = False):
448 455 bp_mark = ""
449 456 bp_mark_color = ""
450 457
451 458 new_line, err = self.parser.format2(line, 'str')
452 459 if not err:
453 460 line = new_line
454 461
455 462 bp = None
456 463 if lineno in self.get_file_breaks(filename):
457 464 bps = self.get_breaks(filename, lineno)
458 465 bp = bps[-1]
459 466
460 467 if bp:
461 468 Colors = self.color_scheme_table.active_colors
462 469 bp_mark = str(bp.number)
463 470 bp_mark_color = Colors.breakpoint_enabled
464 471 if not bp.enabled:
465 472 bp_mark_color = Colors.breakpoint_disabled
466 473
467 474 numbers_width = 7
468 475 if arrow:
469 476 # This is the line with the error
470 477 pad = numbers_width - len(str(lineno)) - len(bp_mark)
471 478 num = '%s%s' % (make_arrow(pad), str(lineno))
472 479 else:
473 480 num = '%*s' % (numbers_width - len(bp_mark), str(lineno))
474 481
475 482 return tpl_line % (bp_mark_color + bp_mark, num, line)
476 483
477 484
478 485 def print_list_lines(self, filename, first, last):
479 486 """The printing (as opposed to the parsing part of a 'list'
480 487 command."""
481 488 try:
482 489 Colors = self.color_scheme_table.active_colors
483 490 ColorsNormal = Colors.Normal
484 491 tpl_line = '%%s%s%%s %s%%s' % (Colors.lineno, ColorsNormal)
485 492 tpl_line_em = '%%s%s%%s %s%%s%s' % (Colors.linenoEm, Colors.line, ColorsNormal)
486 493 src = []
487 494 if filename == "<string>" and hasattr(self, "_exec_filename"):
488 495 filename = self._exec_filename
489 496
490 497 for lineno in range(first, last+1):
491 498 line = linecache.getline(filename, lineno)
492 499 if not line:
493 500 break
494 501
495 502 if lineno == self.curframe.f_lineno:
496 503 line = self.__format_line(tpl_line_em, filename, lineno, line, arrow = True)
497 504 else:
498 505 line = self.__format_line(tpl_line, filename, lineno, line, arrow = False)
499 506
500 507 src.append(line)
501 508 self.lineno = lineno
502 509
503 510 print(''.join(src), file=self.stdout)
504 511
505 512 except KeyboardInterrupt:
506 513 pass
507 514
508 515 def do_skip_hidden(self, arg):
509 516 """
510 517 Change whether or not we should skip frames with the
511 518 __tracebackhide__ attribute.
512 519 """
513 520 if arg.strip().lower() in ("true", "yes"):
514 521 self.skip_hidden = True
515 522 elif arg.strip().lower() in ("false", "no"):
516 523 self.skip_hidden = False
517 524
518 525 def do_list(self, arg):
519 526 """Print lines of code from the current stack frame
520 527 """
521 528 self.lastcmd = 'list'
522 529 last = None
523 530 if arg:
524 531 try:
525 532 x = eval(arg, {}, {})
526 533 if type(x) == type(()):
527 534 first, last = x
528 535 first = int(first)
529 536 last = int(last)
530 537 if last < first:
531 538 # Assume it's a count
532 539 last = first + last
533 540 else:
534 541 first = max(1, int(x) - 5)
535 542 except:
536 543 print('*** Error in argument:', repr(arg), file=self.stdout)
537 544 return
538 545 elif self.lineno is None:
539 546 first = max(1, self.curframe.f_lineno - 5)
540 547 else:
541 548 first = self.lineno + 1
542 549 if last is None:
543 550 last = first + 10
544 551 self.print_list_lines(self.curframe.f_code.co_filename, first, last)
545 552
546 553 # vds: >>
547 554 lineno = first
548 555 filename = self.curframe.f_code.co_filename
549 556 self.shell.hooks.synchronize_with_editor(filename, lineno, 0)
550 557 # vds: <<
551 558
552 559 do_l = do_list
553 560
554 561 def getsourcelines(self, obj):
555 562 lines, lineno = inspect.findsource(obj)
556 563 if inspect.isframe(obj) and obj.f_globals is obj.f_locals:
557 564 # must be a module frame: do not try to cut a block out of it
558 565 return lines, 1
559 566 elif inspect.ismodule(obj):
560 567 return lines, 1
561 568 return inspect.getblock(lines[lineno:]), lineno+1
562 569
563 570 def do_longlist(self, arg):
564 571 """Print lines of code from the current stack frame.
565 572
566 573 Shows more lines than 'list' does.
567 574 """
568 575 self.lastcmd = 'longlist'
569 576 try:
570 577 lines, lineno = self.getsourcelines(self.curframe)
571 578 except OSError as err:
572 579 self.error(err)
573 580 return
574 581 last = lineno + len(lines)
575 582 self.print_list_lines(self.curframe.f_code.co_filename, lineno, last)
576 583 do_ll = do_longlist
577 584
578 585 def do_debug(self, arg):
579 586 """debug code
580 587 Enter a recursive debugger that steps through the code
581 588 argument (which is an arbitrary expression or statement to be
582 589 executed in the current environment).
583 590 """
584 591 sys.settrace(None)
585 592 globals = self.curframe.f_globals
586 593 locals = self.curframe_locals
587 594 p = self.__class__(completekey=self.completekey,
588 595 stdin=self.stdin, stdout=self.stdout)
589 596 p.use_rawinput = self.use_rawinput
590 597 p.prompt = "(%s) " % self.prompt.strip()
591 598 self.message("ENTERING RECURSIVE DEBUGGER")
592 599 sys.call_tracing(p.run, (arg, globals, locals))
593 600 self.message("LEAVING RECURSIVE DEBUGGER")
594 601 sys.settrace(self.trace_dispatch)
595 602 self.lastcmd = p.lastcmd
596 603
597 604 def do_pdef(self, arg):
598 605 """Print the call signature for any callable object.
599 606
600 607 The debugger interface to %pdef"""
601 608 namespaces = [('Locals', self.curframe.f_locals),
602 609 ('Globals', self.curframe.f_globals)]
603 610 self.shell.find_line_magic('pdef')(arg, namespaces=namespaces)
604 611
605 612 def do_pdoc(self, arg):
606 613 """Print the docstring for an object.
607 614
608 615 The debugger interface to %pdoc."""
609 616 namespaces = [('Locals', self.curframe.f_locals),
610 617 ('Globals', self.curframe.f_globals)]
611 618 self.shell.find_line_magic('pdoc')(arg, namespaces=namespaces)
612 619
613 620 def do_pfile(self, arg):
614 621 """Print (or run through pager) the file where an object is defined.
615 622
616 623 The debugger interface to %pfile.
617 624 """
618 625 namespaces = [('Locals', self.curframe.f_locals),
619 626 ('Globals', self.curframe.f_globals)]
620 627 self.shell.find_line_magic('pfile')(arg, namespaces=namespaces)
621 628
622 629 def do_pinfo(self, arg):
623 630 """Provide detailed information about an object.
624 631
625 632 The debugger interface to %pinfo, i.e., obj?."""
626 633 namespaces = [('Locals', self.curframe.f_locals),
627 634 ('Globals', self.curframe.f_globals)]
628 635 self.shell.find_line_magic('pinfo')(arg, namespaces=namespaces)
629 636
630 637 def do_pinfo2(self, arg):
631 638 """Provide extra detailed information about an object.
632 639
633 640 The debugger interface to %pinfo2, i.e., obj??."""
634 641 namespaces = [('Locals', self.curframe.f_locals),
635 642 ('Globals', self.curframe.f_globals)]
636 643 self.shell.find_line_magic('pinfo2')(arg, namespaces=namespaces)
637 644
638 645 def do_psource(self, arg):
639 646 """Print (or run through pager) the source code for an object."""
640 647 namespaces = [('Locals', self.curframe.f_locals),
641 648 ('Globals', self.curframe.f_globals)]
642 649 self.shell.find_line_magic('psource')(arg, namespaces=namespaces)
643 650
644 651 def do_where(self, arg):
645 652 """w(here)
646 653 Print a stack trace, with the most recent frame at the bottom.
647 654 An arrow indicates the "current frame", which determines the
648 655 context of most commands. 'bt' is an alias for this command.
649 656
650 657 Take a number as argument as an (optional) number of context line to
651 658 print"""
652 659 if arg:
653 660 try:
654 661 context = int(arg)
655 662 except ValueError as err:
656 663 self.error(err)
657 664 return
658 665 self.print_stack_trace(context)
659 666 else:
660 667 self.print_stack_trace()
661 668
662 669 do_w = do_where
663 670
664 671 def stop_here(self, frame):
665 672 hidden = False
666 673 if self.skip_hidden:
667 674 hidden = frame.f_locals.get("__tracebackhide__", False)
668 675 if hidden:
669 676 Colors = self.color_scheme_table.active_colors
670 677 ColorsNormal = Colors.Normal
671 678 print(f"{Colors.excName} [... skipped 1 hidden frame]{ColorsNormal}\n")
672 679
673 680 return super().stop_here(frame)
674 681
675 682 def do_up(self, arg):
676 683 """u(p) [count]
677 684 Move the current frame count (default one) levels up in the
678 685 stack trace (to an older frame).
679 686
680 687 Will skip hidden frames.
681 688 """
682 689 ## modified version of upstream that skips
683 690 # frames with __tracebackide__
684 691 if self.curindex == 0:
685 692 self.error("Oldest frame")
686 693 return
687 694 try:
688 695 count = int(arg or 1)
689 696 except ValueError:
690 697 self.error("Invalid frame count (%s)" % arg)
691 698 return
692 699 skipped = 0
693 700 if count < 0:
694 701 _newframe = 0
695 702 else:
696 703 _newindex = self.curindex
697 704 counter = 0
698 705 hidden_frames = self.hidden_frames(self.stack)
699 706 for i in range(self.curindex - 1, -1, -1):
700 707 frame = self.stack[i][0]
701 708 if hidden_frames[i] and self.skip_hidden:
702 709 skipped += 1
703 710 continue
704 711 counter += 1
705 712 if counter >= count:
706 713 break
707 714 else:
708 715 # if no break occured.
709 716 self.error("all frames above hidden")
710 717 return
711 718
712 719 Colors = self.color_scheme_table.active_colors
713 720 ColorsNormal = Colors.Normal
714 721 _newframe = i
715 722 self._select_frame(_newframe)
716 723 if skipped:
717 724 print(
718 725 f"{Colors.excName} [... skipped {skipped} hidden frame(s)]{ColorsNormal}\n"
719 726 )
720 727
721 728 def do_down(self, arg):
722 729 """d(own) [count]
723 730 Move the current frame count (default one) levels down in the
724 731 stack trace (to a newer frame).
725 732
726 733 Will skip hidden frames.
727 734 """
728 735 if self.curindex + 1 == len(self.stack):
729 736 self.error("Newest frame")
730 737 return
731 738 try:
732 739 count = int(arg or 1)
733 740 except ValueError:
734 741 self.error("Invalid frame count (%s)" % arg)
735 742 return
736 743 if count < 0:
737 744 _newframe = len(self.stack) - 1
738 745 else:
739 746 _newindex = self.curindex
740 747 counter = 0
741 748 skipped = 0
742 749 hidden_frames = self.hidden_frames(self.stack)
743 750 for i in range(self.curindex + 1, len(self.stack)):
744 751 frame = self.stack[i][0]
745 752 if hidden_frames[i] and self.skip_hidden:
746 753 skipped += 1
747 754 continue
748 755 counter += 1
749 756 if counter >= count:
750 757 break
751 758 else:
752 759 self.error("all frames bellow hidden")
753 760 return
754 761
755 762 Colors = self.color_scheme_table.active_colors
756 763 ColorsNormal = Colors.Normal
757 764 if skipped:
758 765 print(
759 766 f"{Colors.excName} [... skipped {skipped} hidden frame(s)]{ColorsNormal}\n"
760 767 )
761 768 _newframe = i
762 769
763 770 self._select_frame(_newframe)
764 771
765 772 do_d = do_down
766 773 do_u = do_up
767 774
768 775 class InterruptiblePdb(Pdb):
769 776 """Version of debugger where KeyboardInterrupt exits the debugger altogether."""
770 777
771 778 def cmdloop(self):
772 779 """Wrap cmdloop() such that KeyboardInterrupt stops the debugger."""
773 780 try:
774 781 return OldPdb.cmdloop(self)
775 782 except KeyboardInterrupt:
776 783 self.stop_here = lambda frame: False
777 784 self.do_quit("")
778 785 sys.settrace(None)
779 786 self.quitting = False
780 787 raise
781 788
782 789 def _cmdloop(self):
783 790 while True:
784 791 try:
785 792 # keyboard interrupts allow for an easy way to cancel
786 793 # the current command, so allow them during interactive input
787 794 self.allow_kbdint = True
788 795 self.cmdloop()
789 796 self.allow_kbdint = False
790 797 break
791 798 except KeyboardInterrupt:
792 799 self.message('--KeyboardInterrupt--')
793 800 raise
794 801
795 802
796 803 def set_trace(frame=None):
797 804 """
798 805 Start debugging from `frame`.
799 806
800 807 If frame is not specified, debugging starts from caller's frame.
801 808 """
802 809 Pdb().set_trace(frame or sys._getframe().f_back)
General Comments 0
You need to be logged in to leave comments. Login now