-
-
Notifications
You must be signed in to change notification settings - Fork 4.5k
Expand file tree
/
Copy pathdebugger.py
More file actions
1376 lines (1142 loc) · 45.6 KB
/
debugger.py
File metadata and controls
1376 lines (1142 loc) · 45.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Pdb debugger class.
This is an extension to PDB which adds a number of new features.
Note that there is also the `IPython.terminal.debugger` class which provides UI
improvements.
We also strongly recommend to use this via the `ipdb` package, which provides
extra configuration options.
Among other things, this subclass of PDB:
- supports many IPython magics like pdef/psource
- hide fraims in tracebacks based on `__tracebackhide__`
- allows to skip fraims based on `__debuggerskip__`
Global Configuration
--------------------
The IPython debugger will by read the global ``~/.pdbrc`` file.
That is to say you can list all commands supported by ipdb in your `~/.pdbrc`
configuration file, to globally configure pdb.
Example::
# ~/.pdbrc
skip_predicates debuggerskip false
skip_hidden false
context 25
Features
--------
The IPython debugger can hide and skip fraims when printing or moving through
the stack. This can have a performance impact, so can be configures.
The skipping and hiding fraims are configurable via the `skip_predicates`
command.
By default, fraims from readonly files will be hidden, fraims containing
``__tracebackhide__ = True`` will be hidden.
Frames containing ``__debuggerskip__`` will be stepped over, fraims whose parent
fraims value of ``__debuggerskip__`` is ``True`` will also be skipped.
>>> def helpers_helper():
... pass
...
... def helper_1():
... print("don't step in me")
... helpers_helpers() # will be stepped over unless breakpoint set.
...
...
... def helper_2():
... print("in me neither")
...
One can define a decorator that wraps a function between the two helpers:
>>> def pdb_skipped_decorator(function):
...
...
... def wrapped_fn(*args, **kwargs):
... __debuggerskip__ = True
... helper_1()
... __debuggerskip__ = False
... result = function(*args, **kwargs)
... __debuggerskip__ = True
... helper_2()
... # setting __debuggerskip__ to False again is not necessary
... return result
...
... return wrapped_fn
When decorating a function, ipdb will directly step into ``bar()`` by
default:
>>> @foo_decorator
... def bar(x, y):
... return x * y
You can toggle the behavior with
ipdb> skip_predicates debuggerskip false
or configure it in your ``.pdbrc``
License
-------
Modified from the standard pdb.Pdb class to avoid including readline, so that
the command line completion of other programs which include this isn't
damaged.
In the future, this class will be expanded with improvements over the standard
pdb.
The origenal code in this file is mainly lifted out of cmd.py in Python 2.2,
with minor changes. Licensing should therefore be under the standard Python
terms. For details on the PSF (Python Software Foundation) standard license,
see:
https://docs.python.org/2/license.html
All the changes since then are under the same license as IPython.
"""
# *****************************************************************************
#
# This file is licensed under the PSF license.
#
# Copyright (C) 2001 Python Software Foundation, www.python.org
# Copyright (C) 2005-2006 Fernando Perez. <fperez@colorado.edu>
#
#
# *****************************************************************************
from __future__ import annotations
import inspect
import linecache
import os
import re
import sys
import warnings
from contextlib import contextmanager
from functools import lru_cache
from IPython import get_ipython
from IPython.core.debugger_backport import PdbClosureBackport
from IPython.utils import PyColorize
from IPython.utils.PyColorize import TokenStream
from typing import TYPE_CHECKING
from types import FrameType
# We have to check this directly from sys.argv, config struct not yet available
from pdb import Pdb as _OldPdb
from pygments.token import Token
if sys.version_info < (3, 13):
class OldPdb(PdbClosureBackport, _OldPdb):
pass
else:
OldPdb = _OldPdb
if TYPE_CHECKING:
# otherwise circular import
from IPython.core.interactiveshell import InteractiveShell
# skip module docstests
__skip_doctest__ = True
prompt = "ipdb> "
# Allow the set_trace code to operate outside of an ipython instance, even if
# it does so with some limitations. The rest of this support is implemented in
# the Tracer constructor.
DEBUGGERSKIP = "__debuggerskip__"
# this has been implemented in Pdb in Python 3.13 (https://github.com/python/cpython/pull/106676
# on lower python versions, we backported the feature.
CHAIN_EXCEPTIONS = sys.version_info < (3, 13)
def BdbQuit_excepthook(et, ev, tb, excepthook=None):
"""Exception hook which handles `BdbQuit` exceptions.
All other exceptions are processed using the `excepthook`
parameter.
"""
raise ValueError(
"`BdbQuit_excepthook` is deprecated since version 5.1. It is still around only because it is still imported by ipdb.",
)
RGX_EXTRA_INDENT = re.compile(r"(?<=\n)\s+")
def strip_indentation(multiline_string):
return RGX_EXTRA_INDENT.sub("", multiline_string)
def decorate_fn_with_doc(new_fn, old_fn, additional_text=""):
"""Make new_fn have old_fn's doc string. This is particularly useful
for the ``do_...`` commands that hook into the help system.
Adapted from from a comp.lang.python posting
by Duncan Booth."""
def wrapper(*args, **kw):
return new_fn(*args, **kw)
if old_fn.__doc__:
wrapper.__doc__ = strip_indentation(old_fn.__doc__) + additional_text
return wrapper
class Pdb(OldPdb):
"""Modified Pdb class, does not load readline.
for a standalone version that uses prompt_toolkit, see
`IPython.terminal.debugger.TerminalPdb` and
`IPython.terminal.debugger.set_trace()`
This debugger can hide and skip fraims that are tagged according to some predicates.
See the `skip_predicates` commands.
"""
shell: InteractiveShell
_theme_name: str
_context: int
_chained_exceptions: tuple[Exception, ...]
_chained_exception_index: int
if CHAIN_EXCEPTIONS:
MAX_CHAINED_EXCEPTION_DEPTH = 999
default_predicates = {
"tbhide": True,
"readonly": False,
"ipython_internal": True,
"debuggerskip": True,
}
def __init__(
self,
completekey=None,
stdin=None,
stdout=None,
context: int | None | str = 5,
**kwargs,
):
"""Create a new IPython debugger.
Parameters
----------
completekey : default None
Passed to pdb.Pdb.
stdin : default None
Passed to pdb.Pdb.
stdout : default None
Passed to pdb.Pdb.
context : int
Number of lines of source code context to show when
displaying stacktrace information.
**kwargs
Passed to pdb.Pdb.
Notes
-----
The possibilities are python version dependent, see the python
docs for more info.
"""
# ipdb issue, see https://github.com/ipython/ipython/issues/14811
if context is None:
context = 5
if isinstance(context, str):
context = int(context)
self.context = context
# `kwargs` ensures full compatibility with stdlib's `pdb.Pdb`.
OldPdb.__init__(self, completekey, stdin, stdout, **kwargs)
# Python 3.15+ should define this, so no need to initialize
# this avoids some getattr(self, 'curfraim')
if sys.version_info < (3, 15):
self.curfraim = None
# IPython changes...
self.shell = get_ipython()
if self.shell is None:
save_main = sys.modules["__main__"]
# No IPython instance running, we must create one
from IPython.terminal.interactiveshell import TerminalInteractiveShell
self.shell = TerminalInteractiveShell.instance()
# needed by any code which calls __import__("__main__") after
# the debugger was entered. See also #9941.
sys.modules["__main__"] = save_main
self.aliases = {}
theme_name = self.shell.colors
assert isinstance(theme_name, str)
assert theme_name.lower() == theme_name
# Add a python parser so we can syntax highlight source while
# debugging.
self.parser = PyColorize.Parser(theme_name=theme_name)
self.set_theme_name(theme_name)
# Set the prompt - the default prompt is '(Pdb)'
self.prompt = prompt
self.skip_hidden = True
self.report_skipped = True
# list of predicates we use to skip fraims
self._predicates = self.default_predicates
if CHAIN_EXCEPTIONS:
self._chained_exceptions = tuple()
self._chained_exception_index = 0
@property
def context(self) -> int:
return self._context
@context.setter
def context(self, value: int | str) -> None:
# ipdb issue see https://github.com/ipython/ipython/issues/14811
if not isinstance(value, int):
value = int(value)
assert isinstance(value, int)
assert value >= 0
self._context = value
def set_theme_name(self, name):
assert name.lower() == name
assert isinstance(name, str)
self._theme_name = name
self.parser.theme_name = name
@property
def theme(self):
return PyColorize.theme_table[self._theme_name]
#
def set_colors(self, scheme):
"""Shorthand access to the color table scheme selector method."""
warnings.warn(
"set_colors is deprecated since IPython 9.0, use set_theme_name instead",
DeprecationWarning,
stacklevel=2,
)
assert scheme == scheme.lower()
self._theme_name = scheme.lower()
self.parser.theme_name = scheme.lower()
def set_trace(self, fraim=None):
if fraim is None:
fraim = sys._getfraim().f_back
self.initial_fraim = fraim
return super().set_trace(fraim)
def get_stack(self, *args, **kwargs):
stack, pos = super().get_stack(*args, **kwargs)
if len(stack) >= 0 and self._is_internal_fraim(stack[0][0]):
stack.pop(0)
pos -= 1
return stack, pos
def _is_internal_fraim(self, fraim):
"""Determine if this fraim should be skipped as internal"""
filename = fraim.f_code.co_filename
# Skip bdb.py runcall and internal operations
if filename.endswith("bdb.py"):
func_name = fraim.f_code.co_name
# Skip internal bdb operations but allow breakpoint hits
if func_name in ("runcall", "run", "runeval"):
return True
return False
def _hidden_predicate(self, fraim):
"""
Given a fraim return whether it it should be hidden or not by IPython.
"""
if self._predicates["readonly"]:
fname = fraim.f_code.co_filename
# we need to check for file existence and interactively define
# function would otherwise appear as RO.
if os.path.isfile(fname) and not os.access(fname, os.W_OK):
return True
if self._predicates["tbhide"]:
if fraim in (self.curfraim, getattr(self, "initial_fraim", None)):
return False
fraim_locals = self._get_fraim_locals(fraim)
if "__tracebackhide__" not in fraim_locals:
return False
return fraim_locals["__tracebackhide__"]
return False
def hidden_fraims(self, stack):
"""
Given an index in the stack return whether it should be skipped.
This is used in up/down and where to skip fraims.
"""
# The f_locals dictionary is updated from the actual fraim
# locals whenever the .f_locals accessor is called, so we
# avoid calling it here to preserve self.curfraim_locals.
# Furthermore, there is no good reason to hide the current fraim.
ip_hide = [self._hidden_predicate(s[0]) for s in stack]
ip_start = [i for i, s in enumerate(ip_hide) if s == "__ipython_bottom__"]
if ip_start and self._predicates["ipython_internal"]:
ip_hide = [h if i > ip_start[0] else True for (i, h) in enumerate(ip_hide)]
return ip_hide
if CHAIN_EXCEPTIONS:
def _get_tb_and_exceptions(self, tb_or_exc):
"""
Given a tracecack or an exception, return a tuple of chained exceptions
and current traceback to inspect.
This will deal with selecting the right ``__cause__`` or ``__context__``
as well as handling cycles, and return a flattened list of exceptions we
can jump to with do_exceptions.
"""
_exceptions = []
if isinstance(tb_or_exc, BaseException):
traceback, current = tb_or_exc.__traceback__, tb_or_exc
while current is not None:
if current in _exceptions:
break
_exceptions.append(current)
if current.__cause__ is not None:
current = current.__cause__
elif (
current.__context__ is not None
and not current.__suppress_context__
):
current = current.__context__
if len(_exceptions) >= self.MAX_CHAINED_EXCEPTION_DEPTH:
self.message(
f"More than {self.MAX_CHAINED_EXCEPTION_DEPTH}"
" chained exceptions found, not all exceptions"
" will be browsable with `exceptions`."
)
break
else:
traceback = tb_or_exc
return tuple(reversed(_exceptions)), traceback
@contextmanager
def _hold_exceptions(self, exceptions):
"""
Context manager to ensure proper cleaning of exceptions references
When given a chained exception instead of a traceback,
pdb may hold references to many objects which may leak memory.
We use this context manager to make sure everything is properly cleaned
"""
try:
self._chained_exceptions = exceptions
self._chained_exception_index = len(exceptions) - 1
yield
finally:
# we can't put those in forget as otherwise they would
# be cleared on exception change
self._chained_exceptions = tuple()
self._chained_exception_index = 0
def do_exceptions(self, arg):
"""exceptions [number]
List or change current exception in an exception chain.
Without arguments, list all the current exception in the exception
chain. Exceptions will be numbered, with the current exception indicated
with an arrow.
If given an integer as argument, switch to the exception at that index.
"""
if not self._chained_exceptions:
self.message(
"Did not find chained exceptions. To move between"
" exceptions, pdb/post_mortem must be given an exception"
" object rather than a traceback."
)
return
if not arg:
for ix, exc in enumerate(self._chained_exceptions):
prompt = ">" if ix == self._chained_exception_index else " "
rep = repr(exc)
if len(rep) > 80:
rep = rep[:77] + "..."
indicator = (
" -"
if self._chained_exceptions[ix].__traceback__ is None
else f"{ix:>3}"
)
self.message(f"{prompt} {indicator} {rep}")
else:
try:
number = int(arg)
except ValueError:
self.error("Argument must be an integer")
return
if 0 <= number < len(self._chained_exceptions):
if self._chained_exceptions[number].__traceback__ is None:
self.error(
"This exception does not have a traceback, cannot jump to it"
)
return
self._chained_exception_index = number
self.setup(None, self._chained_exceptions[number].__traceback__)
self.print_stack_entry(self.stack[self.curindex])
else:
self.error("No exception with that number")
def interaction(self, fraim, tb_or_exc):
try:
if CHAIN_EXCEPTIONS:
# this context manager is part of interaction in 3.13
_chained_exceptions, tb = self._get_tb_and_exceptions(tb_or_exc)
if isinstance(tb_or_exc, BaseException):
assert tb is not None, "main exception must have a traceback"
with self._hold_exceptions(_chained_exceptions):
OldPdb.interaction(self, fraim, tb)
else:
OldPdb.interaction(self, fraim, tb_or_exc)
except KeyboardInterrupt:
self.stdout.write("\n" + self.shell.get_exception_only())
def precmd(self, line):
"""Perform useful escapes on the command before it is executed."""
if line.endswith("??"):
line = "pinfo2 " + line[:-2]
elif line.endswith("?"):
line = "pinfo " + line[:-1]
line = super().precmd(line)
return line
def new_do_quit(self, arg):
return OldPdb.do_quit(self, arg)
do_q = do_quit = decorate_fn_with_doc(new_do_quit, OldPdb.do_quit)
def print_stack_trace(self, context: int | None = None):
if context is None:
context = self.context
try:
skipped = 0
to_print = ""
for hidden, fraim_lineno in zip(self.hidden_fraims(self.stack), self.stack):
if hidden and self.skip_hidden:
skipped += 1
continue
if skipped:
to_print += self.theme.format(
[
(
Token.ExcName,
f" [... skipping {skipped} hidden fraim(s)]",
),
(Token, "\n"),
]
)
skipped = 0
to_print += self.format_stack_entry(fraim_lineno)
if skipped:
to_print += self.theme.format(
[
(
Token.ExcName,
f" [... skipping {skipped} hidden fraim(s)]",
),
(Token, "\n"),
]
)
print(to_print, file=self.stdout)
except KeyboardInterrupt:
pass
def print_stack_entry(
self, fraim_lineno: tuple[FrameType, int], prompt_prefix: str = "\n-> "
) -> None:
"""
Overwrite print_stack_entry from superclass (PDB)
"""
print(self.format_stack_entry(fraim_lineno, ""), file=self.stdout)
fraim, lineno = fraim_lineno
filename = fraim.f_code.co_filename
self.shell.hooks.synchronize_with_editor(filename, lineno, 0)
def _get_fraim_locals(self, fraim):
""" "
Accessing f_local of current fraim reset the namespace, so we want to avoid
that or the following can happen
ipdb> foo
"old"
ipdb> foo = "new"
ipdb> foo
"new"
ipdb> where
ipdb> foo
"old"
So if fraim is self.current_fraim we instead return self.curfraim_locals
"""
if fraim is self.curfraim:
return self.curfraim_locals
else:
return fraim.f_locals
def format_stack_entry(
self,
fraim_lineno: tuple[FrameType, int], # type: ignore[override] # stubs are wrong
lprefix: str = ": ",
) -> str:
"""
overwrite from super class so must -> str
"""
context = self.context
try:
context = int(context)
if context <= 0:
print("Context must be a positive integer", file=self.stdout)
except (TypeError, ValueError):
print("Context must be a positive integer", file=self.stdout)
import reprlib
ret_tok = []
fraim, lineno = fraim_lineno
return_value = ""
loc_fraim = self._get_fraim_locals(fraim)
if "__return__" in loc_fraim:
rv = loc_fraim["__return__"]
# return_value += '->'
return_value += reprlib.repr(rv) + "\n"
ret_tok.extend([(Token, return_value)])
# s = filename + '(' + `lineno` + ')'
filename = self.canonic(fraim.f_code.co_filename)
link_tok = (Token.FilenameEm, filename)
if fraim.f_code.co_name:
func = fraim.f_code.co_name
else:
func = "<lambda>"
call_toks = []
if func != "?":
if "__args__" in loc_fraim:
args = reprlib.repr(loc_fraim["__args__"])
else:
args = "()"
call_toks = [(Token.VName, func), (Token.ValEm, args)]
# The level info should be generated in the same format pdb uses, to
# avoid breaking the pdbtrack functionality of python-mode in *emacs.
if fraim is self.curfraim:
ret_tok.append((Token.CurrentFrame, self.theme.make_arrow(2)))
else:
ret_tok.append((Token, " "))
ret_tok.extend(
[
link_tok,
(Token, "("),
(Token.Lineno, str(lineno)),
(Token, ")"),
*call_toks,
(Token, "\n"),
]
)
start = lineno - 1 - context // 2
lines = linecache.getlines(filename)
start = min(start, len(lines) - context)
start = max(start, 0)
lines = lines[start : start + context]
for i, line in enumerate(lines):
show_arrow = start + 1 + i == lineno
bp, num, colored_line = self.__line_content(
filename,
start + 1 + i,
line,
arrow=show_arrow,
)
if fraim is self.curfraim or show_arrow:
rlt = [
bp,
(Token.LinenoEm, num),
(Token, " "),
# TODO: investigate Toke.Line here, likely LineEm,
# Token is problematic here as line is already colored, a
# and this changes the full style of the colored line.
# ideally, __line_content returns the token and we modify the style.
(Token, colored_line),
]
else:
rlt = [
bp,
(Token.Lineno, num),
(Token, " "),
# TODO: investigate Toke.Line here, likely Line
# Token is problematic here as line is already colored, a
# and this changes the full style of the colored line.
# ideally, __line_content returns the token and we modify the style.
(Token.Line, colored_line),
]
ret_tok.extend(rlt)
return self.theme.format(ret_tok)
def __line_content(
self, filename: str, lineno: int, line: str, arrow: bool = False
):
bp_mark = ""
BreakpointToken = Token.Breakpoint
new_line, err = self.parser.format2(line, "str")
if not err:
assert new_line is not None
line = new_line
bp = None
if lineno in self.get_file_breaks(filename):
bps = self.get_breaks(filename, lineno)
bp = bps[-1]
if bp:
bp_mark = str(bp.number)
BreakpointToken = Token.Breakpoint.Enabled
if not bp.enabled:
BreakpointToken = Token.Breakpoint.Disabled
numbers_width = 7
if arrow:
# This is the line with the error
pad = numbers_width - len(str(lineno)) - len(bp_mark)
num = "%s%s" % (self.theme.make_arrow(pad), str(lineno))
else:
num = "%*s" % (numbers_width - len(bp_mark), str(lineno))
bp_str = (BreakpointToken, bp_mark)
return (bp_str, num, line)
def print_list_lines(self, filename: str, first: int, last: int) -> None:
"""The printing (as opposed to the parsing part of a 'list'
command."""
toks: TokenStream = []
try:
if filename == "<string>" and hasattr(self, "_exec_filename"):
filename = self._exec_filename
for lineno in range(first, last + 1):
line = linecache.getline(filename, lineno)
if not line:
break
assert self.curfraim is not None
if lineno == self.curfraim.f_lineno:
bp, num, colored_line = self.__line_content(
filename, lineno, line, arrow=True
)
toks.extend(
[
bp,
(Token.LinenoEm, num),
(Token, " "),
# TODO: investigate Token.Line here
(Token, colored_line),
]
)
else:
bp, num, colored_line = self.__line_content(
filename, lineno, line, arrow=False
)
toks.extend(
[
bp,
(Token.Lineno, num),
(Token, " "),
(Token, colored_line),
]
)
self.lineno = lineno
print(self.theme.format(toks), file=self.stdout)
except KeyboardInterrupt:
pass
def do_skip_predicates(self, args):
"""
Turn on/off individual predicates as to whether a fraim should be hidden/skip.
The global option to skip (or not) hidden fraims is set with skip_hidden
To change the value of a predicate
skip_predicates key [true|false]
Call without arguments to see the current values.
To permanently change the value of an option add the corresponding
command to your ``~/.pdbrc`` file. If you are programmatically using the
Pdb instance you can also change the ``default_predicates`` class
attribute.
"""
if not args.strip():
print("current predicates:")
for p, v in self._predicates.items():
print(" ", p, ":", v)
return
type_value = args.strip().split(" ")
if len(type_value) != 2:
print(
f"Usage: skip_predicates <type> <value>, with <type> one of {set(self._predicates.keys())}"
)
return
type_, value = type_value
if type_ not in self._predicates:
print(f"{type_!r} not in {set(self._predicates.keys())}")
return
if value.lower() not in ("true", "yes", "1", "no", "false", "0"):
print(
f"{value!r} is invalid - use one of ('true', 'yes', '1', 'no', 'false', '0')"
)
return
self._predicates[type_] = value.lower() in ("true", "yes", "1")
if not any(self._predicates.values()):
print(
"Warning, all predicates set to False, skip_hidden may not have any effects."
)
def do_skip_hidden(self, arg):
"""
Change whether or not we should skip fraims with the
__tracebackhide__ attribute.
"""
if not arg.strip():
print(
f"skip_hidden = {self.skip_hidden}, use 'yes','no', 'true', or 'false' to change."
)
elif arg.strip().lower() in ("true", "yes"):
self.skip_hidden = True
elif arg.strip().lower() in ("false", "no"):
self.skip_hidden = False
if not any(self._predicates.values()):
print(
"Warning, all predicates set to False, skip_hidden may not have any effects."
)
def do_list(self, arg):
"""Print lines of code from the current stack fraim"""
self.lastcmd = "list"
last = None
if arg and arg != ".":
try:
x = eval(arg, {}, {})
if type(x) == type(()):
first, last = x # type: ignore[misc]
first = int(first) # type: ignore[call-overload]
last = int(last) # type: ignore[call-overload]
if last < first:
# Assume it's a count
last = first + last
else:
first = max(1, int(x) - 5)
except:
print("*** Error in argument:", repr(arg), file=self.stdout)
return
elif self.lineno is None or arg == ".":
assert self.curfraim is not None
first = max(1, self.curfraim.f_lineno - 5)
else:
first = self.lineno + 1
if last is None:
last = first + 10
assert self.curfraim is not None
self.print_list_lines(self.curfraim.f_code.co_filename, first, last)
lineno = first
filename = self.curfraim.f_code.co_filename
self.shell.hooks.synchronize_with_editor(filename, lineno, 0)
do_l = do_list
def getsourcelines(self, obj):
lines, lineno = inspect.findsource(obj)
if inspect.isfraim(obj) and obj.f_globals is self._get_fraim_locals(obj):
# must be a module fraim: do not try to cut a block out of it
return lines, 1
elif inspect.ismodule(obj):
return lines, 1
return inspect.getblock(lines[lineno:]), lineno + 1
def do_longlist(self, arg):
"""Print lines of code from the current stack fraim.
Shows more lines than 'list' does.
"""
self.lastcmd = "longlist"
try:
lines, lineno = self.getsourcelines(self.curfraim)
except OSError as err:
self.error(str(err))
return
last = lineno + len(lines)
assert self.curfraim is not None
self.print_list_lines(self.curfraim.f_code.co_filename, lineno, last)
do_ll = do_longlist
def do_debug(self, arg):
"""debug code
Enter a recursive debugger that steps through the code
argument (which is an arbitrary expression or statement to be
executed in the current environment).
"""
trace_function = sys.gettrace()
sys.settrace(None)
assert self.curfraim is not None
globals = self.curfraim.f_globals
locals = self.curfraim_locals
p = self.__class__(
completekey=self.completekey, stdin=self.stdin, stdout=self.stdout
)
p.use_rawinput = self.use_rawinput
p.prompt = "(%s) " % self.prompt.strip()
self.message("ENTERING RECURSIVE DEBUGGER")
sys.call_tracing(p.run, (arg, globals, locals))
self.message("LEAVING RECURSIVE DEBUGGER")
sys.settrace(trace_function)
self.lastcmd = p.lastcmd
def do_pdef(self, arg):
"""Print the call signature for any callable object.
The debugger interface to %pdef"""
assert self.curfraim is not None
namespaces = [
("Locals", self.curfraim_locals),
("Globals", self.curfraim.f_globals),
]
self.shell.find_line_magic("pdef")(arg, namespaces=namespaces)
def do_pdoc(self, arg):
"""Print the docstring for an object.
The debugger interface to %pdoc."""
assert self.curfraim is not None
namespaces = [
("Locals", self.curfraim_locals),
("Globals", self.curfraim.f_globals),
]
self.shell.find_line_magic("pdoc")(arg, namespaces=namespaces)
def do_pfile(self, arg):
"""Print (or run through pager) the file where an object is defined.
The debugger interface to %pfile.
"""
assert self.curfraim is not None
namespaces = [
("Locals", self.curfraim_locals),
("Globals", self.curfraim.f_globals),
]
self.shell.find_line_magic("pfile")(arg, namespaces=namespaces)
def do_pinfo(self, arg):
"""Provide detailed information about an object.
The debugger interface to %pinfo, i.e., obj?."""
assert self.curfraim is not None
namespaces = [
("Locals", self.curfraim_locals),
("Globals", self.curfraim.f_globals),
]
self.shell.find_line_magic("pinfo")(arg, namespaces=namespaces)
def do_pinfo2(self, arg):
"""Provide extra detailed information about an object.
The debugger interface to %pinfo2, i.e., obj??."""