Guido van Rossum | 921c824 | 1992-01-10 14:54:42 +0000 | [diff] [blame^] | 1 | # pdb.py -- finally, a Python debugger! |
| 2 | |
| 3 | # To do: |
| 4 | # - Keep a list of exceptions trapped (default only KeyboardInterrupt?) |
| 5 | # - A blank line should repeat the previous command, not execute 'next' |
| 6 | # - Don't line-trace functions (or at least files) without breakpoints |
| 7 | # - Better handling of call/return events |
| 8 | # - It should be possible to intercept KeyboardInterrupt completely |
| 9 | # - Where and when to stop exactly when 'next' encounters a return? |
| 10 | # (should be level-based -- don't trace anything deeper than current) |
| 11 | # - Show stack traces upside-down (like dbx/gdb) |
| 12 | |
| 13 | import string |
| 14 | import sys |
| 15 | import linecache |
| 16 | |
| 17 | |
| 18 | # A generic class to build command interpreters |
| 19 | |
| 20 | PROMPT = '(Cmd) ' |
| 21 | IDENTCHARS = string.letters + string.digits + '_' |
| 22 | |
| 23 | class Cmd: |
| 24 | def init(self): |
| 25 | self.prompt = PROMPT |
| 26 | self.identchars = IDENTCHARS |
| 27 | return self |
| 28 | def commandloop(self): |
| 29 | try: |
| 30 | self.innerloop() |
| 31 | except EOFError: |
| 32 | pass |
| 33 | def innerloop(self): |
| 34 | while 1: |
| 35 | line = string.strip(self.getline()) |
| 36 | self.execline(line) |
| 37 | def execline(self, line): |
| 38 | i, n = 0, len(line) |
| 39 | while i < n and line[i] in self.identchars: i = i+1 |
| 40 | cmd, arg = line[:i], string.strip(line[i:]) |
| 41 | if cmd == '': |
| 42 | self.default(line) |
| 43 | else: |
| 44 | try: |
| 45 | func = eval('self.do_' + cmd) |
| 46 | except AttributeError: |
| 47 | self.default(line) |
| 48 | return |
| 49 | func(arg) |
| 50 | def getline(self): |
| 51 | return raw_input(self.prompt) |
| 52 | def default(self, line): |
| 53 | print '*** Unknown syntax:', line |
| 54 | def do_help(self, arg): |
| 55 | if arg: |
| 56 | # XXX check arg syntax |
| 57 | try: |
| 58 | func = eval('self.help_' + arg) |
| 59 | except: |
| 60 | print '*** No help on', `arg` |
| 61 | return |
| 62 | func() |
| 63 | else: |
| 64 | import getattr |
| 65 | names = getattr.dir(self) |
| 66 | cmds = [] |
| 67 | for name in names: |
| 68 | if name[:3] == 'do_': |
| 69 | cmds.append(name[3:]) |
| 70 | print cmds |
| 71 | |
| 72 | |
| 73 | # A specialization of Cmd for use by the debugger |
| 74 | |
| 75 | PdbDone = 'PdbDone' # Exception used internally |
| 76 | PdbQuit = 'PdbQuit' # Exception to just give up |
| 77 | |
| 78 | class Pdb(Cmd): |
| 79 | |
| 80 | def init(self): |
| 81 | self = Cmd.init(self) |
| 82 | self.prompt = '(Pdb) ' |
| 83 | self.reset() |
| 84 | self.breaks = {} |
| 85 | return self |
| 86 | |
| 87 | def reset(self): |
| 88 | self.whatnext = '' |
| 89 | self.botframe = None |
| 90 | self.forget() |
| 91 | |
| 92 | def forget(self): |
| 93 | self.curframe = self.topframe = None |
| 94 | self.stack = [] |
| 95 | self.lineno = None |
| 96 | |
| 97 | def setup(self, frame): |
| 98 | self.curframe = self.topframe = frame |
| 99 | self.stack = [] |
| 100 | self.lineno = None |
| 101 | self.stopframe = None |
| 102 | self.whatnext = '' |
| 103 | |
| 104 | def run(self, cmd): |
| 105 | if cmd[-1:] != '\n': cmd = cmd + '\n' |
| 106 | self.reset() |
| 107 | sys.trace = self.dispatch |
| 108 | try: |
| 109 | exec(cmd) |
| 110 | except PdbQuit: |
| 111 | pass |
| 112 | finally: |
| 113 | sys.trace = None |
| 114 | del sys.trace |
| 115 | self.reset() |
| 116 | |
| 117 | def dispatch(self, frame, where, arg): |
| 118 | if self.whatnext == 'quit': |
| 119 | return |
| 120 | if self.botframe is None: |
| 121 | self.botframe = frame |
| 122 | if where == 'exception': |
| 123 | stop = 1 |
| 124 | elif self.whatnext == 'continue': |
| 125 | stop = 0 |
| 126 | elif self.whatnext == 'next': |
| 127 | stop = (frame == self.stopframe) |
| 128 | else: |
| 129 | stop = 1 |
| 130 | if not stop: |
| 131 | # Check breakpoints only |
| 132 | filename = frame.f_code.co_filename |
| 133 | if not self.breaks.has_key(filename): |
| 134 | return self.dispatch |
| 135 | lineno = frame.f_lineno |
| 136 | if lineno not in self.breaks[filename]: |
| 137 | return self.dispatch |
| 138 | if where == 'call': |
| 139 | print 'call arguments:', arg |
| 140 | elif where == 'return': |
| 141 | print 'return value:', arg |
| 142 | elif where == 'exception': |
| 143 | print 'exception:', arg[:2] |
| 144 | elif where != 'line': |
| 145 | print 'unknown trace type:', `where` |
| 146 | self.setup(frame) |
| 147 | try: |
| 148 | self.whatnext = self.commandloop() |
| 149 | finally: |
| 150 | self.forget() |
| 151 | if self.whatnext == 'quit': |
| 152 | raise PdbQuit |
| 153 | if self.whatnext == 'next': |
| 154 | if where != 'return': |
| 155 | self.stopframe = frame |
| 156 | else: |
| 157 | self.whatnext = 'step' |
| 158 | return self.dispatch |
| 159 | |
| 160 | def commandloop(self): |
| 161 | self.printwhere(self.curframe) |
| 162 | try: |
| 163 | self.innerloop() |
| 164 | except EOFError: |
| 165 | self.do_next('') |
| 166 | except PdbDone, msg: |
| 167 | return msg |
| 168 | |
| 169 | def default(self, line): |
| 170 | if not line: |
| 171 | self.do_next('') |
| 172 | else: |
| 173 | if line[0] == '!': line = line[1:] |
| 174 | try: |
| 175 | exec(line + '\n', \ |
| 176 | self.curframe.f_globals, \ |
| 177 | self.curframe.f_locals) |
| 178 | except: |
| 179 | print '***', sys.exc_type + ':', |
| 180 | print `sys.exc_value` |
| 181 | |
| 182 | do_h = Cmd.do_help |
| 183 | |
| 184 | def do_break(self, arg): |
| 185 | if not arg: |
| 186 | print self.breaks # XXX |
| 187 | return |
| 188 | try: |
| 189 | lineno = int(eval(arg)) |
| 190 | except: |
| 191 | print '*** Error in argument:', `arg` |
| 192 | return |
| 193 | filename = self.curframe.f_code.co_filename |
| 194 | line = linecache.getline(filename, lineno) |
| 195 | if not line: |
| 196 | print '*** That line does not exist!' |
| 197 | return |
| 198 | if not self.breaks.has_key(filename): |
| 199 | self.breaks[filename] = [] |
| 200 | list = self.breaks[filename] |
| 201 | if lineno in list: |
| 202 | print '*** There is already a break there!' |
| 203 | return |
| 204 | list.append(lineno) |
| 205 | do_b = do_break |
| 206 | |
| 207 | def do_clear(self, arg): |
| 208 | if not arg: |
| 209 | self.breaks = {} |
| 210 | print 'All breaks cleared!' |
| 211 | return |
| 212 | try: |
| 213 | lineno = int(eval(arg)) |
| 214 | except: |
| 215 | print '*** Error in argument:', `arg` |
| 216 | return |
| 217 | filename = self.curframe.f_code.co_filename |
| 218 | try: |
| 219 | self.breaks[filename].remove(lineno) |
| 220 | if self.breaks[filename] == []: |
| 221 | del self.breaks[filename] |
| 222 | except (ValueError, KeyError): |
| 223 | print '*** There is no break there!' |
| 224 | return |
| 225 | |
| 226 | def do_where(self, arg): |
| 227 | self.printtb() |
| 228 | do_w = do_where |
| 229 | |
| 230 | def do_up(self, arg): |
| 231 | if not self.stack: print '*** Top' |
| 232 | else: |
| 233 | self.curframe = self.stack[-1] |
| 234 | self.lineno = None |
| 235 | del self.stack[-1] |
| 236 | self.printwhere(self.curframe) |
| 237 | do_u = do_up |
| 238 | |
| 239 | def do_down(self, arg): |
| 240 | if self.curframe == self.botframe or \ |
| 241 | not self.curframe.f_back: print '*** Bottom' |
| 242 | else: |
| 243 | self.stack.append(self.curframe) |
| 244 | self.curframe = self.curframe.f_back |
| 245 | self.lineno = None |
| 246 | self.printwhere(self.curframe) |
| 247 | do_d = do_down |
| 248 | |
| 249 | def do_step(self, arg): |
| 250 | raise PdbDone, 'step' |
| 251 | do_s = do_step |
| 252 | |
| 253 | def do_next(self, arg): |
| 254 | raise PdbDone, 'next' |
| 255 | do_n = do_next |
| 256 | |
| 257 | def do_continue(self, arg): |
| 258 | raise PdbDone, 'continue' |
| 259 | do_c = do_cont = do_continue |
| 260 | |
| 261 | def do_quit(self, arg): |
| 262 | raise PdbDone, 'quit' |
| 263 | do_q = do_quit |
| 264 | |
| 265 | def do_list(self, arg): |
| 266 | last = None |
| 267 | if arg: |
| 268 | try: |
| 269 | x = eval(arg, {}, {}) |
| 270 | if type(x) == type(()): |
| 271 | first, last = x |
| 272 | first = int(first) |
| 273 | last = int(last) |
| 274 | if last < first: |
| 275 | # Assume it's a count |
| 276 | last = first + last |
| 277 | else: |
| 278 | first = int(x) |
| 279 | except: |
| 280 | print '*** Error in argument:', `arg` |
| 281 | return |
| 282 | elif self.lineno is None: |
| 283 | first = max(1, self.curframe.f_lineno - 5) |
| 284 | else: |
| 285 | first = self.lineno + 1 |
| 286 | if last is None: |
| 287 | last = first + 10 |
| 288 | filename = self.curframe.f_code.co_filename |
| 289 | if self.breaks.has_key(filename): |
| 290 | breaklist = self.breaks[filename] |
| 291 | else: |
| 292 | breaklist = [] |
| 293 | try: |
| 294 | for lineno in range(first, last+1): |
| 295 | line = linecache.getline(filename, lineno) |
| 296 | if not line: |
| 297 | print '[EOF]' |
| 298 | break |
| 299 | else: |
| 300 | s = string.rjust(`lineno`, 3) |
| 301 | if len(s) < 4: s = s + ' ' |
| 302 | if lineno in breaklist: s = s + 'B' |
| 303 | else: s = s + ' ' |
| 304 | if lineno == self.curframe.f_lineno: |
| 305 | s = s + '->' |
| 306 | print s + '\t' + line, |
| 307 | self.lineno = lineno |
| 308 | except KeyboardInterrupt: |
| 309 | pass |
| 310 | do_l = do_list |
| 311 | |
| 312 | # Print a traceback starting at a given stack frame |
| 313 | # Note that it is printed upside-down with respect |
| 314 | # to the orientation suggested by the up/down commands. |
| 315 | # This is consistent with gdb. |
| 316 | def printtb(self): |
| 317 | list = [] |
| 318 | frame = self.topframe |
| 319 | while frame: |
| 320 | list.append(frame) |
| 321 | if frame is self.botframe: break |
| 322 | frame = frame.f_back |
| 323 | list.reverse() |
| 324 | for frame in list: |
| 325 | self.printwhere(frame) |
| 326 | |
| 327 | def printwhere(self, frame): |
| 328 | if frame is self.curframe: print '->', |
| 329 | code = frame.f_code |
| 330 | filename = code.co_filename |
| 331 | lineno = frame.f_lineno |
| 332 | print filename + '(' + `lineno` + ')', |
| 333 | line = linecache.getline(filename, lineno) |
| 334 | if line: print string.strip(line), |
| 335 | print |
| 336 | |
| 337 | |
| 338 | # --------------------- testing --------------------- |
| 339 | |
| 340 | # The Ackermann function -- a highly recursive beast |
| 341 | cheat = 0 |
| 342 | cache = {} |
| 343 | def ack(x, y): |
| 344 | key = `(long(x), long(y))` |
| 345 | if cache.has_key(key): |
| 346 | res = cache[key] |
| 347 | else: |
| 348 | if x == 0: |
| 349 | res = 1L |
| 350 | elif y == 0: |
| 351 | if x == 1: |
| 352 | res = 2L |
| 353 | else: |
| 354 | res = 2L + x |
| 355 | elif y == 1 and cheat >= 1: |
| 356 | res = 2L * x |
| 357 | elif y == 2 and cheat >= 2: |
| 358 | res = pow(2L, x) |
| 359 | else: |
| 360 | res = ack(ack(x-1, y), y-1) |
| 361 | cache[key] = res |
| 362 | return res |
| 363 | |
| 364 | def foo(n): |
| 365 | print 'foo', n |
| 366 | x = bar(n*2) |
| 367 | print 'bar returned', x |
| 368 | return |
| 369 | |
| 370 | def bar(a): |
| 371 | print 'bar', a |
| 372 | return a*10 |
| 373 | |
| 374 | def test(): |
| 375 | linecache.checkcache() |
| 376 | Pdb().init().run('foo(12)') |
| 377 | |
| 378 | |
| 379 | # --------------------- main --------------------- |
| 380 | |
| 381 | import os |
| 382 | |
| 383 | def main(): |
| 384 | if sys.argv[1:]: |
| 385 | file = sys.argv[1] |
| 386 | head, tail = os.path.split(file) |
| 387 | if tail[-3:] != '.py': |
| 388 | print 'Sorry, file arg must be a python module' |
| 389 | print '(i.e., must end in \'.py\')' |
| 390 | # XXX Or we could copy it to a temp file |
| 391 | sys.exit(2) |
| 392 | del sys.argv[0] |
| 393 | sys.path.insert(0, head) |
| 394 | Pdb().init().run('import ' + tail[:-3]) |
| 395 | else: |
| 396 | Pdb().init().run('') |