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