blob: cee71a41bd862b4ec8119e5136c5ff942f059d93 [file] [log] [blame]
Guido van Rossum4acc25b2000-02-02 15:10:15 +00001"""Debugger basics"""
Guido van Rossumbabe2bf1992-01-22 22:21:31 +00002
Georg Brandl243ad662009-05-05 09:00:19 +00003import fnmatch
Guido van Rossumbabe2bf1992-01-22 22:21:31 +00004import sys
Barry Warsaw148ffbc1999-09-09 23:24:33 +00005import os
Guido van Rossum4808dcb1996-10-15 14:40:21 +00006import types
Guido van Rossumbabe2bf1992-01-22 22:21:31 +00007
Skip Montanaroe99d5ea2001-01-20 19:54:20 +00008__all__ = ["BdbQuit","Bdb","Breakpoint"]
9
Neal Norwitz93cf79f2002-03-31 14:06:41 +000010class BdbQuit(Exception):
11 """Exception to give up completely"""
Guido van Rossumbabe2bf1992-01-22 22:21:31 +000012
13
Guido van Rossum6ea27cc1999-01-25 20:51:34 +000014class Bdb:
Tim Peters11cf6052001-01-14 21:54:20 +000015
Guido van Rossum4acc25b2000-02-02 15:10:15 +000016 """Generic Python debugger base class.
Guido van Rossum6ea27cc1999-01-25 20:51:34 +000017
Guido van Rossum4acc25b2000-02-02 15:10:15 +000018 This class takes care of details of the trace facility;
19 a derived class should implement user interaction.
20 The standard debugger class (pdb.Pdb) is an example.
21 """
Guido van Rossum6ea27cc1999-01-25 20:51:34 +000022
Georg Brandl243ad662009-05-05 09:00:19 +000023 def __init__(self, skip=None):
24 self.skip = set(skip) if skip else None
Guido van Rossum4acc25b2000-02-02 15:10:15 +000025 self.breaks = {}
26 self.fncache = {}
Barry Warsaw148ffbc1999-09-09 23:24:33 +000027
Guido van Rossum4acc25b2000-02-02 15:10:15 +000028 def canonic(self, filename):
Guido van Rossum42f53322001-11-29 02:50:15 +000029 if filename == "<" + filename[1:-1] + ">":
30 return filename
Guido van Rossum4acc25b2000-02-02 15:10:15 +000031 canonic = self.fncache.get(filename)
32 if not canonic:
33 canonic = os.path.abspath(filename)
Guido van Rossumbdba3202002-02-25 23:23:24 +000034 canonic = os.path.normcase(canonic)
Guido van Rossum4acc25b2000-02-02 15:10:15 +000035 self.fncache[filename] = canonic
36 return canonic
Tim Peters11cf6052001-01-14 21:54:20 +000037
Guido van Rossum4acc25b2000-02-02 15:10:15 +000038 def reset(self):
39 import linecache
40 linecache.checkcache()
41 self.botframe = None
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +000042 self._set_stopinfo(None, None)
Tim Peters11cf6052001-01-14 21:54:20 +000043
Guido van Rossum4acc25b2000-02-02 15:10:15 +000044 def trace_dispatch(self, frame, event, arg):
45 if self.quitting:
46 return # None
47 if event == 'line':
48 return self.dispatch_line(frame)
49 if event == 'call':
50 return self.dispatch_call(frame, arg)
51 if event == 'return':
52 return self.dispatch_return(frame, arg)
53 if event == 'exception':
54 return self.dispatch_exception(frame, arg)
Nicholas Bastinc69ebe82004-03-24 21:57:10 +000055 if event == 'c_call':
56 return self.trace_dispatch
57 if event == 'c_exception':
58 return self.trace_dispatch
59 if event == 'c_return':
60 return self.trace_dispatch
Guido van Rossumbe19ed72007-02-09 05:37:30 +000061 print('bdb.Bdb.dispatch: unknown debugging event:', repr(event))
Guido van Rossum4acc25b2000-02-02 15:10:15 +000062 return self.trace_dispatch
Tim Peters11cf6052001-01-14 21:54:20 +000063
Guido van Rossum4acc25b2000-02-02 15:10:15 +000064 def dispatch_line(self, frame):
65 if self.stop_here(frame) or self.break_here(frame):
66 self.user_line(frame)
67 if self.quitting: raise BdbQuit
68 return self.trace_dispatch
Tim Peters11cf6052001-01-14 21:54:20 +000069
Guido van Rossum4acc25b2000-02-02 15:10:15 +000070 def dispatch_call(self, frame, arg):
71 # XXX 'arg' is no longer used
72 if self.botframe is None:
73 # First call of dispatch since reset()
Christian Tismer313a7512002-05-28 08:04:00 +000074 self.botframe = frame.f_back # (CT) Note that this may also be None!
Guido van Rossum4acc25b2000-02-02 15:10:15 +000075 return self.trace_dispatch
76 if not (self.stop_here(frame) or self.break_anywhere(frame)):
77 # No need to trace this function
78 return # None
79 self.user_call(frame, arg)
80 if self.quitting: raise BdbQuit
81 return self.trace_dispatch
Tim Peters11cf6052001-01-14 21:54:20 +000082
Guido van Rossum4acc25b2000-02-02 15:10:15 +000083 def dispatch_return(self, frame, arg):
84 if self.stop_here(frame) or frame == self.returnframe:
85 self.user_return(frame, arg)
86 if self.quitting: raise BdbQuit
Just van Rossumae1f65f2001-06-25 18:01:24 +000087 return self.trace_dispatch
Tim Peters11cf6052001-01-14 21:54:20 +000088
Guido van Rossum4acc25b2000-02-02 15:10:15 +000089 def dispatch_exception(self, frame, arg):
90 if self.stop_here(frame):
91 self.user_exception(frame, arg)
92 if self.quitting: raise BdbQuit
93 return self.trace_dispatch
Tim Peters11cf6052001-01-14 21:54:20 +000094
Guido van Rossum4acc25b2000-02-02 15:10:15 +000095 # Normally derived classes don't override the following
96 # methods, but they may if they want to redefine the
97 # definition of stopping and breakpoints.
Tim Peters11cf6052001-01-14 21:54:20 +000098
Georg Brandl243ad662009-05-05 09:00:19 +000099 def is_skipped_module(self, module_name):
100 for pattern in self.skip:
101 if fnmatch.fnmatch(module_name, pattern):
102 return True
103 return False
104
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000105 def stop_here(self, frame):
Neal Norwitz72a2b4d2002-05-29 00:54:38 +0000106 # (CT) stopframe may now also be None, see dispatch_call.
107 # (CT) the former test for None is therefore removed from here.
Georg Brandl243ad662009-05-05 09:00:19 +0000108 if self.skip and \
109 self.is_skipped_module(frame.f_globals.get('__name__')):
110 return False
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000111 if frame is self.stopframe:
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000112 return frame.f_lineno >= self.stoplineno
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000113 while frame is not None and frame is not self.stopframe:
114 if frame is self.botframe:
Tim Petersbc0e9102002-04-04 22:55:58 +0000115 return True
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000116 frame = frame.f_back
Tim Petersbc0e9102002-04-04 22:55:58 +0000117 return False
Guido van Rossumd93643f1998-09-11 22:38:35 +0000118
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000119 def break_here(self, frame):
120 filename = self.canonic(frame.f_code.co_filename)
Raymond Hettinger54f02222002-06-01 14:18:47 +0000121 if not filename in self.breaks:
Tim Petersbc0e9102002-04-04 22:55:58 +0000122 return False
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000123 lineno = frame.f_lineno
124 if not lineno in self.breaks[filename]:
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000125 # The line itself has no breakpoint, but maybe the line is the
126 # first line of a function with breakpoint set by function name.
127 lineno = frame.f_code.co_firstlineno
128 if not lineno in self.breaks[filename]:
129 return False
130
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000131 # flag says ok to delete temp. bp
132 (bp, flag) = effective(filename, lineno, frame)
133 if bp:
134 self.currentbp = bp.number
135 if (flag and bp.temporary):
136 self.do_clear(str(bp.number))
Tim Petersbc0e9102002-04-04 22:55:58 +0000137 return True
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000138 else:
Tim Petersbc0e9102002-04-04 22:55:58 +0000139 return False
Tim Peters11cf6052001-01-14 21:54:20 +0000140
Guido van Rossum9cec8fb2001-04-08 15:05:16 +0000141 def do_clear(self, arg):
Collin Winterce36ad82007-08-30 01:19:48 +0000142 raise NotImplementedError("subclass of bdb must implement do_clear()")
Guido van Rossum9cec8fb2001-04-08 15:05:16 +0000143
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000144 def break_anywhere(self, frame):
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000145 return self.canonic(frame.f_code.co_filename) in self.breaks
Tim Peters11cf6052001-01-14 21:54:20 +0000146
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000147 # Derived classes should override the user_* methods
148 # to gain control.
Tim Peters11cf6052001-01-14 21:54:20 +0000149
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000150 def user_call(self, frame, argument_list):
151 """This method is called when there is the remote possibility
152 that we ever need to stop in this function."""
153 pass
Tim Peters11cf6052001-01-14 21:54:20 +0000154
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000155 def user_line(self, frame):
156 """This method is called when we stop or break at this line."""
157 pass
Tim Peters11cf6052001-01-14 21:54:20 +0000158
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000159 def user_return(self, frame, return_value):
160 """This method is called when a return trap is set here."""
161 pass
Tim Peters11cf6052001-01-14 21:54:20 +0000162
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000163 def user_exception(self, frame, exc_info):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000164 """This method is called if an exception occurs,
165 but only if we are to stop at or just below this level."""
166 pass
Tim Peters11cf6052001-01-14 21:54:20 +0000167
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000168 def _set_stopinfo(self, stopframe, returnframe, stoplineno=-1):
169 self.stopframe = stopframe
170 self.returnframe = returnframe
171 self.quitting = 0
172 self.stoplineno = stoplineno
173
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000174 # Derived classes and clients can call the following methods
175 # to affect the stepping state.
Tim Peters11cf6052001-01-14 21:54:20 +0000176
Georg Brandl2dfec552010-07-30 08:43:32 +0000177 def set_until(self, frame, lineno=None):
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000178 """Stop when the line with the line no greater than the current one is
179 reached or when returning from current frame"""
Georg Brandl2dfec552010-07-30 08:43:32 +0000180 # the name "until" is borrowed from gdb
181 if lineno is None:
182 lineno = frame.f_lineno + 1
183 self._set_stopinfo(frame, frame, lineno)
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000184
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000185 def set_step(self):
186 """Stop after one line of code."""
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000187 self._set_stopinfo(None,None)
Tim Peters11cf6052001-01-14 21:54:20 +0000188
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000189 def set_next(self, frame):
190 """Stop on the next line in or below the given frame."""
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000191 self._set_stopinfo(frame, None)
Tim Peters11cf6052001-01-14 21:54:20 +0000192
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000193 def set_return(self, frame):
194 """Stop when returning from the given frame."""
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000195 self._set_stopinfo(frame.f_back, frame)
Tim Peters11cf6052001-01-14 21:54:20 +0000196
Johannes Gijsbers84a6c202004-11-07 11:35:30 +0000197 def set_trace(self, frame=None):
198 """Start debugging from `frame`.
199
200 If frame is not specified, debugging starts from caller's frame.
201 """
202 if frame is None:
203 frame = sys._getframe().f_back
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000204 self.reset()
205 while frame:
206 frame.f_trace = self.trace_dispatch
207 self.botframe = frame
208 frame = frame.f_back
209 self.set_step()
210 sys.settrace(self.trace_dispatch)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000211
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000212 def set_continue(self):
213 # Don't stop except at breakpoints or when finished
Alexandre Vassalotti5f8ced22008-05-16 00:03:33 +0000214 self._set_stopinfo(self.botframe, None)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000215 if not self.breaks:
216 # no breakpoints; run without debugger overhead
217 sys.settrace(None)
Christian Tismer313a7512002-05-28 08:04:00 +0000218 frame = sys._getframe().f_back
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000219 while frame and frame is not self.botframe:
220 del frame.f_trace
221 frame = frame.f_back
Tim Peters11cf6052001-01-14 21:54:20 +0000222
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000223 def set_quit(self):
224 self.stopframe = self.botframe
225 self.returnframe = None
226 self.quitting = 1
227 sys.settrace(None)
Tim Peters11cf6052001-01-14 21:54:20 +0000228
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000229 # Derived classes and clients can call the following methods
230 # to manipulate breakpoints. These methods return an
231 # error message is something went wrong, None if all is well.
232 # Set_break prints out the breakpoint line and file:lineno.
233 # Call self.get_*break*() to see the breakpoints or better
234 # for bp in Breakpoint.bpbynumber: if bp: bp.bpprint().
Tim Peters11cf6052001-01-14 21:54:20 +0000235
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000236 def set_break(self, filename, lineno, temporary=0, cond = None,
237 funcname=None):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000238 filename = self.canonic(filename)
239 import linecache # Import as late as possible
240 line = linecache.getline(filename, lineno)
241 if not line:
242 return 'Line %s:%d does not exist' % (filename,
243 lineno)
Raymond Hettinger54f02222002-06-01 14:18:47 +0000244 if not filename in self.breaks:
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000245 self.breaks[filename] = []
246 list = self.breaks[filename]
247 if not lineno in list:
248 list.append(lineno)
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000249 bp = Breakpoint(filename, lineno, temporary, cond, funcname)
Guido van Rossumd93643f1998-09-11 22:38:35 +0000250
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000251 def clear_break(self, filename, lineno):
252 filename = self.canonic(filename)
Raymond Hettinger54f02222002-06-01 14:18:47 +0000253 if not filename in self.breaks:
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000254 return 'There are no breakpoints in %s' % filename
255 if lineno not in self.breaks[filename]:
256 return 'There is no breakpoint at %s:%d' % (filename,
257 lineno)
258 # If there's only one bp in the list for that file,line
259 # pair, then remove the breaks entry
260 for bp in Breakpoint.bplist[filename, lineno][:]:
261 bp.deleteMe()
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000262 if (filename, lineno) not in Breakpoint.bplist:
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000263 self.breaks[filename].remove(lineno)
264 if not self.breaks[filename]:
265 del self.breaks[filename]
Tim Peters11cf6052001-01-14 21:54:20 +0000266
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000267 def clear_bpbynumber(self, arg):
268 try:
269 number = int(arg)
270 except:
271 return 'Non-numeric breakpoint number (%s)' % arg
272 try:
273 bp = Breakpoint.bpbynumber[number]
274 except IndexError:
275 return 'Breakpoint number (%d) out of range' % number
276 if not bp:
277 return 'Breakpoint (%d) already deleted' % number
278 self.clear_break(bp.file, bp.line)
Guido van Rossum6ea27cc1999-01-25 20:51:34 +0000279
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000280 def clear_all_file_breaks(self, filename):
281 filename = self.canonic(filename)
Raymond Hettinger54f02222002-06-01 14:18:47 +0000282 if not filename in self.breaks:
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000283 return 'There are no breakpoints in %s' % filename
284 for line in self.breaks[filename]:
285 blist = Breakpoint.bplist[filename, line]
286 for bp in blist:
287 bp.deleteMe()
288 del self.breaks[filename]
Tim Peters11cf6052001-01-14 21:54:20 +0000289
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000290 def clear_all_breaks(self):
291 if not self.breaks:
292 return 'There are no breakpoints'
293 for bp in Breakpoint.bpbynumber:
294 if bp:
295 bp.deleteMe()
296 self.breaks = {}
Tim Peters11cf6052001-01-14 21:54:20 +0000297
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000298 def get_break(self, filename, lineno):
299 filename = self.canonic(filename)
Raymond Hettinger54f02222002-06-01 14:18:47 +0000300 return filename in self.breaks and \
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000301 lineno in self.breaks[filename]
Tim Peters11cf6052001-01-14 21:54:20 +0000302
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000303 def get_breaks(self, filename, lineno):
304 filename = self.canonic(filename)
Raymond Hettinger54f02222002-06-01 14:18:47 +0000305 return filename in self.breaks and \
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000306 lineno in self.breaks[filename] and \
307 Breakpoint.bplist[filename, lineno] or []
Tim Peters11cf6052001-01-14 21:54:20 +0000308
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000309 def get_file_breaks(self, filename):
310 filename = self.canonic(filename)
Raymond Hettinger54f02222002-06-01 14:18:47 +0000311 if filename in self.breaks:
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000312 return self.breaks[filename]
313 else:
314 return []
Tim Peters11cf6052001-01-14 21:54:20 +0000315
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000316 def get_all_breaks(self):
317 return self.breaks
Tim Peters11cf6052001-01-14 21:54:20 +0000318
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000319 # Derived classes and clients can call the following method
320 # to get a data structure representing a stack trace.
Tim Peters11cf6052001-01-14 21:54:20 +0000321
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000322 def get_stack(self, f, t):
323 stack = []
324 if t and t.tb_frame is f:
325 t = t.tb_next
326 while f is not None:
327 stack.append((f, f.f_lineno))
328 if f is self.botframe:
329 break
330 f = f.f_back
331 stack.reverse()
332 i = max(0, len(stack) - 1)
333 while t is not None:
334 stack.append((t.tb_frame, t.tb_lineno))
335 t = t.tb_next
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +0000336 if f is None:
337 i = max(0, len(stack) - 1)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000338 return stack, i
Tim Peters11cf6052001-01-14 21:54:20 +0000339
340 #
341
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000342 def format_stack_entry(self, frame_lineno, lprefix=': '):
Alexandre Vassalotti1f2ba4b2008-05-16 07:12:44 +0000343 import linecache, reprlib
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000344 frame, lineno = frame_lineno
345 filename = self.canonic(frame.f_code.co_filename)
Walter Dörwald70a6b492004-02-12 17:35:32 +0000346 s = '%s(%r)' % (filename, lineno)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000347 if frame.f_code.co_name:
348 s = s + frame.f_code.co_name
349 else:
350 s = s + "<lambda>"
Raymond Hettinger54f02222002-06-01 14:18:47 +0000351 if '__args__' in frame.f_locals:
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000352 args = frame.f_locals['__args__']
353 else:
354 args = None
355 if args:
Alexandre Vassalotti1f2ba4b2008-05-16 07:12:44 +0000356 s = s + reprlib.repr(args)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000357 else:
358 s = s + '()'
Raymond Hettinger54f02222002-06-01 14:18:47 +0000359 if '__return__' in frame.f_locals:
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000360 rv = frame.f_locals['__return__']
361 s = s + '->'
Alexandre Vassalotti1f2ba4b2008-05-16 07:12:44 +0000362 s = s + reprlib.repr(rv)
Nick Coghlanf088e5e2008-12-14 11:50:48 +0000363 line = linecache.getline(filename, lineno, frame.f_globals)
Eric S. Raymondb49f4a42001-02-09 05:07:04 +0000364 if line: s = s + lprefix + line.strip()
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000365 return s
Tim Peters11cf6052001-01-14 21:54:20 +0000366
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000367 # The following two methods can be called by clients to use
368 # a debugger to debug a statement, given as a string.
Tim Peters11cf6052001-01-14 21:54:20 +0000369
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000370 def run(self, cmd, globals=None, locals=None):
371 if globals is None:
372 import __main__
373 globals = __main__.__dict__
374 if locals is None:
375 locals = globals
376 self.reset()
377 sys.settrace(self.trace_dispatch)
378 if not isinstance(cmd, types.CodeType):
379 cmd = cmd+'\n'
380 try:
Martin v. Löwisede8ffb2008-03-30 20:43:50 +0000381 exec(cmd, globals, locals)
382 except BdbQuit:
383 pass
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000384 finally:
385 self.quitting = 1
386 sys.settrace(None)
Tim Peters11cf6052001-01-14 21:54:20 +0000387
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000388 def runeval(self, expr, globals=None, locals=None):
389 if globals is None:
390 import __main__
391 globals = __main__.__dict__
392 if locals is None:
393 locals = globals
394 self.reset()
395 sys.settrace(self.trace_dispatch)
396 if not isinstance(expr, types.CodeType):
397 expr = expr+'\n'
398 try:
Martin v. Löwisede8ffb2008-03-30 20:43:50 +0000399 return eval(expr, globals, locals)
400 except BdbQuit:
401 pass
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000402 finally:
403 self.quitting = 1
404 sys.settrace(None)
Guido van Rossum5e38b6f1995-02-27 13:13:40 +0000405
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000406 def runctx(self, cmd, globals, locals):
407 # B/W compatibility
408 self.run(cmd, globals, locals)
Guido van Rossum4e160981992-09-02 20:43:20 +0000409
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000410 # This method is more useful to debug a single function call.
Guido van Rossum4e160981992-09-02 20:43:20 +0000411
Raymond Hettinger2ef7e6c2004-10-24 00:32:24 +0000412 def runcall(self, func, *args, **kwds):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000413 self.reset()
414 sys.settrace(self.trace_dispatch)
415 res = None
416 try:
Martin v. Löwisede8ffb2008-03-30 20:43:50 +0000417 res = func(*args, **kwds)
418 except BdbQuit:
419 pass
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000420 finally:
421 self.quitting = 1
422 sys.settrace(None)
423 return res
Guido van Rossumbabe2bf1992-01-22 22:21:31 +0000424
Guido van Rossumbabe2bf1992-01-22 22:21:31 +0000425
Guido van Rossumb6775db1994-08-01 11:34:53 +0000426def set_trace():
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000427 Bdb().set_trace()
Guido van Rossumb6775db1994-08-01 11:34:53 +0000428
Guido van Rossumd93643f1998-09-11 22:38:35 +0000429
430class Breakpoint:
431
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000432 """Breakpoint class
Guido van Rossumd93643f1998-09-11 22:38:35 +0000433
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000434 Implements temporary breakpoints, ignore counts, disabling and
435 (re)-enabling, and conditionals.
Guido van Rossumd93643f1998-09-11 22:38:35 +0000436
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000437 Breakpoints are indexed by number through bpbynumber and by
438 the file,line tuple using bplist. The former points to a
439 single instance of class Breakpoint. The latter points to a
440 list of such instances since there may be more than one
441 breakpoint per line.
Guido van Rossumd93643f1998-09-11 22:38:35 +0000442
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000443 """
Guido van Rossumd93643f1998-09-11 22:38:35 +0000444
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000445 # XXX Keeping state in the class is a mistake -- this means
446 # you cannot have more than one active Bdb instance.
Guido van Rossumd93643f1998-09-11 22:38:35 +0000447
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000448 next = 1 # Next bp to be assigned
449 bplist = {} # indexed by (file, lineno) tuple
450 bpbynumber = [None] # Each entry is None or an instance of Bpt
451 # index 0 is unused, except for marking an
452 # effective break .... see effective()
Guido van Rossumd93643f1998-09-11 22:38:35 +0000453
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000454 def __init__(self, file, line, temporary=0, cond=None, funcname=None):
455 self.funcname = funcname
456 # Needed if funcname is not None.
457 self.func_first_executable_line = None
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000458 self.file = file # This better be in canonical form!
459 self.line = line
460 self.temporary = temporary
461 self.cond = cond
462 self.enabled = 1
463 self.ignore = 0
464 self.hits = 0
465 self.number = Breakpoint.next
466 Breakpoint.next = Breakpoint.next + 1
467 # Build the two lists
468 self.bpbynumber.append(self)
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000469 if (file, line) in self.bplist:
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000470 self.bplist[file, line].append(self)
471 else:
472 self.bplist[file, line] = [self]
Guido van Rossumd93643f1998-09-11 22:38:35 +0000473
Tim Peters11cf6052001-01-14 21:54:20 +0000474
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000475 def deleteMe(self):
476 index = (self.file, self.line)
477 self.bpbynumber[self.number] = None # No longer in list
478 self.bplist[index].remove(self)
479 if not self.bplist[index]:
480 # No more bp for this f:l combo
481 del self.bplist[index]
Guido van Rossumd93643f1998-09-11 22:38:35 +0000482
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000483 def enable(self):
484 self.enabled = 1
Guido van Rossumd93643f1998-09-11 22:38:35 +0000485
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000486 def disable(self):
487 self.enabled = 0
Guido van Rossumd93643f1998-09-11 22:38:35 +0000488
Thomas Wouters477c8d52006-05-27 19:21:47 +0000489 def bpprint(self, out=None):
490 if out is None:
491 out = sys.stdout
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000492 if self.temporary:
Tim Peters11cf6052001-01-14 21:54:20 +0000493 disp = 'del '
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000494 else:
Tim Peters11cf6052001-01-14 21:54:20 +0000495 disp = 'keep '
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000496 if self.enabled:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000497 disp = disp + 'yes '
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000498 else:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000499 disp = disp + 'no '
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000500 print('%-4dbreakpoint %s at %s:%d' % (self.number, disp,
501 self.file, self.line), file=out)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000502 if self.cond:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000503 print('\tstop only if %s' % (self.cond,), file=out)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000504 if self.ignore:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000505 print('\tignore next %d hits' % (self.ignore), file=out)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000506 if (self.hits):
507 if (self.hits > 1): ss = 's'
508 else: ss = ''
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000509 print(('\tbreakpoint already hit %d time%s' %
510 (self.hits, ss)), file=out)
Guido van Rossumd93643f1998-09-11 22:38:35 +0000511
512# -----------end of Breakpoint class----------
513
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000514def checkfuncname(b, frame):
515 """Check whether we should break here because of `b.funcname`."""
516 if not b.funcname:
517 # Breakpoint was set via line number.
518 if b.line != frame.f_lineno:
519 # Breakpoint was set at a line with a def statement and the function
520 # defined is called: don't break.
521 return False
522 return True
523
524 # Breakpoint set via function name.
525
526 if frame.f_code.co_name != b.funcname:
527 # It's not a function call, but rather execution of def statement.
528 return False
529
530 # We are in the right frame.
531 if not b.func_first_executable_line:
532 # The function is entered for the 1st time.
533 b.func_first_executable_line = frame.f_lineno
534
535 if b.func_first_executable_line != frame.f_lineno:
536 # But we are not at the first line number: don't break.
537 return False
538 return True
539
Guido van Rossumd93643f1998-09-11 22:38:35 +0000540# Determines if there is an effective (active) breakpoint at this
541# line of code. Returns breakpoint number or 0 if none
542def effective(file, line, frame):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000543 """Determine which breakpoint for this file:line is to be acted upon.
Guido van Rossumd93643f1998-09-11 22:38:35 +0000544
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000545 Called only if we know there is a bpt at this
546 location. Returns breakpoint that was triggered and a flag
547 that indicates if it is ok to delete a temporary bp.
Guido van Rossumd93643f1998-09-11 22:38:35 +0000548
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000549 """
550 possibles = Breakpoint.bplist[file,line]
551 for i in range(0, len(possibles)):
552 b = possibles[i]
553 if b.enabled == 0:
554 continue
Johannes Gijsbers4a9faa12004-08-30 13:29:44 +0000555 if not checkfuncname(b, frame):
556 continue
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000557 # Count every hit when bp is enabled
558 b.hits = b.hits + 1
559 if not b.cond:
560 # If unconditional, and ignoring,
561 # go on to next, else break
562 if b.ignore > 0:
563 b.ignore = b.ignore -1
564 continue
565 else:
566 # breakpoint and marker that's ok
567 # to delete if temporary
568 return (b,1)
569 else:
570 # Conditional bp.
571 # Ignore count applies only to those bpt hits where the
572 # condition evaluates to true.
573 try:
574 val = eval(b.cond, frame.f_globals,
Tim Peters11cf6052001-01-14 21:54:20 +0000575 frame.f_locals)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000576 if val:
577 if b.ignore > 0:
578 b.ignore = b.ignore -1
579 # continue
580 else:
581 return (b,1)
582 # else:
583 # continue
584 except:
585 # if eval fails, most conservative
586 # thing is to stop on breakpoint
Tim Peters11cf6052001-01-14 21:54:20 +0000587 # regardless of ignore count.
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000588 # Don't delete temporary,
589 # as another hint to user.
590 return (b,0)
591 return (None, None)
Guido van Rossumd93643f1998-09-11 22:38:35 +0000592
Guido van Rossumbabe2bf1992-01-22 22:21:31 +0000593# -------------------- testing --------------------
594
595class Tdb(Bdb):
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000596 def user_call(self, frame, args):
597 name = frame.f_code.co_name
598 if not name: name = '???'
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000599 print('+++ call', name, args)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000600 def user_line(self, frame):
Eric S. Raymondb49f4a42001-02-09 05:07:04 +0000601 import linecache
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000602 name = frame.f_code.co_name
603 if not name: name = '???'
604 fn = self.canonic(frame.f_code.co_filename)
Nick Coghlanf088e5e2008-12-14 11:50:48 +0000605 line = linecache.getline(fn, frame.f_lineno, frame.f_globals)
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000606 print('+++', fn, frame.f_lineno, name, ':', line.strip())
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000607 def user_return(self, frame, retval):
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000608 print('+++ return', retval)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000609 def user_exception(self, frame, exc_stuff):
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000610 print('+++ exception', exc_stuff)
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000611 self.set_continue()
Guido van Rossumbabe2bf1992-01-22 22:21:31 +0000612
613def foo(n):
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000614 print('foo(', n, ')')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000615 x = bar(n*10)
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000616 print('bar returned', x)
Guido van Rossumbabe2bf1992-01-22 22:21:31 +0000617
618def bar(a):
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000619 print('bar(', a, ')')
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000620 return a/2
Guido van Rossumbabe2bf1992-01-22 22:21:31 +0000621
622def test():
Guido van Rossum4acc25b2000-02-02 15:10:15 +0000623 t = Tdb()
624 t.run('import bdb; bdb.foo(10)')
Eric S. Raymondb49f4a42001-02-09 05:07:04 +0000625
626# end