blob: 60bdb7675c8131660b2064150fa739911382c1d2 [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
71import re
Guido van Rossum921c8241992-01-10 14:54:42 +000072import sys
Guido van Rossum23efba41992-01-27 16:58:47 +000073import cmd
74import bdb
Georg Brandl0a9c3e92010-07-30 18:46:38 +000075import dis
Georg Brandl1acb7462010-12-04 11:20:26 +000076import code
Georg Brandl4c7c3c52012-03-10 22:36:48 +010077import glob
Barry Warsaw210bd202002-11-05 22:40:20 +000078import pprint
Georg Brandl44f2b642010-12-04 16:00:47 +000079import signal
Georg Brandle59ca2a2010-07-30 17:04:28 +000080import inspect
Georg Brandl1acb7462010-12-04 11:20:26 +000081import traceback
82import linecache
Guido van Rossumd8faa362007-04-27 19:54:29 +000083
84
85class Restart(Exception):
86 """Causes a debugger to be restarted for the debugged python program."""
87 pass
88
Skip Montanaro352674d2001-02-07 23:14:30 +000089__all__ = ["run", "pm", "Pdb", "runeval", "runctx", "runcall", "set_trace",
90 "post_mortem", "help"]
91
Barry Warsaw2bee8fe1999-09-09 16:32:41 +000092def find_function(funcname, filename):
Thomas Wouters89f507f2006-12-13 04:49:30 +000093 cre = re.compile(r'def\s+%s\s*[(]' % re.escape(funcname))
Tim Peters2344fae2001-01-15 00:50:52 +000094 try:
95 fp = open(filename)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +020096 except OSError:
Tim Peters2344fae2001-01-15 00:50:52 +000097 return None
98 # consumer of this info expects the first line to be 1
Georg Brandl6e220552013-10-13 20:51:47 +020099 with fp:
100 for lineno, line in enumerate(fp, start=1):
101 if cre.match(line):
102 return funcname, filename, lineno
103 return None
Guido van Rossum921c8241992-01-10 14:54:42 +0000104
Georg Brandl5ed2b5a2010-07-30 18:08:12 +0000105def getsourcelines(obj):
106 lines, lineno = inspect.findsource(obj)
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000107 if inspect.isframe(obj) and obj.f_globals is obj.f_locals:
Georg Brandl5ed2b5a2010-07-30 18:08:12 +0000108 # must be a module frame: do not try to cut a block out of it
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000109 return lines, 1
Georg Brandl5ed2b5a2010-07-30 18:08:12 +0000110 elif inspect.ismodule(obj):
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000111 return lines, 1
Georg Brandl5ed2b5a2010-07-30 18:08:12 +0000112 return inspect.getblock(lines[lineno:]), lineno+1
Guido van Rossum921c8241992-01-10 14:54:42 +0000113
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000114def lasti2lineno(code, lasti):
115 linestarts = list(dis.findlinestarts(code))
116 linestarts.reverse()
117 for i, lineno in linestarts:
118 if lasti >= i:
119 return lineno
120 return 0
121
122
Georg Brandlcbc79c72010-12-04 16:21:42 +0000123class _rstr(str):
124 """String that doesn't quote its repr."""
125 def __repr__(self):
126 return self
127
128
Guido van Rossuma558e371994-11-10 22:27:35 +0000129# Interaction prompt line will separate file and call info from code
130# text using value of line_prefix string. A newline and arrow may
131# be to your liking. You can set it once pdb is imported using the
132# command "pdb.line_prefix = '\n% '".
Tim Peters2344fae2001-01-15 00:50:52 +0000133# line_prefix = ': ' # Use this to get the old situation back
134line_prefix = '\n-> ' # Probably a better default
Guido van Rossuma558e371994-11-10 22:27:35 +0000135
Guido van Rossum23efba41992-01-27 16:58:47 +0000136class Pdb(bdb.Bdb, cmd.Cmd):
Guido van Rossum2424f851998-09-11 22:50:09 +0000137
Xavier de Gaye10e54ae2016-10-12 20:13:24 +0200138 _previous_sigint_handler = None
139
Georg Brandl44f2b642010-12-04 16:00:47 +0000140 def __init__(self, completekey='tab', stdin=None, stdout=None, skip=None,
Ɓukasz Langa2eb6eca2016-09-09 22:21:17 -0700141 nosigint=False, readrc=True):
Georg Brandl243ad662009-05-05 09:00:19 +0000142 bdb.Bdb.__init__(self, skip=skip)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000143 cmd.Cmd.__init__(self, completekey, stdin, stdout)
144 if stdout:
145 self.use_rawinput = 0
Tim Peters2344fae2001-01-15 00:50:52 +0000146 self.prompt = '(Pdb) '
147 self.aliases = {}
Georg Brandlcbc79c72010-12-04 16:21:42 +0000148 self.displaying = {}
Johannes Gijsbers25b38c82004-10-12 18:12:09 +0000149 self.mainpyfile = ''
Georg Brandlac9a2bb2010-11-29 20:19:15 +0000150 self._wait_for_mainpyfile = False
Georg Brandl0a9c3e92010-07-30 18:46:38 +0000151 self.tb_lineno = {}
Tim Peters2344fae2001-01-15 00:50:52 +0000152 # Try to load readline if it exists
153 try:
154 import readline
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100155 # remove some common file name delimiters
156 readline.set_completer_delims(' \t\n`@#$%^&*()=+[{]}\\|;:\'",<>?')
Brett Cannoncd171c82013-07-04 17:43:24 -0400157 except ImportError:
Tim Peters2344fae2001-01-15 00:50:52 +0000158 pass
Georg Brandl44f2b642010-12-04 16:00:47 +0000159 self.allow_kbdint = False
160 self.nosigint = nosigint
Guido van Rossum2424f851998-09-11 22:50:09 +0000161
Tim Peters2344fae2001-01-15 00:50:52 +0000162 # Read $HOME/.pdbrc and ./.pdbrc
163 self.rcLines = []
Ɓukasz Langa2eb6eca2016-09-09 22:21:17 -0700164 if readrc:
165 if 'HOME' in os.environ:
166 envHome = os.environ['HOME']
167 try:
168 with open(os.path.join(envHome, ".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:
344 signal.signal(signal.SIGINT, Pdb._previous_sigint_handler)
345 Pdb._previous_sigint_handler = None
Georg Brandle0230912010-07-30 08:29:39 +0000346 if self.setup(frame, traceback):
347 # no interaction desired at this time (happens if .pdbrc contains
348 # a command like "continue")
349 self.forget()
350 return
Tim Peters2344fae2001-01-15 00:50:52 +0000351 self.print_stack_entry(self.stack[self.curindex])
Georg Brandl44f2b642010-12-04 16:00:47 +0000352 self._cmdloop()
Tim Peters2344fae2001-01-15 00:50:52 +0000353 self.forget()
354
Benjamin Petersond23f8222009-04-05 19:13:16 +0000355 def displayhook(self, obj):
356 """Custom displayhook for the exec in default(), which prevents
357 assignment of the _ variable in the builtins.
358 """
Georg Brandl9fa2e022009-09-16 16:40:45 +0000359 # reproduce the behavior of the standard displayhook, not printing None
360 if obj is not None:
Georg Brandl0d089622010-07-30 16:00:46 +0000361 self.message(repr(obj))
Benjamin Petersond23f8222009-04-05 19:13:16 +0000362
Tim Peters2344fae2001-01-15 00:50:52 +0000363 def default(self, line):
364 if line[:1] == '!': line = line[1:]
Benjamin Petersond23f8222009-04-05 19:13:16 +0000365 locals = self.curframe_locals
Tim Peters2344fae2001-01-15 00:50:52 +0000366 globals = self.curframe.f_globals
367 try:
368 code = compile(line + '\n', '<stdin>', 'single')
Christian Heimes679db4a2008-01-18 09:56:22 +0000369 save_stdout = sys.stdout
370 save_stdin = sys.stdin
Benjamin Petersond23f8222009-04-05 19:13:16 +0000371 save_displayhook = sys.displayhook
Guido van Rossum7736b5b2008-01-15 21:44:53 +0000372 try:
373 sys.stdin = self.stdin
374 sys.stdout = self.stdout
Benjamin Petersond23f8222009-04-05 19:13:16 +0000375 sys.displayhook = self.displayhook
Guido van Rossum7736b5b2008-01-15 21:44:53 +0000376 exec(code, globals, locals)
377 finally:
378 sys.stdout = save_stdout
379 sys.stdin = save_stdin
Benjamin Petersond23f8222009-04-05 19:13:16 +0000380 sys.displayhook = save_displayhook
Tim Peters2344fae2001-01-15 00:50:52 +0000381 except:
Georg Brandl0d089622010-07-30 16:00:46 +0000382 exc_info = sys.exc_info()[:2]
383 self.error(traceback.format_exception_only(*exc_info)[-1].strip())
Tim Peters2344fae2001-01-15 00:50:52 +0000384
385 def precmd(self, line):
386 """Handle alias expansion and ';;' separator."""
Guido van Rossum08454592002-07-12 13:10:53 +0000387 if not line.strip():
Tim Peters2344fae2001-01-15 00:50:52 +0000388 return line
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000389 args = line.split()
Raymond Hettinger54f02222002-06-01 14:18:47 +0000390 while args[0] in self.aliases:
Tim Peters2344fae2001-01-15 00:50:52 +0000391 line = self.aliases[args[0]]
392 ii = 1
393 for tmpArg in args[1:]:
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000394 line = line.replace("%" + str(ii),
Tim Peters2344fae2001-01-15 00:50:52 +0000395 tmpArg)
Georg Brandlac9a2bb2010-11-29 20:19:15 +0000396 ii += 1
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000397 line = line.replace("%*", ' '.join(args[1:]))
398 args = line.split()
Tim Peters2344fae2001-01-15 00:50:52 +0000399 # split into ';;' separated commands
400 # unless it's an alias command
401 if args[0] != 'alias':
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000402 marker = line.find(';;')
Tim Peters2344fae2001-01-15 00:50:52 +0000403 if marker >= 0:
404 # queue up everything after marker
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000405 next = line[marker+2:].lstrip()
Tim Peters2344fae2001-01-15 00:50:52 +0000406 self.cmdqueue.append(next)
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000407 line = line[:marker].rstrip()
Tim Peters2344fae2001-01-15 00:50:52 +0000408 return line
409
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000410 def onecmd(self, line):
411 """Interpret the argument as though it had been typed in response
412 to the prompt.
413
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000414 Checks whether this line is typed at the normal prompt or in
415 a breakpoint command list definition.
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000416 """
417 if not self.commands_defining:
418 return cmd.Cmd.onecmd(self, line)
419 else:
420 return self.handle_command_def(line)
421
Georg Brandlb90ffd82010-07-30 22:20:16 +0000422 def handle_command_def(self, line):
Georg Brandl44f8bf92010-07-30 08:54:49 +0000423 """Handles one command line during command list definition."""
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000424 cmd, arg, line = self.parseline(line)
Georg Brandl44f8bf92010-07-30 08:54:49 +0000425 if not cmd:
426 return
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000427 if cmd == 'silent':
428 self.commands_silent[self.commands_bnum] = True
429 return # continue to handle other cmd def in the cmd list
430 elif cmd == 'end':
431 self.cmdqueue = []
432 return 1 # end of cmd list
433 cmdlist = self.commands[self.commands_bnum]
Georg Brandl44f8bf92010-07-30 08:54:49 +0000434 if arg:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000435 cmdlist.append(cmd+' '+arg)
436 else:
437 cmdlist.append(cmd)
438 # Determine if we must stop
439 try:
440 func = getattr(self, 'do_' + cmd)
441 except AttributeError:
442 func = self.default
Georg Brandl3078df02009-05-05 09:11:31 +0000443 # one of the resuming commands
444 if func.__name__ in self.commands_resuming:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000445 self.commands_doprompt[self.commands_bnum] = False
446 self.cmdqueue = []
447 return 1
448 return
449
Georg Brandl0d089622010-07-30 16:00:46 +0000450 # interface abstraction functions
451
452 def message(self, msg):
453 print(msg, file=self.stdout)
454
455 def error(self, msg):
456 print('***', msg, file=self.stdout)
457
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100458 # Generic completion functions. Individual complete_foo methods can be
459 # assigned below to one of these functions.
460
461 def _complete_location(self, text, line, begidx, endidx):
462 # Complete a file/module/function location for break/tbreak/clear.
463 if line.strip().endswith((':', ',')):
464 # Here comes a line number or a condition which we can't complete.
465 return []
466 # First, try to find matching functions (i.e. expressions).
467 try:
468 ret = self._complete_expression(text, line, begidx, endidx)
469 except Exception:
470 ret = []
471 # Then, try to complete file names as well.
472 globs = glob.glob(text + '*')
473 for fn in globs:
474 if os.path.isdir(fn):
475 ret.append(fn + '/')
476 elif os.path.isfile(fn) and fn.lower().endswith(('.py', '.pyw')):
477 ret.append(fn + ':')
478 return ret
479
480 def _complete_bpnumber(self, text, line, begidx, endidx):
481 # Complete a breakpoint number. (This would be more helpful if we could
482 # display additional info along with the completions, such as file/line
483 # of the breakpoint.)
484 return [str(i) for i, bp in enumerate(bdb.Breakpoint.bpbynumber)
485 if bp is not None and str(i).startswith(text)]
486
487 def _complete_expression(self, text, line, begidx, endidx):
488 # Complete an arbitrary expression.
489 if not self.curframe:
490 return []
491 # Collect globals and locals. It is usually not really sensible to also
492 # complete builtins, and they clutter the namespace quite heavily, so we
493 # leave them out.
494 ns = self.curframe.f_globals.copy()
495 ns.update(self.curframe_locals)
496 if '.' in text:
497 # Walk an attribute chain up to the last part, similar to what
498 # rlcompleter does. This will bail if any of the parts are not
499 # simple attribute access, which is what we want.
500 dotted = text.split('.')
501 try:
502 obj = ns[dotted[0]]
503 for part in dotted[1:-1]:
504 obj = getattr(obj, part)
505 except (KeyError, AttributeError):
506 return []
507 prefix = '.'.join(dotted[:-1]) + '.'
508 return [prefix + n for n in dir(obj) if n.startswith(dotted[-1])]
509 else:
510 # Complete a simple name.
511 return [n for n in ns.keys() if n.startswith(text)]
512
Tim Peters2344fae2001-01-15 00:50:52 +0000513 # Command definitions, called by cmdloop()
514 # The argument is the remaining string on the command line
515 # Return true to exit from the command loop
516
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000517 def do_commands(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000518 """commands [bpnumber]
519 (com) ...
520 (com) end
521 (Pdb)
Georg Brandl3078df02009-05-05 09:11:31 +0000522
Georg Brandl0d089622010-07-30 16:00:46 +0000523 Specify a list of commands for breakpoint number bpnumber.
524 The commands themselves are entered on the following lines.
525 Type a line containing just 'end' to terminate the commands.
526 The commands are executed when the breakpoint is hit.
527
528 To remove all commands from a breakpoint, type commands and
529 follow it immediately with end; that is, give no commands.
530
531 With no bpnumber argument, commands refers to the last
532 breakpoint set.
533
534 You can use breakpoint commands to start your program up
535 again. Simply use the continue command, or step, or any other
536 command that resumes execution.
537
538 Specifying any command resuming execution (currently continue,
539 step, next, return, jump, quit and their abbreviations)
540 terminates the command list (as if that command was
541 immediately followed by end). This is because any time you
542 resume execution (even with a simple next or step), you may
543 encounter another breakpoint -- which could have its own
544 command list, leading to ambiguities about which list to
545 execute.
546
547 If you use the 'silent' command in the command list, the usual
548 message about stopping at a breakpoint is not printed. This
549 may be desirable for breakpoints that are to print a specific
550 message and then continue. If none of the other commands
551 print anything, you will see no sign that the breakpoint was
552 reached.
553 """
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000554 if not arg:
Georg Brandl7410dd12010-07-30 12:01:20 +0000555 bnum = len(bdb.Breakpoint.bpbynumber) - 1
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000556 else:
557 try:
558 bnum = int(arg)
559 except:
Georg Brandl0d089622010-07-30 16:00:46 +0000560 self.error("Usage: commands [bnum]\n ...\n end")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000561 return
562 self.commands_bnum = bnum
Georg Brandlb90ffd82010-07-30 22:20:16 +0000563 # Save old definitions for the case of a keyboard interrupt.
564 if bnum in self.commands:
565 old_command_defs = (self.commands[bnum],
566 self.commands_doprompt[bnum],
567 self.commands_silent[bnum])
568 else:
569 old_command_defs = None
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000570 self.commands[bnum] = []
571 self.commands_doprompt[bnum] = True
572 self.commands_silent[bnum] = False
Georg Brandlb90ffd82010-07-30 22:20:16 +0000573
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000574 prompt_back = self.prompt
575 self.prompt = '(com) '
576 self.commands_defining = True
Georg Brandl44f8bf92010-07-30 08:54:49 +0000577 try:
578 self.cmdloop()
Georg Brandlb90ffd82010-07-30 22:20:16 +0000579 except KeyboardInterrupt:
580 # Restore old definitions.
581 if old_command_defs:
582 self.commands[bnum] = old_command_defs[0]
583 self.commands_doprompt[bnum] = old_command_defs[1]
584 self.commands_silent[bnum] = old_command_defs[2]
585 else:
586 del self.commands[bnum]
587 del self.commands_doprompt[bnum]
588 del self.commands_silent[bnum]
589 self.error('command definition aborted, old commands restored')
Georg Brandl44f8bf92010-07-30 08:54:49 +0000590 finally:
591 self.commands_defining = False
592 self.prompt = prompt_back
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000593
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100594 complete_commands = _complete_bpnumber
595
Tim Peters2344fae2001-01-15 00:50:52 +0000596 def do_break(self, arg, temporary = 0):
Georg Brandl0d089622010-07-30 16:00:46 +0000597 """b(reak) [ ([filename:]lineno | function) [, condition] ]
598 Without argument, list all breaks.
599
600 With a line number argument, set a break at this line in the
601 current file. With a function name, set a break at the first
602 executable line of that function. If a second argument is
603 present, it is a string specifying an expression which must
604 evaluate to true before the breakpoint is honored.
605
606 The line number may be prefixed with a filename and a colon,
607 to specify a breakpoint in another file (probably one that
608 hasn't been loaded yet). The file is searched for on
609 sys.path; the .py suffix may be omitted.
610 """
Tim Peters2344fae2001-01-15 00:50:52 +0000611 if not arg:
612 if self.breaks: # There's at least one
Georg Brandl0d089622010-07-30 16:00:46 +0000613 self.message("Num Type Disp Enb Where")
Tim Peters2344fae2001-01-15 00:50:52 +0000614 for bp in bdb.Breakpoint.bpbynumber:
615 if bp:
Georg Brandl0d089622010-07-30 16:00:46 +0000616 self.message(bp.bpformat())
Tim Peters2344fae2001-01-15 00:50:52 +0000617 return
618 # parse arguments; comma has lowest precedence
619 # and cannot occur in filename
620 filename = None
621 lineno = None
622 cond = None
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000623 comma = arg.find(',')
Tim Peters2344fae2001-01-15 00:50:52 +0000624 if comma > 0:
625 # parse stuff after comma: "condition"
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000626 cond = arg[comma+1:].lstrip()
627 arg = arg[:comma].rstrip()
Tim Peters2344fae2001-01-15 00:50:52 +0000628 # parse stuff before comma: [filename:]lineno | function
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000629 colon = arg.rfind(':')
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000630 funcname = None
Tim Peters2344fae2001-01-15 00:50:52 +0000631 if colon >= 0:
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000632 filename = arg[:colon].rstrip()
Tim Peters2344fae2001-01-15 00:50:52 +0000633 f = self.lookupmodule(filename)
634 if not f:
Georg Brandl0d089622010-07-30 16:00:46 +0000635 self.error('%r not found from sys.path' % filename)
Tim Peters2344fae2001-01-15 00:50:52 +0000636 return
637 else:
638 filename = f
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000639 arg = arg[colon+1:].lstrip()
Tim Peters2344fae2001-01-15 00:50:52 +0000640 try:
641 lineno = int(arg)
Georg Brandlf93390a2010-10-14 07:17:44 +0000642 except ValueError:
Georg Brandl0d089622010-07-30 16:00:46 +0000643 self.error('Bad lineno: %s' % arg)
Tim Peters2344fae2001-01-15 00:50:52 +0000644 return
645 else:
646 # no colon; can be lineno or function
647 try:
648 lineno = int(arg)
649 except ValueError:
650 try:
651 func = eval(arg,
652 self.curframe.f_globals,
Benjamin Petersond23f8222009-04-05 19:13:16 +0000653 self.curframe_locals)
Tim Peters2344fae2001-01-15 00:50:52 +0000654 except:
655 func = arg
656 try:
Christian Heimesff737952007-11-27 10:40:20 +0000657 if hasattr(func, '__func__'):
658 func = func.__func__
Neal Norwitz221085d2007-02-25 20:55:47 +0000659 code = func.__code__
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000660 #use co_name to identify the bkpt (function names
661 #could be aliased, but co_name is invariant)
662 funcname = code.co_name
Tim Peters2344fae2001-01-15 00:50:52 +0000663 lineno = code.co_firstlineno
664 filename = code.co_filename
665 except:
666 # last thing to try
667 (ok, filename, ln) = self.lineinfo(arg)
668 if not ok:
Georg Brandl0d089622010-07-30 16:00:46 +0000669 self.error('The specified object %r is not a function '
670 'or was not found along sys.path.' % arg)
Tim Peters2344fae2001-01-15 00:50:52 +0000671 return
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000672 funcname = ok # ok contains a function name
Tim Peters2344fae2001-01-15 00:50:52 +0000673 lineno = int(ln)
674 if not filename:
675 filename = self.defaultFile()
676 # Check for reasonable breakpoint
677 line = self.checkline(filename, lineno)
678 if line:
679 # now set the break point
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000680 err = self.set_break(filename, line, temporary, cond, funcname)
Georg Brandl0d089622010-07-30 16:00:46 +0000681 if err:
Berker Peksagad5ffd42014-07-12 18:24:32 +0300682 self.error(err)
Tim Peters2344fae2001-01-15 00:50:52 +0000683 else:
684 bp = self.get_breaks(filename, line)[-1]
Georg Brandl0d089622010-07-30 16:00:46 +0000685 self.message("Breakpoint %d at %s:%d" %
686 (bp.number, bp.file, bp.line))
Tim Peters2344fae2001-01-15 00:50:52 +0000687
688 # To be overridden in derived debuggers
689 def defaultFile(self):
690 """Produce a reasonable default."""
691 filename = self.curframe.f_code.co_filename
Johannes Gijsbers25b38c82004-10-12 18:12:09 +0000692 if filename == '<string>' and self.mainpyfile:
693 filename = self.mainpyfile
Tim Peters2344fae2001-01-15 00:50:52 +0000694 return filename
695
696 do_b = do_break
697
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100698 complete_break = _complete_location
699 complete_b = _complete_location
700
Tim Peters2344fae2001-01-15 00:50:52 +0000701 def do_tbreak(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000702 """tbreak [ ([filename:]lineno | function) [, condition] ]
703 Same arguments as break, but sets a temporary breakpoint: it
704 is automatically deleted when first hit.
705 """
Tim Peters2344fae2001-01-15 00:50:52 +0000706 self.do_break(arg, 1)
707
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100708 complete_tbreak = _complete_location
709
Tim Peters2344fae2001-01-15 00:50:52 +0000710 def lineinfo(self, identifier):
711 failed = (None, None, None)
712 # Input is identifier, may be in single quotes
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000713 idstring = identifier.split("'")
Tim Peters2344fae2001-01-15 00:50:52 +0000714 if len(idstring) == 1:
715 # not in single quotes
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000716 id = idstring[0].strip()
Tim Peters2344fae2001-01-15 00:50:52 +0000717 elif len(idstring) == 3:
718 # quoted
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000719 id = idstring[1].strip()
Tim Peters2344fae2001-01-15 00:50:52 +0000720 else:
721 return failed
722 if id == '': return failed
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000723 parts = id.split('.')
Tim Peters2344fae2001-01-15 00:50:52 +0000724 # Protection for derived debuggers
725 if parts[0] == 'self':
726 del parts[0]
727 if len(parts) == 0:
728 return failed
729 # Best first guess at file to look at
730 fname = self.defaultFile()
731 if len(parts) == 1:
732 item = parts[0]
733 else:
734 # More than one part.
735 # First is module, second is method/class
736 f = self.lookupmodule(parts[0])
737 if f:
738 fname = f
739 item = parts[1]
740 answer = find_function(item, fname)
741 return answer or failed
742
743 def checkline(self, filename, lineno):
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000744 """Check whether specified line seems to be executable.
Tim Peters2344fae2001-01-15 00:50:52 +0000745
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000746 Return `lineno` if it is, 0 if not (e.g. a docstring, comment, blank
747 line or EOF). Warning: testing is not comprehensive.
748 """
Georg Brandl1e30bd32010-07-30 07:21:26 +0000749 # this method should be callable before starting debugging, so default
750 # to "no globals" if there is no current frame
751 globs = self.curframe.f_globals if hasattr(self, 'curframe') else None
752 line = linecache.getline(filename, lineno, globs)
Tim Peters2344fae2001-01-15 00:50:52 +0000753 if not line:
Georg Brandl0d089622010-07-30 16:00:46 +0000754 self.message('End of file')
Tim Peters2344fae2001-01-15 00:50:52 +0000755 return 0
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000756 line = line.strip()
Tim Peters2344fae2001-01-15 00:50:52 +0000757 # Don't allow setting breakpoint at a blank line
Guido van Rossum08454592002-07-12 13:10:53 +0000758 if (not line or (line[0] == '#') or
759 (line[:3] == '"""') or line[:3] == "'''"):
Georg Brandl0d089622010-07-30 16:00:46 +0000760 self.error('Blank or comment')
Tim Peters2344fae2001-01-15 00:50:52 +0000761 return 0
Tim Peters2344fae2001-01-15 00:50:52 +0000762 return lineno
763
764 def do_enable(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000765 """enable bpnumber [bpnumber ...]
766 Enables the breakpoints given as a space separated list of
767 breakpoint numbers.
768 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000769 args = arg.split()
Tim Peters2344fae2001-01-15 00:50:52 +0000770 for i in args:
Andrew M. Kuchlingb1f8bab2003-05-22 14:46:12 +0000771 try:
Georg Brandl7410dd12010-07-30 12:01:20 +0000772 bp = self.get_bpbynumber(i)
773 except ValueError as err:
Georg Brandl0d089622010-07-30 16:00:46 +0000774 self.error(err)
Georg Brandl7410dd12010-07-30 12:01:20 +0000775 else:
Tim Peters2344fae2001-01-15 00:50:52 +0000776 bp.enable()
Georg Brandl0d089622010-07-30 16:00:46 +0000777 self.message('Enabled %s' % bp)
Tim Peters2344fae2001-01-15 00:50:52 +0000778
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100779 complete_enable = _complete_bpnumber
780
Tim Peters2344fae2001-01-15 00:50:52 +0000781 def do_disable(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000782 """disable bpnumber [bpnumber ...]
783 Disables the breakpoints given as a space separated list of
784 breakpoint numbers. Disabling a breakpoint means it cannot
785 cause the program to stop execution, but unlike clearing a
786 breakpoint, it remains in the list of breakpoints and can be
787 (re-)enabled.
788 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000789 args = arg.split()
Tim Peters2344fae2001-01-15 00:50:52 +0000790 for i in args:
Andrew M. Kuchlingb1f8bab2003-05-22 14:46:12 +0000791 try:
Georg Brandl7410dd12010-07-30 12:01:20 +0000792 bp = self.get_bpbynumber(i)
793 except ValueError as err:
Georg Brandl0d089622010-07-30 16:00:46 +0000794 self.error(err)
Georg Brandl7410dd12010-07-30 12:01:20 +0000795 else:
Tim Peters2344fae2001-01-15 00:50:52 +0000796 bp.disable()
Georg Brandl0d089622010-07-30 16:00:46 +0000797 self.message('Disabled %s' % bp)
Tim Peters2344fae2001-01-15 00:50:52 +0000798
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100799 complete_disable = _complete_bpnumber
800
Tim Peters2344fae2001-01-15 00:50:52 +0000801 def do_condition(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000802 """condition bpnumber [condition]
803 Set a new condition for the breakpoint, an expression which
804 must evaluate to true before the breakpoint is honored. If
805 condition is absent, any existing condition is removed; i.e.,
806 the breakpoint is made unconditional.
807 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000808 args = arg.split(' ', 1)
Thomas Woutersb2137042007-02-01 18:02:27 +0000809 try:
Tim Peters2344fae2001-01-15 00:50:52 +0000810 cond = args[1]
Georg Brandl7410dd12010-07-30 12:01:20 +0000811 except IndexError:
Tim Peters2344fae2001-01-15 00:50:52 +0000812 cond = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000813 try:
Georg Brandl7410dd12010-07-30 12:01:20 +0000814 bp = self.get_bpbynumber(args[0].strip())
Georg Brandl0079ffc2013-10-14 16:08:15 +0200815 except IndexError:
816 self.error('Breakpoint number expected')
Georg Brandl7410dd12010-07-30 12:01:20 +0000817 except ValueError as err:
Georg Brandl0d089622010-07-30 16:00:46 +0000818 self.error(err)
Georg Brandl7410dd12010-07-30 12:01:20 +0000819 else:
Tim Peters2344fae2001-01-15 00:50:52 +0000820 bp.cond = cond
821 if not cond:
Georg Brandl0d089622010-07-30 16:00:46 +0000822 self.message('Breakpoint %d is now unconditional.' % bp.number)
Georg Brandl7410dd12010-07-30 12:01:20 +0000823 else:
Georg Brandl0d089622010-07-30 16:00:46 +0000824 self.message('New condition set for breakpoint %d.' % bp.number)
Tim Peters2344fae2001-01-15 00:50:52 +0000825
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100826 complete_condition = _complete_bpnumber
827
Georg Brandl7410dd12010-07-30 12:01:20 +0000828 def do_ignore(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000829 """ignore bpnumber [count]
830 Set the ignore count for the given breakpoint number. If
831 count is omitted, the ignore count is set to 0. A breakpoint
832 becomes active when the ignore count is zero. When non-zero,
833 the count is decremented each time the breakpoint is reached
834 and the breakpoint is not disabled and any associated
835 condition evaluates to true.
836 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000837 args = arg.split()
Thomas Woutersb2137042007-02-01 18:02:27 +0000838 try:
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000839 count = int(args[1].strip())
Tim Peters2344fae2001-01-15 00:50:52 +0000840 except:
841 count = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +0000842 try:
Georg Brandl7410dd12010-07-30 12:01:20 +0000843 bp = self.get_bpbynumber(args[0].strip())
Georg Brandl0079ffc2013-10-14 16:08:15 +0200844 except IndexError:
845 self.error('Breakpoint number expected')
Georg Brandl7410dd12010-07-30 12:01:20 +0000846 except ValueError as err:
Georg Brandl0d089622010-07-30 16:00:46 +0000847 self.error(err)
Georg Brandl7410dd12010-07-30 12:01:20 +0000848 else:
Tim Peters2344fae2001-01-15 00:50:52 +0000849 bp.ignore = count
Guido van Rossum08454592002-07-12 13:10:53 +0000850 if count > 0:
Guido van Rossum08454592002-07-12 13:10:53 +0000851 if count > 1:
Georg Brandl0d089622010-07-30 16:00:46 +0000852 countstr = '%d crossings' % count
Tim Peters2344fae2001-01-15 00:50:52 +0000853 else:
Georg Brandl0d089622010-07-30 16:00:46 +0000854 countstr = '1 crossing'
855 self.message('Will ignore next %s of breakpoint %d.' %
856 (countstr, bp.number))
Tim Peters2344fae2001-01-15 00:50:52 +0000857 else:
Georg Brandl0d089622010-07-30 16:00:46 +0000858 self.message('Will stop next time breakpoint %d is reached.'
859 % bp.number)
Tim Peters2344fae2001-01-15 00:50:52 +0000860
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100861 complete_ignore = _complete_bpnumber
862
Tim Peters2344fae2001-01-15 00:50:52 +0000863 def do_clear(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000864 """cl(ear) filename:lineno\ncl(ear) [bpnumber [bpnumber...]]
865 With a space separated list of breakpoint numbers, clear
866 those breakpoints. Without argument, clear all breaks (but
867 first ask confirmation). With a filename:lineno argument,
868 clear all breaks at that line in that file.
869 """
Tim Peters2344fae2001-01-15 00:50:52 +0000870 if not arg:
871 try:
Guido van Rossumc5b6ab02007-05-27 09:19:52 +0000872 reply = input('Clear all breaks? ')
Tim Peters2344fae2001-01-15 00:50:52 +0000873 except EOFError:
874 reply = 'no'
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000875 reply = reply.strip().lower()
Tim Peters2344fae2001-01-15 00:50:52 +0000876 if reply in ('y', 'yes'):
Georg Brandl7410dd12010-07-30 12:01:20 +0000877 bplist = [bp for bp in bdb.Breakpoint.bpbynumber if bp]
Tim Peters2344fae2001-01-15 00:50:52 +0000878 self.clear_all_breaks()
Georg Brandl7410dd12010-07-30 12:01:20 +0000879 for bp in bplist:
Georg Brandl0d089622010-07-30 16:00:46 +0000880 self.message('Deleted %s' % bp)
Tim Peters2344fae2001-01-15 00:50:52 +0000881 return
882 if ':' in arg:
883 # Make sure it works for "clear C:\foo\bar.py:12"
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000884 i = arg.rfind(':')
Tim Peters2344fae2001-01-15 00:50:52 +0000885 filename = arg[:i]
886 arg = arg[i+1:]
887 try:
888 lineno = int(arg)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000889 except ValueError:
Tim Peters2344fae2001-01-15 00:50:52 +0000890 err = "Invalid line number (%s)" % arg
891 else:
Georg Brandl7410dd12010-07-30 12:01:20 +0000892 bplist = self.get_breaks(filename, lineno)
Tim Peters2344fae2001-01-15 00:50:52 +0000893 err = self.clear_break(filename, lineno)
Georg Brandl7410dd12010-07-30 12:01:20 +0000894 if err:
Georg Brandl0d089622010-07-30 16:00:46 +0000895 self.error(err)
Georg Brandl7410dd12010-07-30 12:01:20 +0000896 else:
897 for bp in bplist:
Georg Brandl0d089622010-07-30 16:00:46 +0000898 self.message('Deleted %s' % bp)
Tim Peters2344fae2001-01-15 00:50:52 +0000899 return
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +0000900 numberlist = arg.split()
Tim Peters2344fae2001-01-15 00:50:52 +0000901 for i in numberlist:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000902 try:
Georg Brandl7410dd12010-07-30 12:01:20 +0000903 bp = self.get_bpbynumber(i)
904 except ValueError as err:
Georg Brandl0d089622010-07-30 16:00:46 +0000905 self.error(err)
Tim Peters2344fae2001-01-15 00:50:52 +0000906 else:
Senthil Kumaran6f107042010-11-29 11:54:17 +0000907 self.clear_bpbynumber(i)
Georg Brandl0d089622010-07-30 16:00:46 +0000908 self.message('Deleted %s' % bp)
Tim Peters2344fae2001-01-15 00:50:52 +0000909 do_cl = do_clear # 'c' is already an abbreviation for 'continue'
910
Georg Brandl4c7c3c52012-03-10 22:36:48 +0100911 complete_clear = _complete_location
912 complete_cl = _complete_location
913
Tim Peters2344fae2001-01-15 00:50:52 +0000914 def do_where(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000915 """w(here)
916 Print a stack trace, with the most recent frame at the bottom.
917 An arrow indicates the "current frame", which determines the
918 context of most commands. 'bt' is an alias for this command.
919 """
Tim Peters2344fae2001-01-15 00:50:52 +0000920 self.print_stack_trace()
921 do_w = do_where
Guido van Rossum6bd68352001-01-20 17:57:37 +0000922 do_bt = do_where
Tim Peters2344fae2001-01-15 00:50:52 +0000923
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000924 def _select_frame(self, number):
925 assert 0 <= number < len(self.stack)
926 self.curindex = number
927 self.curframe = self.stack[self.curindex][0]
928 self.curframe_locals = self.curframe.f_locals
929 self.print_stack_entry(self.stack[self.curindex])
930 self.lineno = None
931
Tim Peters2344fae2001-01-15 00:50:52 +0000932 def do_up(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000933 """u(p) [count]
934 Move the current frame count (default one) levels up in the
935 stack trace (to an older frame).
936 """
Tim Peters2344fae2001-01-15 00:50:52 +0000937 if self.curindex == 0:
Georg Brandl0d089622010-07-30 16:00:46 +0000938 self.error('Oldest frame')
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000939 return
940 try:
941 count = int(arg or 1)
942 except ValueError:
Georg Brandl0d089622010-07-30 16:00:46 +0000943 self.error('Invalid frame count (%s)' % arg)
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000944 return
945 if count < 0:
946 newframe = 0
Tim Peters2344fae2001-01-15 00:50:52 +0000947 else:
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000948 newframe = max(0, self.curindex - count)
949 self._select_frame(newframe)
Tim Peters2344fae2001-01-15 00:50:52 +0000950 do_u = do_up
951
952 def do_down(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000953 """d(own) [count]
954 Move the current frame count (default one) levels down in the
955 stack trace (to a newer frame).
956 """
Tim Peters2344fae2001-01-15 00:50:52 +0000957 if self.curindex + 1 == len(self.stack):
Georg Brandl0d089622010-07-30 16:00:46 +0000958 self.error('Newest frame')
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000959 return
960 try:
961 count = int(arg or 1)
962 except ValueError:
Georg Brandl0d089622010-07-30 16:00:46 +0000963 self.error('Invalid frame count (%s)' % arg)
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000964 return
965 if count < 0:
966 newframe = len(self.stack) - 1
Tim Peters2344fae2001-01-15 00:50:52 +0000967 else:
Georg Brandleb1f4aa2010-06-27 10:37:48 +0000968 newframe = min(len(self.stack) - 1, self.curindex + count)
969 self._select_frame(newframe)
Tim Peters2344fae2001-01-15 00:50:52 +0000970 do_d = do_down
971
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000972 def do_until(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000973 """unt(il) [lineno]
974 Without argument, continue execution until the line with a
975 number greater than the current one is reached. With a line
976 number, continue execution until a line with a number greater
977 or equal to that is reached. In both cases, also stop when
978 the current frame returns.
979 """
Georg Brandl2dfec552010-07-30 08:43:32 +0000980 if arg:
981 try:
982 lineno = int(arg)
983 except ValueError:
Georg Brandl0d089622010-07-30 16:00:46 +0000984 self.error('Error in argument: %r' % arg)
Georg Brandl2dfec552010-07-30 08:43:32 +0000985 return
986 if lineno <= self.curframe.f_lineno:
Georg Brandl0d089622010-07-30 16:00:46 +0000987 self.error('"until" line number is smaller than current '
988 'line number')
Georg Brandl2dfec552010-07-30 08:43:32 +0000989 return
990 else:
991 lineno = None
992 self.set_until(self.curframe, lineno)
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000993 return 1
994 do_unt = do_until
995
Tim Peters2344fae2001-01-15 00:50:52 +0000996 def do_step(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +0000997 """s(tep)
998 Execute the current line, stop at the first possible occasion
999 (either in a function that is called or in the current
1000 function).
1001 """
Tim Peters2344fae2001-01-15 00:50:52 +00001002 self.set_step()
1003 return 1
1004 do_s = do_step
1005
1006 def do_next(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001007 """n(ext)
1008 Continue execution until the next line in the current function
1009 is reached or it returns.
1010 """
Tim Peters2344fae2001-01-15 00:50:52 +00001011 self.set_next(self.curframe)
1012 return 1
1013 do_n = do_next
1014
Guido van Rossumd8faa362007-04-27 19:54:29 +00001015 def do_run(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001016 """run [args...]
1017 Restart the debugged python program. If a string is supplied
Ezio Melotti30b9d5d2013-08-17 15:50:46 +03001018 it is split with "shlex", and the result is used as the new
Georg Brandl0d089622010-07-30 16:00:46 +00001019 sys.argv. History, breakpoints, actions and debugger options
1020 are preserved. "restart" is an alias for "run".
1021 """
Guido van Rossumd8faa362007-04-27 19:54:29 +00001022 if arg:
1023 import shlex
1024 argv0 = sys.argv[0:1]
1025 sys.argv = shlex.split(arg)
1026 sys.argv[:0] = argv0
Georg Brandl0d089622010-07-30 16:00:46 +00001027 # this is caught in the main debugger loop
Guido van Rossumd8faa362007-04-27 19:54:29 +00001028 raise Restart
1029
1030 do_restart = do_run
1031
Tim Peters2344fae2001-01-15 00:50:52 +00001032 def do_return(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001033 """r(eturn)
1034 Continue execution until the current function returns.
1035 """
Tim Peters2344fae2001-01-15 00:50:52 +00001036 self.set_return(self.curframe)
1037 return 1
1038 do_r = do_return
1039
1040 def do_continue(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001041 """c(ont(inue))
1042 Continue execution, only stop when a breakpoint is encountered.
1043 """
Georg Brandl44f2b642010-12-04 16:00:47 +00001044 if not self.nosigint:
Andrew Svetlov539ee5d2012-12-04 21:08:28 +02001045 try:
Xavier de Gaye10e54ae2016-10-12 20:13:24 +02001046 Pdb._previous_sigint_handler = \
Andrew Svetlov539ee5d2012-12-04 21:08:28 +02001047 signal.signal(signal.SIGINT, self.sigint_handler)
1048 except ValueError:
1049 # ValueError happens when do_continue() is invoked from
1050 # a non-main thread in which case we just continue without
1051 # SIGINT set. Would printing a message here (once) make
1052 # sense?
1053 pass
Tim Peters2344fae2001-01-15 00:50:52 +00001054 self.set_continue()
1055 return 1
1056 do_c = do_cont = do_continue
1057
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001058 def do_jump(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001059 """j(ump) lineno
1060 Set the next line that will be executed. Only available in
1061 the bottom-most frame. This lets you jump back and execute
1062 code again, or jump forward to skip code that you don't want
1063 to run.
1064
1065 It should be noted that not all jumps are allowed -- for
1066 instance it is not possible to jump into the middle of a
1067 for loop or out of a finally clause.
1068 """
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001069 if self.curindex + 1 != len(self.stack):
Georg Brandl0d089622010-07-30 16:00:46 +00001070 self.error('You can only jump within the bottom frame')
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001071 return
1072 try:
1073 arg = int(arg)
1074 except ValueError:
Georg Brandl0d089622010-07-30 16:00:46 +00001075 self.error("The 'jump' command requires a line number")
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001076 else:
1077 try:
1078 # Do the jump, fix up our copy of the stack, and display the
1079 # new position
1080 self.curframe.f_lineno = arg
1081 self.stack[self.curindex] = self.stack[self.curindex][0], arg
1082 self.print_stack_entry(self.stack[self.curindex])
Guido van Rossumb940e112007-01-10 16:19:56 +00001083 except ValueError as e:
Georg Brandl0d089622010-07-30 16:00:46 +00001084 self.error('Jump failed: %s' % e)
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001085 do_j = do_jump
1086
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001087 def do_debug(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001088 """debug code
1089 Enter a recursive debugger that steps through the code
1090 argument (which is an arbitrary expression or statement to be
1091 executed in the current environment).
1092 """
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001093 sys.settrace(None)
1094 globals = self.curframe.f_globals
Benjamin Petersond23f8222009-04-05 19:13:16 +00001095 locals = self.curframe_locals
Guido van Rossum7736b5b2008-01-15 21:44:53 +00001096 p = Pdb(self.completekey, self.stdin, self.stdout)
Guido van Rossumed538d82003-04-09 19:36:34 +00001097 p.prompt = "(%s) " % self.prompt.strip()
Georg Brandl0d089622010-07-30 16:00:46 +00001098 self.message("ENTERING RECURSIVE DEBUGGER")
Guido van Rossumed538d82003-04-09 19:36:34 +00001099 sys.call_tracing(p.run, (arg, globals, locals))
Georg Brandl0d089622010-07-30 16:00:46 +00001100 self.message("LEAVING RECURSIVE DEBUGGER")
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001101 sys.settrace(self.trace_dispatch)
1102 self.lastcmd = p.lastcmd
1103
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001104 complete_debug = _complete_expression
1105
Tim Peters2344fae2001-01-15 00:50:52 +00001106 def do_quit(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001107 """q(uit)\nexit
1108 Quit from the debugger. The program being executed is aborted.
1109 """
Georg Brandlac9a2bb2010-11-29 20:19:15 +00001110 self._user_requested_quit = True
Tim Peters2344fae2001-01-15 00:50:52 +00001111 self.set_quit()
1112 return 1
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001113
Tim Peters2344fae2001-01-15 00:50:52 +00001114 do_q = do_quit
Guido van Rossumd1c08f32002-04-15 00:48:24 +00001115 do_exit = do_quit
Tim Peters2344fae2001-01-15 00:50:52 +00001116
Guido van Rossumeef26072003-01-13 21:13:55 +00001117 def do_EOF(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001118 """EOF
1119 Handles the receipt of EOF as a command.
1120 """
1121 self.message('')
Georg Brandlac9a2bb2010-11-29 20:19:15 +00001122 self._user_requested_quit = True
Guido van Rossumeef26072003-01-13 21:13:55 +00001123 self.set_quit()
1124 return 1
1125
Tim Peters2344fae2001-01-15 00:50:52 +00001126 def do_args(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001127 """a(rgs)
1128 Print the argument list of the current function.
1129 """
Benjamin Petersond23f8222009-04-05 19:13:16 +00001130 co = self.curframe.f_code
1131 dict = self.curframe_locals
Tim Peters2344fae2001-01-15 00:50:52 +00001132 n = co.co_argcount
1133 if co.co_flags & 4: n = n+1
1134 if co.co_flags & 8: n = n+1
1135 for i in range(n):
1136 name = co.co_varnames[i]
Georg Brandl0d089622010-07-30 16:00:46 +00001137 if name in dict:
1138 self.message('%s = %r' % (name, dict[name]))
1139 else:
1140 self.message('%s = *** undefined ***' % (name,))
Tim Peters2344fae2001-01-15 00:50:52 +00001141 do_a = do_args
Guido van Rossum2424f851998-09-11 22:50:09 +00001142
Tim Peters2344fae2001-01-15 00:50:52 +00001143 def do_retval(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001144 """retval
1145 Print the return value for the last return of a function.
1146 """
Benjamin Petersond23f8222009-04-05 19:13:16 +00001147 if '__return__' in self.curframe_locals:
Georg Brandl0d089622010-07-30 16:00:46 +00001148 self.message(repr(self.curframe_locals['__return__']))
Tim Peters2344fae2001-01-15 00:50:52 +00001149 else:
Georg Brandl0d089622010-07-30 16:00:46 +00001150 self.error('Not yet returned!')
Tim Peters2344fae2001-01-15 00:50:52 +00001151 do_rv = do_retval
Guido van Rossum2424f851998-09-11 22:50:09 +00001152
Barry Warsaw210bd202002-11-05 22:40:20 +00001153 def _getval(self, arg):
Tim Peters2344fae2001-01-15 00:50:52 +00001154 try:
Benjamin Petersond23f8222009-04-05 19:13:16 +00001155 return eval(arg, self.curframe.f_globals, self.curframe_locals)
Tim Peters2344fae2001-01-15 00:50:52 +00001156 except:
Georg Brandl0d089622010-07-30 16:00:46 +00001157 exc_info = sys.exc_info()[:2]
1158 self.error(traceback.format_exception_only(*exc_info)[-1].strip())
Barry Warsaw210bd202002-11-05 22:40:20 +00001159 raise
Guido van Rossum2424f851998-09-11 22:50:09 +00001160
Georg Brandlcbc79c72010-12-04 16:21:42 +00001161 def _getval_except(self, arg, frame=None):
1162 try:
1163 if frame is None:
1164 return eval(arg, self.curframe.f_globals, self.curframe_locals)
1165 else:
1166 return eval(arg, frame.f_globals, frame.f_locals)
1167 except:
1168 exc_info = sys.exc_info()[:2]
1169 err = traceback.format_exception_only(*exc_info)[-1].strip()
1170 return _rstr('** raised %s **' % err)
1171
Barry Warsaw210bd202002-11-05 22:40:20 +00001172 def do_p(self, arg):
R David Murray78d692f2013-10-10 17:23:26 -04001173 """p expression
Georg Brandl0d089622010-07-30 16:00:46 +00001174 Print the value of the expression.
1175 """
Barry Warsaw210bd202002-11-05 22:40:20 +00001176 try:
Georg Brandl0d089622010-07-30 16:00:46 +00001177 self.message(repr(self._getval(arg)))
Barry Warsaw210bd202002-11-05 22:40:20 +00001178 except:
1179 pass
1180
1181 def do_pp(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001182 """pp expression
1183 Pretty-print the value of the expression.
1184 """
Barry Warsaw210bd202002-11-05 22:40:20 +00001185 try:
Georg Brandl0d089622010-07-30 16:00:46 +00001186 self.message(pprint.pformat(self._getval(arg)))
Barry Warsaw210bd202002-11-05 22:40:20 +00001187 except:
1188 pass
Guido van Rossum2424f851998-09-11 22:50:09 +00001189
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001190 complete_print = _complete_expression
1191 complete_p = _complete_expression
1192 complete_pp = _complete_expression
1193
Tim Peters2344fae2001-01-15 00:50:52 +00001194 def do_list(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001195 """l(ist) [first [,last] | .]
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001196
1197 List source code for the current file. Without arguments,
1198 list 11 lines around the current line or continue the previous
1199 listing. With . as argument, list 11 lines around the current
1200 line. With one argument, list 11 lines starting at that line.
1201 With two arguments, list the given range; if the second
1202 argument is less than the first, it is a count.
1203
1204 The current line in the current frame is indicated by "->".
1205 If an exception is being debugged, the line where the
1206 exception was originally raised or propagated is indicated by
1207 ">>", if it differs from the current line.
Georg Brandl0d089622010-07-30 16:00:46 +00001208 """
Tim Peters2344fae2001-01-15 00:50:52 +00001209 self.lastcmd = 'list'
1210 last = None
Georg Brandla91a94b2010-07-30 07:14:01 +00001211 if arg and arg != '.':
Tim Peters2344fae2001-01-15 00:50:52 +00001212 try:
Georg Brandl0d089622010-07-30 16:00:46 +00001213 if ',' in arg:
1214 first, last = arg.split(',')
1215 first = int(first.strip())
1216 last = int(last.strip())
Tim Peters2344fae2001-01-15 00:50:52 +00001217 if last < first:
Georg Brandl0d089622010-07-30 16:00:46 +00001218 # assume it's a count
Tim Peters2344fae2001-01-15 00:50:52 +00001219 last = first + last
1220 else:
Georg Brandl0d089622010-07-30 16:00:46 +00001221 first = int(arg.strip())
1222 first = max(1, first - 5)
1223 except ValueError:
1224 self.error('Error in argument: %r' % arg)
Tim Peters2344fae2001-01-15 00:50:52 +00001225 return
Georg Brandla91a94b2010-07-30 07:14:01 +00001226 elif self.lineno is None or arg == '.':
Tim Peters2344fae2001-01-15 00:50:52 +00001227 first = max(1, self.curframe.f_lineno - 5)
1228 else:
1229 first = self.lineno + 1
1230 if last is None:
1231 last = first + 10
1232 filename = self.curframe.f_code.co_filename
1233 breaklist = self.get_file_breaks(filename)
1234 try:
Georg Brandle59ca2a2010-07-30 17:04:28 +00001235 lines = linecache.getlines(filename, self.curframe.f_globals)
1236 self._print_lines(lines[first-1:last], first, breaklist,
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001237 self.curframe)
Georg Brandle59ca2a2010-07-30 17:04:28 +00001238 self.lineno = min(last, len(lines))
1239 if len(lines) < last:
1240 self.message('[EOF]')
Tim Peters2344fae2001-01-15 00:50:52 +00001241 except KeyboardInterrupt:
1242 pass
1243 do_l = do_list
Guido van Rossum2424f851998-09-11 22:50:09 +00001244
Georg Brandle59ca2a2010-07-30 17:04:28 +00001245 def do_longlist(self, arg):
1246 """longlist | ll
1247 List the whole source code for the current function or frame.
1248 """
1249 filename = self.curframe.f_code.co_filename
1250 breaklist = self.get_file_breaks(filename)
1251 try:
Georg Brandl5ed2b5a2010-07-30 18:08:12 +00001252 lines, lineno = getsourcelines(self.curframe)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001253 except OSError as err:
Georg Brandle59ca2a2010-07-30 17:04:28 +00001254 self.error(err)
1255 return
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001256 self._print_lines(lines, lineno, breaklist, self.curframe)
Georg Brandle59ca2a2010-07-30 17:04:28 +00001257 do_ll = do_longlist
1258
1259 def do_source(self, arg):
1260 """source expression
1261 Try to get source code for the given object and display it.
1262 """
1263 try:
1264 obj = self._getval(arg)
1265 except:
1266 return
1267 try:
Georg Brandl5ed2b5a2010-07-30 18:08:12 +00001268 lines, lineno = getsourcelines(obj)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001269 except (OSError, TypeError) as err:
Georg Brandle59ca2a2010-07-30 17:04:28 +00001270 self.error(err)
1271 return
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001272 self._print_lines(lines, lineno)
Georg Brandle59ca2a2010-07-30 17:04:28 +00001273
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001274 complete_source = _complete_expression
1275
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001276 def _print_lines(self, lines, start, breaks=(), frame=None):
Georg Brandle59ca2a2010-07-30 17:04:28 +00001277 """Print a range of lines."""
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001278 if frame:
1279 current_lineno = frame.f_lineno
1280 exc_lineno = self.tb_lineno.get(frame, -1)
1281 else:
1282 current_lineno = exc_lineno = -1
Georg Brandle59ca2a2010-07-30 17:04:28 +00001283 for lineno, line in enumerate(lines, start):
1284 s = str(lineno).rjust(3)
1285 if len(s) < 4:
1286 s += ' '
1287 if lineno in breaks:
1288 s += 'B'
1289 else:
1290 s += ' '
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001291 if lineno == current_lineno:
Georg Brandle59ca2a2010-07-30 17:04:28 +00001292 s += '->'
Georg Brandl0a9c3e92010-07-30 18:46:38 +00001293 elif lineno == exc_lineno:
Georg Brandle59ca2a2010-07-30 17:04:28 +00001294 s += '>>'
1295 self.message(s + '\t' + line.rstrip())
1296
Tim Peters2344fae2001-01-15 00:50:52 +00001297 def do_whatis(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001298 """whatis arg
1299 Print the type of the argument.
1300 """
Tim Peters2344fae2001-01-15 00:50:52 +00001301 try:
Georg Brandl0d089622010-07-30 16:00:46 +00001302 value = self._getval(arg)
Tim Peters2344fae2001-01-15 00:50:52 +00001303 except:
Georg Brandl0d089622010-07-30 16:00:46 +00001304 # _getval() already printed the error
Tim Peters2344fae2001-01-15 00:50:52 +00001305 return
1306 code = None
1307 # Is it a function?
Georg Brandl0d089622010-07-30 16:00:46 +00001308 try:
1309 code = value.__code__
1310 except Exception:
1311 pass
Tim Peters2344fae2001-01-15 00:50:52 +00001312 if code:
Georg Brandl0d089622010-07-30 16:00:46 +00001313 self.message('Function %s' % code.co_name)
Tim Peters2344fae2001-01-15 00:50:52 +00001314 return
1315 # Is it an instance method?
Georg Brandl0d089622010-07-30 16:00:46 +00001316 try:
1317 code = value.__func__.__code__
1318 except Exception:
1319 pass
Tim Peters2344fae2001-01-15 00:50:52 +00001320 if code:
Georg Brandl0d089622010-07-30 16:00:46 +00001321 self.message('Method %s' % code.co_name)
1322 return
1323 # Is it a class?
1324 if value.__class__ is type:
Serhiy Storchaka521e5862014-07-22 15:00:37 +03001325 self.message('Class %s.%s' % (value.__module__, value.__qualname__))
Tim Peters2344fae2001-01-15 00:50:52 +00001326 return
1327 # None of the above...
Georg Brandl0d089622010-07-30 16:00:46 +00001328 self.message(type(value))
Guido van Rossum8e2ec561993-07-29 09:37:38 +00001329
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001330 complete_whatis = _complete_expression
1331
Georg Brandlcbc79c72010-12-04 16:21:42 +00001332 def do_display(self, arg):
1333 """display [expression]
1334
1335 Display the value of the expression if it changed, each time execution
1336 stops in the current frame.
1337
1338 Without expression, list all display expressions for the current frame.
1339 """
1340 if not arg:
1341 self.message('Currently displaying:')
1342 for item in self.displaying.get(self.curframe, {}).items():
1343 self.message('%s: %r' % item)
1344 else:
1345 val = self._getval_except(arg)
1346 self.displaying.setdefault(self.curframe, {})[arg] = val
1347 self.message('display %s: %r' % (arg, val))
1348
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001349 complete_display = _complete_expression
1350
Georg Brandlcbc79c72010-12-04 16:21:42 +00001351 def do_undisplay(self, arg):
1352 """undisplay [expression]
1353
1354 Do not display the expression any more in the current frame.
1355
1356 Without expression, clear all display expressions for the current frame.
1357 """
1358 if arg:
1359 try:
1360 del self.displaying.get(self.curframe, {})[arg]
1361 except KeyError:
1362 self.error('not displaying %s' % arg)
1363 else:
1364 self.displaying.pop(self.curframe, None)
1365
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001366 def complete_undisplay(self, text, line, begidx, endidx):
1367 return [e for e in self.displaying.get(self.curframe, {})
1368 if e.startswith(text)]
1369
Georg Brandl1acb7462010-12-04 11:20:26 +00001370 def do_interact(self, arg):
1371 """interact
1372
Ezio Melotti30b9d5d2013-08-17 15:50:46 +03001373 Start an interactive interpreter whose global namespace
Georg Brandl1acb7462010-12-04 11:20:26 +00001374 contains all the (global and local) names found in the current scope.
1375 """
1376 ns = self.curframe.f_globals.copy()
1377 ns.update(self.curframe_locals)
1378 code.interact("*interactive*", local=ns)
1379
Tim Peters2344fae2001-01-15 00:50:52 +00001380 def do_alias(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001381 """alias [name [command [parameter parameter ...] ]]
1382 Create an alias called 'name' that executes 'command'. The
1383 command must *not* be enclosed in quotes. Replaceable
1384 parameters can be indicated by %1, %2, and so on, while %* is
1385 replaced by all the parameters. If no command is given, the
1386 current alias for name is shown. If no name is given, all
1387 aliases are listed.
1388
1389 Aliases may be nested and can contain anything that can be
1390 legally typed at the pdb prompt. Note! You *can* override
1391 internal pdb commands with aliases! Those internal commands
1392 are then hidden until the alias is removed. Aliasing is
1393 recursively applied to the first word of the command line; all
1394 other words in the line are left alone.
1395
1396 As an example, here are two useful aliases (especially when
1397 placed in the .pdbrc file):
1398
1399 # Print instance variables (usage "pi classInst")
R David Murray78d692f2013-10-10 17:23:26 -04001400 alias pi for k in %1.__dict__.keys(): print("%1.",k,"=",%1.__dict__[k])
Georg Brandl0d089622010-07-30 16:00:46 +00001401 # Print instance variables in self
1402 alias ps pi self
1403 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +00001404 args = arg.split()
Tim Peters2344fae2001-01-15 00:50:52 +00001405 if len(args) == 0:
Benjamin Petersonbe74a372009-09-11 21:17:13 +00001406 keys = sorted(self.aliases.keys())
Tim Peters2344fae2001-01-15 00:50:52 +00001407 for alias in keys:
Georg Brandl0d089622010-07-30 16:00:46 +00001408 self.message("%s = %s" % (alias, self.aliases[alias]))
Tim Peters2344fae2001-01-15 00:50:52 +00001409 return
Guido van Rossum08454592002-07-12 13:10:53 +00001410 if args[0] in self.aliases and len(args) == 1:
Georg Brandl0d089622010-07-30 16:00:46 +00001411 self.message("%s = %s" % (args[0], self.aliases[args[0]]))
Tim Peters2344fae2001-01-15 00:50:52 +00001412 else:
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +00001413 self.aliases[args[0]] = ' '.join(args[1:])
Guido van Rossum23efba41992-01-27 16:58:47 +00001414
Tim Peters2344fae2001-01-15 00:50:52 +00001415 def do_unalias(self, arg):
Georg Brandl0d089622010-07-30 16:00:46 +00001416 """unalias name
1417 Delete the specified alias.
1418 """
Eric S. Raymond9b93c5f2001-02-09 07:58:53 +00001419 args = arg.split()
Tim Peters2344fae2001-01-15 00:50:52 +00001420 if len(args) == 0: return
Raymond Hettinger54f02222002-06-01 14:18:47 +00001421 if args[0] in self.aliases:
Tim Peters2344fae2001-01-15 00:50:52 +00001422 del self.aliases[args[0]]
Guido van Rossum00230781993-03-29 11:39:45 +00001423
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001424 def complete_unalias(self, text, line, begidx, endidx):
1425 return [a for a in self.aliases if a.startswith(text)]
1426
Georg Brandl0d089622010-07-30 16:00:46 +00001427 # List of all the commands making the program resume execution.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001428 commands_resuming = ['do_continue', 'do_step', 'do_next', 'do_return',
1429 'do_quit', 'do_jump']
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001430
Tim Peters2344fae2001-01-15 00:50:52 +00001431 # Print a traceback starting at the top stack frame.
1432 # The most recently entered frame is printed last;
1433 # this is different from dbx and gdb, but consistent with
1434 # the Python interpreter's stack trace.
1435 # It is also consistent with the up/down commands (which are
1436 # compatible with dbx and gdb: up moves towards 'main()'
1437 # and down moves towards the most recent stack frame).
Guido van Rossum2424f851998-09-11 22:50:09 +00001438
Tim Peters2344fae2001-01-15 00:50:52 +00001439 def print_stack_trace(self):
1440 try:
1441 for frame_lineno in self.stack:
1442 self.print_stack_entry(frame_lineno)
1443 except KeyboardInterrupt:
1444 pass
Guido van Rossum2424f851998-09-11 22:50:09 +00001445
Tim Peters2344fae2001-01-15 00:50:52 +00001446 def print_stack_entry(self, frame_lineno, prompt_prefix=line_prefix):
1447 frame, lineno = frame_lineno
1448 if frame is self.curframe:
Georg Brandl0d089622010-07-30 16:00:46 +00001449 prefix = '> '
Tim Peters2344fae2001-01-15 00:50:52 +00001450 else:
Georg Brandl0d089622010-07-30 16:00:46 +00001451 prefix = ' '
1452 self.message(prefix +
1453 self.format_stack_entry(frame_lineno, prompt_prefix))
Guido van Rossum2424f851998-09-11 22:50:09 +00001454
Georg Brandl0d089622010-07-30 16:00:46 +00001455 # Provide help
Guido van Rossum921c8241992-01-10 14:54:42 +00001456
Georg Brandl0d089622010-07-30 16:00:46 +00001457 def do_help(self, arg):
1458 """h(elp)
1459 Without argument, print the list of available commands.
1460 With a command name as argument, print help about that command.
1461 "help pdb" shows the full pdb documentation.
1462 "help exec" gives help on the ! command.
1463 """
1464 if not arg:
1465 return cmd.Cmd.do_help(self, arg)
1466 try:
1467 try:
1468 topic = getattr(self, 'help_' + arg)
1469 return topic()
1470 except AttributeError:
1471 command = getattr(self, 'do_' + arg)
1472 except AttributeError:
1473 self.error('No help for %r' % arg)
1474 else:
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001475 if sys.flags.optimize >= 2:
1476 self.error('No help for %r; please do not run Python with -OO '
1477 'if you need command help' % arg)
1478 return
Georg Brandl0d089622010-07-30 16:00:46 +00001479 self.message(command.__doc__.rstrip())
Guido van Rossum921c8241992-01-10 14:54:42 +00001480
Georg Brandl0d089622010-07-30 16:00:46 +00001481 do_h = do_help
Barry Warsaw210bd202002-11-05 22:40:20 +00001482
Tim Peters2344fae2001-01-15 00:50:52 +00001483 def help_exec(self):
Georg Brandl0d089622010-07-30 16:00:46 +00001484 """(!) statement
1485 Execute the (one-line) statement in the context of the current
1486 stack frame. The exclamation point can be omitted unless the
1487 first word of the statement resembles a debugger command. To
1488 assign to a global variable you must always prefix the command
1489 with a 'global' command, e.g.:
1490 (Pdb) global list_options; list_options = ['-l']
1491 (Pdb)
1492 """
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001493 self.message((self.help_exec.__doc__ or '').strip())
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001494
Tim Peters2344fae2001-01-15 00:50:52 +00001495 def help_pdb(self):
1496 help()
Guido van Rossumb6775db1994-08-01 11:34:53 +00001497
Georg Brandl0d089622010-07-30 16:00:46 +00001498 # other helper functions
1499
Tim Peters2344fae2001-01-15 00:50:52 +00001500 def lookupmodule(self, filename):
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001501 """Helper function for break/clear parsing -- may be overridden.
1502
1503 lookupmodule() translates (possibly incomplete) file or module name
1504 into an absolute file name.
1505 """
1506 if os.path.isabs(filename) and os.path.exists(filename):
Tim Peterse718f612004-10-12 21:51:32 +00001507 return filename
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001508 f = os.path.join(sys.path[0], filename)
1509 if os.path.exists(f) and self.canonic(f) == self.mainpyfile:
1510 return f
Tim Peters2344fae2001-01-15 00:50:52 +00001511 root, ext = os.path.splitext(filename)
1512 if ext == '':
1513 filename = filename + '.py'
1514 if os.path.isabs(filename):
1515 return filename
1516 for dirname in sys.path:
1517 while os.path.islink(dirname):
1518 dirname = os.readlink(dirname)
1519 fullname = os.path.join(dirname, filename)
1520 if os.path.exists(fullname):
1521 return fullname
1522 return None
Guido van Rossumb5699c71998-07-20 23:13:54 +00001523
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001524 def _runmodule(self, module_name):
1525 self._wait_for_mainpyfile = True
1526 self._user_requested_quit = False
1527 import runpy
1528 mod_name, mod_spec, code = runpy._get_module_details(module_name)
1529 self.mainpyfile = self.canonic(code.co_filename)
1530 import __main__
1531 __main__.__dict__.clear()
1532 __main__.__dict__.update({
1533 "__name__": "__main__",
1534 "__file__": self.mainpyfile,
Miss Islington (bot)1a0239e2018-02-04 00:07:16 -08001535 "__package__": mod_spec.parent,
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001536 "__loader__": mod_spec.loader,
1537 "__spec__": mod_spec,
1538 "__builtins__": __builtins__,
1539 })
1540 self.run(code)
1541
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001542 def _runscript(self, filename):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001543 # The script has to run in __main__ namespace (or imports from
1544 # __main__ will break).
1545 #
1546 # So we clear up the __main__ and set several special variables
1547 # (this gets rid of pdb's globals and cleans old variables on restarts).
1548 import __main__
1549 __main__.__dict__.clear()
1550 __main__.__dict__.update({"__name__" : "__main__",
1551 "__file__" : filename,
1552 "__builtins__": __builtins__,
1553 })
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001554
1555 # When bdb sets tracing, a number of call and line events happens
1556 # BEFORE debugger even reaches user's code (and the exact sequence of
1557 # events depends on python version). So we take special measures to
1558 # avoid stopping before we reach the main script (see user_line and
1559 # user_call for details).
Georg Brandlac9a2bb2010-11-29 20:19:15 +00001560 self._wait_for_mainpyfile = True
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001561 self.mainpyfile = self.canonic(filename)
Georg Brandlac9a2bb2010-11-29 20:19:15 +00001562 self._user_requested_quit = False
Georg Brandld07ac642009-08-13 07:50:57 +00001563 with open(filename, "rb") as fp:
1564 statement = "exec(compile(%r, %r, 'exec'))" % \
1565 (fp.read(), self.mainpyfile)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001566 self.run(statement)
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001567
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001568# Collect all command help into docstring, if not run with -OO
Georg Brandl0d089622010-07-30 16:00:46 +00001569
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001570if __doc__ is not None:
1571 # unfortunately we can't guess this order from the class definition
1572 _help_order = [
1573 'help', 'where', 'down', 'up', 'break', 'tbreak', 'clear', 'disable',
1574 'enable', 'ignore', 'condition', 'commands', 'step', 'next', 'until',
1575 'jump', 'return', 'retval', 'run', 'continue', 'list', 'longlist',
R David Murray78d692f2013-10-10 17:23:26 -04001576 'args', 'p', 'pp', 'whatis', 'source', 'display', 'undisplay',
Georg Brandlcbc79c72010-12-04 16:21:42 +00001577 'interact', 'alias', 'unalias', 'debug', 'quit',
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001578 ]
Georg Brandl0d089622010-07-30 16:00:46 +00001579
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001580 for _command in _help_order:
1581 __doc__ += getattr(Pdb, 'do_' + _command).__doc__.strip() + '\n\n'
1582 __doc__ += Pdb.help_exec.__doc__
Georg Brandl0d089622010-07-30 16:00:46 +00001583
Georg Brandl9e7dbc82010-10-14 07:14:31 +00001584 del _help_order, _command
1585
Georg Brandl0d089622010-07-30 16:00:46 +00001586
Guido van Rossum35771131992-09-08 11:59:04 +00001587# Simplified interface
1588
Guido van Rossum5e38b6f1995-02-27 13:13:40 +00001589def run(statement, globals=None, locals=None):
Tim Peters2344fae2001-01-15 00:50:52 +00001590 Pdb().run(statement, globals, locals)
Guido van Rossum5e38b6f1995-02-27 13:13:40 +00001591
1592def runeval(expression, globals=None, locals=None):
Tim Peters2344fae2001-01-15 00:50:52 +00001593 return Pdb().runeval(expression, globals, locals)
Guido van Rossum6fe08b01992-01-16 13:50:21 +00001594
1595def runctx(statement, globals, locals):
Tim Peters2344fae2001-01-15 00:50:52 +00001596 # B/W compatibility
1597 run(statement, globals, locals)
Guido van Rossum6fe08b01992-01-16 13:50:21 +00001598
Raymond Hettinger2ef7e6c2004-10-24 00:32:24 +00001599def runcall(*args, **kwds):
1600 return Pdb().runcall(*args, **kwds)
Guido van Rossum4e160981992-09-02 20:43:20 +00001601
Barry Warsaw35425d62017-09-22 12:29:42 -04001602def set_trace(*, header=None):
1603 pdb = Pdb()
1604 if header is not None:
1605 pdb.message(header)
1606 pdb.set_trace(sys._getframe().f_back)
Guido van Rossum35771131992-09-08 11:59:04 +00001607
1608# Post-Mortem interface
1609
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001610def post_mortem(t=None):
1611 # handling the default
1612 if t is None:
1613 # sys.exc_info() returns (type, value, traceback) if an exception is
1614 # being handled, otherwise it returns None
1615 t = sys.exc_info()[2]
Georg Brandl0d089622010-07-30 16:00:46 +00001616 if t is None:
1617 raise ValueError("A valid traceback must be passed if no "
1618 "exception is being handled")
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001619
Tim Peters2344fae2001-01-15 00:50:52 +00001620 p = Pdb()
1621 p.reset()
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001622 p.interaction(None, t)
Guido van Rossum35771131992-09-08 11:59:04 +00001623
1624def pm():
Tim Peters2344fae2001-01-15 00:50:52 +00001625 post_mortem(sys.last_traceback)
Guido van Rossum35771131992-09-08 11:59:04 +00001626
1627
1628# Main program for testing
1629
Guido van Rossum23efba41992-01-27 16:58:47 +00001630TESTCMD = 'import x; x.main()'
Guido van Rossum6fe08b01992-01-16 13:50:21 +00001631
Guido van Rossum921c8241992-01-10 14:54:42 +00001632def test():
Tim Peters2344fae2001-01-15 00:50:52 +00001633 run(TESTCMD)
Guido van Rossume61fa0a1993-10-22 13:56:35 +00001634
1635# print help
1636def help():
Georg Brandl02053ee2010-07-18 10:11:03 +00001637 import pydoc
1638 pydoc.pager(__doc__)
Guido van Rossumf17361d1996-07-30 16:28:13 +00001639
Georg Brandle0230912010-07-30 08:29:39 +00001640_usage = """\
Mario Corcherofcf8b4c2018-01-28 04:58:47 +00001641usage: pdb.py [-c command] ... [-m module | pyfile] [arg] ...
Georg Brandle0230912010-07-30 08:29:39 +00001642
Mario Corcherofcf8b4c2018-01-28 04:58:47 +00001643Debug the Python program given by pyfile. Alternatively,
1644an executable module or package to debug can be specified using
1645the -m switch.
Georg Brandle0230912010-07-30 08:29:39 +00001646
1647Initial commands are read from .pdbrc files in your home directory
1648and in the current directory, if they exist. Commands supplied with
1649-c are executed after commands from .pdbrc files.
1650
1651To let the script run until an exception occurs, use "-c continue".
Georg Brandl2dfec552010-07-30 08:43:32 +00001652To let the script run up to a given line X in the debugged file, use
1653"-c 'until X'"."""
Georg Brandle0230912010-07-30 08:29:39 +00001654
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001655def main():
Georg Brandle0230912010-07-30 08:29:39 +00001656 import getopt
1657
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001658 opts, args = getopt.getopt(sys.argv[1:], 'mhc:', ['--help', '--command='])
Georg Brandle0230912010-07-30 08:29:39 +00001659
1660 if not args:
1661 print(_usage)
Tim Peters2344fae2001-01-15 00:50:52 +00001662 sys.exit(2)
Guido van Rossumf17361d1996-07-30 16:28:13 +00001663
Georg Brandle0230912010-07-30 08:29:39 +00001664 commands = []
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001665 run_as_module = False
Georg Brandle0230912010-07-30 08:29:39 +00001666 for opt, optarg in opts:
1667 if opt in ['-h', '--help']:
1668 print(_usage)
1669 sys.exit()
1670 elif opt in ['-c', '--command']:
1671 commands.append(optarg)
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001672 elif opt in ['-m']:
1673 run_as_module = True
Georg Brandle0230912010-07-30 08:29:39 +00001674
1675 mainpyfile = args[0] # Get script filename
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001676 if not run_as_module and not os.path.exists(mainpyfile):
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001677 print('Error:', mainpyfile, 'does not exist')
Tim Peters2344fae2001-01-15 00:50:52 +00001678 sys.exit(1)
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001679
Georg Brandle0230912010-07-30 08:29:39 +00001680 sys.argv[:] = args # Hide "pdb.py" and pdb options from argument list
Guido van Rossumec577d51996-09-10 17:39:34 +00001681
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001682 # Replace pdb's dir with script's dir in front of module search path.
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001683 if not run_as_module:
1684 sys.path[0] = os.path.dirname(mainpyfile)
Guido van Rossumf17361d1996-07-30 16:28:13 +00001685
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001686 # Note on saving/restoring sys.argv: it's a good idea when sys.argv was
1687 # modified by the script being debugged. It's a bad idea when it was
Georg Brandl3078df02009-05-05 09:11:31 +00001688 # changed by the user from the command line. There is a "restart" command
1689 # which allows explicit specification of command line arguments.
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001690 pdb = Pdb()
Georg Brandle0230912010-07-30 08:29:39 +00001691 pdb.rcLines.extend(commands)
Georg Brandl1e30bd32010-07-30 07:21:26 +00001692 while True:
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001693 try:
Mario Corchero9f1e5f12018-01-06 07:53:05 +00001694 if run_as_module:
1695 pdb._runmodule(mainpyfile)
1696 else:
1697 pdb._runscript(mainpyfile)
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001698 if pdb._user_requested_quit:
1699 break
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001700 print("The program finished and will be restarted")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001701 except Restart:
1702 print("Restarting", mainpyfile, "with arguments:")
Georg Brandle0230912010-07-30 08:29:39 +00001703 print("\t" + " ".join(args))
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001704 except SystemExit:
1705 # In most cases SystemExit does not warrant a post-mortem session.
Georg Brandle0230912010-07-30 08:29:39 +00001706 print("The program exited via sys.exit(). Exit status:", end=' ')
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001707 print(sys.exc_info()[1])
Terry Jan Reedyca3f4352015-09-05 19:13:26 -04001708 except SyntaxError:
1709 traceback.print_exc()
1710 sys.exit(1)
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001711 except:
1712 traceback.print_exc()
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001713 print("Uncaught exception. Entering post mortem debugging")
1714 print("Running 'cont' or 'step' will restart the program")
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001715 t = sys.exc_info()[2]
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001716 pdb.interaction(None, t)
Georg Brandl3078df02009-05-05 09:11:31 +00001717 print("Post mortem debugger finished. The " + mainpyfile +
1718 " will be restarted")
Johannes Gijsbers25b38c82004-10-12 18:12:09 +00001719
1720
1721# When invoked as main program, invoke the debugger on a script
Guido van Rossumd8faa362007-04-27 19:54:29 +00001722if __name__ == '__main__':
1723 import pdb
1724 pdb.main()