Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 1 | """Debugger basics""" |
Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 2 | |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 3 | import fnmatch |
Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 4 | import sys |
Barry Warsaw | 148ffbc | 1999-09-09 23:24:33 +0000 | [diff] [blame] | 5 | import os |
Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 6 | from inspect import CO_GENERATOR |
Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 7 | |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 8 | __all__ = ["BdbQuit", "Bdb", "Breakpoint"] |
Skip Montanaro | e99d5ea | 2001-01-20 19:54:20 +0000 | [diff] [blame] | 9 | |
Neal Norwitz | 93cf79f | 2002-03-31 14:06:41 +0000 | [diff] [blame] | 10 | class BdbQuit(Exception): |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 11 | """Exception to give up completely.""" |
Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 12 | |
| 13 | |
Guido van Rossum | 6ea27cc | 1999-01-25 20:51:34 +0000 | [diff] [blame] | 14 | class Bdb: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 15 | """Generic Python debugger base class. |
Guido van Rossum | 6ea27cc | 1999-01-25 20:51:34 +0000 | [diff] [blame] | 16 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 17 | This class takes care of details of the trace facility; |
| 18 | a derived class should implement user interaction. |
| 19 | The standard debugger class (pdb.Pdb) is an example. |
| 20 | """ |
Guido van Rossum | 6ea27cc | 1999-01-25 20:51:34 +0000 | [diff] [blame] | 21 | |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 22 | def __init__(self, skip=None): |
| 23 | self.skip = set(skip) if skip else None |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 24 | self.breaks = {} |
| 25 | self.fncache = {} |
Senthil Kumaran | 42d7081 | 2012-05-01 10:07:49 +0800 | [diff] [blame] | 26 | self.frame_returning = None |
Barry Warsaw | 148ffbc | 1999-09-09 23:24:33 +0000 | [diff] [blame] | 27 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 28 | def canonic(self, filename): |
Guido van Rossum | 42f5332 | 2001-11-29 02:50:15 +0000 | [diff] [blame] | 29 | if filename == "<" + filename[1:-1] + ">": |
| 30 | return filename |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 31 | canonic = self.fncache.get(filename) |
| 32 | if not canonic: |
| 33 | canonic = os.path.abspath(filename) |
Guido van Rossum | bdba320 | 2002-02-25 23:23:24 +0000 | [diff] [blame] | 34 | canonic = os.path.normcase(canonic) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 35 | self.fncache[filename] = canonic |
| 36 | return canonic |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 37 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 38 | def reset(self): |
| 39 | import linecache |
| 40 | linecache.checkcache() |
| 41 | self.botframe = None |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 42 | self._set_stopinfo(None, None) |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 43 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 44 | 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 Bastin | c69ebe8 | 2004-03-24 21:57:10 +0000 | [diff] [blame] | 55 | 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 Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 61 | print('bdb.Bdb.dispatch: unknown debugging event:', repr(event)) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 62 | return self.trace_dispatch |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 63 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 64 | 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 Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 69 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 70 | 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 Tismer | 313a751 | 2002-05-28 08:04:00 +0000 | [diff] [blame] | 74 | self.botframe = frame.f_back # (CT) Note that this may also be None! |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 75 | 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 |
Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 79 | # Ignore call events in generator except when stepping. |
| 80 | if self.stopframe and frame.f_code.co_flags & CO_GENERATOR: |
| 81 | return self.trace_dispatch |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 82 | self.user_call(frame, arg) |
| 83 | if self.quitting: raise BdbQuit |
| 84 | return self.trace_dispatch |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 85 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 86 | def dispatch_return(self, frame, arg): |
| 87 | if self.stop_here(frame) or frame == self.returnframe: |
Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 88 | # Ignore return events in generator except when stepping. |
| 89 | if self.stopframe and frame.f_code.co_flags & CO_GENERATOR: |
| 90 | return self.trace_dispatch |
Senthil Kumaran | 42d7081 | 2012-05-01 10:07:49 +0800 | [diff] [blame] | 91 | try: |
| 92 | self.frame_returning = frame |
| 93 | self.user_return(frame, arg) |
| 94 | finally: |
| 95 | self.frame_returning = None |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 96 | if self.quitting: raise BdbQuit |
Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 97 | # The user issued a 'next' or 'until' command. |
| 98 | if self.stopframe is frame and self.stoplineno != -1: |
| 99 | self._set_stopinfo(None, None) |
Just van Rossum | ae1f65f | 2001-06-25 18:01:24 +0000 | [diff] [blame] | 100 | return self.trace_dispatch |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 101 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 102 | def dispatch_exception(self, frame, arg): |
| 103 | if self.stop_here(frame): |
Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 104 | # When stepping with next/until/return in a generator frame, skip |
| 105 | # the internal StopIteration exception (with no traceback) |
| 106 | # triggered by a subiterator run with the 'yield from' statement. |
| 107 | if not (frame.f_code.co_flags & CO_GENERATOR |
| 108 | and arg[0] is StopIteration and arg[2] is None): |
| 109 | self.user_exception(frame, arg) |
| 110 | if self.quitting: raise BdbQuit |
| 111 | # Stop at the StopIteration or GeneratorExit exception when the user |
| 112 | # has set stopframe in a generator by issuing a return command, or a |
| 113 | # next/until command at the last statement in the generator before the |
| 114 | # exception. |
| 115 | elif (self.stopframe and frame is not self.stopframe |
| 116 | and self.stopframe.f_code.co_flags & CO_GENERATOR |
| 117 | and arg[0] in (StopIteration, GeneratorExit)): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 118 | self.user_exception(frame, arg) |
| 119 | if self.quitting: raise BdbQuit |
Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 120 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 121 | return self.trace_dispatch |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 122 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 123 | # Normally derived classes don't override the following |
| 124 | # methods, but they may if they want to redefine the |
| 125 | # definition of stopping and breakpoints. |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 126 | |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 127 | def is_skipped_module(self, module_name): |
| 128 | for pattern in self.skip: |
| 129 | if fnmatch.fnmatch(module_name, pattern): |
| 130 | return True |
| 131 | return False |
| 132 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 133 | def stop_here(self, frame): |
Neal Norwitz | 72a2b4d | 2002-05-29 00:54:38 +0000 | [diff] [blame] | 134 | # (CT) stopframe may now also be None, see dispatch_call. |
| 135 | # (CT) the former test for None is therefore removed from here. |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 136 | if self.skip and \ |
| 137 | self.is_skipped_module(frame.f_globals.get('__name__')): |
| 138 | return False |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 139 | if frame is self.stopframe: |
Georg Brandl | 3f94089 | 2010-07-30 10:29:19 +0000 | [diff] [blame] | 140 | if self.stoplineno == -1: |
| 141 | return False |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 142 | return frame.f_lineno >= self.stoplineno |
Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 143 | if not self.stopframe: |
| 144 | return True |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 145 | return False |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 146 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 147 | def break_here(self, frame): |
| 148 | filename = self.canonic(frame.f_code.co_filename) |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 149 | if filename not in self.breaks: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 150 | return False |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 151 | lineno = frame.f_lineno |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 152 | if lineno not in self.breaks[filename]: |
Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 153 | # The line itself has no breakpoint, but maybe the line is the |
| 154 | # first line of a function with breakpoint set by function name. |
| 155 | lineno = frame.f_code.co_firstlineno |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 156 | if lineno not in self.breaks[filename]: |
Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 157 | return False |
| 158 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 159 | # flag says ok to delete temp. bp |
| 160 | (bp, flag) = effective(filename, lineno, frame) |
| 161 | if bp: |
| 162 | self.currentbp = bp.number |
| 163 | if (flag and bp.temporary): |
| 164 | self.do_clear(str(bp.number)) |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 165 | return True |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 166 | else: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 167 | return False |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 168 | |
Guido van Rossum | 9cec8fb | 2001-04-08 15:05:16 +0000 | [diff] [blame] | 169 | def do_clear(self, arg): |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 170 | raise NotImplementedError("subclass of bdb must implement do_clear()") |
Guido van Rossum | 9cec8fb | 2001-04-08 15:05:16 +0000 | [diff] [blame] | 171 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 172 | def break_anywhere(self, frame): |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 173 | return self.canonic(frame.f_code.co_filename) in self.breaks |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 174 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 175 | # Derived classes should override the user_* methods |
| 176 | # to gain control. |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 177 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 178 | def user_call(self, frame, argument_list): |
| 179 | """This method is called when there is the remote possibility |
| 180 | that we ever need to stop in this function.""" |
| 181 | pass |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 182 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 183 | def user_line(self, frame): |
| 184 | """This method is called when we stop or break at this line.""" |
| 185 | pass |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 186 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 187 | def user_return(self, frame, return_value): |
| 188 | """This method is called when a return trap is set here.""" |
| 189 | pass |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 190 | |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 191 | def user_exception(self, frame, exc_info): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 192 | """This method is called if an exception occurs, |
| 193 | but only if we are to stop at or just below this level.""" |
| 194 | pass |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 195 | |
Georg Brandl | 3f94089 | 2010-07-30 10:29:19 +0000 | [diff] [blame] | 196 | def _set_stopinfo(self, stopframe, returnframe, stoplineno=0): |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 197 | self.stopframe = stopframe |
| 198 | self.returnframe = returnframe |
Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 199 | self.quitting = False |
Georg Brandl | 3f94089 | 2010-07-30 10:29:19 +0000 | [diff] [blame] | 200 | # stoplineno >= 0 means: stop at line >= the stoplineno |
| 201 | # stoplineno -1 means: don't stop at all |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 202 | self.stoplineno = stoplineno |
| 203 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 204 | # Derived classes and clients can call the following methods |
| 205 | # to affect the stepping state. |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 206 | |
Georg Brandl | 2dfec55 | 2010-07-30 08:43:32 +0000 | [diff] [blame] | 207 | def set_until(self, frame, lineno=None): |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 208 | """Stop when the line with the line no greater than the current one is |
| 209 | reached or when returning from current frame""" |
Georg Brandl | 2dfec55 | 2010-07-30 08:43:32 +0000 | [diff] [blame] | 210 | # the name "until" is borrowed from gdb |
| 211 | if lineno is None: |
| 212 | lineno = frame.f_lineno + 1 |
| 213 | self._set_stopinfo(frame, frame, lineno) |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 214 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 215 | def set_step(self): |
| 216 | """Stop after one line of code.""" |
Senthil Kumaran | 42d7081 | 2012-05-01 10:07:49 +0800 | [diff] [blame] | 217 | # Issue #13183: pdb skips frames after hitting a breakpoint and running |
| 218 | # step commands. |
| 219 | # Restore the trace function in the caller (that may not have been set |
| 220 | # for performance reasons) when returning from the current frame. |
| 221 | if self.frame_returning: |
| 222 | caller_frame = self.frame_returning.f_back |
| 223 | if caller_frame and not caller_frame.f_trace: |
| 224 | caller_frame.f_trace = self.trace_dispatch |
Georg Brandl | 3f94089 | 2010-07-30 10:29:19 +0000 | [diff] [blame] | 225 | self._set_stopinfo(None, None) |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 226 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 227 | def set_next(self, frame): |
| 228 | """Stop on the next line in or below the given frame.""" |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 229 | self._set_stopinfo(frame, None) |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 230 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 231 | def set_return(self, frame): |
| 232 | """Stop when returning from the given frame.""" |
Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 233 | if frame.f_code.co_flags & CO_GENERATOR: |
| 234 | self._set_stopinfo(frame, None, -1) |
| 235 | else: |
| 236 | self._set_stopinfo(frame.f_back, frame) |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 237 | |
Johannes Gijsbers | 84a6c20 | 2004-11-07 11:35:30 +0000 | [diff] [blame] | 238 | def set_trace(self, frame=None): |
| 239 | """Start debugging from `frame`. |
| 240 | |
| 241 | If frame is not specified, debugging starts from caller's frame. |
| 242 | """ |
| 243 | if frame is None: |
| 244 | frame = sys._getframe().f_back |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 245 | self.reset() |
| 246 | while frame: |
| 247 | frame.f_trace = self.trace_dispatch |
| 248 | self.botframe = frame |
| 249 | frame = frame.f_back |
| 250 | self.set_step() |
| 251 | sys.settrace(self.trace_dispatch) |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 252 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 253 | def set_continue(self): |
| 254 | # Don't stop except at breakpoints or when finished |
Georg Brandl | 3f94089 | 2010-07-30 10:29:19 +0000 | [diff] [blame] | 255 | self._set_stopinfo(self.botframe, None, -1) |
Georg Brandl | f8b893e | 2010-12-04 16:22:44 +0000 | [diff] [blame] | 256 | if not self.breaks: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 257 | # no breakpoints; run without debugger overhead |
| 258 | sys.settrace(None) |
Christian Tismer | 313a751 | 2002-05-28 08:04:00 +0000 | [diff] [blame] | 259 | frame = sys._getframe().f_back |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 260 | while frame and frame is not self.botframe: |
| 261 | del frame.f_trace |
| 262 | frame = frame.f_back |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 263 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 264 | def set_quit(self): |
| 265 | self.stopframe = self.botframe |
| 266 | self.returnframe = None |
Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 267 | self.quitting = True |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 268 | sys.settrace(None) |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 269 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 270 | # Derived classes and clients can call the following methods |
| 271 | # to manipulate breakpoints. These methods return an |
| 272 | # error message is something went wrong, None if all is well. |
| 273 | # Set_break prints out the breakpoint line and file:lineno. |
| 274 | # Call self.get_*break*() to see the breakpoints or better |
| 275 | # for bp in Breakpoint.bpbynumber: if bp: bp.bpprint(). |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 276 | |
Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 277 | def set_break(self, filename, lineno, temporary=False, cond=None, |
Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 278 | funcname=None): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 279 | filename = self.canonic(filename) |
| 280 | import linecache # Import as late as possible |
| 281 | line = linecache.getline(filename, lineno) |
| 282 | if not line: |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 283 | return 'Line %s:%d does not exist' % (filename, lineno) |
| 284 | list = self.breaks.setdefault(filename, []) |
| 285 | if lineno not in list: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 286 | list.append(lineno) |
Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 287 | bp = Breakpoint(filename, lineno, temporary, cond, funcname) |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 288 | |
Senthil Kumaran | 6f10704 | 2010-11-29 11:54:17 +0000 | [diff] [blame] | 289 | def _prune_breaks(self, filename, lineno): |
| 290 | if (filename, lineno) not in Breakpoint.bplist: |
| 291 | self.breaks[filename].remove(lineno) |
| 292 | if not self.breaks[filename]: |
| 293 | del self.breaks[filename] |
| 294 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 295 | def clear_break(self, filename, lineno): |
| 296 | filename = self.canonic(filename) |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 297 | if filename not in self.breaks: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 298 | return 'There are no breakpoints in %s' % filename |
| 299 | if lineno not in self.breaks[filename]: |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 300 | return 'There is no breakpoint at %s:%d' % (filename, lineno) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 301 | # If there's only one bp in the list for that file,line |
| 302 | # pair, then remove the breaks entry |
| 303 | for bp in Breakpoint.bplist[filename, lineno][:]: |
| 304 | bp.deleteMe() |
Senthil Kumaran | 6f10704 | 2010-11-29 11:54:17 +0000 | [diff] [blame] | 305 | self._prune_breaks(filename, lineno) |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 306 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 307 | def clear_bpbynumber(self, arg): |
| 308 | try: |
Georg Brandl | 7410dd1 | 2010-07-30 12:01:20 +0000 | [diff] [blame] | 309 | bp = self.get_bpbynumber(arg) |
| 310 | except ValueError as err: |
| 311 | return str(err) |
Senthil Kumaran | 6f10704 | 2010-11-29 11:54:17 +0000 | [diff] [blame] | 312 | bp.deleteMe() |
| 313 | self._prune_breaks(bp.file, bp.line) |
Guido van Rossum | 6ea27cc | 1999-01-25 20:51:34 +0000 | [diff] [blame] | 314 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 315 | def clear_all_file_breaks(self, filename): |
| 316 | filename = self.canonic(filename) |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 317 | if filename not in self.breaks: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 318 | return 'There are no breakpoints in %s' % filename |
| 319 | for line in self.breaks[filename]: |
| 320 | blist = Breakpoint.bplist[filename, line] |
| 321 | for bp in blist: |
| 322 | bp.deleteMe() |
| 323 | del self.breaks[filename] |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 324 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 325 | def clear_all_breaks(self): |
| 326 | if not self.breaks: |
| 327 | return 'There are no breakpoints' |
| 328 | for bp in Breakpoint.bpbynumber: |
| 329 | if bp: |
| 330 | bp.deleteMe() |
| 331 | self.breaks = {} |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 332 | |
Georg Brandl | 7410dd1 | 2010-07-30 12:01:20 +0000 | [diff] [blame] | 333 | def get_bpbynumber(self, arg): |
| 334 | if not arg: |
| 335 | raise ValueError('Breakpoint number expected') |
| 336 | try: |
| 337 | number = int(arg) |
| 338 | except ValueError: |
| 339 | raise ValueError('Non-numeric breakpoint number %s' % arg) |
| 340 | try: |
| 341 | bp = Breakpoint.bpbynumber[number] |
| 342 | except IndexError: |
| 343 | raise ValueError('Breakpoint number %d out of range' % number) |
| 344 | if bp is None: |
| 345 | raise ValueError('Breakpoint %d already deleted' % number) |
| 346 | return bp |
| 347 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 348 | def get_break(self, filename, lineno): |
| 349 | filename = self.canonic(filename) |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 350 | return filename in self.breaks and \ |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 351 | lineno in self.breaks[filename] |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 352 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 353 | def get_breaks(self, filename, lineno): |
| 354 | filename = self.canonic(filename) |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 355 | return filename in self.breaks and \ |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 356 | lineno in self.breaks[filename] and \ |
| 357 | Breakpoint.bplist[filename, lineno] or [] |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 358 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 359 | def get_file_breaks(self, filename): |
| 360 | filename = self.canonic(filename) |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 361 | if filename in self.breaks: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 362 | return self.breaks[filename] |
| 363 | else: |
| 364 | return [] |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 365 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 366 | def get_all_breaks(self): |
| 367 | return self.breaks |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 368 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 369 | # Derived classes and clients can call the following method |
| 370 | # to get a data structure representing a stack trace. |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 371 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 372 | def get_stack(self, f, t): |
| 373 | stack = [] |
| 374 | if t and t.tb_frame is f: |
| 375 | t = t.tb_next |
| 376 | while f is not None: |
| 377 | stack.append((f, f.f_lineno)) |
| 378 | if f is self.botframe: |
| 379 | break |
| 380 | f = f.f_back |
| 381 | stack.reverse() |
| 382 | i = max(0, len(stack) - 1) |
| 383 | while t is not None: |
| 384 | stack.append((t.tb_frame, t.tb_lineno)) |
| 385 | t = t.tb_next |
Benjamin Peterson | 1a6e0d0 | 2008-10-25 15:49:17 +0000 | [diff] [blame] | 386 | if f is None: |
| 387 | i = max(0, len(stack) - 1) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 388 | return stack, i |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 389 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 390 | def format_stack_entry(self, frame_lineno, lprefix=': '): |
Alexandre Vassalotti | 1f2ba4b | 2008-05-16 07:12:44 +0000 | [diff] [blame] | 391 | import linecache, reprlib |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 392 | frame, lineno = frame_lineno |
| 393 | filename = self.canonic(frame.f_code.co_filename) |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 394 | s = '%s(%r)' % (filename, lineno) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 395 | if frame.f_code.co_name: |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 396 | s += frame.f_code.co_name |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 397 | else: |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 398 | s += "<lambda>" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 399 | if '__args__' in frame.f_locals: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 400 | args = frame.f_locals['__args__'] |
| 401 | else: |
| 402 | args = None |
| 403 | if args: |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 404 | s += reprlib.repr(args) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 405 | else: |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 406 | s += '()' |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 407 | if '__return__' in frame.f_locals: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 408 | rv = frame.f_locals['__return__'] |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 409 | s += '->' |
| 410 | s += reprlib.repr(rv) |
Nick Coghlan | f088e5e | 2008-12-14 11:50:48 +0000 | [diff] [blame] | 411 | line = linecache.getline(filename, lineno, frame.f_globals) |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 412 | if line: |
| 413 | s += lprefix + line.strip() |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 414 | return s |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 415 | |
Georg Brandl | 46b9afc | 2010-07-30 09:14:20 +0000 | [diff] [blame] | 416 | # The following methods can be called by clients to use |
| 417 | # a debugger to debug a statement or an expression. |
| 418 | # Both can be given as a string, or a code object. |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 419 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 420 | def run(self, cmd, globals=None, locals=None): |
| 421 | if globals is None: |
| 422 | import __main__ |
| 423 | globals = __main__.__dict__ |
| 424 | if locals is None: |
| 425 | locals = globals |
| 426 | self.reset() |
Victor Stinner | 4bd8172 | 2011-01-06 00:49:38 +0000 | [diff] [blame] | 427 | if isinstance(cmd, str): |
| 428 | cmd = compile(cmd, "<string>", "exec") |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 429 | sys.settrace(self.trace_dispatch) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 430 | try: |
Martin v. Löwis | ede8ffb | 2008-03-30 20:43:50 +0000 | [diff] [blame] | 431 | exec(cmd, globals, locals) |
| 432 | except BdbQuit: |
| 433 | pass |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 434 | finally: |
Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 435 | self.quitting = True |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 436 | sys.settrace(None) |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 437 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 438 | def runeval(self, expr, globals=None, locals=None): |
| 439 | if globals is None: |
| 440 | import __main__ |
| 441 | globals = __main__.__dict__ |
| 442 | if locals is None: |
| 443 | locals = globals |
| 444 | self.reset() |
| 445 | sys.settrace(self.trace_dispatch) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 446 | try: |
Martin v. Löwis | ede8ffb | 2008-03-30 20:43:50 +0000 | [diff] [blame] | 447 | return eval(expr, globals, locals) |
| 448 | except BdbQuit: |
| 449 | pass |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 450 | finally: |
Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 451 | self.quitting = True |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 452 | sys.settrace(None) |
Guido van Rossum | 5e38b6f | 1995-02-27 13:13:40 +0000 | [diff] [blame] | 453 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 454 | def runctx(self, cmd, globals, locals): |
| 455 | # B/W compatibility |
| 456 | self.run(cmd, globals, locals) |
Guido van Rossum | 4e16098 | 1992-09-02 20:43:20 +0000 | [diff] [blame] | 457 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 458 | # This method is more useful to debug a single function call. |
Guido van Rossum | 4e16098 | 1992-09-02 20:43:20 +0000 | [diff] [blame] | 459 | |
Raymond Hettinger | 2ef7e6c | 2004-10-24 00:32:24 +0000 | [diff] [blame] | 460 | def runcall(self, func, *args, **kwds): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 461 | self.reset() |
| 462 | sys.settrace(self.trace_dispatch) |
| 463 | res = None |
| 464 | try: |
Martin v. Löwis | ede8ffb | 2008-03-30 20:43:50 +0000 | [diff] [blame] | 465 | res = func(*args, **kwds) |
| 466 | except BdbQuit: |
| 467 | pass |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 468 | finally: |
Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 469 | self.quitting = True |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 470 | sys.settrace(None) |
| 471 | return res |
Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 472 | |
Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 473 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 474 | def set_trace(): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 475 | Bdb().set_trace() |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 476 | |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 477 | |
| 478 | class Breakpoint: |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 479 | """Breakpoint class. |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 480 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 481 | Implements temporary breakpoints, ignore counts, disabling and |
| 482 | (re)-enabling, and conditionals. |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 483 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 484 | Breakpoints are indexed by number through bpbynumber and by |
| 485 | the file,line tuple using bplist. The former points to a |
| 486 | single instance of class Breakpoint. The latter points to a |
| 487 | list of such instances since there may be more than one |
| 488 | breakpoint per line. |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 489 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 490 | """ |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 491 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 492 | # XXX Keeping state in the class is a mistake -- this means |
| 493 | # you cannot have more than one active Bdb instance. |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 494 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 495 | next = 1 # Next bp to be assigned |
| 496 | bplist = {} # indexed by (file, lineno) tuple |
| 497 | bpbynumber = [None] # Each entry is None or an instance of Bpt |
| 498 | # index 0 is unused, except for marking an |
| 499 | # effective break .... see effective() |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 500 | |
Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 501 | def __init__(self, file, line, temporary=False, cond=None, funcname=None): |
Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 502 | self.funcname = funcname |
| 503 | # Needed if funcname is not None. |
| 504 | self.func_first_executable_line = None |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 505 | self.file = file # This better be in canonical form! |
| 506 | self.line = line |
| 507 | self.temporary = temporary |
| 508 | self.cond = cond |
Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 509 | self.enabled = True |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 510 | self.ignore = 0 |
| 511 | self.hits = 0 |
| 512 | self.number = Breakpoint.next |
Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 513 | Breakpoint.next += 1 |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 514 | # Build the two lists |
| 515 | self.bpbynumber.append(self) |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 516 | if (file, line) in self.bplist: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 517 | self.bplist[file, line].append(self) |
| 518 | else: |
| 519 | self.bplist[file, line] = [self] |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 520 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 521 | def deleteMe(self): |
| 522 | index = (self.file, self.line) |
| 523 | self.bpbynumber[self.number] = None # No longer in list |
| 524 | self.bplist[index].remove(self) |
| 525 | if not self.bplist[index]: |
| 526 | # No more bp for this f:l combo |
| 527 | del self.bplist[index] |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 528 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 529 | def enable(self): |
Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 530 | self.enabled = True |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 531 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 532 | def disable(self): |
Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 533 | self.enabled = False |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 534 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 535 | def bpprint(self, out=None): |
| 536 | if out is None: |
| 537 | out = sys.stdout |
Georg Brandl | d2fd4ca | 2010-07-30 15:01:23 +0000 | [diff] [blame] | 538 | print(self.bpformat(), file=out) |
| 539 | |
| 540 | def bpformat(self): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 541 | if self.temporary: |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 542 | disp = 'del ' |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 543 | else: |
Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 544 | disp = 'keep ' |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 545 | if self.enabled: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 546 | disp = disp + 'yes ' |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 547 | else: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 548 | disp = disp + 'no ' |
Georg Brandl | d2fd4ca | 2010-07-30 15:01:23 +0000 | [diff] [blame] | 549 | ret = '%-4dbreakpoint %s at %s:%d' % (self.number, disp, |
| 550 | self.file, self.line) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 551 | if self.cond: |
Georg Brandl | d2fd4ca | 2010-07-30 15:01:23 +0000 | [diff] [blame] | 552 | ret += '\n\tstop only if %s' % (self.cond,) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 553 | if self.ignore: |
Georg Brandl | d2fd4ca | 2010-07-30 15:01:23 +0000 | [diff] [blame] | 554 | ret += '\n\tignore next %d hits' % (self.ignore,) |
| 555 | if self.hits: |
| 556 | if self.hits > 1: |
| 557 | ss = 's' |
| 558 | else: |
| 559 | ss = '' |
| 560 | ret += '\n\tbreakpoint already hit %d time%s' % (self.hits, ss) |
| 561 | return ret |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 562 | |
Georg Brandl | 7410dd1 | 2010-07-30 12:01:20 +0000 | [diff] [blame] | 563 | def __str__(self): |
| 564 | return 'breakpoint %s at %s:%s' % (self.number, self.file, self.line) |
| 565 | |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 566 | # -----------end of Breakpoint class---------- |
| 567 | |
Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 568 | def checkfuncname(b, frame): |
| 569 | """Check whether we should break here because of `b.funcname`.""" |
| 570 | if not b.funcname: |
| 571 | # Breakpoint was set via line number. |
| 572 | if b.line != frame.f_lineno: |
| 573 | # Breakpoint was set at a line with a def statement and the function |
| 574 | # defined is called: don't break. |
| 575 | return False |
| 576 | return True |
| 577 | |
| 578 | # Breakpoint set via function name. |
| 579 | |
| 580 | if frame.f_code.co_name != b.funcname: |
| 581 | # It's not a function call, but rather execution of def statement. |
| 582 | return False |
| 583 | |
| 584 | # We are in the right frame. |
| 585 | if not b.func_first_executable_line: |
| 586 | # The function is entered for the 1st time. |
| 587 | b.func_first_executable_line = frame.f_lineno |
| 588 | |
| 589 | if b.func_first_executable_line != frame.f_lineno: |
| 590 | # But we are not at the first line number: don't break. |
| 591 | return False |
| 592 | return True |
| 593 | |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 594 | # Determines if there is an effective (active) breakpoint at this |
| 595 | # line of code. Returns breakpoint number or 0 if none |
| 596 | def effective(file, line, frame): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 597 | """Determine which breakpoint for this file:line is to be acted upon. |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 598 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 599 | Called only if we know there is a bpt at this |
| 600 | location. Returns breakpoint that was triggered and a flag |
| 601 | that indicates if it is ok to delete a temporary bp. |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 602 | |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 603 | """ |
Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 604 | possibles = Breakpoint.bplist[file, line] |
| 605 | for b in possibles: |
| 606 | if not b.enabled: |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 607 | continue |
Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 608 | if not checkfuncname(b, frame): |
| 609 | continue |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 610 | # Count every hit when bp is enabled |
Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 611 | b.hits += 1 |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 612 | if not b.cond: |
Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 613 | # If unconditional, and ignoring go on to next, else break |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 614 | if b.ignore > 0: |
Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 615 | b.ignore -= 1 |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 616 | continue |
| 617 | else: |
Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 618 | # breakpoint and marker that it's ok to delete if temporary |
| 619 | return (b, True) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 620 | else: |
| 621 | # Conditional bp. |
| 622 | # Ignore count applies only to those bpt hits where the |
| 623 | # condition evaluates to true. |
| 624 | try: |
Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 625 | val = eval(b.cond, frame.f_globals, frame.f_locals) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 626 | if val: |
| 627 | if b.ignore > 0: |
Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 628 | b.ignore -= 1 |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 629 | # continue |
| 630 | else: |
Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 631 | return (b, True) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 632 | # else: |
| 633 | # continue |
| 634 | except: |
Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 635 | # if eval fails, most conservative thing is to stop on |
| 636 | # breakpoint regardless of ignore count. Don't delete |
| 637 | # temporary, as another hint to user. |
| 638 | return (b, False) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 639 | return (None, None) |
Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 640 | |
Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 641 | |
Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 642 | # -------------------- testing -------------------- |
| 643 | |
| 644 | class Tdb(Bdb): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 645 | def user_call(self, frame, args): |
| 646 | name = frame.f_code.co_name |
| 647 | if not name: name = '???' |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 648 | print('+++ call', name, args) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 649 | def user_line(self, frame): |
Eric S. Raymond | b49f4a4 | 2001-02-09 05:07:04 +0000 | [diff] [blame] | 650 | import linecache |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 651 | name = frame.f_code.co_name |
| 652 | if not name: name = '???' |
| 653 | fn = self.canonic(frame.f_code.co_filename) |
Nick Coghlan | f088e5e | 2008-12-14 11:50:48 +0000 | [diff] [blame] | 654 | line = linecache.getline(fn, frame.f_lineno, frame.f_globals) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 655 | print('+++', fn, frame.f_lineno, name, ':', line.strip()) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 656 | def user_return(self, frame, retval): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 657 | print('+++ return', retval) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 658 | def user_exception(self, frame, exc_stuff): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 659 | print('+++ exception', exc_stuff) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 660 | self.set_continue() |
Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 661 | |
| 662 | def foo(n): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 663 | print('foo(', n, ')') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 664 | x = bar(n*10) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 665 | print('bar returned', x) |
Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 666 | |
| 667 | def bar(a): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 668 | print('bar(', a, ')') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 669 | return a/2 |
Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 670 | |
| 671 | def test(): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 672 | t = Tdb() |
| 673 | t.run('import bdb; bdb.foo(10)') |