blob: bf503f1e73ee1412908954dd5cdaf1f3e57168f7 [file] [log] [blame]
Benjamin Peterson90f5ba52010-03-11 22:53:45 +00001#! /usr/bin/env python3
Guido van Rossumf17361d1996-07-30 16:28:13 +00002
Georg Brandl02053ee2010-07-18 10:11:03 +00003"""
4The Python Debugger Pdb
5=======================
Guido van Rossum92df0c61992-01-14 18:30:15 +00006
Georg Brandl02053ee2010-07-18 10:11:03 +00007To use the debugger in its simplest form:
8
9 >>> import pdb
10 >>> pdb.run('<a statement>')
11
12The debugger's prompt is '(Pdb) '. This will stop in the first
13function call in <a statement>.
14
15Alternatively, if a statement terminated with an unhandled exception,
16you can use pdb's post-mortem facility to inspect the contents of the
17traceback:
18
19 >>> <a statement>
20 <exception traceback>
21 >>> import pdb
22 >>> pdb.pm()
23
24The commands recognized by the debugger are listed in the next
25section. Most can be abbreviated as indicated; e.g., h(elp) means
26that 'help' can be typed as 'h' or 'help' (but not as 'he' or 'hel',
27nor as 'H' or 'Help' or 'HELP'). Optional arguments are enclosed in
28square brackets. Alternatives in the command syntax are separated
29by a vertical bar (|).
30
31A blank line repeats the previous command literally, except for
32'list', where it lists the next 11 lines.
33
34Commands that the debugger doesn't recognize are assumed to be Python
35statements and are executed in the context of the program being
36debugged. Python statements can also be prefixed with an exclamation
37point ('!'). This is a powerful way to inspect the program being
38debugged; it is even possible to change variables or call functions.
39When an exception occurs in such a statement, the exception name is
40printed but the debugger's state is not changed.
41
42The debugger supports aliases, which can save typing. And aliases can
43have parameters (see the alias help entry) which allows one a certain
44level of adaptability to the context under examination.
45
46Multiple commands may be entered on a single line, separated by the
47pair ';;'. No intelligence is applied to separating the commands; the
48input is split at the first ';;', even if it is in the middle of a
49quoted string.
50
51If a file ".pdbrc" exists in your home directory or in the current
52directory, it is read in and executed as if it had been typed at the
53debugger prompt. This is particularly useful for aliases. If both
54files exist, the one in the home directory is read first and aliases
Ɓukasz Langa2eb6eca2016-09-09 22:21:17 -070055defined there can be overridden by the local file. This behavior can be
56disabled by passing the "readrc=False" argument to the Pdb constructor.
Georg Brandl02053ee2010-07-18 10:11:03 +000057
58Aside from aliases, the debugger is not directly programmable; but it
59is implemented as a class from which you can derive your own debugger
60class, which you can make as fancy as you like.
61
62
63Debugger commands
64=================
65
Georg Brandl02053ee2010-07-18 10:11:03 +000066"""
Georg Brandl0d089622010-07-30 16:00:46 +000067# NOTE: the actual command documentation is collected from docstrings of the
68# commands and is appended to __doc__ after the class has been defined.
Guido van Rossum921c8241992-01-10 14:54:42 +000069
Georg Brandl44f2b642010-12-04 16:00:47 +000070import os
jsnkllnd5938812019-11-12 17:42:47 -050071import io
Georg Brandl44f2b642010-12-04 16:00:47 +000072import re
Guido van Rossum921c8241992-01-10 14:54:42 +000073import sys
Guido van Rossum23efba41992-01-27 16:58:47 +000074import cmd
75import bdb
Georg Brandl0a9c3e92010-07-30 18:46:38 +000076import dis
Georg Brandl1acb7462010-12-04 11:20:26 +000077import code
Georg Brandl4c7c3c52012-03-10 22:36:48 +010078import glob
Barry Warsaw210bd202002-11-05 22:40:20 +000079import pprint
Georg Brandl44f2b642010-12-04 16:00:47 +000080import signal
Georg Brandle59ca2a2010-07-30 17:04:28 +000081import inspect
Georg Brandl1acb7462010-12-04 11:20:26 +000082import traceback
83import linecache
Guido van Rossumd8faa362007-04-27 19:54:29 +000084
85
86class Restart(Exception):
87 """Causes a debugger to be restarted for the debugged python program."""
88 pass
89
Skip Montanaro352674d2001-02-07 23:14:30 +000090__all__ = ["run", "pm", "Pdb", "runeval", "runctx", "runcall", "set_trace",
91 "post_mortem", "help"]
92
Barry Warsaw2bee8fe1999-09-09 16:32:41 +000093def find_function(funcname, filename):
Thomas Wouters89f507f2006-12-13 04:49:30 +000094 cre = re.compile(r'def\s+%s\s*[(]' % re.escape(funcname))
Tim Peters2344fae2001-01-15 00:50:52 +000095 try:
96 fp = open(filename)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +020097 except OSError:
Tim Peters2344fae2001-01-15 00:50:52 +000098 return None
99 # consumer of this info expects the first line to be 1
Georg Brandl6e220552013-10-13 20:51:47 +0200100 with fp:
101 for lineno, line in enumerate(fp, start=1):
102 if cre.match(line):
103 return funcname, filename, lineno
104 return None
Guido van Rossum921c8241992-01-10 14:54:42 +0000105
Georg Brandl5ed2b5a2010-07-30 18:08:12 +0000106def getsourcelines(obj):
107 lines, lineno = inspect.findsource(obj)
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000108 if inspect.isframe(obj) and obj.f_globals is obj.f_locals:
Georg Brandl5ed2b5a2010-07-30 18:08:12 +0000109 # must be a module frame: do not try to cut a block out of it
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000110 return lines, 1
Georg Brandl5ed2b5a2010-07-30 18:08:12 +0000111 elif inspect.ismodule(obj):
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000112 return lines, 1
Georg Brandl5ed2b5a2010-07-30 18:08:12 +0000113 return inspect.getblock(lines[lineno:]), lineno+1
Guido van Rossum921c8241992-01-10 14:54:42 +0000114
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000115def lasti2lineno(code, lasti):
116 linestarts = list(dis.findlinestarts(code))
117 linestarts.reverse()
118 for i, lineno in linestarts:
119 if lasti >= i:
120 return lineno
121 return 0
122
123
Georg Brandlcbc79c72010-12-04 16:21:42 +0000124class _rstr(str):
125 """String that doesn't quote its repr."""
126 def __repr__(self):
127 return self
128
129
Guido van Rossuma558e371994-11-10 22:27:35 +0000130# Interaction prompt line will separate file and call info from code
131# text using value of line_prefix string. A newline and arrow may
132# be to your liking. You can set it once pdb is imported using the
133# command "pdb.line_prefix = '\n% '".
Tim Peters2344fae2001-01-15 00:50:52 +0000134# line_prefix = ': ' # Use this to get the old situation back
135line_prefix = '\n-> ' # Probably a better default
Guido van Rossuma558e371994-11-10 22:27:35 +0000136
Guido van Rossum23efba41992-01-27 16:58:47 +0000137class Pdb(bdb.Bdb, cmd.Cmd):
Guido van Rossum2424f851998-09-11 22:50:09 +0000138
Xavier de Gaye10e54ae2016-10-12 20:13:24 +0200139 _previous_sigint_handler = None
140
Georg Brandl44f2b642010-12-04 16:00:47 +0000141 def __init__(self, completekey='tab', stdin=None, stdout=None, skip=None,
Ɓukasz Langa2eb6eca2016-09-09 22:21:17 -0700142 nosigint=False, readrc=True):
Georg Brandl243ad662009-05-05 09:00:19 +0000143 bdb.Bdb.__init__(self, skip=skip)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000144 cmd.Cmd.__init__(self, completekey, stdin, stdout)
Steve Dower60419a72019-06-24 08:42:54 -0700145 sys.audit("pdb.Pdb")
Thomas Wouters477c8d52006-05-27 19:21:47 +0000146 if stdout:
147 self.use_rawinput = 0
Tim Peters2344fae2001-01-15 00:50:52 +0000148 self.prompt = '(Pdb) '
149 self.aliases = {}
Georg Brandlcbc79c72010-12-04 16:21:42 +0000150 self.displaying = {}
Johannes Gijsbers25b38c82004-10-12 18:12:09 +0000151 self.mainpyfile = ''
Georg Brandlac9a2bb2010-11-29 20:19:15 +0000152 self._wait_for_mainpyfile = False
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000153 self.tb_lineno = {}
Tim Peters2344fae2001-01-15 00:50:52 +0000154 # Try to load readline if it exists
155 try:
156 import readline
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100157 # remove some common file name delimiters
158 readline.set_completer_delims(' \t\n`@#$%^&*()=+[{]}\\|;:\'",<>?')
Brett Cannoncd171c82013-07-04 17:43:24 -0400159 except ImportError:
Tim Peters2344fae2001-01-15 00:50:52 +0000160 pass
Georg Brandl44f2b642010-12-04 16:00:47 +0000161 self.allow_kbdint = False
162 self.nosigint = nosigint
Guido van Rossum2424f851998-09-11 22:50:09 +0000163
Timothy Hopper7ea9a852019-08-02 18:20:14 -0400164 # Read ~/.pdbrc and ./.pdbrc
Tim Peters2344fae2001-01-15 00:50:52 +0000165 self.rcLines = []
Ɓukasz Langa2eb6eca2016-09-09 22:21:17 -0700166 if readrc:
Timothy Hopper7ea9a852019-08-02 18:20:14 -0400167 try:
168 with open(os.path.expanduser('~/.pdbrc')) as rcFile:
169 self.rcLines.extend(rcFile)
170 except OSError:
171 pass
Tim Peters2344fae2001-01-15 00:50:52 +0000172 try:
Ɓukasz Langa2eb6eca2016-09-09 22:21:17 -0700173 with open(".pdbrc") as rcFile:
Florent Xicluna7dde7922010-09-03 19:52:03 +0000174 self.rcLines.extend(rcFile)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200175 except OSError:
Tim Peters2344fae2001-01-15 00:50:52 +0000176 pass
Guido van Rossum23efba41992-01-27 16:58:47 +0000177
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000178 self.commands = {} # associates a command list to breakpoint numbers
Benjamin Petersond23f8222009-04-05 19:13:16 +0000179 self.commands_doprompt = {} # for each bp num, tells if the prompt
180 # must be disp. after execing the cmd list
181 self.commands_silent = {} # for each bp num, tells if the stack trace
182 # must be disp. after execing the cmd list
183 self.commands_defining = False # True while in the process of defining
184 # a command list
185 self.commands_bnum = None # The breakpoint number for which we are
186 # defining a list
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000187
Georg Brandl44f2b642010-12-04 16:00:47 +0000188 def sigint_handler(self, signum, frame):
189 if self.allow_kbdint:
190 raise KeyboardInterrupt
191 self.message("\nProgram interrupted. (Use 'cont' to resume).")
192 self.set_step()
193 self.set_trace(frame)
Georg Brandl44f2b642010-12-04 16:00:47 +0000194
Tim Peters2344fae2001-01-15 00:50:52 +0000195 def reset(self):
196 bdb.Bdb.reset(self)
197 self.forget()
Guido van Rossum23efba41992-01-27 16:58:47 +0000198
Tim Peters2344fae2001-01-15 00:50:52 +0000199 def forget(self):
200 self.lineno = None
201 self.stack = []
202 self.curindex = 0
203 self.curframe = None
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000204 self.tb_lineno.clear()
Guido van Rossum2424f851998-09-11 22:50:09 +0000205
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000206 def setup(self, f, tb):
Tim Peters2344fae2001-01-15 00:50:52 +0000207 self.forget()
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000208 self.stack, self.curindex = self.get_stack(f, tb)
209 while tb:
210 # when setting up post-mortem debugging with a traceback, save all
211 # the original line numbers to be displayed along the current line
212 # numbers (which can be different, e.g. due to finally clauses)
213 lineno = lasti2lineno(tb.tb_frame.f_code, tb.tb_lasti)
214 self.tb_lineno[tb.tb_frame] = lineno
215 tb = tb.tb_next
Tim Peters2344fae2001-01-15 00:50:52 +0000216 self.curframe = self.stack[self.curindex][0]
Benjamin Petersond23f8222009-04-05 19:13:16 +0000217 # The f_locals dictionary is updated from the actual frame
218 # locals whenever the .f_locals accessor is called, so we
219 # cache it here to ensure that modifications are not overwritten.
220 self.curframe_locals = self.curframe.f_locals
Georg Brandle0230912010-07-30 08:29:39 +0000221 return self.execRcLines()
Guido van Rossumb6775db1994-08-01 11:34:53 +0000222
Tim Peters2344fae2001-01-15 00:50:52 +0000223 # Can be executed earlier than 'setup' if desired
224 def execRcLines(self):
Georg Brandle0230912010-07-30 08:29:39 +0000225 if not self.rcLines:
226 return
227 # local copy because of recursion
228 rcLines = self.rcLines
229 rcLines.reverse()
230 # execute every line only once
231 self.rcLines = []
232 while rcLines:
233 line = rcLines.pop().strip()
234 if line and line[0] != '#':
235 if self.onecmd(line):
236 # if onecmd returns True, the command wants to exit
237 # from the interaction, save leftover rc lines
238 # to execute before next interaction
239 self.rcLines += reversed(rcLines)
240 return True
Guido van Rossum2424f851998-09-11 22:50:09 +0000241
Tim Peters280488b2002-08-23 18:19:30 +0000242 # Override Bdb methods
Michael W. Hudsondd32a912002-08-15 14:59:02 +0000243
244 def user_call(self, frame, argument_list):
245 """This method is called when there is the remote possibility
246 that we ever need to stop in this function."""
Johannes Gijsbers25b38c82004-10-12 18:12:09 +0000247 if self._wait_for_mainpyfile:
248 return
Michael W. Hudson01eb85c2003-01-31 17:48:29 +0000249 if self.stop_here(frame):
Georg Brandl0d089622010-07-30 16:00:46 +0000250 self.message('--Call--')
Michael W. Hudson01eb85c2003-01-31 17:48:29 +0000251 self.interaction(frame, None)
Guido van Rossum2424f851998-09-11 22:50:09 +0000252
Tim Peters2344fae2001-01-15 00:50:52 +0000253 def user_line(self, frame):
254 """This function is called when we stop or break at this line."""
Johannes Gijsbers25b38c82004-10-12 18:12:09 +0000255 if self._wait_for_mainpyfile:
256 if (self.mainpyfile != self.canonic(frame.f_code.co_filename)
Georg Brandlac9a2bb2010-11-29 20:19:15 +0000257 or frame.f_lineno <= 0):
Johannes Gijsbers25b38c82004-10-12 18:12:09 +0000258 return
Georg Brandlac9a2bb2010-11-29 20:19:15 +0000259 self._wait_for_mainpyfile = False
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000260 if self.bp_commands(frame):
261 self.interaction(frame, None)
262
Georg Brandle0230912010-07-30 08:29:39 +0000263 def bp_commands(self, frame):
Georg Brandl3078df02009-05-05 09:11:31 +0000264 """Call every command that was set for the current active breakpoint
265 (if there is one).
266
267 Returns True if the normal interaction function must be called,
268 False otherwise."""
269 # self.currentbp is set in bdb in Bdb.break_here if a breakpoint was hit
270 if getattr(self, "currentbp", False) and \
271 self.currentbp in self.commands:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000272 currentbp = self.currentbp
273 self.currentbp = 0
274 lastcmd_back = self.lastcmd
275 self.setup(frame, None)
276 for line in self.commands[currentbp]:
277 self.onecmd(line)
278 self.lastcmd = lastcmd_back
279 if not self.commands_silent[currentbp]:
280 self.print_stack_entry(self.stack[self.curindex])
281 if self.commands_doprompt[currentbp]:
Georg Brandl44f2b642010-12-04 16:00:47 +0000282 self._cmdloop()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000283 self.forget()
284 return
285 return 1
Guido van Rossum9e1ee971997-07-11 13:43:53 +0000286
Tim Peters2344fae2001-01-15 00:50:52 +0000287 def user_return(self, frame, return_value):
288 """This function is called when a return trap is set here."""
Georg Brandl34cc0f52010-07-30 09:43:00 +0000289 if self._wait_for_mainpyfile:
290 return
Tim Peters2344fae2001-01-15 00:50:52 +0000291 frame.f_locals['__return__'] = return_value
Georg Brandl0d089622010-07-30 16:00:46 +0000292 self.message('--Return--')
Tim Peters2344fae2001-01-15 00:50:52 +0000293 self.interaction(frame, None)
Guido van Rossum2424f851998-09-11 22:50:09 +0000294
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000295 def user_exception(self, frame, exc_info):
Tim Peters2344fae2001-01-15 00:50:52 +0000296 """This function is called if an exception occurs,
297 but only if we are to stop at or just below this level."""
Georg Brandl34cc0f52010-07-30 09:43:00 +0000298 if self._wait_for_mainpyfile:
299 return
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000300 exc_type, exc_value, exc_traceback = exc_info
Tim Peters2344fae2001-01-15 00:50:52 +0000301 frame.f_locals['__exception__'] = exc_type, exc_value
Guido van Rossum8820c232013-11-21 11:30:06 -0800302
303 # An 'Internal StopIteration' exception is an exception debug event
304 # issued by the interpreter when handling a subgenerator run with
Martin Panter46f50722016-05-26 05:35:26 +0000305 # 'yield from' or a generator controlled by a for loop. No exception has
Berker Peksagf23530f2014-10-19 18:04:38 +0300306 # actually occurred in this case. The debugger uses this debug event to
Guido van Rossum8820c232013-11-21 11:30:06 -0800307 # stop when the debuggee is returning from such generators.
308 prefix = 'Internal ' if (not exc_traceback
309 and exc_type is StopIteration) else ''
310 self.message('%s%s' % (prefix,
311 traceback.format_exception_only(exc_type, exc_value)[-1].strip()))
Tim Peters2344fae2001-01-15 00:50:52 +0000312 self.interaction(frame, exc_traceback)
Guido van Rossum2424f851998-09-11 22:50:09 +0000313
Tim Peters2344fae2001-01-15 00:50:52 +0000314 # General interaction function
Georg Brandl44f2b642010-12-04 16:00:47 +0000315 def _cmdloop(self):
316 while True:
317 try:
318 # keyboard interrupts allow for an easy way to cancel
319 # the current command, so allow them during interactive input
320 self.allow_kbdint = True
321 self.cmdloop()
322 self.allow_kbdint = False
323 break
324 except KeyboardInterrupt:
325 self.message('--KeyboardInterrupt--')
Tim Peters2344fae2001-01-15 00:50:52 +0000326
Georg Brandlcbc79c72010-12-04 16:21:42 +0000327 # Called before loop, handles display expressions
328 def preloop(self):
329 displaying = self.displaying.get(self.curframe)
330 if displaying:
331 for expr, oldvalue in displaying.items():
332 newvalue = self._getval_except(expr)
333 # check for identity first; this prevents custom __eq__ to
334 # be called at every loop, and also prevents instances whose
335 # fields are changed to be displayed
336 if newvalue is not oldvalue and newvalue != oldvalue:
337 displaying[expr] = newvalue
338 self.message('display %s: %r [old: %r]' %
339 (expr, newvalue, oldvalue))
340
Tim Peters2344fae2001-01-15 00:50:52 +0000341 def interaction(self, frame, traceback):
Xavier de Gaye10e54ae2016-10-12 20:13:24 +0200342 # Restore the previous signal handler at the Pdb prompt.
343 if Pdb._previous_sigint_handler:
Daniel Hahler8d64bfa2019-09-09 12:45:58 +0200344 try:
345 signal.signal(signal.SIGINT, Pdb._previous_sigint_handler)
346 except ValueError: # ValueError: signal only works in main thread
347 pass
348 else:
349 Pdb._previous_sigint_handler = None
Georg Brandle0230912010-07-30 08:29:39 +0000350 if self.setup(frame, traceback):
351 # no interaction desired at this time (happens if .pdbrc contains
352 # a command like "continue")
353 self.forget()
354 return
Tim Peters2344fae2001-01-15 00:50:52 +0000355 self.print_stack_entry(self.stack[self.curindex])
Georg Brandl44f2b642010-12-04 16:00:47 +0000356 self._cmdloop()
Tim Peters2344fae2001-01-15 00:50:52 +0000357 self.forget()
358
Benjamin Petersond23f8222009-04-05 19:13:16 +0000359 def displayhook(self, obj):
360 """Custom displayhook for the exec in default(), which prevents
361 assignment of the _ variable in the builtins.
362 """
Georg Brandl9fa2e022009-09-16 16:40:45 +0000363 # reproduce the behavior of the standard displayhook, not printing None
364 if obj is not None:
Georg Brandl0d089622010-07-30 16:00:46 +0000365 self.message(repr(obj))
Benjamin Petersond23f8222009-04-05 19:13:16 +0000366
Tim Peters2344fae2001-01-15 00:50:52 +0000367 def default(self, line):
368 if line[:1] == '!': line = line[1:]
Benjamin Petersond23f8222009-04-05 19:13:16 +0000369 locals = self.curframe_locals
Tim Peters2344fae2001-01-15 00:50:52 +0000370 globals = self.curframe.f_globals
371 try:
372 code = compile(line + '\n', '<stdin>', 'single')
Christian Heimes679db4a2008-01-18 09:56:22 +0000373 save_stdout = sys.stdout
374 save_stdin = sys.stdin
Benjamin Petersond23f8222009-04-05 19:13:16 +0000375 save_displayhook = sys.displayhook
Guido van Rossum7736b5b2008-01-15 21:44:53 +0000376 try:
377 sys.stdin = self.stdin
378 sys.stdout = self.stdout
Benjamin Petersond23f8222009-04-05 19:13:16 +0000379 sys.displayhook = self.displayhook
Guido van Rossum7736b5b2008-01-15 21:44:53 +0000380 exec(code, globals, locals)
381 finally:
382 sys.stdout = save_stdout
383 sys.stdin = save_stdin
Benjamin Petersond23f8222009-04-05 19:13:16 +0000384 sys.displayhook = save_displayhook
Tim Peters2344fae2001-01-15 00:50:52 +0000385 except:
Georg Brandl0d089622010-07-30 16:00:46 +0000386 exc_info = sys.exc_info()[:2]
387 self.error(traceback.format_exception_only(*exc_info)[-1].strip())
Tim Peters2344fae2001-01-15 00:50:52 +0000388
389 def precmd(self, line):
390 """Handle alias expansion and ';;' separator."""
Guido van Rossum08454592002-07-12 13:10:53 +0000391 if not line.strip():
Tim Peters2344fae2001-01-15 00:50:52 +0000392 return line
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000393 args = line.split()
Raymond Hettinger54f02222002-06-01 14:18:47 +0000394 while args[0] in self.aliases:
Tim Peters2344fae2001-01-15 00:50:52 +0000395 line = self.aliases[args[0]]
396 ii = 1
397 for tmpArg in args[1:]:
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000398 line = line.replace("%" + str(ii),
Tim Peters2344fae2001-01-15 00:50:52 +0000399 tmpArg)
Georg Brandlac9a2bb2010-11-29 20:19:15 +0000400 ii += 1
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000401 line = line.replace("%*", ' '.join(args[1:]))
402 args = line.split()
Tim Peters2344fae2001-01-15 00:50:52 +0000403 # split into ';;' separated commands
404 # unless it's an alias command
405 if args[0] != 'alias':
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000406 marker = line.find(';;')
Tim Peters2344fae2001-01-15 00:50:52 +0000407 if marker >= 0:
408 # queue up everything after marker
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000409 next = line[marker+2:].lstrip()
Tim Peters2344fae2001-01-15 00:50:52 +0000410 self.cmdqueue.append(next)
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000411 line = line[:marker].rstrip()
Tim Peters2344fae2001-01-15 00:50:52 +0000412 return line
413
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000414 def onecmd(self, line):
415 """Interpret the argument as though it had been typed in response
416 to the prompt.
417
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000418 Checks whether this line is typed at the normal prompt or in
419 a breakpoint command list definition.
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000420 """
421 if not self.commands_defining:
422 return cmd.Cmd.onecmd(self, line)
423 else:
424 return self.handle_command_def(line)
425
Georg Brandlb90ffd82010-07-30 22:20:16 +0000426 def handle_command_def(self, line):
Georg Brandl44f8bf92010-07-30 08:54:49 +0000427 """Handles one command line during command list definition."""
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000428 cmd, arg, line = self.parseline(line)
Georg Brandl44f8bf92010-07-30 08:54:49 +0000429 if not cmd:
430 return
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000431 if cmd == 'silent':
432 self.commands_silent[self.commands_bnum] = True
433 return # continue to handle other cmd def in the cmd list
434 elif cmd == 'end':
435 self.cmdqueue = []
436 return 1 # end of cmd list
437 cmdlist = self.commands[self.commands_bnum]
Georg Brandl44f8bf92010-07-30 08:54:49 +0000438 if arg:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000439 cmdlist.append(cmd+' '+arg)
440 else:
441 cmdlist.append(cmd)
442 # Determine if we must stop
443 try:
444 func = getattr(self, 'do_' + cmd)
445 except AttributeError:
446 func = self.default
Georg Brandl3078df02009-05-05 09:11:31 +0000447 # one of the resuming commands
448 if func.__name__ in self.commands_resuming:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000449 self.commands_doprompt[self.commands_bnum] = False
450 self.cmdqueue = []
451 return 1
452 return
453
Georg Brandl0d089622010-07-30 16:00:46 +0000454 # interface abstraction functions
455
456 def message(self, msg):
457 print(msg, file=self.stdout)
458
459 def error(self, msg):
460 print('***', msg, file=self.stdout)
461
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100462 # Generic completion functions. Individual complete_foo methods can be
463 # assigned below to one of these functions.
464
465 def _complete_location(self, text, line, begidx, endidx):
466 # Complete a file/module/function location for break/tbreak/clear.
467 if line.strip().endswith((':', ',')):
468 # Here comes a line number or a condition which we can't complete.
469 return []
470 # First, try to find matching functions (i.e. expressions).
471 try:
472 ret = self._complete_expression(text, line, begidx, endidx)
473 except Exception:
474 ret = []
475 # Then, try to complete file names as well.
476 globs = glob.glob(text + '*')
477 for fn in globs:
478 if os.path.isdir(fn):
479 ret.append(fn + '/')
480 elif os.path.isfile(fn) and fn.lower().endswith(('.py', '.pyw')):
481 ret.append(fn + ':')
482 return ret
483
484 def _complete_bpnumber(self, text, line, begidx, endidx):
485 # Complete a breakpoint number. (This would be more helpful if we could
486 # display additional info along with the completions, such as file/line
487 # of the breakpoint.)
488 return [str(i) for i, bp in enumerate(bdb.Breakpoint.bpbynumber)
489 if bp is not None and str(i).startswith(text)]
490
491 def _complete_expression(self, text, line, begidx, endidx):
492 # Complete an arbitrary expression.
493 if not self.curframe:
494 return []
495 # Collect globals and locals. It is usually not really sensible to also
496 # complete builtins, and they clutter the namespace quite heavily, so we
497 # leave them out.
Serhiy Storchakada084702019-03-27 08:02:28 +0200498 ns = {**self.curframe.f_globals, **self.curframe_locals}
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100499 if '.' in text:
500 # Walk an attribute chain up to the last part, similar to what
501 # rlcompleter does. This will bail if any of the parts are not
502 # simple attribute access, which is what we want.
503 dotted = text.split('.')
504 try:
505 obj = ns[dotted[0]]
506 for part in dotted[1:-1]:
507 obj = getattr(obj, part)
508 except (KeyError, AttributeError):
509 return []
510 prefix = '.'.join(dotted[:-1]) + '.'
511 return [prefix + n for n in dir(obj) if n.startswith(dotted[-1])]
512 else:
513 # Complete a simple name.
514 return [n for n in ns.keys() if n.startswith(text)]
515
Tim Peters2344fae2001-01-15 00:50:52 +0000516 # Command definitions, called by cmdloop()
517 # The argument is the remaining string on the command line
518 # Return true to exit from the command loop
519
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000520 def do_commands(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000521 """commands [bpnumber]
522 (com) ...
523 (com) end
524 (Pdb)
Georg Brandl3078df02009-05-05 09:11:31 +0000525
Georg Brandl0d089622010-07-30 16:00:46 +0000526 Specify a list of commands for breakpoint number bpnumber.
527 The commands themselves are entered on the following lines.
528 Type a line containing just 'end' to terminate the commands.
529 The commands are executed when the breakpoint is hit.
530
531 To remove all commands from a breakpoint, type commands and
532 follow it immediately with end; that is, give no commands.
533
534 With no bpnumber argument, commands refers to the last
535 breakpoint set.
536
537 You can use breakpoint commands to start your program up
538 again. Simply use the continue command, or step, or any other
539 command that resumes execution.
540
541 Specifying any command resuming execution (currently continue,
542 step, next, return, jump, quit and their abbreviations)
543 terminates the command list (as if that command was
544 immediately followed by end). This is because any time you
545 resume execution (even with a simple next or step), you may
546 encounter another breakpoint -- which could have its own
547 command list, leading to ambiguities about which list to
548 execute.
549
550 If you use the 'silent' command in the command list, the usual
551 message about stopping at a breakpoint is not printed. This
552 may be desirable for breakpoints that are to print a specific
553 message and then continue. If none of the other commands
554 print anything, you will see no sign that the breakpoint was
555 reached.
556 """
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000557 if not arg:
Georg Brandl7410dd12010-07-30 12:01:20 +0000558 bnum = len(bdb.Breakpoint.bpbynumber) - 1
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000559 else:
560 try:
561 bnum = int(arg)
562 except:
Georg Brandl0d089622010-07-30 16:00:46 +0000563 self.error("Usage: commands [bnum]\n ...\n end")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000564 return
565 self.commands_bnum = bnum
Georg Brandlb90ffd82010-07-30 22:20:16 +0000566 # Save old definitions for the case of a keyboard interrupt.
567 if bnum in self.commands:
568 old_command_defs = (self.commands[bnum],
569 self.commands_doprompt[bnum],
570 self.commands_silent[bnum])
571 else:
572 old_command_defs = None
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000573 self.commands[bnum] = []
574 self.commands_doprompt[bnum] = True
575 self.commands_silent[bnum] = False
Georg Brandlb90ffd82010-07-30 22:20:16 +0000576
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000577 prompt_back = self.prompt
578 self.prompt = '(com) '
579 self.commands_defining = True
Georg Brandl44f8bf92010-07-30 08:54:49 +0000580 try:
581 self.cmdloop()
Georg Brandlb90ffd82010-07-30 22:20:16 +0000582 except KeyboardInterrupt:
583 # Restore old definitions.
584 if old_command_defs:
585 self.commands[bnum] = old_command_defs[0]
586 self.commands_doprompt[bnum] = old_command_defs[1]
587 self.commands_silent[bnum] = old_command_defs[2]
588 else:
589 del self.commands[bnum]
590 del self.commands_doprompt[bnum]
591 del self.commands_silent[bnum]
592 self.error('command definition aborted, old commands restored')
Georg Brandl44f8bf92010-07-30 08:54:49 +0000593 finally:
594 self.commands_defining = False
595 self.prompt = prompt_back
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000596
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100597 complete_commands = _complete_bpnumber
598
Tim Peters2344fae2001-01-15 00:50:52 +0000599 def do_break(self, arg, temporary = 0):
Georg Brandl0d089622010-07-30 16:00:46 +0000600 """b(reak) [ ([filename:]lineno | function) [, condition] ]
601 Without argument, list all breaks.
602
603 With a line number argument, set a break at this line in the
604 current file. With a function name, set a break at the first
605 executable line of that function. If a second argument is
606 present, it is a string specifying an expression which must
607 evaluate to true before the breakpoint is honored.
608
609 The line number may be prefixed with a filename and a colon,
610 to specify a breakpoint in another file (probably one that
611 hasn't been loaded yet). The file is searched for on
612 sys.path; the .py suffix may be omitted.
613 """
Tim Peters2344fae2001-01-15 00:50:52 +0000614 if not arg:
615 if self.breaks: # There's at least one
Georg Brandl0d089622010-07-30 16:00:46 +0000616 self.message("Num Type Disp Enb Where")
Tim Peters2344fae2001-01-15 00:50:52 +0000617 for bp in bdb.Breakpoint.bpbynumber:
618 if bp:
Georg Brandl0d089622010-07-30 16:00:46 +0000619 self.message(bp.bpformat())
Tim Peters2344fae2001-01-15 00:50:52 +0000620 return
621 # parse arguments; comma has lowest precedence
622 # and cannot occur in filename
623 filename = None
624 lineno = None
625 cond = None
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000626 comma = arg.find(',')
Tim Peters2344fae2001-01-15 00:50:52 +0000627 if comma > 0:
628 # parse stuff after comma: "condition"
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000629 cond = arg[comma+1:].lstrip()
630 arg = arg[:comma].rstrip()
Tim Peters2344fae2001-01-15 00:50:52 +0000631 # parse stuff before comma: [filename:]lineno | function
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000632 colon = arg.rfind(':')
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000633 funcname = None
Tim Peters2344fae2001-01-15 00:50:52 +0000634 if colon >= 0:
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000635 filename = arg[:colon].rstrip()
Tim Peters2344fae2001-01-15 00:50:52 +0000636 f = self.lookupmodule(filename)
637 if not f:
Georg Brandl0d089622010-07-30 16:00:46 +0000638 self.error('%r not found from sys.path' % filename)
Tim Peters2344fae2001-01-15 00:50:52 +0000639 return
640 else:
641 filename = f
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000642 arg = arg[colon+1:].lstrip()
Tim Peters2344fae2001-01-15 00:50:52 +0000643 try:
644 lineno = int(arg)
Georg Brandlf93390a2010-10-14 07:17:44 +0000645 except ValueError:
Georg Brandl0d089622010-07-30 16:00:46 +0000646 self.error('Bad lineno: %s' % arg)
Tim Peters2344fae2001-01-15 00:50:52 +0000647 return
648 else:
649 # no colon; can be lineno or function
650 try:
651 lineno = int(arg)
652 except ValueError:
653 try:
654 func = eval(arg,
655 self.curframe.f_globals,
Benjamin Petersond23f8222009-04-05 19:13:16 +0000656 self.curframe_locals)
Tim Peters2344fae2001-01-15 00:50:52 +0000657 except:
658 func = arg
659 try:
Christian Heimesff737952007-11-27 10:40:20 +0000660 if hasattr(func, '__func__'):
661 func = func.__func__
Neal Norwitz221085d2007-02-25 20:55:47 +0000662 code = func.__code__
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000663 #use co_name to identify the bkpt (function names
664 #could be aliased, but co_name is invariant)
665 funcname = code.co_name
Tim Peters2344fae2001-01-15 00:50:52 +0000666 lineno = code.co_firstlineno
667 filename = code.co_filename
668 except:
669 # last thing to try
670 (ok, filename, ln) = self.lineinfo(arg)
671 if not ok:
Georg Brandl0d089622010-07-30 16:00:46 +0000672 self.error('The specified object %r is not a function '
673 'or was not found along sys.path.' % arg)
Tim Peters2344fae2001-01-15 00:50:52 +0000674 return
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000675 funcname = ok # ok contains a function name
Tim Peters2344fae2001-01-15 00:50:52 +0000676 lineno = int(ln)
677 if not filename:
678 filename = self.defaultFile()
679 # Check for reasonable breakpoint
680 line = self.checkline(filename, lineno)
681 if line:
682 # now set the break point
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000683 err = self.set_break(filename, line, temporary, cond, funcname)
Georg Brandl0d089622010-07-30 16:00:46 +0000684 if err:
Berker Peksagad5ffd42014-07-12 18:24:32 +0300685 self.error(err)
Tim Peters2344fae2001-01-15 00:50:52 +0000686 else:
687 bp = self.get_breaks(filename, line)[-1]
Georg Brandl0d089622010-07-30 16:00:46 +0000688 self.message("Breakpoint %d at %s:%d" %
689 (bp.number, bp.file, bp.line))
Tim Peters2344fae2001-01-15 00:50:52 +0000690
691 # To be overridden in derived debuggers
692 def defaultFile(self):
693 """Produce a reasonable default."""
694 filename = self.curframe.f_code.co_filename
Johannes Gijsbers25b38c82004-10-12 18:12:09 +0000695 if filename == '<string>' and self.mainpyfile:
696 filename = self.mainpyfile
Tim Peters2344fae2001-01-15 00:50:52 +0000697 return filename
698
699 do_b = do_break
700
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100701 complete_break = _complete_location
702 complete_b = _complete_location
703
Tim Peters2344fae2001-01-15 00:50:52 +0000704 def do_tbreak(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000705 """tbreak [ ([filename:]lineno | function) [, condition] ]
706 Same arguments as break, but sets a temporary breakpoint: it
707 is automatically deleted when first hit.
708 """
Tim Peters2344fae2001-01-15 00:50:52 +0000709 self.do_break(arg, 1)
710
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100711 complete_tbreak = _complete_location
712
Tim Peters2344fae2001-01-15 00:50:52 +0000713 def lineinfo(self, identifier):
714 failed = (None, None, None)
715 # Input is identifier, may be in single quotes
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000716 idstring = identifier.split("'")
Tim Peters2344fae2001-01-15 00:50:52 +0000717 if len(idstring) == 1:
718 # not in single quotes
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000719 id = idstring[0].strip()
Tim Peters2344fae2001-01-15 00:50:52 +0000720 elif len(idstring) == 3:
721 # quoted
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000722 id = idstring[1].strip()
Tim Peters2344fae2001-01-15 00:50:52 +0000723 else:
724 return failed
725 if id == '': return failed
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000726 parts = id.split('.')
Tim Peters2344fae2001-01-15 00:50:52 +0000727 # Protection for derived debuggers
728 if parts[0] == 'self':
729 del parts[0]
730 if len(parts) == 0:
731 return failed
732 # Best first guess at file to look at
733 fname = self.defaultFile()
734 if len(parts) == 1:
735 item = parts[0]
736 else:
737 # More than one part.
738 # First is module, second is method/class
739 f = self.lookupmodule(parts[0])
740 if f:
741 fname = f
742 item = parts[1]
743 answer = find_function(item, fname)
744 return answer or failed
745
746 def checkline(self, filename, lineno):
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000747 """Check whether specified line seems to be executable.
Tim Peters2344fae2001-01-15 00:50:52 +0000748
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000749 Return `lineno` if it is, 0 if not (e.g. a docstring, comment, blank
750 line or EOF). Warning: testing is not comprehensive.
751 """
Georg Brandl1e30bd32010-07-30 07:21:26 +0000752 # this method should be callable before starting debugging, so default
753 # to "no globals" if there is no current frame
754 globs = self.curframe.f_globals if hasattr(self, 'curframe') else None
755 line = linecache.getline(filename, lineno, globs)
Tim Peters2344fae2001-01-15 00:50:52 +0000756 if not line:
Georg Brandl0d089622010-07-30 16:00:46 +0000757 self.message('End of file')
Tim Peters2344fae2001-01-15 00:50:52 +0000758 return 0
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000759 line = line.strip()
Tim Peters2344fae2001-01-15 00:50:52 +0000760 # Don't allow setting breakpoint at a blank line
Guido van Rossum08454592002-07-12 13:10:53 +0000761 if (not line or (line[0] == '#') or
762 (line[:3] == '"""') or line[:3] == "'''"):
Georg Brandl0d089622010-07-30 16:00:46 +0000763 self.error('Blank or comment')
Tim Peters2344fae2001-01-15 00:50:52 +0000764 return 0
Tim Peters2344fae2001-01-15 00:50:52 +0000765 return lineno
766
767 def do_enable(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000768 """enable bpnumber [bpnumber ...]
769 Enables the breakpoints given as a space separated list of
770 breakpoint numbers.
771 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000772 args = arg.split()
Tim Peters2344fae2001-01-15 00:50:52 +0000773 for i in args:
Andrew M. Kuchlingb1f8bab2003-05-22 14:46:12 +0000774 try:
Georg Brandl7410dd12010-07-30 12:01:20 +0000775 bp = self.get_bpbynumber(i)
776 except ValueError as err:
Georg Brandl0d089622010-07-30 16:00:46 +0000777 self.error(err)
Georg Brandl7410dd12010-07-30 12:01:20 +0000778 else:
Tim Peters2344fae2001-01-15 00:50:52 +0000779 bp.enable()
Georg Brandl0d089622010-07-30 16:00:46 +0000780 self.message('Enabled %s' % bp)
Tim Peters2344fae2001-01-15 00:50:52 +0000781
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100782 complete_enable = _complete_bpnumber
783
Tim Peters2344fae2001-01-15 00:50:52 +0000784 def do_disable(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000785 """disable bpnumber [bpnumber ...]
786 Disables the breakpoints given as a space separated list of
787 breakpoint numbers. Disabling a breakpoint means it cannot
788 cause the program to stop execution, but unlike clearing a
789 breakpoint, it remains in the list of breakpoints and can be
790 (re-)enabled.
791 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000792 args = arg.split()
Tim Peters2344fae2001-01-15 00:50:52 +0000793 for i in args:
Andrew M. Kuchlingb1f8bab2003-05-22 14:46:12 +0000794 try:
Georg Brandl7410dd12010-07-30 12:01:20 +0000795 bp = self.get_bpbynumber(i)
796 except ValueError as err:
Georg Brandl0d089622010-07-30 16:00:46 +0000797 self.error(err)
Georg Brandl7410dd12010-07-30 12:01:20 +0000798 else:
Tim Peters2344fae2001-01-15 00:50:52 +0000799 bp.disable()
Georg Brandl0d089622010-07-30 16:00:46 +0000800 self.message('Disabled %s' % bp)
Tim Peters2344fae2001-01-15 00:50:52 +0000801
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100802 complete_disable = _complete_bpnumber
803
Tim Peters2344fae2001-01-15 00:50:52 +0000804 def do_condition(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000805 """condition bpnumber [condition]
806 Set a new condition for the breakpoint, an expression which
807 must evaluate to true before the breakpoint is honored. If
808 condition is absent, any existing condition is removed; i.e.,
809 the breakpoint is made unconditional.
810 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000811 args = arg.split(' ', 1)
Thomas Woutersb2137042007-02-01 18:02:27 +0000812 try:
Tim Peters2344fae2001-01-15 00:50:52 +0000813 cond = args[1]
Georg Brandl7410dd12010-07-30 12:01:20 +0000814 except IndexError:
Tim Peters2344fae2001-01-15 00:50:52 +0000815 cond = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000816 try:
Georg Brandl7410dd12010-07-30 12:01:20 +0000817 bp = self.get_bpbynumber(args[0].strip())
Georg Brandl0079ffc2013-10-14 16:08:15 +0200818 except IndexError:
819 self.error('Breakpoint number expected')
Georg Brandl7410dd12010-07-30 12:01:20 +0000820 except ValueError as err:
Georg Brandl0d089622010-07-30 16:00:46 +0000821 self.error(err)
Georg Brandl7410dd12010-07-30 12:01:20 +0000822 else:
Tim Peters2344fae2001-01-15 00:50:52 +0000823 bp.cond = cond
824 if not cond:
Georg Brandl0d089622010-07-30 16:00:46 +0000825 self.message('Breakpoint %d is now unconditional.' % bp.number)
Georg Brandl7410dd12010-07-30 12:01:20 +0000826 else:
Georg Brandl0d089622010-07-30 16:00:46 +0000827 self.message('New condition set for breakpoint %d.' % bp.number)
Tim Peters2344fae2001-01-15 00:50:52 +0000828
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100829 complete_condition = _complete_bpnumber
830
Georg Brandl7410dd12010-07-30 12:01:20 +0000831 def do_ignore(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000832 """ignore bpnumber [count]
833 Set the ignore count for the given breakpoint number. If
834 count is omitted, the ignore count is set to 0. A breakpoint
835 becomes active when the ignore count is zero. When non-zero,
836 the count is decremented each time the breakpoint is reached
837 and the breakpoint is not disabled and any associated
838 condition evaluates to true.
839 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000840 args = arg.split()
Thomas Woutersb2137042007-02-01 18:02:27 +0000841 try:
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000842 count = int(args[1].strip())
Tim Peters2344fae2001-01-15 00:50:52 +0000843 except:
844 count = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +0000845 try:
Georg Brandl7410dd12010-07-30 12:01:20 +0000846 bp = self.get_bpbynumber(args[0].strip())
Georg Brandl0079ffc2013-10-14 16:08:15 +0200847 except IndexError:
848 self.error('Breakpoint number expected')
Georg Brandl7410dd12010-07-30 12:01:20 +0000849 except ValueError as err:
Georg Brandl0d089622010-07-30 16:00:46 +0000850 self.error(err)
Georg Brandl7410dd12010-07-30 12:01:20 +0000851 else:
Tim Peters2344fae2001-01-15 00:50:52 +0000852 bp.ignore = count
Guido van Rossum08454592002-07-12 13:10:53 +0000853 if count > 0:
Guido van Rossum08454592002-07-12 13:10:53 +0000854 if count > 1:
Georg Brandl0d089622010-07-30 16:00:46 +0000855 countstr = '%d crossings' % count
Tim Peters2344fae2001-01-15 00:50:52 +0000856 else:
Georg Brandl0d089622010-07-30 16:00:46 +0000857 countstr = '1 crossing'
858 self.message('Will ignore next %s of breakpoint %d.' %
859 (countstr, bp.number))
Tim Peters2344fae2001-01-15 00:50:52 +0000860 else:
Georg Brandl0d089622010-07-30 16:00:46 +0000861 self.message('Will stop next time breakpoint %d is reached.'
862 % bp.number)
Tim Peters2344fae2001-01-15 00:50:52 +0000863
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100864 complete_ignore = _complete_bpnumber
865
Tim Peters2344fae2001-01-15 00:50:52 +0000866 def do_clear(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000867 """cl(ear) filename:lineno\ncl(ear) [bpnumber [bpnumber...]]
868 With a space separated list of breakpoint numbers, clear
869 those breakpoints. Without argument, clear all breaks (but
870 first ask confirmation). With a filename:lineno argument,
871 clear all breaks at that line in that file.
872 """
Tim Peters2344fae2001-01-15 00:50:52 +0000873 if not arg:
874 try:
Guido van Rossumc5b6ab02007-05-27 09:19:52 +0000875 reply = input('Clear all breaks? ')
Tim Peters2344fae2001-01-15 00:50:52 +0000876 except EOFError:
877 reply = 'no'
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000878 reply = reply.strip().lower()
Tim Peters2344fae2001-01-15 00:50:52 +0000879 if reply in ('y', 'yes'):
Georg Brandl7410dd12010-07-30 12:01:20 +0000880 bplist = [bp for bp in bdb.Breakpoint.bpbynumber if bp]
Tim Peters2344fae2001-01-15 00:50:52 +0000881 self.clear_all_breaks()
Georg Brandl7410dd12010-07-30 12:01:20 +0000882 for bp in bplist:
Georg Brandl0d089622010-07-30 16:00:46 +0000883 self.message('Deleted %s' % bp)
Tim Peters2344fae2001-01-15 00:50:52 +0000884 return
885 if ':' in arg:
886 # Make sure it works for "clear C:\foo\bar.py:12"
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000887 i = arg.rfind(':')
Tim Peters2344fae2001-01-15 00:50:52 +0000888 filename = arg[:i]
889 arg = arg[i+1:]
890 try:
891 lineno = int(arg)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000892 except ValueError:
Tim Peters2344fae2001-01-15 00:50:52 +0000893 err = "Invalid line number (%s)" % arg
894 else:
Georg Brandl7410dd12010-07-30 12:01:20 +0000895 bplist = self.get_breaks(filename, lineno)
Tim Peters2344fae2001-01-15 00:50:52 +0000896 err = self.clear_break(filename, lineno)
Georg Brandl7410dd12010-07-30 12:01:20 +0000897 if err:
Georg Brandl0d089622010-07-30 16:00:46 +0000898 self.error(err)
Georg Brandl7410dd12010-07-30 12:01:20 +0000899 else:
900 for bp in bplist:
Georg Brandl0d089622010-07-30 16:00:46 +0000901 self.message('Deleted %s' % bp)
Tim Peters2344fae2001-01-15 00:50:52 +0000902 return
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000903 numberlist = arg.split()
Tim Peters2344fae2001-01-15 00:50:52 +0000904 for i in numberlist:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000905 try:
Georg Brandl7410dd12010-07-30 12:01:20 +0000906 bp = self.get_bpbynumber(i)
907 except ValueError as err:
Georg Brandl0d089622010-07-30 16:00:46 +0000908 self.error(err)
Tim Peters2344fae2001-01-15 00:50:52 +0000909 else:
Senthil Kumaran6f107042010-11-29 11:54:17 +0000910 self.clear_bpbynumber(i)
Georg Brandl0d089622010-07-30 16:00:46 +0000911 self.message('Deleted %s' % bp)
Tim Peters2344fae2001-01-15 00:50:52 +0000912 do_cl = do_clear # 'c' is already an abbreviation for 'continue'
913
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100914 complete_clear = _complete_location
915 complete_cl = _complete_location
916
Tim Peters2344fae2001-01-15 00:50:52 +0000917 def do_where(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000918 """w(here)
919 Print a stack trace, with the most recent frame at the bottom.
920 An arrow indicates the "current frame", which determines the
921 context of most commands. 'bt' is an alias for this command.
922 """
Tim Peters2344fae2001-01-15 00:50:52 +0000923 self.print_stack_trace()
924 do_w = do_where
Guido van Rossum6bd68352001-01-20 17:57:37 +0000925 do_bt = do_where
Tim Peters2344fae2001-01-15 00:50:52 +0000926
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000927 def _select_frame(self, number):
928 assert 0 <= number < len(self.stack)
929 self.curindex = number
930 self.curframe = self.stack[self.curindex][0]
931 self.curframe_locals = self.curframe.f_locals
932 self.print_stack_entry(self.stack[self.curindex])
933 self.lineno = None
934
Tim Peters2344fae2001-01-15 00:50:52 +0000935 def do_up(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000936 """u(p) [count]
937 Move the current frame count (default one) levels up in the
938 stack trace (to an older frame).
939 """
Tim Peters2344fae2001-01-15 00:50:52 +0000940 if self.curindex == 0:
Georg Brandl0d089622010-07-30 16:00:46 +0000941 self.error('Oldest frame')
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000942 return
943 try:
944 count = int(arg or 1)
945 except ValueError:
Georg Brandl0d089622010-07-30 16:00:46 +0000946 self.error('Invalid frame count (%s)' % arg)
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000947 return
948 if count < 0:
949 newframe = 0
Tim Peters2344fae2001-01-15 00:50:52 +0000950 else:
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000951 newframe = max(0, self.curindex - count)
952 self._select_frame(newframe)
Tim Peters2344fae2001-01-15 00:50:52 +0000953 do_u = do_up
954
955 def do_down(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000956 """d(own) [count]
957 Move the current frame count (default one) levels down in the
958 stack trace (to a newer frame).
959 """
Tim Peters2344fae2001-01-15 00:50:52 +0000960 if self.curindex + 1 == len(self.stack):
Georg Brandl0d089622010-07-30 16:00:46 +0000961 self.error('Newest frame')
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000962 return
963 try:
964 count = int(arg or 1)
965 except ValueError:
Georg Brandl0d089622010-07-30 16:00:46 +0000966 self.error('Invalid frame count (%s)' % arg)
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000967 return
968 if count < 0:
969 newframe = len(self.stack) - 1
Tim Peters2344fae2001-01-15 00:50:52 +0000970 else:
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000971 newframe = min(len(self.stack) - 1, self.curindex + count)
972 self._select_frame(newframe)
Tim Peters2344fae2001-01-15 00:50:52 +0000973 do_d = do_down
974
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000975 def do_until(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000976 """unt(il) [lineno]
977 Without argument, continue execution until the line with a
978 number greater than the current one is reached. With a line
979 number, continue execution until a line with a number greater
980 or equal to that is reached. In both cases, also stop when
981 the current frame returns.
982 """
Georg Brandl2dfec552010-07-30 08:43:32 +0000983 if arg:
984 try:
985 lineno = int(arg)
986 except ValueError:
Georg Brandl0d089622010-07-30 16:00:46 +0000987 self.error('Error in argument: %r' % arg)
Georg Brandl2dfec552010-07-30 08:43:32 +0000988 return
989 if lineno <= self.curframe.f_lineno:
Georg Brandl0d089622010-07-30 16:00:46 +0000990 self.error('"until" line number is smaller than current '
991 'line number')
Georg Brandl2dfec552010-07-30 08:43:32 +0000992 return
993 else:
994 lineno = None
995 self.set_until(self.curframe, lineno)
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000996 return 1
997 do_unt = do_until
998
Tim Peters2344fae2001-01-15 00:50:52 +0000999 def do_step(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001000 """s(tep)
1001 Execute the current line, stop at the first possible occasion
1002 (either in a function that is called or in the current
1003 function).
1004 """
Tim Peters2344fae2001-01-15 00:50:52 +00001005 self.set_step()
1006 return 1
1007 do_s = do_step
1008
1009 def do_next(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001010 """n(ext)
1011 Continue execution until the next line in the current function
1012 is reached or it returns.
1013 """
Tim Peters2344fae2001-01-15 00:50:52 +00001014 self.set_next(self.curframe)
1015 return 1
1016 do_n = do_next
1017
Guido van Rossumd8faa362007-04-27 19:54:29 +00001018 def do_run(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001019 """run [args...]
1020 Restart the debugged python program. If a string is supplied
Ezio Melotti30b9d5d2013-08-17 15:50:46 +03001021 it is split with "shlex", and the result is used as the new
Georg Brandl0d089622010-07-30 16:00:46 +00001022 sys.argv. History, breakpoints, actions and debugger options
1023 are preserved. "restart" is an alias for "run".
1024 """
Guido van Rossumd8faa362007-04-27 19:54:29 +00001025 if arg:
1026 import shlex
1027 argv0 = sys.argv[0:1]
1028 sys.argv = shlex.split(arg)
1029 sys.argv[:0] = argv0
Georg Brandl0d089622010-07-30 16:00:46 +00001030 # this is caught in the main debugger loop
Guido van Rossumd8faa362007-04-27 19:54:29 +00001031 raise Restart
1032
1033 do_restart = do_run
1034
Tim Peters2344fae2001-01-15 00:50:52 +00001035 def do_return(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001036 """r(eturn)
1037 Continue execution until the current function returns.
1038 """
Tim Peters2344fae2001-01-15 00:50:52 +00001039 self.set_return(self.curframe)
1040 return 1
1041 do_r = do_return
1042
1043 def do_continue(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001044 """c(ont(inue))
1045 Continue execution, only stop when a breakpoint is encountered.
1046 """
Georg Brandl44f2b642010-12-04 16:00:47 +00001047 if not self.nosigint:
Andrew Svetlov539ee5d2012-12-04 21:08:28 +02001048 try:
Xavier de Gaye10e54ae2016-10-12 20:13:24 +02001049 Pdb._previous_sigint_handler = \
Andrew Svetlov539ee5d2012-12-04 21:08:28 +02001050 signal.signal(signal.SIGINT, self.sigint_handler)
1051 except ValueError:
1052 # ValueError happens when do_continue() is invoked from
1053 # a non-main thread in which case we just continue without
1054 # SIGINT set. Would printing a message here (once) make
1055 # sense?
1056 pass
Tim Peters2344fae2001-01-15 00:50:52 +00001057 self.set_continue()
1058 return 1
1059 do_c = do_cont = do_continue
1060
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001061 def do_jump(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001062 """j(ump) lineno
1063 Set the next line that will be executed. Only available in
1064 the bottom-most frame. This lets you jump back and execute
1065 code again, or jump forward to skip code that you don't want
1066 to run.
1067
1068 It should be noted that not all jumps are allowed -- for
1069 instance it is not possible to jump into the middle of a
1070 for loop or out of a finally clause.
1071 """
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001072 if self.curindex + 1 != len(self.stack):
Georg Brandl0d089622010-07-30 16:00:46 +00001073 self.error('You can only jump within the bottom frame')
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001074 return
1075 try:
1076 arg = int(arg)
1077 except ValueError:
Georg Brandl0d089622010-07-30 16:00:46 +00001078 self.error("The 'jump' command requires a line number")
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001079 else:
1080 try:
1081 # Do the jump, fix up our copy of the stack, and display the
1082 # new position
1083 self.curframe.f_lineno = arg
1084 self.stack[self.curindex] = self.stack[self.curindex][0], arg
1085 self.print_stack_entry(self.stack[self.curindex])
Guido van Rossumb940e112007-01-10 16:19:56 +00001086 except ValueError as e:
Georg Brandl0d089622010-07-30 16:00:46 +00001087 self.error('Jump failed: %s' % e)
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001088 do_j = do_jump
1089
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001090 def do_debug(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001091 """debug code
1092 Enter a recursive debugger that steps through the code
1093 argument (which is an arbitrary expression or statement to be
1094 executed in the current environment).
1095 """
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001096 sys.settrace(None)
1097 globals = self.curframe.f_globals
Benjamin Petersond23f8222009-04-05 19:13:16 +00001098 locals = self.curframe_locals
Guido van Rossum7736b5b2008-01-15 21:44:53 +00001099 p = Pdb(self.completekey, self.stdin, self.stdout)
Guido van Rossumed538d82003-04-09 19:36:34 +00001100 p.prompt = "(%s) " % self.prompt.strip()
Georg Brandl0d089622010-07-30 16:00:46 +00001101 self.message("ENTERING RECURSIVE DEBUGGER")
Daniel Hahler3e936432019-03-12 04:29:04 +01001102 try:
1103 sys.call_tracing(p.run, (arg, globals, locals))
1104 except Exception:
1105 exc_info = sys.exc_info()[:2]
1106 self.error(traceback.format_exception_only(*exc_info)[-1].strip())
Georg Brandl0d089622010-07-30 16:00:46 +00001107 self.message("LEAVING RECURSIVE DEBUGGER")
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001108 sys.settrace(self.trace_dispatch)
1109 self.lastcmd = p.lastcmd
1110
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001111 complete_debug = _complete_expression
1112
Tim Peters2344fae2001-01-15 00:50:52 +00001113 def do_quit(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001114 """q(uit)\nexit
1115 Quit from the debugger. The program being executed is aborted.
1116 """
Georg Brandlac9a2bb2010-11-29 20:19:15 +00001117 self._user_requested_quit = True
Tim Peters2344fae2001-01-15 00:50:52 +00001118 self.set_quit()
1119 return 1
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001120
Tim Peters2344fae2001-01-15 00:50:52 +00001121 do_q = do_quit
Guido van Rossumd1c08f32002-04-15 00:48:24 +00001122 do_exit = do_quit
Tim Peters2344fae2001-01-15 00:50:52 +00001123
Guido van Rossumeef26072003-01-13 21:13:55 +00001124 def do_EOF(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001125 """EOF
1126 Handles the receipt of EOF as a command.
1127 """
1128 self.message('')
Georg Brandlac9a2bb2010-11-29 20:19:15 +00001129 self._user_requested_quit = True
Guido van Rossumeef26072003-01-13 21:13:55 +00001130 self.set_quit()
1131 return 1
1132
Tim Peters2344fae2001-01-15 00:50:52 +00001133 def do_args(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001134 """a(rgs)
1135 Print the argument list of the current function.
1136 """
Benjamin Petersond23f8222009-04-05 19:13:16 +00001137 co = self.curframe.f_code
1138 dict = self.curframe_locals
Pablo Galindocd74e662019-06-01 18:08:04 +01001139 n = co.co_argcount + co.co_kwonlyargcount
Rémi Lapeyrebf457c72019-05-21 00:17:30 +02001140 if co.co_flags & inspect.CO_VARARGS: n = n+1
1141 if co.co_flags & inspect.CO_VARKEYWORDS: n = n+1
Tim Peters2344fae2001-01-15 00:50:52 +00001142 for i in range(n):
1143 name = co.co_varnames[i]
Georg Brandl0d089622010-07-30 16:00:46 +00001144 if name in dict:
1145 self.message('%s = %r' % (name, dict[name]))
1146 else:
1147 self.message('%s = *** undefined ***' % (name,))
Tim Peters2344fae2001-01-15 00:50:52 +00001148 do_a = do_args
Guido van Rossum2424f851998-09-11 22:50:09 +00001149
Tim Peters2344fae2001-01-15 00:50:52 +00001150 def do_retval(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001151 """retval
1152 Print the return value for the last return of a function.
1153 """
Benjamin Petersond23f8222009-04-05 19:13:16 +00001154 if '__return__' in self.curframe_locals:
Georg Brandl0d089622010-07-30 16:00:46 +00001155 self.message(repr(self.curframe_locals['__return__']))
Tim Peters2344fae2001-01-15 00:50:52 +00001156 else:
Georg Brandl0d089622010-07-30 16:00:46 +00001157 self.error('Not yet returned!')
Tim Peters2344fae2001-01-15 00:50:52 +00001158 do_rv = do_retval
Guido van Rossum2424f851998-09-11 22:50:09 +00001159
Barry Warsaw210bd202002-11-05 22:40:20 +00001160 def _getval(self, arg):
Tim Peters2344fae2001-01-15 00:50:52 +00001161 try:
Benjamin Petersond23f8222009-04-05 19:13:16 +00001162 return eval(arg, self.curframe.f_globals, self.curframe_locals)
Tim Peters2344fae2001-01-15 00:50:52 +00001163 except:
Georg Brandl0d089622010-07-30 16:00:46 +00001164 exc_info = sys.exc_info()[:2]
1165 self.error(traceback.format_exception_only(*exc_info)[-1].strip())
Barry Warsaw210bd202002-11-05 22:40:20 +00001166 raise
Guido van Rossum2424f851998-09-11 22:50:09 +00001167
Georg Brandlcbc79c72010-12-04 16:21:42 +00001168 def _getval_except(self, arg, frame=None):
1169 try:
1170 if frame is None:
1171 return eval(arg, self.curframe.f_globals, self.curframe_locals)
1172 else:
1173 return eval(arg, frame.f_globals, frame.f_locals)
1174 except:
1175 exc_info = sys.exc_info()[:2]
1176 err = traceback.format_exception_only(*exc_info)[-1].strip()
1177 return _rstr('** raised %s **' % err)
1178
Barry Warsaw210bd202002-11-05 22:40:20 +00001179 def do_p(self, arg):
R David Murray78d692f2013-10-10 17:23:26 -04001180 """p expression
Georg Brandl0d089622010-07-30 16:00:46 +00001181 Print the value of the expression.
1182 """
Barry Warsaw210bd202002-11-05 22:40:20 +00001183 try:
Georg Brandl0d089622010-07-30 16:00:46 +00001184 self.message(repr(self._getval(arg)))
Barry Warsaw210bd202002-11-05 22:40:20 +00001185 except:
1186 pass
1187
1188 def do_pp(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001189 """pp expression
1190 Pretty-print the value of the expression.
1191 """
Barry Warsaw210bd202002-11-05 22:40:20 +00001192 try:
Georg Brandl0d089622010-07-30 16:00:46 +00001193 self.message(pprint.pformat(self._getval(arg)))
Barry Warsaw210bd202002-11-05 22:40:20 +00001194 except:
1195 pass
Guido van Rossum2424f851998-09-11 22:50:09 +00001196
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001197 complete_print = _complete_expression
1198 complete_p = _complete_expression
1199 complete_pp = _complete_expression
1200
Tim Peters2344fae2001-01-15 00:50:52 +00001201 def do_list(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001202 """l(ist) [first [,last] | .]
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001203
1204 List source code for the current file. Without arguments,
1205 list 11 lines around the current line or continue the previous
1206 listing. With . as argument, list 11 lines around the current
1207 line. With one argument, list 11 lines starting at that line.
1208 With two arguments, list the given range; if the second
1209 argument is less than the first, it is a count.
1210
1211 The current line in the current frame is indicated by "->".
1212 If an exception is being debugged, the line where the
1213 exception was originally raised or propagated is indicated by
1214 ">>", if it differs from the current line.
Georg Brandl0d089622010-07-30 16:00:46 +00001215 """
Tim Peters2344fae2001-01-15 00:50:52 +00001216 self.lastcmd = 'list'
1217 last = None
Georg Brandla91a94b2010-07-30 07:14:01 +00001218 if arg and arg != '.':
Tim Peters2344fae2001-01-15 00:50:52 +00001219 try:
Georg Brandl0d089622010-07-30 16:00:46 +00001220 if ',' in arg:
1221 first, last = arg.split(',')
1222 first = int(first.strip())
1223 last = int(last.strip())
Tim Peters2344fae2001-01-15 00:50:52 +00001224 if last < first:
Georg Brandl0d089622010-07-30 16:00:46 +00001225 # assume it's a count
Tim Peters2344fae2001-01-15 00:50:52 +00001226 last = first + last
1227 else:
Georg Brandl0d089622010-07-30 16:00:46 +00001228 first = int(arg.strip())
1229 first = max(1, first - 5)
1230 except ValueError:
1231 self.error('Error in argument: %r' % arg)
Tim Peters2344fae2001-01-15 00:50:52 +00001232 return
Georg Brandla91a94b2010-07-30 07:14:01 +00001233 elif self.lineno is None or arg == '.':
Tim Peters2344fae2001-01-15 00:50:52 +00001234 first = max(1, self.curframe.f_lineno - 5)
1235 else:
1236 first = self.lineno + 1
1237 if last is None:
1238 last = first + 10
1239 filename = self.curframe.f_code.co_filename
1240 breaklist = self.get_file_breaks(filename)
1241 try:
Georg Brandle59ca2a2010-07-30 17:04:28 +00001242 lines = linecache.getlines(filename, self.curframe.f_globals)
1243 self._print_lines(lines[first-1:last], first, breaklist,
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001244 self.curframe)
Georg Brandle59ca2a2010-07-30 17:04:28 +00001245 self.lineno = min(last, len(lines))
1246 if len(lines) < last:
1247 self.message('[EOF]')
Tim Peters2344fae2001-01-15 00:50:52 +00001248 except KeyboardInterrupt:
1249 pass
1250 do_l = do_list
Guido van Rossum2424f851998-09-11 22:50:09 +00001251
Georg Brandle59ca2a2010-07-30 17:04:28 +00001252 def do_longlist(self, arg):
1253 """longlist | ll
1254 List the whole source code for the current function or frame.
1255 """
1256 filename = self.curframe.f_code.co_filename
1257 breaklist = self.get_file_breaks(filename)
1258 try:
Georg Brandl5ed2b5a2010-07-30 18:08:12 +00001259 lines, lineno = getsourcelines(self.curframe)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001260 except OSError as err:
Georg Brandle59ca2a2010-07-30 17:04:28 +00001261 self.error(err)
1262 return
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001263 self._print_lines(lines, lineno, breaklist, self.curframe)
Georg Brandle59ca2a2010-07-30 17:04:28 +00001264 do_ll = do_longlist
1265
1266 def do_source(self, arg):
1267 """source expression
1268 Try to get source code for the given object and display it.
1269 """
1270 try:
1271 obj = self._getval(arg)
1272 except:
1273 return
1274 try:
Georg Brandl5ed2b5a2010-07-30 18:08:12 +00001275 lines, lineno = getsourcelines(obj)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001276 except (OSError, TypeError) as err:
Georg Brandle59ca2a2010-07-30 17:04:28 +00001277 self.error(err)
1278 return
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001279 self._print_lines(lines, lineno)
Georg Brandle59ca2a2010-07-30 17:04:28 +00001280
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001281 complete_source = _complete_expression
1282
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001283 def _print_lines(self, lines, start, breaks=(), frame=None):
Georg Brandle59ca2a2010-07-30 17:04:28 +00001284 """Print a range of lines."""
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001285 if frame:
1286 current_lineno = frame.f_lineno
1287 exc_lineno = self.tb_lineno.get(frame, -1)
1288 else:
1289 current_lineno = exc_lineno = -1
Georg Brandle59ca2a2010-07-30 17:04:28 +00001290 for lineno, line in enumerate(lines, start):
1291 s = str(lineno).rjust(3)
1292 if len(s) < 4:
1293 s += ' '
1294 if lineno in breaks:
1295 s += 'B'
1296 else:
1297 s += ' '
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001298 if lineno == current_lineno:
Georg Brandle59ca2a2010-07-30 17:04:28 +00001299 s += '->'
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001300 elif lineno == exc_lineno:
Georg Brandle59ca2a2010-07-30 17:04:28 +00001301 s += '>>'
1302 self.message(s + '\t' + line.rstrip())
1303
Tim Peters2344fae2001-01-15 00:50:52 +00001304 def do_whatis(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001305 """whatis arg
1306 Print the type of the argument.
1307 """
Tim Peters2344fae2001-01-15 00:50:52 +00001308 try:
Georg Brandl0d089622010-07-30 16:00:46 +00001309 value = self._getval(arg)
Tim Peters2344fae2001-01-15 00:50:52 +00001310 except:
Georg Brandl0d089622010-07-30 16:00:46 +00001311 # _getval() already printed the error
Tim Peters2344fae2001-01-15 00:50:52 +00001312 return
1313 code = None
1314 # Is it a function?
Georg Brandl0d089622010-07-30 16:00:46 +00001315 try:
1316 code = value.__code__
1317 except Exception:
1318 pass
Tim Peters2344fae2001-01-15 00:50:52 +00001319 if code:
Georg Brandl0d089622010-07-30 16:00:46 +00001320 self.message('Function %s' % code.co_name)
Tim Peters2344fae2001-01-15 00:50:52 +00001321 return
1322 # Is it an instance method?
Georg Brandl0d089622010-07-30 16:00:46 +00001323 try:
1324 code = value.__func__.__code__
1325 except Exception:
1326 pass
Tim Peters2344fae2001-01-15 00:50:52 +00001327 if code:
Georg Brandl0d089622010-07-30 16:00:46 +00001328 self.message('Method %s' % code.co_name)
1329 return
1330 # Is it a class?
1331 if value.__class__ is type:
Serhiy Storchaka521e5862014-07-22 15:00:37 +03001332 self.message('Class %s.%s' % (value.__module__, value.__qualname__))
Tim Peters2344fae2001-01-15 00:50:52 +00001333 return
1334 # None of the above...
Georg Brandl0d089622010-07-30 16:00:46 +00001335 self.message(type(value))
Guido van Rossum8e2ec561993-07-29 09:37:38 +00001336
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001337 complete_whatis = _complete_expression
1338
Georg Brandlcbc79c72010-12-04 16:21:42 +00001339 def do_display(self, arg):
1340 """display [expression]
1341
1342 Display the value of the expression if it changed, each time execution
1343 stops in the current frame.
1344
1345 Without expression, list all display expressions for the current frame.
1346 """
1347 if not arg:
1348 self.message('Currently displaying:')
1349 for item in self.displaying.get(self.curframe, {}).items():
1350 self.message('%s: %r' % item)
1351 else:
1352 val = self._getval_except(arg)
1353 self.displaying.setdefault(self.curframe, {})[arg] = val
1354 self.message('display %s: %r' % (arg, val))
1355
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001356 complete_display = _complete_expression
1357
Georg Brandlcbc79c72010-12-04 16:21:42 +00001358 def do_undisplay(self, arg):
1359 """undisplay [expression]
1360
1361 Do not display the expression any more in the current frame.
1362
1363 Without expression, clear all display expressions for the current frame.
1364 """
1365 if arg:
1366 try:
1367 del self.displaying.get(self.curframe, {})[arg]
1368 except KeyError:
1369 self.error('not displaying %s' % arg)
1370 else:
1371 self.displaying.pop(self.curframe, None)
1372
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001373 def complete_undisplay(self, text, line, begidx, endidx):
1374 return [e for e in self.displaying.get(self.curframe, {})
1375 if e.startswith(text)]
1376
Georg Brandl1acb7462010-12-04 11:20:26 +00001377 def do_interact(self, arg):
1378 """interact
1379
Ezio Melotti30b9d5d2013-08-17 15:50:46 +03001380 Start an interactive interpreter whose global namespace
Georg Brandl1acb7462010-12-04 11:20:26 +00001381 contains all the (global and local) names found in the current scope.
1382 """
Serhiy Storchakada084702019-03-27 08:02:28 +02001383 ns = {**self.curframe.f_globals, **self.curframe_locals}
Georg Brandl1acb7462010-12-04 11:20:26 +00001384 code.interact("*interactive*", local=ns)
1385
Tim Peters2344fae2001-01-15 00:50:52 +00001386 def do_alias(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001387 """alias [name [command [parameter parameter ...] ]]
1388 Create an alias called 'name' that executes 'command'. The
1389 command must *not* be enclosed in quotes. Replaceable
1390 parameters can be indicated by %1, %2, and so on, while %* is
1391 replaced by all the parameters. If no command is given, the
1392 current alias for name is shown. If no name is given, all
1393 aliases are listed.
1394
1395 Aliases may be nested and can contain anything that can be
1396 legally typed at the pdb prompt. Note! You *can* override
1397 internal pdb commands with aliases! Those internal commands
1398 are then hidden until the alias is removed. Aliasing is
1399 recursively applied to the first word of the command line; all
1400 other words in the line are left alone.
1401
1402 As an example, here are two useful aliases (especially when
1403 placed in the .pdbrc file):
1404
1405 # Print instance variables (usage "pi classInst")
R David Murray78d692f2013-10-10 17:23:26 -04001406 alias pi for k in %1.__dict__.keys(): print("%1.",k,"=",%1.__dict__[k])
Georg Brandl0d089622010-07-30 16:00:46 +00001407 # Print instance variables in self
1408 alias ps pi self
1409 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +00001410 args = arg.split()
Tim Peters2344fae2001-01-15 00:50:52 +00001411 if len(args) == 0:
Benjamin Petersonbe74a372009-09-11 21:17:13 +00001412 keys = sorted(self.aliases.keys())
Tim Peters2344fae2001-01-15 00:50:52 +00001413 for alias in keys:
Georg Brandl0d089622010-07-30 16:00:46 +00001414 self.message("%s = %s" % (alias, self.aliases[alias]))
Tim Peters2344fae2001-01-15 00:50:52 +00001415 return
Guido van Rossum08454592002-07-12 13:10:53 +00001416 if args[0] in self.aliases and len(args) == 1:
Georg Brandl0d089622010-07-30 16:00:46 +00001417 self.message("%s = %s" % (args[0], self.aliases[args[0]]))
Tim Peters2344fae2001-01-15 00:50:52 +00001418 else:
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +00001419 self.aliases[args[0]] = ' '.join(args[1:])
Guido van Rossum23efba41992-01-27 16:58:47 +00001420
Tim Peters2344fae2001-01-15 00:50:52 +00001421 def do_unalias(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001422 """unalias name
1423 Delete the specified alias.
1424 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +00001425 args = arg.split()
Tim Peters2344fae2001-01-15 00:50:52 +00001426 if len(args) == 0: return
Raymond Hettinger54f02222002-06-01 14:18:47 +00001427 if args[0] in self.aliases:
Tim Peters2344fae2001-01-15 00:50:52 +00001428 del self.aliases[args[0]]
Guido van Rossum00230781993-03-29 11:39:45 +00001429
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001430 def complete_unalias(self, text, line, begidx, endidx):
1431 return [a for a in self.aliases if a.startswith(text)]
1432
Georg Brandl0d089622010-07-30 16:00:46 +00001433 # List of all the commands making the program resume execution.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001434 commands_resuming = ['do_continue', 'do_step', 'do_next', 'do_return',
1435 'do_quit', 'do_jump']
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001436
Tim Peters2344fae2001-01-15 00:50:52 +00001437 # Print a traceback starting at the top stack frame.
1438 # The most recently entered frame is printed last;
1439 # this is different from dbx and gdb, but consistent with
1440 # the Python interpreter's stack trace.
1441 # It is also consistent with the up/down commands (which are
1442 # compatible with dbx and gdb: up moves towards 'main()'
1443 # and down moves towards the most recent stack frame).
Guido van Rossum2424f851998-09-11 22:50:09 +00001444
Tim Peters2344fae2001-01-15 00:50:52 +00001445 def print_stack_trace(self):
1446 try:
1447 for frame_lineno in self.stack:
1448 self.print_stack_entry(frame_lineno)
1449 except KeyboardInterrupt:
1450 pass
Guido van Rossum2424f851998-09-11 22:50:09 +00001451
Tim Peters2344fae2001-01-15 00:50:52 +00001452 def print_stack_entry(self, frame_lineno, prompt_prefix=line_prefix):
1453 frame, lineno = frame_lineno
1454 if frame is self.curframe:
Georg Brandl0d089622010-07-30 16:00:46 +00001455 prefix = '> '
Tim Peters2344fae2001-01-15 00:50:52 +00001456 else:
Georg Brandl0d089622010-07-30 16:00:46 +00001457 prefix = ' '
1458 self.message(prefix +
1459 self.format_stack_entry(frame_lineno, prompt_prefix))
Guido van Rossum2424f851998-09-11 22:50:09 +00001460
Georg Brandl0d089622010-07-30 16:00:46 +00001461 # Provide help
Guido van Rossum921c8241992-01-10 14:54:42 +00001462
Georg Brandl0d089622010-07-30 16:00:46 +00001463 def do_help(self, arg):
1464 """h(elp)
1465 Without argument, print the list of available commands.
1466 With a command name as argument, print help about that command.
1467 "help pdb" shows the full pdb documentation.
1468 "help exec" gives help on the ! command.
1469 """
1470 if not arg:
1471 return cmd.Cmd.do_help(self, arg)
1472 try:
1473 try:
1474 topic = getattr(self, 'help_' + arg)
1475 return topic()
1476 except AttributeError:
1477 command = getattr(self, 'do_' + arg)
1478 except AttributeError:
1479 self.error('No help for %r' % arg)
1480 else:
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001481 if sys.flags.optimize >= 2:
1482 self.error('No help for %r; please do not run Python with -OO '
1483 'if you need command help' % arg)
1484 return
Georg Brandl0d089622010-07-30 16:00:46 +00001485 self.message(command.__doc__.rstrip())
Guido van Rossum921c8241992-01-10 14:54:42 +00001486
Georg Brandl0d089622010-07-30 16:00:46 +00001487 do_h = do_help
Barry Warsaw210bd202002-11-05 22:40:20 +00001488
Tim Peters2344fae2001-01-15 00:50:52 +00001489 def help_exec(self):
Georg Brandl0d089622010-07-30 16:00:46 +00001490 """(!) statement
1491 Execute the (one-line) statement in the context of the current
1492 stack frame. The exclamation point can be omitted unless the
1493 first word of the statement resembles a debugger command. To
1494 assign to a global variable you must always prefix the command
1495 with a 'global' command, e.g.:
1496 (Pdb) global list_options; list_options = ['-l']
1497 (Pdb)
1498 """
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001499 self.message((self.help_exec.__doc__ or '').strip())
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001500
Tim Peters2344fae2001-01-15 00:50:52 +00001501 def help_pdb(self):
1502 help()
Guido van Rossumb6775db1994-08-01 11:34:53 +00001503
Georg Brandl0d089622010-07-30 16:00:46 +00001504 # other helper functions
1505
Tim Peters2344fae2001-01-15 00:50:52 +00001506 def lookupmodule(self, filename):
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001507 """Helper function for break/clear parsing -- may be overridden.
1508
1509 lookupmodule() translates (possibly incomplete) file or module name
1510 into an absolute file name.
1511 """
1512 if os.path.isabs(filename) and os.path.exists(filename):
Tim Peterse718f612004-10-12 21:51:32 +00001513 return filename
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001514 f = os.path.join(sys.path[0], filename)
1515 if os.path.exists(f) and self.canonic(f) == self.mainpyfile:
1516 return f
Tim Peters2344fae2001-01-15 00:50:52 +00001517 root, ext = os.path.splitext(filename)
1518 if ext == '':
1519 filename = filename + '.py'
1520 if os.path.isabs(filename):
1521 return filename
1522 for dirname in sys.path:
1523 while os.path.islink(dirname):
1524 dirname = os.readlink(dirname)
1525 fullname = os.path.join(dirname, filename)
1526 if os.path.exists(fullname):
1527 return fullname
1528 return None
Guido van Rossumb5699c71998-07-20 23:13:54 +00001529
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001530 def _runmodule(self, module_name):
1531 self._wait_for_mainpyfile = True
1532 self._user_requested_quit = False
1533 import runpy
1534 mod_name, mod_spec, code = runpy._get_module_details(module_name)
1535 self.mainpyfile = self.canonic(code.co_filename)
1536 import __main__
1537 __main__.__dict__.clear()
1538 __main__.__dict__.update({
1539 "__name__": "__main__",
1540 "__file__": self.mainpyfile,
Mario Corchero38bfa842018-02-03 06:40:11 +00001541 "__package__": mod_spec.parent,
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001542 "__loader__": mod_spec.loader,
1543 "__spec__": mod_spec,
1544 "__builtins__": __builtins__,
1545 })
1546 self.run(code)
1547
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001548 def _runscript(self, filename):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001549 # The script has to run in __main__ namespace (or imports from
1550 # __main__ will break).
1551 #
1552 # So we clear up the __main__ and set several special variables
1553 # (this gets rid of pdb's globals and cleans old variables on restarts).
1554 import __main__
1555 __main__.__dict__.clear()
1556 __main__.__dict__.update({"__name__" : "__main__",
1557 "__file__" : filename,
1558 "__builtins__": __builtins__,
1559 })
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001560
1561 # When bdb sets tracing, a number of call and line events happens
1562 # BEFORE debugger even reaches user's code (and the exact sequence of
1563 # events depends on python version). So we take special measures to
1564 # avoid stopping before we reach the main script (see user_line and
1565 # user_call for details).
Georg Brandlac9a2bb2010-11-29 20:19:15 +00001566 self._wait_for_mainpyfile = True
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001567 self.mainpyfile = self.canonic(filename)
Georg Brandlac9a2bb2010-11-29 20:19:15 +00001568 self._user_requested_quit = False
jsnkllnd5938812019-11-12 17:42:47 -05001569 with io.open_code(filename) as fp:
Georg Brandld07ac642009-08-13 07:50:57 +00001570 statement = "exec(compile(%r, %r, 'exec'))" % \
1571 (fp.read(), self.mainpyfile)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001572 self.run(statement)
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001573
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001574# Collect all command help into docstring, if not run with -OO
Georg Brandl0d089622010-07-30 16:00:46 +00001575
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001576if __doc__ is not None:
1577 # unfortunately we can't guess this order from the class definition
1578 _help_order = [
1579 'help', 'where', 'down', 'up', 'break', 'tbreak', 'clear', 'disable',
1580 'enable', 'ignore', 'condition', 'commands', 'step', 'next', 'until',
1581 'jump', 'return', 'retval', 'run', 'continue', 'list', 'longlist',
R David Murray78d692f2013-10-10 17:23:26 -04001582 'args', 'p', 'pp', 'whatis', 'source', 'display', 'undisplay',
Georg Brandlcbc79c72010-12-04 16:21:42 +00001583 'interact', 'alias', 'unalias', 'debug', 'quit',
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001584 ]
Georg Brandl0d089622010-07-30 16:00:46 +00001585
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001586 for _command in _help_order:
1587 __doc__ += getattr(Pdb, 'do_' + _command).__doc__.strip() + '\n\n'
1588 __doc__ += Pdb.help_exec.__doc__
Georg Brandl0d089622010-07-30 16:00:46 +00001589
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001590 del _help_order, _command
1591
Georg Brandl0d089622010-07-30 16:00:46 +00001592
Guido van Rossum35771131992-09-08 11:59:04 +00001593# Simplified interface
1594
Guido van Rossum5e38b6f1995-02-27 13:13:40 +00001595def run(statement, globals=None, locals=None):
Tim Peters2344fae2001-01-15 00:50:52 +00001596 Pdb().run(statement, globals, locals)
Guido van Rossum5e38b6f1995-02-27 13:13:40 +00001597
1598def runeval(expression, globals=None, locals=None):
Tim Peters2344fae2001-01-15 00:50:52 +00001599 return Pdb().runeval(expression, globals, locals)
Guido van Rossum6fe08b01992-01-16 13:50:21 +00001600
1601def runctx(statement, globals, locals):
Tim Peters2344fae2001-01-15 00:50:52 +00001602 # B/W compatibility
1603 run(statement, globals, locals)
Guido van Rossum6fe08b01992-01-16 13:50:21 +00001604
Raymond Hettinger2ef7e6c2004-10-24 00:32:24 +00001605def runcall(*args, **kwds):
1606 return Pdb().runcall(*args, **kwds)
Guido van Rossum4e160981992-09-02 20:43:20 +00001607
Barry Warsaw35425d62017-09-22 12:29:42 -04001608def set_trace(*, header=None):
1609 pdb = Pdb()
1610 if header is not None:
1611 pdb.message(header)
1612 pdb.set_trace(sys._getframe().f_back)
Guido van Rossum35771131992-09-08 11:59:04 +00001613
1614# Post-Mortem interface
1615
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001616def post_mortem(t=None):
1617 # handling the default
1618 if t is None:
1619 # sys.exc_info() returns (type, value, traceback) if an exception is
1620 # being handled, otherwise it returns None
1621 t = sys.exc_info()[2]
Georg Brandl0d089622010-07-30 16:00:46 +00001622 if t is None:
1623 raise ValueError("A valid traceback must be passed if no "
1624 "exception is being handled")
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001625
Tim Peters2344fae2001-01-15 00:50:52 +00001626 p = Pdb()
1627 p.reset()
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001628 p.interaction(None, t)
Guido van Rossum35771131992-09-08 11:59:04 +00001629
1630def pm():
Tim Peters2344fae2001-01-15 00:50:52 +00001631 post_mortem(sys.last_traceback)
Guido van Rossum35771131992-09-08 11:59:04 +00001632
1633
1634# Main program for testing
1635
Guido van Rossum23efba41992-01-27 16:58:47 +00001636TESTCMD = 'import x; x.main()'
Guido van Rossum6fe08b01992-01-16 13:50:21 +00001637
Guido van Rossum921c8241992-01-10 14:54:42 +00001638def test():
Tim Peters2344fae2001-01-15 00:50:52 +00001639 run(TESTCMD)
Guido van Rossume61fa0a1993-10-22 13:56:35 +00001640
1641# print help
1642def help():
Georg Brandl02053ee2010-07-18 10:11:03 +00001643 import pydoc
1644 pydoc.pager(__doc__)
Guido van Rossumf17361d1996-07-30 16:28:13 +00001645
Georg Brandle0230912010-07-30 08:29:39 +00001646_usage = """\
Mario Corcherofcf8b4c2018-01-28 04:58:47 +00001647usage: pdb.py [-c command] ... [-m module | pyfile] [arg] ...
Georg Brandle0230912010-07-30 08:29:39 +00001648
Mario Corcherofcf8b4c2018-01-28 04:58:47 +00001649Debug the Python program given by pyfile. Alternatively,
1650an executable module or package to debug can be specified using
1651the -m switch.
Georg Brandle0230912010-07-30 08:29:39 +00001652
1653Initial commands are read from .pdbrc files in your home directory
1654and in the current directory, if they exist. Commands supplied with
1655-c are executed after commands from .pdbrc files.
1656
1657To let the script run until an exception occurs, use "-c continue".
Georg Brandl2dfec552010-07-30 08:43:32 +00001658To let the script run up to a given line X in the debugged file, use
1659"-c 'until X'"."""
Georg Brandle0230912010-07-30 08:29:39 +00001660
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001661def main():
Georg Brandle0230912010-07-30 08:29:39 +00001662 import getopt
1663
Daniel Hahler855df7f2019-09-12 17:46:37 +02001664 opts, args = getopt.getopt(sys.argv[1:], 'mhc:', ['help', 'command='])
Georg Brandle0230912010-07-30 08:29:39 +00001665
1666 if not args:
1667 print(_usage)
Tim Peters2344fae2001-01-15 00:50:52 +00001668 sys.exit(2)
Guido van Rossumf17361d1996-07-30 16:28:13 +00001669
Georg Brandle0230912010-07-30 08:29:39 +00001670 commands = []
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001671 run_as_module = False
Georg Brandle0230912010-07-30 08:29:39 +00001672 for opt, optarg in opts:
1673 if opt in ['-h', '--help']:
1674 print(_usage)
1675 sys.exit()
1676 elif opt in ['-c', '--command']:
1677 commands.append(optarg)
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001678 elif opt in ['-m']:
1679 run_as_module = True
Georg Brandle0230912010-07-30 08:29:39 +00001680
1681 mainpyfile = args[0] # Get script filename
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001682 if not run_as_module and not os.path.exists(mainpyfile):
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001683 print('Error:', mainpyfile, 'does not exist')
Tim Peters2344fae2001-01-15 00:50:52 +00001684 sys.exit(1)
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001685
Georg Brandle0230912010-07-30 08:29:39 +00001686 sys.argv[:] = args # Hide "pdb.py" and pdb options from argument list
Guido van Rossumec577d51996-09-10 17:39:34 +00001687
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001688 # Replace pdb's dir with script's dir in front of module search path.
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001689 if not run_as_module:
1690 sys.path[0] = os.path.dirname(mainpyfile)
Guido van Rossumf17361d1996-07-30 16:28:13 +00001691
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001692 # Note on saving/restoring sys.argv: it's a good idea when sys.argv was
1693 # modified by the script being debugged. It's a bad idea when it was
Georg Brandl3078df02009-05-05 09:11:31 +00001694 # changed by the user from the command line. There is a "restart" command
1695 # which allows explicit specification of command line arguments.
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001696 pdb = Pdb()
Georg Brandle0230912010-07-30 08:29:39 +00001697 pdb.rcLines.extend(commands)
Georg Brandl1e30bd32010-07-30 07:21:26 +00001698 while True:
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001699 try:
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001700 if run_as_module:
1701 pdb._runmodule(mainpyfile)
1702 else:
1703 pdb._runscript(mainpyfile)
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001704 if pdb._user_requested_quit:
1705 break
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001706 print("The program finished and will be restarted")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001707 except Restart:
1708 print("Restarting", mainpyfile, "with arguments:")
Georg Brandle0230912010-07-30 08:29:39 +00001709 print("\t" + " ".join(args))
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001710 except SystemExit:
1711 # In most cases SystemExit does not warrant a post-mortem session.
Georg Brandle0230912010-07-30 08:29:39 +00001712 print("The program exited via sys.exit(). Exit status:", end=' ')
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001713 print(sys.exc_info()[1])
Terry Jan Reedyca3f4352015-09-05 19:13:26 -04001714 except SyntaxError:
1715 traceback.print_exc()
1716 sys.exit(1)
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001717 except:
1718 traceback.print_exc()
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001719 print("Uncaught exception. Entering post mortem debugging")
1720 print("Running 'cont' or 'step' will restart the program")
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001721 t = sys.exc_info()[2]
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001722 pdb.interaction(None, t)
Georg Brandl3078df02009-05-05 09:11:31 +00001723 print("Post mortem debugger finished. The " + mainpyfile +
1724 " will be restarted")
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001725
1726
1727# When invoked as main program, invoke the debugger on a script
Guido van Rossumd8faa362007-04-27 19:54:29 +00001728if __name__ == '__main__':
1729 import pdb
1730 pdb.main()