##// END OF EJS Templates
Make stop_here actually stop...
Quentin Peter -
Show More
@@ -1,811 +1,811 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):
224 224 raise ValueError("Context must be a positive integer")
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 297 # The f_locals dictionary is updated from the actual frame
298 298 # locals whenever the .f_locals accessor is called, so we
299 299 # avoid calling it here to preserve self.curframe_locals.
300 300 # Futhermore, there is no good reason to hide the current frame.
301 301 ip_hide = [
302 302 False if s[0] is self.curframe else s[0].f_locals.get(
303 303 "__tracebackhide__", False)
304 304 for s in stack]
305 305 ip_start = [i for i, s in enumerate(ip_hide) if s == "__ipython_bottom__"]
306 306 if ip_start:
307 307 ip_hide = [h if i > ip_start[0] else True for (i, h) in enumerate(ip_hide)]
308 308 return ip_hide
309 309
310 310 def interaction(self, frame, traceback):
311 311 try:
312 312 OldPdb.interaction(self, frame, traceback)
313 313 except KeyboardInterrupt:
314 314 self.stdout.write("\n" + self.shell.get_exception_only())
315 315
316 316 def new_do_frame(self, arg):
317 317 OldPdb.do_frame(self, arg)
318 318
319 319 def new_do_quit(self, arg):
320 320
321 321 if hasattr(self, 'old_all_completions'):
322 322 self.shell.Completer.all_completions=self.old_all_completions
323 323
324 324 return OldPdb.do_quit(self, arg)
325 325
326 326 do_q = do_quit = decorate_fn_with_doc(new_do_quit, OldPdb.do_quit)
327 327
328 328 def new_do_restart(self, arg):
329 329 """Restart command. In the context of ipython this is exactly the same
330 330 thing as 'quit'."""
331 331 self.msg("Restart doesn't make sense here. Using 'quit' instead.")
332 332 return self.do_quit(arg)
333 333
334 334 def print_stack_trace(self, context=None):
335 335 Colors = self.color_scheme_table.active_colors
336 336 ColorsNormal = Colors.Normal
337 337 if context is None:
338 338 context = self.context
339 339 try:
340 340 context=int(context)
341 341 if context <= 0:
342 342 raise ValueError("Context must be a positive integer")
343 343 except (TypeError, ValueError):
344 344 raise ValueError("Context must be a positive integer")
345 345 try:
346 346 skipped = 0
347 347 for hidden, frame_lineno in zip(self.hidden_frames(self.stack), self.stack):
348 348 if hidden and self.skip_hidden:
349 349 skipped += 1
350 350 continue
351 351 if skipped:
352 352 print(
353 353 f"{Colors.excName} [... skipping {skipped} hidden frame(s)]{ColorsNormal}\n"
354 354 )
355 355 skipped = 0
356 356 self.print_stack_entry(frame_lineno, context=context)
357 357 if skipped:
358 358 print(
359 359 f"{Colors.excName} [... skipping {skipped} hidden frame(s)]{ColorsNormal}\n"
360 360 )
361 361 except KeyboardInterrupt:
362 362 pass
363 363
364 364 def print_stack_entry(self, frame_lineno, prompt_prefix='\n-> ',
365 365 context=None):
366 366 if context is None:
367 367 context = self.context
368 368 try:
369 369 context=int(context)
370 370 if context <= 0:
371 371 raise ValueError("Context must be a positive integer")
372 372 except (TypeError, ValueError):
373 373 raise ValueError("Context must be a positive integer")
374 374 print(self.format_stack_entry(frame_lineno, '', context), file=self.stdout)
375 375
376 376 # vds: >>
377 377 frame, lineno = frame_lineno
378 378 filename = frame.f_code.co_filename
379 379 self.shell.hooks.synchronize_with_editor(filename, lineno, 0)
380 380 # vds: <<
381 381
382 382 def format_stack_entry(self, frame_lineno, lprefix=': ', context=None):
383 383 if context is None:
384 384 context = self.context
385 385 try:
386 386 context=int(context)
387 387 if context <= 0:
388 388 print("Context must be a positive integer", file=self.stdout)
389 389 except (TypeError, ValueError):
390 390 print("Context must be a positive integer", file=self.stdout)
391 391 try:
392 392 import reprlib # Py 3
393 393 except ImportError:
394 394 import repr as reprlib # Py 2
395 395
396 396 ret = []
397 397
398 398 Colors = self.color_scheme_table.active_colors
399 399 ColorsNormal = Colors.Normal
400 400 tpl_link = u'%s%%s%s' % (Colors.filenameEm, ColorsNormal)
401 401 tpl_call = u'%s%%s%s%%s%s' % (Colors.vName, Colors.valEm, ColorsNormal)
402 402 tpl_line = u'%%s%s%%s %s%%s' % (Colors.lineno, ColorsNormal)
403 403 tpl_line_em = u'%%s%s%%s %s%%s%s' % (Colors.linenoEm, Colors.line,
404 404 ColorsNormal)
405 405
406 406 frame, lineno = frame_lineno
407 407
408 408 return_value = ''
409 409 if '__return__' in frame.f_locals:
410 410 rv = frame.f_locals['__return__']
411 411 #return_value += '->'
412 412 return_value += reprlib.repr(rv) + '\n'
413 413 ret.append(return_value)
414 414
415 415 #s = filename + '(' + `lineno` + ')'
416 416 filename = self.canonic(frame.f_code.co_filename)
417 417 link = tpl_link % py3compat.cast_unicode(filename)
418 418
419 419 if frame.f_code.co_name:
420 420 func = frame.f_code.co_name
421 421 else:
422 422 func = "<lambda>"
423 423
424 424 call = ''
425 425 if func != '?':
426 426 if '__args__' in frame.f_locals:
427 427 args = reprlib.repr(frame.f_locals['__args__'])
428 428 else:
429 429 args = '()'
430 430 call = tpl_call % (func, args)
431 431
432 432 # The level info should be generated in the same format pdb uses, to
433 433 # avoid breaking the pdbtrack functionality of python-mode in *emacs.
434 434 if frame is self.curframe:
435 435 ret.append('> ')
436 436 else:
437 437 ret.append(' ')
438 438 ret.append(u'%s(%s)%s\n' % (link,lineno,call))
439 439
440 440 start = lineno - 1 - context//2
441 441 lines = linecache.getlines(filename)
442 442 start = min(start, len(lines) - context)
443 443 start = max(start, 0)
444 444 lines = lines[start : start + context]
445 445
446 446 for i,line in enumerate(lines):
447 447 show_arrow = (start + 1 + i == lineno)
448 448 linetpl = (frame is self.curframe or show_arrow) \
449 449 and tpl_line_em \
450 450 or tpl_line
451 451 ret.append(self.__format_line(linetpl, filename,
452 452 start + 1 + i, line,
453 453 arrow = show_arrow) )
454 454 return ''.join(ret)
455 455
456 456 def __format_line(self, tpl_line, filename, lineno, line, arrow = False):
457 457 bp_mark = ""
458 458 bp_mark_color = ""
459 459
460 460 new_line, err = self.parser.format2(line, 'str')
461 461 if not err:
462 462 line = new_line
463 463
464 464 bp = None
465 465 if lineno in self.get_file_breaks(filename):
466 466 bps = self.get_breaks(filename, lineno)
467 467 bp = bps[-1]
468 468
469 469 if bp:
470 470 Colors = self.color_scheme_table.active_colors
471 471 bp_mark = str(bp.number)
472 472 bp_mark_color = Colors.breakpoint_enabled
473 473 if not bp.enabled:
474 474 bp_mark_color = Colors.breakpoint_disabled
475 475
476 476 numbers_width = 7
477 477 if arrow:
478 478 # This is the line with the error
479 479 pad = numbers_width - len(str(lineno)) - len(bp_mark)
480 480 num = '%s%s' % (make_arrow(pad), str(lineno))
481 481 else:
482 482 num = '%*s' % (numbers_width - len(bp_mark), str(lineno))
483 483
484 484 return tpl_line % (bp_mark_color + bp_mark, num, line)
485 485
486 486
487 487 def print_list_lines(self, filename, first, last):
488 488 """The printing (as opposed to the parsing part of a 'list'
489 489 command."""
490 490 try:
491 491 Colors = self.color_scheme_table.active_colors
492 492 ColorsNormal = Colors.Normal
493 493 tpl_line = '%%s%s%%s %s%%s' % (Colors.lineno, ColorsNormal)
494 494 tpl_line_em = '%%s%s%%s %s%%s%s' % (Colors.linenoEm, Colors.line, ColorsNormal)
495 495 src = []
496 496 if filename == "<string>" and hasattr(self, "_exec_filename"):
497 497 filename = self._exec_filename
498 498
499 499 for lineno in range(first, last+1):
500 500 line = linecache.getline(filename, lineno)
501 501 if not line:
502 502 break
503 503
504 504 if lineno == self.curframe.f_lineno:
505 505 line = self.__format_line(tpl_line_em, filename, lineno, line, arrow = True)
506 506 else:
507 507 line = self.__format_line(tpl_line, filename, lineno, line, arrow = False)
508 508
509 509 src.append(line)
510 510 self.lineno = lineno
511 511
512 512 print(''.join(src), file=self.stdout)
513 513
514 514 except KeyboardInterrupt:
515 515 pass
516 516
517 517 def do_skip_hidden(self, arg):
518 518 """
519 519 Change whether or not we should skip frames with the
520 520 __tracebackhide__ attribute.
521 521 """
522 522 if arg.strip().lower() in ("true", "yes"):
523 523 self.skip_hidden = True
524 524 elif arg.strip().lower() in ("false", "no"):
525 525 self.skip_hidden = False
526 526
527 527 def do_list(self, arg):
528 528 """Print lines of code from the current stack frame
529 529 """
530 530 self.lastcmd = 'list'
531 531 last = None
532 532 if arg:
533 533 try:
534 534 x = eval(arg, {}, {})
535 535 if type(x) == type(()):
536 536 first, last = x
537 537 first = int(first)
538 538 last = int(last)
539 539 if last < first:
540 540 # Assume it's a count
541 541 last = first + last
542 542 else:
543 543 first = max(1, int(x) - 5)
544 544 except:
545 545 print('*** Error in argument:', repr(arg), file=self.stdout)
546 546 return
547 547 elif self.lineno is None:
548 548 first = max(1, self.curframe.f_lineno - 5)
549 549 else:
550 550 first = self.lineno + 1
551 551 if last is None:
552 552 last = first + 10
553 553 self.print_list_lines(self.curframe.f_code.co_filename, first, last)
554 554
555 555 # vds: >>
556 556 lineno = first
557 557 filename = self.curframe.f_code.co_filename
558 558 self.shell.hooks.synchronize_with_editor(filename, lineno, 0)
559 559 # vds: <<
560 560
561 561 do_l = do_list
562 562
563 563 def getsourcelines(self, obj):
564 564 lines, lineno = inspect.findsource(obj)
565 565 if inspect.isframe(obj) and obj.f_globals is obj.f_locals:
566 566 # must be a module frame: do not try to cut a block out of it
567 567 return lines, 1
568 568 elif inspect.ismodule(obj):
569 569 return lines, 1
570 570 return inspect.getblock(lines[lineno:]), lineno+1
571 571
572 572 def do_longlist(self, arg):
573 573 """Print lines of code from the current stack frame.
574 574
575 575 Shows more lines than 'list' does.
576 576 """
577 577 self.lastcmd = 'longlist'
578 578 try:
579 579 lines, lineno = self.getsourcelines(self.curframe)
580 580 except OSError as err:
581 581 self.error(err)
582 582 return
583 583 last = lineno + len(lines)
584 584 self.print_list_lines(self.curframe.f_code.co_filename, lineno, last)
585 585 do_ll = do_longlist
586 586
587 587 def do_debug(self, arg):
588 588 """debug code
589 589 Enter a recursive debugger that steps through the code
590 590 argument (which is an arbitrary expression or statement to be
591 591 executed in the current environment).
592 592 """
593 593 sys.settrace(None)
594 594 globals = self.curframe.f_globals
595 595 locals = self.curframe_locals
596 596 p = self.__class__(completekey=self.completekey,
597 597 stdin=self.stdin, stdout=self.stdout)
598 598 p.use_rawinput = self.use_rawinput
599 599 p.prompt = "(%s) " % self.prompt.strip()
600 600 self.message("ENTERING RECURSIVE DEBUGGER")
601 601 sys.call_tracing(p.run, (arg, globals, locals))
602 602 self.message("LEAVING RECURSIVE DEBUGGER")
603 603 sys.settrace(self.trace_dispatch)
604 604 self.lastcmd = p.lastcmd
605 605
606 606 def do_pdef(self, arg):
607 607 """Print the call signature for any callable object.
608 608
609 609 The debugger interface to %pdef"""
610 610 namespaces = [('Locals', self.curframe.f_locals),
611 611 ('Globals', self.curframe.f_globals)]
612 612 self.shell.find_line_magic('pdef')(arg, namespaces=namespaces)
613 613
614 614 def do_pdoc(self, arg):
615 615 """Print the docstring for an object.
616 616
617 617 The debugger interface to %pdoc."""
618 618 namespaces = [('Locals', self.curframe.f_locals),
619 619 ('Globals', self.curframe.f_globals)]
620 620 self.shell.find_line_magic('pdoc')(arg, namespaces=namespaces)
621 621
622 622 def do_pfile(self, arg):
623 623 """Print (or run through pager) the file where an object is defined.
624 624
625 625 The debugger interface to %pfile.
626 626 """
627 627 namespaces = [('Locals', self.curframe.f_locals),
628 628 ('Globals', self.curframe.f_globals)]
629 629 self.shell.find_line_magic('pfile')(arg, namespaces=namespaces)
630 630
631 631 def do_pinfo(self, arg):
632 632 """Provide detailed information about an object.
633 633
634 634 The debugger interface to %pinfo, i.e., obj?."""
635 635 namespaces = [('Locals', self.curframe.f_locals),
636 636 ('Globals', self.curframe.f_globals)]
637 637 self.shell.find_line_magic('pinfo')(arg, namespaces=namespaces)
638 638
639 639 def do_pinfo2(self, arg):
640 640 """Provide extra detailed information about an object.
641 641
642 642 The debugger interface to %pinfo2, i.e., obj??."""
643 643 namespaces = [('Locals', self.curframe.f_locals),
644 644 ('Globals', self.curframe.f_globals)]
645 645 self.shell.find_line_magic('pinfo2')(arg, namespaces=namespaces)
646 646
647 647 def do_psource(self, arg):
648 648 """Print (or run through pager) the source code for an object."""
649 649 namespaces = [('Locals', self.curframe.f_locals),
650 650 ('Globals', self.curframe.f_globals)]
651 651 self.shell.find_line_magic('psource')(arg, namespaces=namespaces)
652 652
653 653 def do_where(self, arg):
654 654 """w(here)
655 655 Print a stack trace, with the most recent frame at the bottom.
656 656 An arrow indicates the "current frame", which determines the
657 657 context of most commands. 'bt' is an alias for this command.
658 658
659 659 Take a number as argument as an (optional) number of context line to
660 660 print"""
661 661 if arg:
662 662 try:
663 663 context = int(arg)
664 664 except ValueError as err:
665 665 self.error(err)
666 666 return
667 667 self.print_stack_trace(context)
668 668 else:
669 669 self.print_stack_trace()
670 670
671 671 do_w = do_where
672 672
673 673 def stop_here(self, frame):
674 hidden = False
675 if self.skip_hidden:
676 hidden = frame.f_locals.get("__tracebackhide__", False)
677 if hidden:
674 """Check if pdb should stop here"""
675 if not super().stop_here(frame):
676 return False
677 if self.skip_hidden and frame.f_locals.get("__tracebackhide__", False):
678 678 Colors = self.color_scheme_table.active_colors
679 679 ColorsNormal = Colors.Normal
680 680 print(f"{Colors.excName} [... skipped 1 hidden frame]{ColorsNormal}\n")
681
682 return super().stop_here(frame)
681 return False
682 return True
683 683
684 684 def do_up(self, arg):
685 685 """u(p) [count]
686 686 Move the current frame count (default one) levels up in the
687 687 stack trace (to an older frame).
688 688
689 689 Will skip hidden frames.
690 690 """
691 691 ## modified version of upstream that skips
692 692 # frames with __tracebackide__
693 693 if self.curindex == 0:
694 694 self.error("Oldest frame")
695 695 return
696 696 try:
697 697 count = int(arg or 1)
698 698 except ValueError:
699 699 self.error("Invalid frame count (%s)" % arg)
700 700 return
701 701 skipped = 0
702 702 if count < 0:
703 703 _newframe = 0
704 704 else:
705 705 _newindex = self.curindex
706 706 counter = 0
707 707 hidden_frames = self.hidden_frames(self.stack)
708 708 for i in range(self.curindex - 1, -1, -1):
709 709 frame = self.stack[i][0]
710 710 if hidden_frames[i] and self.skip_hidden:
711 711 skipped += 1
712 712 continue
713 713 counter += 1
714 714 if counter >= count:
715 715 break
716 716 else:
717 717 # if no break occured.
718 718 self.error("all frames above hidden")
719 719 return
720 720
721 721 Colors = self.color_scheme_table.active_colors
722 722 ColorsNormal = Colors.Normal
723 723 _newframe = i
724 724 self._select_frame(_newframe)
725 725 if skipped:
726 726 print(
727 727 f"{Colors.excName} [... skipped {skipped} hidden frame(s)]{ColorsNormal}\n"
728 728 )
729 729
730 730 def do_down(self, arg):
731 731 """d(own) [count]
732 732 Move the current frame count (default one) levels down in the
733 733 stack trace (to a newer frame).
734 734
735 735 Will skip hidden frames.
736 736 """
737 737 if self.curindex + 1 == len(self.stack):
738 738 self.error("Newest frame")
739 739 return
740 740 try:
741 741 count = int(arg or 1)
742 742 except ValueError:
743 743 self.error("Invalid frame count (%s)" % arg)
744 744 return
745 745 if count < 0:
746 746 _newframe = len(self.stack) - 1
747 747 else:
748 748 _newindex = self.curindex
749 749 counter = 0
750 750 skipped = 0
751 751 hidden_frames = self.hidden_frames(self.stack)
752 752 for i in range(self.curindex + 1, len(self.stack)):
753 753 frame = self.stack[i][0]
754 754 if hidden_frames[i] and self.skip_hidden:
755 755 skipped += 1
756 756 continue
757 757 counter += 1
758 758 if counter >= count:
759 759 break
760 760 else:
761 761 self.error("all frames bellow hidden")
762 762 return
763 763
764 764 Colors = self.color_scheme_table.active_colors
765 765 ColorsNormal = Colors.Normal
766 766 if skipped:
767 767 print(
768 768 f"{Colors.excName} [... skipped {skipped} hidden frame(s)]{ColorsNormal}\n"
769 769 )
770 770 _newframe = i
771 771
772 772 self._select_frame(_newframe)
773 773
774 774 do_d = do_down
775 775 do_u = do_up
776 776
777 777 class InterruptiblePdb(Pdb):
778 778 """Version of debugger where KeyboardInterrupt exits the debugger altogether."""
779 779
780 780 def cmdloop(self):
781 781 """Wrap cmdloop() such that KeyboardInterrupt stops the debugger."""
782 782 try:
783 783 return OldPdb.cmdloop(self)
784 784 except KeyboardInterrupt:
785 785 self.stop_here = lambda frame: False
786 786 self.do_quit("")
787 787 sys.settrace(None)
788 788 self.quitting = False
789 789 raise
790 790
791 791 def _cmdloop(self):
792 792 while True:
793 793 try:
794 794 # keyboard interrupts allow for an easy way to cancel
795 795 # the current command, so allow them during interactive input
796 796 self.allow_kbdint = True
797 797 self.cmdloop()
798 798 self.allow_kbdint = False
799 799 break
800 800 except KeyboardInterrupt:
801 801 self.message('--KeyboardInterrupt--')
802 802 raise
803 803
804 804
805 805 def set_trace(frame=None):
806 806 """
807 807 Start debugging from `frame`.
808 808
809 809 If frame is not specified, debugging starts from caller's frame.
810 810 """
811 811 Pdb().set_trace(frame or sys._getframe().f_back)
General Comments 0
You need to be logged in to leave comments. Login now