| 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 | 
| Pablo Galindo | c7ab581 | 2018-01-29 01:31:00 +0000 | [diff] [blame] | 6 | from inspect import CO_GENERATOR, CO_COROUTINE, CO_ASYNC_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 |  | 
| Pablo Galindo | c7ab581 | 2018-01-29 01:31:00 +0000 | [diff] [blame] | 10 | GENERATOR_AND_COROUTINE_FLAGS = CO_GENERATOR | CO_COROUTINE | CO_ASYNC_GENERATOR | 
|  | 11 |  | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 12 |  | 
| Neal Norwitz | 93cf79f | 2002-03-31 14:06:41 +0000 | [diff] [blame] | 13 | class BdbQuit(Exception): | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 14 | """Exception to give up completely.""" | 
| Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 15 |  | 
|  | 16 |  | 
| Guido van Rossum | 6ea27cc | 1999-01-25 20:51:34 +0000 | [diff] [blame] | 17 | class Bdb: | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 18 | """Generic Python debugger base class. | 
| Guido van Rossum | 6ea27cc | 1999-01-25 20:51:34 +0000 | [diff] [blame] | 19 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 20 | This class takes care of details of the trace facility; | 
|  | 21 | a derived class should implement user interaction. | 
|  | 22 | The standard debugger class (pdb.Pdb) is an example. | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 23 |  | 
|  | 24 | The optional skip argument must be an iterable of glob-style | 
|  | 25 | module name patterns.  The debugger will not step into frames | 
|  | 26 | that originate in a module that matches one of these patterns. | 
|  | 27 | Whether a frame is considered to originate in a certain module | 
|  | 28 | is determined by the __name__ in the frame globals. | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 29 | """ | 
| Guido van Rossum | 6ea27cc | 1999-01-25 20:51:34 +0000 | [diff] [blame] | 30 |  | 
| Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 31 | def __init__(self, skip=None): | 
|  | 32 | self.skip = set(skip) if skip else None | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 33 | self.breaks = {} | 
|  | 34 | self.fncache = {} | 
| Senthil Kumaran | 42d7081 | 2012-05-01 10:07:49 +0800 | [diff] [blame] | 35 | self.frame_returning = None | 
| Barry Warsaw | 148ffbc | 1999-09-09 23:24:33 +0000 | [diff] [blame] | 36 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 37 | def canonic(self, filename): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 38 | """Return canonical form of filename. | 
|  | 39 |  | 
|  | 40 | For real filenames, the canonical form is a case-normalized (on | 
|  | 41 | case insenstive filesystems) absolute path.  'Filenames' with | 
|  | 42 | angle brackets, such as "<stdin>", generated in interactive | 
|  | 43 | mode, are returned unchanged. | 
|  | 44 | """ | 
| Guido van Rossum | 42f5332 | 2001-11-29 02:50:15 +0000 | [diff] [blame] | 45 | if filename == "<" + filename[1:-1] + ">": | 
|  | 46 | return filename | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 47 | canonic = self.fncache.get(filename) | 
|  | 48 | if not canonic: | 
|  | 49 | canonic = os.path.abspath(filename) | 
| Guido van Rossum | bdba320 | 2002-02-25 23:23:24 +0000 | [diff] [blame] | 50 | canonic = os.path.normcase(canonic) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 51 | self.fncache[filename] = canonic | 
|  | 52 | return canonic | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 53 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 54 | def reset(self): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 55 | """Set values of attributes as ready to start debugging.""" | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 56 | import linecache | 
|  | 57 | linecache.checkcache() | 
|  | 58 | self.botframe = None | 
| Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 59 | self._set_stopinfo(None, None) | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 60 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 61 | def trace_dispatch(self, frame, event, arg): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 62 | """Dispatch a trace function for debugged frames based on the event. | 
|  | 63 |  | 
|  | 64 | This function is installed as the trace function for debugged | 
|  | 65 | frames. Its return value is the new trace function, which is | 
|  | 66 | usually itself. The default implementation decides how to | 
|  | 67 | dispatch a frame, depending on the type of event (passed in as a | 
|  | 68 | string) that is about to be executed. | 
|  | 69 |  | 
|  | 70 | The event can be one of the following: | 
|  | 71 | line: A new line of code is going to be executed. | 
|  | 72 | call: A function is about to be called or another code block | 
|  | 73 | is entered. | 
|  | 74 | return: A function or other code block is about to return. | 
|  | 75 | exception: An exception has occurred. | 
|  | 76 | c_call: A C function is about to be called. | 
| Stéphane Wirtel | 07fbbfd | 2018-10-05 16:17:18 +0200 | [diff] [blame] | 77 | c_return: A C function has returned. | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 78 | c_exception: A C function has raised an exception. | 
|  | 79 |  | 
|  | 80 | For the Python events, specialized functions (see the dispatch_*() | 
|  | 81 | methods) are called.  For the C events, no action is taken. | 
|  | 82 |  | 
|  | 83 | The arg parameter depends on the previous event. | 
|  | 84 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 85 | if self.quitting: | 
|  | 86 | return # None | 
|  | 87 | if event == 'line': | 
|  | 88 | return self.dispatch_line(frame) | 
|  | 89 | if event == 'call': | 
|  | 90 | return self.dispatch_call(frame, arg) | 
|  | 91 | if event == 'return': | 
|  | 92 | return self.dispatch_return(frame, arg) | 
|  | 93 | if event == 'exception': | 
|  | 94 | return self.dispatch_exception(frame, arg) | 
| Nicholas Bastin | c69ebe8 | 2004-03-24 21:57:10 +0000 | [diff] [blame] | 95 | if event == 'c_call': | 
|  | 96 | return self.trace_dispatch | 
|  | 97 | if event == 'c_exception': | 
|  | 98 | return self.trace_dispatch | 
|  | 99 | if event == 'c_return': | 
|  | 100 | return self.trace_dispatch | 
| Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 101 | print('bdb.Bdb.dispatch: unknown debugging event:', repr(event)) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 102 | return self.trace_dispatch | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 103 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 104 | def dispatch_line(self, frame): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 105 | """Invoke user function and return trace function for line event. | 
|  | 106 |  | 
|  | 107 | If the debugger stops on the current line, invoke | 
|  | 108 | self.user_line(). Raise BdbQuit if self.quitting is set. | 
|  | 109 | Return self.trace_dispatch to continue tracing in this scope. | 
|  | 110 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 111 | if self.stop_here(frame) or self.break_here(frame): | 
|  | 112 | self.user_line(frame) | 
|  | 113 | if self.quitting: raise BdbQuit | 
|  | 114 | return self.trace_dispatch | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 115 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 116 | def dispatch_call(self, frame, arg): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 117 | """Invoke user function and return trace function for call event. | 
|  | 118 |  | 
|  | 119 | If the debugger stops on this function call, invoke | 
|  | 120 | self.user_call(). Raise BbdQuit if self.quitting is set. | 
|  | 121 | Return self.trace_dispatch to continue tracing in this scope. | 
|  | 122 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 123 | # XXX 'arg' is no longer used | 
|  | 124 | if self.botframe is None: | 
|  | 125 | # First call of dispatch since reset() | 
| Christian Tismer | 313a751 | 2002-05-28 08:04:00 +0000 | [diff] [blame] | 126 | 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] | 127 | return self.trace_dispatch | 
|  | 128 | if not (self.stop_here(frame) or self.break_anywhere(frame)): | 
|  | 129 | # No need to trace this function | 
|  | 130 | return # None | 
| Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 131 | # Ignore call events in generator except when stepping. | 
| Pablo Galindo | c7ab581 | 2018-01-29 01:31:00 +0000 | [diff] [blame] | 132 | if self.stopframe and frame.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS: | 
| Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 133 | return self.trace_dispatch | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 134 | self.user_call(frame, arg) | 
|  | 135 | if self.quitting: raise BdbQuit | 
|  | 136 | return self.trace_dispatch | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 137 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 138 | def dispatch_return(self, frame, arg): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 139 | """Invoke user function and return trace function for return event. | 
|  | 140 |  | 
|  | 141 | If the debugger stops on this function return, invoke | 
|  | 142 | self.user_return(). Raise BdbQuit if self.quitting is set. | 
|  | 143 | Return self.trace_dispatch to continue tracing in this scope. | 
|  | 144 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 145 | if self.stop_here(frame) or frame == self.returnframe: | 
| Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 146 | # Ignore return events in generator except when stepping. | 
| Pablo Galindo | c7ab581 | 2018-01-29 01:31:00 +0000 | [diff] [blame] | 147 | if self.stopframe and frame.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS: | 
| Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 148 | return self.trace_dispatch | 
| Senthil Kumaran | 42d7081 | 2012-05-01 10:07:49 +0800 | [diff] [blame] | 149 | try: | 
|  | 150 | self.frame_returning = frame | 
|  | 151 | self.user_return(frame, arg) | 
|  | 152 | finally: | 
|  | 153 | self.frame_returning = None | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 154 | if self.quitting: raise BdbQuit | 
| Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 155 | # The user issued a 'next' or 'until' command. | 
|  | 156 | if self.stopframe is frame and self.stoplineno != -1: | 
|  | 157 | self._set_stopinfo(None, None) | 
| Just van Rossum | ae1f65f | 2001-06-25 18:01:24 +0000 | [diff] [blame] | 158 | return self.trace_dispatch | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 159 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 160 | def dispatch_exception(self, frame, arg): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 161 | """Invoke user function and return trace function for exception event. | 
|  | 162 |  | 
|  | 163 | If the debugger stops on this exception, invoke | 
|  | 164 | self.user_exception(). Raise BdbQuit if self.quitting is set. | 
|  | 165 | Return self.trace_dispatch to continue tracing in this scope. | 
|  | 166 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 167 | if self.stop_here(frame): | 
| Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 168 | # When stepping with next/until/return in a generator frame, skip | 
|  | 169 | # the internal StopIteration exception (with no traceback) | 
|  | 170 | # triggered by a subiterator run with the 'yield from' statement. | 
| Pablo Galindo | c7ab581 | 2018-01-29 01:31:00 +0000 | [diff] [blame] | 171 | if not (frame.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS | 
| Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 172 | and arg[0] is StopIteration and arg[2] is None): | 
|  | 173 | self.user_exception(frame, arg) | 
|  | 174 | if self.quitting: raise BdbQuit | 
|  | 175 | # Stop at the StopIteration or GeneratorExit exception when the user | 
|  | 176 | # has set stopframe in a generator by issuing a return command, or a | 
|  | 177 | # next/until command at the last statement in the generator before the | 
|  | 178 | # exception. | 
|  | 179 | elif (self.stopframe and frame is not self.stopframe | 
| Pablo Galindo | c7ab581 | 2018-01-29 01:31:00 +0000 | [diff] [blame] | 180 | and self.stopframe.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS | 
| Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 181 | and arg[0] in (StopIteration, GeneratorExit)): | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 182 | self.user_exception(frame, arg) | 
|  | 183 | if self.quitting: raise BdbQuit | 
| Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 184 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 185 | return self.trace_dispatch | 
| 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 | # Normally derived classes don't override the following | 
|  | 188 | # methods, but they may if they want to redefine the | 
|  | 189 | # definition of stopping and breakpoints. | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 190 |  | 
| Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 191 | def is_skipped_module(self, module_name): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 192 | "Return True if module_name matches any skip pattern." | 
| Anthony Sottile | 86900a4 | 2019-03-12 20:57:09 -0700 | [diff] [blame] | 193 | if module_name is None:  # some modules do not have names | 
|  | 194 | return False | 
| Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 195 | for pattern in self.skip: | 
|  | 196 | if fnmatch.fnmatch(module_name, pattern): | 
|  | 197 | return True | 
|  | 198 | return False | 
|  | 199 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 200 | def stop_here(self, frame): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 201 | "Return True if frame is below the starting frame in the stack." | 
| Neal Norwitz | 72a2b4d | 2002-05-29 00:54:38 +0000 | [diff] [blame] | 202 | # (CT) stopframe may now also be None, see dispatch_call. | 
|  | 203 | # (CT) the former test for None is therefore removed from here. | 
| Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 204 | if self.skip and \ | 
|  | 205 | self.is_skipped_module(frame.f_globals.get('__name__')): | 
|  | 206 | return False | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 207 | if frame is self.stopframe: | 
| Georg Brandl | 3f94089 | 2010-07-30 10:29:19 +0000 | [diff] [blame] | 208 | if self.stoplineno == -1: | 
|  | 209 | return False | 
| Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 210 | return frame.f_lineno >= self.stoplineno | 
| Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 211 | if not self.stopframe: | 
|  | 212 | return True | 
| Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 213 | return False | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 214 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 215 | def break_here(self, frame): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 216 | """Return True if there is an effective breakpoint for this line. | 
|  | 217 |  | 
|  | 218 | Check for line or function breakpoint and if in effect. | 
|  | 219 | Delete temporary breakpoints if effective() says to. | 
|  | 220 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 221 | filename = self.canonic(frame.f_code.co_filename) | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 222 | if filename not in self.breaks: | 
| Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 223 | return False | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 224 | lineno = frame.f_lineno | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 225 | if lineno not in self.breaks[filename]: | 
| Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 226 | # The line itself has no breakpoint, but maybe the line is the | 
|  | 227 | # first line of a function with breakpoint set by function name. | 
|  | 228 | lineno = frame.f_code.co_firstlineno | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 229 | if lineno not in self.breaks[filename]: | 
| Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 230 | return False | 
|  | 231 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 232 | # flag says ok to delete temp. bp | 
|  | 233 | (bp, flag) = effective(filename, lineno, frame) | 
|  | 234 | if bp: | 
|  | 235 | self.currentbp = bp.number | 
|  | 236 | if (flag and bp.temporary): | 
|  | 237 | self.do_clear(str(bp.number)) | 
| Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 238 | return True | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 239 | else: | 
| Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 240 | return False | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 241 |  | 
| Guido van Rossum | 9cec8fb | 2001-04-08 15:05:16 +0000 | [diff] [blame] | 242 | def do_clear(self, arg): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 243 | """Remove temporary breakpoint. | 
|  | 244 |  | 
|  | 245 | Must implement in derived classes or get NotImplementedError. | 
|  | 246 | """ | 
| Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 247 | raise NotImplementedError("subclass of bdb must implement do_clear()") | 
| Guido van Rossum | 9cec8fb | 2001-04-08 15:05:16 +0000 | [diff] [blame] | 248 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 249 | def break_anywhere(self, frame): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 250 | """Return True if there is any breakpoint for frame's filename. | 
|  | 251 | """ | 
| Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 252 | return self.canonic(frame.f_code.co_filename) in self.breaks | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 253 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 254 | # Derived classes should override the user_* methods | 
|  | 255 | # to gain control. | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 256 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 257 | def user_call(self, frame, argument_list): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 258 | """Called if we might stop in a function.""" | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 259 | pass | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 260 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 261 | def user_line(self, frame): | 
| Eitan Adler | b5c246f | 2018-06-02 07:16:19 -0700 | [diff] [blame] | 262 | """Called when we stop or break at a line.""" | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 263 | pass | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 264 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 265 | def user_return(self, frame, return_value): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 266 | """Called when a return trap is set here.""" | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 267 | pass | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 268 |  | 
| Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 269 | def user_exception(self, frame, exc_info): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 270 | """Called when we stop on an exception.""" | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 271 | pass | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 272 |  | 
| Georg Brandl | 3f94089 | 2010-07-30 10:29:19 +0000 | [diff] [blame] | 273 | def _set_stopinfo(self, stopframe, returnframe, stoplineno=0): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 274 | """Set the attributes for stopping. | 
|  | 275 |  | 
|  | 276 | If stoplineno is greater than or equal to 0, then stop at line | 
|  | 277 | greater than or equal to the stopline.  If stoplineno is -1, then | 
|  | 278 | don't stop at all. | 
|  | 279 | """ | 
| Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 280 | self.stopframe = stopframe | 
|  | 281 | self.returnframe = returnframe | 
| Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 282 | self.quitting = False | 
| Georg Brandl | 3f94089 | 2010-07-30 10:29:19 +0000 | [diff] [blame] | 283 | # stoplineno >= 0 means: stop at line >= the stoplineno | 
|  | 284 | # stoplineno -1 means: don't stop at all | 
| Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 285 | self.stoplineno = stoplineno | 
|  | 286 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 287 | # Derived classes and clients can call the following methods | 
|  | 288 | # to affect the stepping state. | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 289 |  | 
| Georg Brandl | 2dfec55 | 2010-07-30 08:43:32 +0000 | [diff] [blame] | 290 | def set_until(self, frame, lineno=None): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 291 | """Stop when the line with the lineno greater than the current one is | 
|  | 292 | reached or when returning from current frame.""" | 
| Georg Brandl | 2dfec55 | 2010-07-30 08:43:32 +0000 | [diff] [blame] | 293 | # the name "until" is borrowed from gdb | 
|  | 294 | if lineno is None: | 
|  | 295 | lineno = frame.f_lineno + 1 | 
|  | 296 | self._set_stopinfo(frame, frame, lineno) | 
| Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 297 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 298 | def set_step(self): | 
|  | 299 | """Stop after one line of code.""" | 
| Senthil Kumaran | 42d7081 | 2012-05-01 10:07:49 +0800 | [diff] [blame] | 300 | # Issue #13183: pdb skips frames after hitting a breakpoint and running | 
|  | 301 | # step commands. | 
|  | 302 | # Restore the trace function in the caller (that may not have been set | 
|  | 303 | # for performance reasons) when returning from the current frame. | 
|  | 304 | if self.frame_returning: | 
|  | 305 | caller_frame = self.frame_returning.f_back | 
|  | 306 | if caller_frame and not caller_frame.f_trace: | 
|  | 307 | caller_frame.f_trace = self.trace_dispatch | 
| Georg Brandl | 3f94089 | 2010-07-30 10:29:19 +0000 | [diff] [blame] | 308 | self._set_stopinfo(None, None) | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 309 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 310 | def set_next(self, frame): | 
|  | 311 | """Stop on the next line in or below the given frame.""" | 
| Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 312 | self._set_stopinfo(frame, None) | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 313 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 314 | def set_return(self, frame): | 
|  | 315 | """Stop when returning from the given frame.""" | 
| Pablo Galindo | c7ab581 | 2018-01-29 01:31:00 +0000 | [diff] [blame] | 316 | if frame.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS: | 
| Guido van Rossum | 8820c23 | 2013-11-21 11:30:06 -0800 | [diff] [blame] | 317 | self._set_stopinfo(frame, None, -1) | 
|  | 318 | else: | 
|  | 319 | self._set_stopinfo(frame.f_back, frame) | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 320 |  | 
| Johannes Gijsbers | 84a6c20 | 2004-11-07 11:35:30 +0000 | [diff] [blame] | 321 | def set_trace(self, frame=None): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 322 | """Start debugging from frame. | 
| Johannes Gijsbers | 84a6c20 | 2004-11-07 11:35:30 +0000 | [diff] [blame] | 323 |  | 
|  | 324 | If frame is not specified, debugging starts from caller's frame. | 
|  | 325 | """ | 
|  | 326 | if frame is None: | 
|  | 327 | frame = sys._getframe().f_back | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 328 | self.reset() | 
|  | 329 | while frame: | 
|  | 330 | frame.f_trace = self.trace_dispatch | 
|  | 331 | self.botframe = frame | 
|  | 332 | frame = frame.f_back | 
|  | 333 | self.set_step() | 
|  | 334 | sys.settrace(self.trace_dispatch) | 
| Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 335 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 336 | def set_continue(self): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 337 | """Stop only at breakpoints or when finished. | 
|  | 338 |  | 
|  | 339 | If there are no breakpoints, set the system trace function to None. | 
|  | 340 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 341 | # Don't stop except at breakpoints or when finished | 
| Georg Brandl | 3f94089 | 2010-07-30 10:29:19 +0000 | [diff] [blame] | 342 | self._set_stopinfo(self.botframe, None, -1) | 
| Georg Brandl | f8b893e | 2010-12-04 16:22:44 +0000 | [diff] [blame] | 343 | if not self.breaks: | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 344 | # no breakpoints; run without debugger overhead | 
|  | 345 | sys.settrace(None) | 
| Christian Tismer | 313a751 | 2002-05-28 08:04:00 +0000 | [diff] [blame] | 346 | frame = sys._getframe().f_back | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 347 | while frame and frame is not self.botframe: | 
|  | 348 | del frame.f_trace | 
|  | 349 | frame = frame.f_back | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 350 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 351 | def set_quit(self): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 352 | """Set quitting attribute to True. | 
|  | 353 |  | 
|  | 354 | Raises BdbQuit exception in the next call to a dispatch_*() method. | 
|  | 355 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 356 | self.stopframe = self.botframe | 
|  | 357 | self.returnframe = None | 
| Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 358 | self.quitting = True | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 359 | sys.settrace(None) | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 360 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 361 | # Derived classes and clients can call the following methods | 
|  | 362 | # to manipulate breakpoints.  These methods return an | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 363 | # error message if something went wrong, None if all is well. | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 364 | # Set_break prints out the breakpoint line and file:lineno. | 
|  | 365 | # Call self.get_*break*() to see the breakpoints or better | 
|  | 366 | # for bp in Breakpoint.bpbynumber: if bp: bp.bpprint(). | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 367 |  | 
| Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 368 | def set_break(self, filename, lineno, temporary=False, cond=None, | 
| Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 369 | funcname=None): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 370 | """Set a new breakpoint for filename:lineno. | 
|  | 371 |  | 
|  | 372 | If lineno doesn't exist for the filename, return an error message. | 
|  | 373 | The filename should be in canonical form. | 
|  | 374 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 375 | filename = self.canonic(filename) | 
|  | 376 | import linecache # Import as late as possible | 
|  | 377 | line = linecache.getline(filename, lineno) | 
|  | 378 | if not line: | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 379 | return 'Line %s:%d does not exist' % (filename, lineno) | 
|  | 380 | list = self.breaks.setdefault(filename, []) | 
|  | 381 | if lineno not in list: | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 382 | list.append(lineno) | 
| Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 383 | bp = Breakpoint(filename, lineno, temporary, cond, funcname) | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 384 | return None | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 385 |  | 
| Senthil Kumaran | 6f10704 | 2010-11-29 11:54:17 +0000 | [diff] [blame] | 386 | def _prune_breaks(self, filename, lineno): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 387 | """Prune breakpoints for filname:lineno. | 
|  | 388 |  | 
|  | 389 | A list of breakpoints is maintained in the Bdb instance and in | 
|  | 390 | the Breakpoint class.  If a breakpoint in the Bdb instance no | 
|  | 391 | longer exists in the Breakpoint class, then it's removed from the | 
|  | 392 | Bdb instance. | 
|  | 393 | """ | 
| Senthil Kumaran | 6f10704 | 2010-11-29 11:54:17 +0000 | [diff] [blame] | 394 | if (filename, lineno) not in Breakpoint.bplist: | 
|  | 395 | self.breaks[filename].remove(lineno) | 
|  | 396 | if not self.breaks[filename]: | 
|  | 397 | del self.breaks[filename] | 
|  | 398 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 399 | def clear_break(self, filename, lineno): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 400 | """Delete breakpoints for filename:lineno. | 
|  | 401 |  | 
|  | 402 | If no breakpoints were set, return an error message. | 
|  | 403 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 404 | filename = self.canonic(filename) | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 405 | if filename not in self.breaks: | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 406 | return 'There are no breakpoints in %s' % filename | 
|  | 407 | if lineno not in self.breaks[filename]: | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 408 | return 'There is no breakpoint at %s:%d' % (filename, lineno) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 409 | # If there's only one bp in the list for that file,line | 
|  | 410 | # pair, then remove the breaks entry | 
|  | 411 | for bp in Breakpoint.bplist[filename, lineno][:]: | 
|  | 412 | bp.deleteMe() | 
| Senthil Kumaran | 6f10704 | 2010-11-29 11:54:17 +0000 | [diff] [blame] | 413 | self._prune_breaks(filename, lineno) | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 414 | return None | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 415 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 416 | def clear_bpbynumber(self, arg): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 417 | """Delete a breakpoint by its index in Breakpoint.bpbynumber. | 
|  | 418 |  | 
|  | 419 | If arg is invalid, return an error message. | 
|  | 420 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 421 | try: | 
| Georg Brandl | 7410dd1 | 2010-07-30 12:01:20 +0000 | [diff] [blame] | 422 | bp = self.get_bpbynumber(arg) | 
|  | 423 | except ValueError as err: | 
|  | 424 | return str(err) | 
| Senthil Kumaran | 6f10704 | 2010-11-29 11:54:17 +0000 | [diff] [blame] | 425 | bp.deleteMe() | 
|  | 426 | self._prune_breaks(bp.file, bp.line) | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 427 | return None | 
| Guido van Rossum | 6ea27cc | 1999-01-25 20:51:34 +0000 | [diff] [blame] | 428 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 429 | def clear_all_file_breaks(self, filename): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 430 | """Delete all breakpoints in filename. | 
|  | 431 |  | 
|  | 432 | If none were set, return an error message. | 
|  | 433 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 434 | filename = self.canonic(filename) | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 435 | if filename not in self.breaks: | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 436 | return 'There are no breakpoints in %s' % filename | 
|  | 437 | for line in self.breaks[filename]: | 
|  | 438 | blist = Breakpoint.bplist[filename, line] | 
|  | 439 | for bp in blist: | 
|  | 440 | bp.deleteMe() | 
|  | 441 | del self.breaks[filename] | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 442 | return None | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 443 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 444 | def clear_all_breaks(self): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 445 | """Delete all existing breakpoints. | 
|  | 446 |  | 
|  | 447 | If none were set, return an error message. | 
|  | 448 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 449 | if not self.breaks: | 
|  | 450 | return 'There are no breakpoints' | 
|  | 451 | for bp in Breakpoint.bpbynumber: | 
|  | 452 | if bp: | 
|  | 453 | bp.deleteMe() | 
|  | 454 | self.breaks = {} | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 455 | return None | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 456 |  | 
| Georg Brandl | 7410dd1 | 2010-07-30 12:01:20 +0000 | [diff] [blame] | 457 | def get_bpbynumber(self, arg): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 458 | """Return a breakpoint by its index in Breakpoint.bybpnumber. | 
|  | 459 |  | 
|  | 460 | For invalid arg values or if the breakpoint doesn't exist, | 
|  | 461 | raise a ValueError. | 
|  | 462 | """ | 
| Georg Brandl | 7410dd1 | 2010-07-30 12:01:20 +0000 | [diff] [blame] | 463 | if not arg: | 
|  | 464 | raise ValueError('Breakpoint number expected') | 
|  | 465 | try: | 
|  | 466 | number = int(arg) | 
|  | 467 | except ValueError: | 
| Serhiy Storchaka | 5affd23 | 2017-04-05 09:37:24 +0300 | [diff] [blame] | 468 | raise ValueError('Non-numeric breakpoint number %s' % arg) from None | 
| Georg Brandl | 7410dd1 | 2010-07-30 12:01:20 +0000 | [diff] [blame] | 469 | try: | 
|  | 470 | bp = Breakpoint.bpbynumber[number] | 
|  | 471 | except IndexError: | 
| Serhiy Storchaka | 5affd23 | 2017-04-05 09:37:24 +0300 | [diff] [blame] | 472 | raise ValueError('Breakpoint number %d out of range' % number) from None | 
| Georg Brandl | 7410dd1 | 2010-07-30 12:01:20 +0000 | [diff] [blame] | 473 | if bp is None: | 
|  | 474 | raise ValueError('Breakpoint %d already deleted' % number) | 
|  | 475 | return bp | 
|  | 476 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 477 | def get_break(self, filename, lineno): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 478 | """Return True if there is a breakpoint for filename:lineno.""" | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 479 | filename = self.canonic(filename) | 
| Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 480 | return filename in self.breaks and \ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 481 | lineno in self.breaks[filename] | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 482 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 483 | def get_breaks(self, filename, lineno): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 484 | """Return all breakpoints for filename:lineno. | 
|  | 485 |  | 
|  | 486 | If no breakpoints are set, return an empty list. | 
|  | 487 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 488 | filename = self.canonic(filename) | 
| Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 489 | return filename in self.breaks and \ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 490 | lineno in self.breaks[filename] and \ | 
|  | 491 | Breakpoint.bplist[filename, lineno] or [] | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 492 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 493 | def get_file_breaks(self, filename): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 494 | """Return all lines with breakpoints for filename. | 
|  | 495 |  | 
|  | 496 | If no breakpoints are set, return an empty list. | 
|  | 497 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 498 | filename = self.canonic(filename) | 
| Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 499 | if filename in self.breaks: | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 500 | return self.breaks[filename] | 
|  | 501 | else: | 
|  | 502 | return [] | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 503 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 504 | def get_all_breaks(self): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 505 | """Return all breakpoints that are set.""" | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 506 | return self.breaks | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 507 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 508 | # Derived classes and clients can call the following method | 
|  | 509 | # to get a data structure representing a stack trace. | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 510 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 511 | def get_stack(self, f, t): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 512 | """Return a list of (frame, lineno) in a stack trace and a size. | 
|  | 513 |  | 
|  | 514 | List starts with original calling frame, if there is one. | 
|  | 515 | Size may be number of frames above or below f. | 
|  | 516 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 517 | stack = [] | 
|  | 518 | if t and t.tb_frame is f: | 
|  | 519 | t = t.tb_next | 
|  | 520 | while f is not None: | 
|  | 521 | stack.append((f, f.f_lineno)) | 
|  | 522 | if f is self.botframe: | 
|  | 523 | break | 
|  | 524 | f = f.f_back | 
|  | 525 | stack.reverse() | 
|  | 526 | i = max(0, len(stack) - 1) | 
|  | 527 | while t is not None: | 
|  | 528 | stack.append((t.tb_frame, t.tb_lineno)) | 
|  | 529 | t = t.tb_next | 
| Benjamin Peterson | 1a6e0d0 | 2008-10-25 15:49:17 +0000 | [diff] [blame] | 530 | if f is None: | 
|  | 531 | i = max(0, len(stack) - 1) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 532 | return stack, i | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 533 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 534 | def format_stack_entry(self, frame_lineno, lprefix=': '): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 535 | """Return a string with information about a stack entry. | 
|  | 536 |  | 
|  | 537 | The stack entry frame_lineno is a (frame, lineno) tuple.  The | 
|  | 538 | return string contains the canonical filename, the function name | 
|  | 539 | or '<lambda>', the input arguments, the return value, and the | 
|  | 540 | line of code (if it exists). | 
|  | 541 |  | 
|  | 542 | """ | 
| Alexandre Vassalotti | 1f2ba4b | 2008-05-16 07:12:44 +0000 | [diff] [blame] | 543 | import linecache, reprlib | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 544 | frame, lineno = frame_lineno | 
|  | 545 | filename = self.canonic(frame.f_code.co_filename) | 
| Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 546 | s = '%s(%r)' % (filename, lineno) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 547 | if frame.f_code.co_name: | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 548 | s += frame.f_code.co_name | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 549 | else: | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 550 | s += "<lambda>" | 
| Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 551 | if '__args__' in frame.f_locals: | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 552 | args = frame.f_locals['__args__'] | 
|  | 553 | else: | 
|  | 554 | args = None | 
|  | 555 | if args: | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 556 | s += reprlib.repr(args) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 557 | else: | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 558 | s += '()' | 
| Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 559 | if '__return__' in frame.f_locals: | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 560 | rv = frame.f_locals['__return__'] | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 561 | s += '->' | 
|  | 562 | s += reprlib.repr(rv) | 
| Nick Coghlan | f088e5e | 2008-12-14 11:50:48 +0000 | [diff] [blame] | 563 | line = linecache.getline(filename, lineno, frame.f_globals) | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 564 | if line: | 
|  | 565 | s += lprefix + line.strip() | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 566 | return s | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 567 |  | 
| Georg Brandl | 46b9afc | 2010-07-30 09:14:20 +0000 | [diff] [blame] | 568 | # The following methods can be called by clients to use | 
|  | 569 | # a debugger to debug a statement or an expression. | 
|  | 570 | # Both can be given as a string, or a code object. | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 571 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 572 | def run(self, cmd, globals=None, locals=None): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 573 | """Debug a statement executed via the exec() function. | 
|  | 574 |  | 
|  | 575 | globals defaults to __main__.dict; locals defaults to globals. | 
|  | 576 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 577 | if globals is None: | 
|  | 578 | import __main__ | 
|  | 579 | globals = __main__.__dict__ | 
|  | 580 | if locals is None: | 
|  | 581 | locals = globals | 
|  | 582 | self.reset() | 
| Victor Stinner | 4bd8172 | 2011-01-06 00:49:38 +0000 | [diff] [blame] | 583 | if isinstance(cmd, str): | 
|  | 584 | cmd = compile(cmd, "<string>", "exec") | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 585 | sys.settrace(self.trace_dispatch) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 586 | try: | 
| Martin v. Löwis | ede8ffb | 2008-03-30 20:43:50 +0000 | [diff] [blame] | 587 | exec(cmd, globals, locals) | 
|  | 588 | except BdbQuit: | 
|  | 589 | pass | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 590 | finally: | 
| Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 591 | self.quitting = True | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 592 | sys.settrace(None) | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 593 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 594 | def runeval(self, expr, globals=None, locals=None): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 595 | """Debug an expression executed via the eval() function. | 
|  | 596 |  | 
|  | 597 | globals defaults to __main__.dict; locals defaults to globals. | 
|  | 598 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 599 | if globals is None: | 
|  | 600 | import __main__ | 
|  | 601 | globals = __main__.__dict__ | 
|  | 602 | if locals is None: | 
|  | 603 | locals = globals | 
|  | 604 | self.reset() | 
|  | 605 | sys.settrace(self.trace_dispatch) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 606 | try: | 
| Martin v. Löwis | ede8ffb | 2008-03-30 20:43:50 +0000 | [diff] [blame] | 607 | return eval(expr, globals, locals) | 
|  | 608 | except BdbQuit: | 
|  | 609 | pass | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 610 | finally: | 
| Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 611 | self.quitting = True | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 612 | sys.settrace(None) | 
| Guido van Rossum | 5e38b6f | 1995-02-27 13:13:40 +0000 | [diff] [blame] | 613 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 614 | def runctx(self, cmd, globals, locals): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 615 | """For backwards-compatibility.  Defers to run().""" | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 616 | # B/W compatibility | 
|  | 617 | self.run(cmd, globals, locals) | 
| Guido van Rossum | 4e16098 | 1992-09-02 20:43:20 +0000 | [diff] [blame] | 618 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 619 | # This method is more useful to debug a single function call. | 
| Guido van Rossum | 4e16098 | 1992-09-02 20:43:20 +0000 | [diff] [blame] | 620 |  | 
| Serhiy Storchaka | 42a139e | 2019-04-01 09:16:35 +0300 | [diff] [blame] | 621 | def runcall(*args, **kwds): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 622 | """Debug a single function call. | 
|  | 623 |  | 
|  | 624 | Return the result of the function call. | 
|  | 625 | """ | 
| Serhiy Storchaka | 42a139e | 2019-04-01 09:16:35 +0300 | [diff] [blame] | 626 | if len(args) >= 2: | 
|  | 627 | self, func, *args = args | 
|  | 628 | elif not args: | 
|  | 629 | raise TypeError("descriptor 'runcall' of 'Bdb' object " | 
|  | 630 | "needs an argument") | 
|  | 631 | elif 'func' in kwds: | 
|  | 632 | func = kwds.pop('func') | 
|  | 633 | self, *args = args | 
|  | 634 | import warnings | 
|  | 635 | warnings.warn("Passing 'func' as keyword argument is deprecated", | 
|  | 636 | DeprecationWarning, stacklevel=2) | 
|  | 637 | else: | 
|  | 638 | raise TypeError('runcall expected at least 1 positional argument, ' | 
|  | 639 | 'got %d' % (len(args)-1)) | 
|  | 640 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 641 | self.reset() | 
|  | 642 | sys.settrace(self.trace_dispatch) | 
|  | 643 | res = None | 
|  | 644 | try: | 
| Martin v. Löwis | ede8ffb | 2008-03-30 20:43:50 +0000 | [diff] [blame] | 645 | res = func(*args, **kwds) | 
|  | 646 | except BdbQuit: | 
|  | 647 | pass | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 648 | finally: | 
| Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 649 | self.quitting = True | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 650 | sys.settrace(None) | 
|  | 651 | return res | 
| Serhiy Storchaka | d53cf99 | 2019-05-06 22:40:27 +0300 | [diff] [blame] | 652 | runcall.__text_signature__ = '($self, func, /, *args, **kwds)' | 
| Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 653 |  | 
| Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 654 |  | 
| Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 655 | def set_trace(): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 656 | """Start debugging with a Bdb instance from the caller's frame.""" | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 657 | Bdb().set_trace() | 
| Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 658 |  | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 659 |  | 
|  | 660 | class Breakpoint: | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 661 | """Breakpoint class. | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 662 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 663 | Implements temporary breakpoints, ignore counts, disabling and | 
|  | 664 | (re)-enabling, and conditionals. | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 665 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 666 | Breakpoints are indexed by number through bpbynumber and by | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 667 | the (file, line) tuple using bplist.  The former points to a | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 668 | single instance of class Breakpoint.  The latter points to a | 
|  | 669 | list of such instances since there may be more than one | 
|  | 670 | breakpoint per line. | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 671 |  | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 672 | When creating a breakpoint, its associated filename should be | 
|  | 673 | in canonical form.  If funcname is defined, a breakpoint hit will be | 
|  | 674 | counted when the first line of that function is executed.  A | 
|  | 675 | conditional breakpoint always counts a hit. | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 676 | """ | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 677 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 678 | # XXX Keeping state in the class is a mistake -- this means | 
|  | 679 | # you cannot have more than one active Bdb instance. | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 680 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 681 | next = 1        # Next bp to be assigned | 
|  | 682 | bplist = {}     # indexed by (file, lineno) tuple | 
|  | 683 | bpbynumber = [None] # Each entry is None or an instance of Bpt | 
|  | 684 | # index 0 is unused, except for marking an | 
|  | 685 | # effective break .... see effective() | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 686 |  | 
| Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 687 | def __init__(self, file, line, temporary=False, cond=None, funcname=None): | 
| Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 688 | self.funcname = funcname | 
|  | 689 | # Needed if funcname is not None. | 
|  | 690 | self.func_first_executable_line = None | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 691 | self.file = file    # This better be in canonical form! | 
|  | 692 | self.line = line | 
|  | 693 | self.temporary = temporary | 
|  | 694 | self.cond = cond | 
| Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 695 | self.enabled = True | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 696 | self.ignore = 0 | 
|  | 697 | self.hits = 0 | 
|  | 698 | self.number = Breakpoint.next | 
| Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 699 | Breakpoint.next += 1 | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 700 | # Build the two lists | 
|  | 701 | self.bpbynumber.append(self) | 
| Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 702 | if (file, line) in self.bplist: | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 703 | self.bplist[file, line].append(self) | 
|  | 704 | else: | 
|  | 705 | self.bplist[file, line] = [self] | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 706 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 707 | def deleteMe(self): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 708 | """Delete the breakpoint from the list associated to a file:line. | 
|  | 709 |  | 
|  | 710 | If it is the last breakpoint in that position, it also deletes | 
|  | 711 | the entry for the file:line. | 
|  | 712 | """ | 
|  | 713 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 714 | index = (self.file, self.line) | 
|  | 715 | self.bpbynumber[self.number] = None   # No longer in list | 
|  | 716 | self.bplist[index].remove(self) | 
|  | 717 | if not self.bplist[index]: | 
|  | 718 | # No more bp for this f:l combo | 
|  | 719 | del self.bplist[index] | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 720 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 721 | def enable(self): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 722 | """Mark the breakpoint as enabled.""" | 
| Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 723 | self.enabled = True | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 724 |  | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 725 | def disable(self): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 726 | """Mark the breakpoint as disabled.""" | 
| Georg Brandl | ac9a2bb | 2010-11-29 20:19:15 +0000 | [diff] [blame] | 727 | self.enabled = False | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 728 |  | 
| Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 729 | def bpprint(self, out=None): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 730 | """Print the output of bpformat(). | 
|  | 731 |  | 
|  | 732 | The optional out argument directs where the output is sent | 
|  | 733 | and defaults to standard output. | 
|  | 734 | """ | 
| Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 735 | if out is None: | 
|  | 736 | out = sys.stdout | 
| Georg Brandl | d2fd4ca | 2010-07-30 15:01:23 +0000 | [diff] [blame] | 737 | print(self.bpformat(), file=out) | 
|  | 738 |  | 
|  | 739 | def bpformat(self): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 740 | """Return a string with information about the breakpoint. | 
|  | 741 |  | 
|  | 742 | The information includes the breakpoint number, temporary | 
|  | 743 | status, file:line position, break condition, number of times to | 
|  | 744 | ignore, and number of times hit. | 
|  | 745 |  | 
|  | 746 | """ | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 747 | if self.temporary: | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 748 | disp = 'del  ' | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 749 | else: | 
| Tim Peters | 11cf605 | 2001-01-14 21:54:20 +0000 | [diff] [blame] | 750 | disp = 'keep ' | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 751 | if self.enabled: | 
| Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 752 | disp = disp + 'yes  ' | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 753 | else: | 
| Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 754 | disp = disp + 'no   ' | 
| Georg Brandl | d2fd4ca | 2010-07-30 15:01:23 +0000 | [diff] [blame] | 755 | ret = '%-4dbreakpoint   %s at %s:%d' % (self.number, disp, | 
|  | 756 | self.file, self.line) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 757 | if self.cond: | 
| Georg Brandl | d2fd4ca | 2010-07-30 15:01:23 +0000 | [diff] [blame] | 758 | ret += '\n\tstop only if %s' % (self.cond,) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 759 | if self.ignore: | 
| Georg Brandl | d2fd4ca | 2010-07-30 15:01:23 +0000 | [diff] [blame] | 760 | ret += '\n\tignore next %d hits' % (self.ignore,) | 
|  | 761 | if self.hits: | 
|  | 762 | if self.hits > 1: | 
|  | 763 | ss = 's' | 
|  | 764 | else: | 
|  | 765 | ss = '' | 
|  | 766 | ret += '\n\tbreakpoint already hit %d time%s' % (self.hits, ss) | 
|  | 767 | return ret | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 768 |  | 
| Georg Brandl | 7410dd1 | 2010-07-30 12:01:20 +0000 | [diff] [blame] | 769 | def __str__(self): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 770 | "Return a condensed description of the breakpoint." | 
| Georg Brandl | 7410dd1 | 2010-07-30 12:01:20 +0000 | [diff] [blame] | 771 | return 'breakpoint %s at %s:%s' % (self.number, self.file, self.line) | 
|  | 772 |  | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 773 | # -----------end of Breakpoint class---------- | 
|  | 774 |  | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 775 |  | 
| Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 776 | def checkfuncname(b, frame): | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 777 | """Return True if break should happen here. | 
|  | 778 |  | 
|  | 779 | Whether a break should happen depends on the way that b (the breakpoint) | 
|  | 780 | was set.  If it was set via line number, check if b.line is the same as | 
|  | 781 | the one in the frame.  If it was set via function name, check if this is | 
|  | 782 | the right function and if it is on the first executable line. | 
|  | 783 | """ | 
| Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 784 | if not b.funcname: | 
|  | 785 | # Breakpoint was set via line number. | 
|  | 786 | if b.line != frame.f_lineno: | 
|  | 787 | # Breakpoint was set at a line with a def statement and the function | 
|  | 788 | # defined is called: don't break. | 
|  | 789 | return False | 
|  | 790 | return True | 
|  | 791 |  | 
|  | 792 | # Breakpoint set via function name. | 
| Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 793 | if frame.f_code.co_name != b.funcname: | 
|  | 794 | # It's not a function call, but rather execution of def statement. | 
|  | 795 | return False | 
|  | 796 |  | 
|  | 797 | # We are in the right frame. | 
|  | 798 | if not b.func_first_executable_line: | 
|  | 799 | # The function is entered for the 1st time. | 
|  | 800 | b.func_first_executable_line = frame.f_lineno | 
|  | 801 |  | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 802 | if b.func_first_executable_line != frame.f_lineno: | 
| Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 803 | # But we are not at the first line number: don't break. | 
|  | 804 | return False | 
|  | 805 | return True | 
|  | 806 |  | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 807 |  | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 808 | # Determines if there is an effective (active) breakpoint at this | 
|  | 809 | # line of code.  Returns breakpoint number or 0 if none | 
|  | 810 | def effective(file, line, frame): | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 811 | """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] | 812 |  | 
| csabella | 0774e79 | 2017-05-16 18:28:02 -0400 | [diff] [blame] | 813 | Called only if we know there is a breakpoint at this location.  Return | 
|  | 814 | the breakpoint that was triggered and a boolean that indicates if it is | 
|  | 815 | ok to delete a temporary breakpoint.  Return (None, None) if there is no | 
|  | 816 | matching breakpoint. | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 817 | """ | 
| Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 818 | possibles = Breakpoint.bplist[file, line] | 
|  | 819 | for b in possibles: | 
|  | 820 | if not b.enabled: | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 821 | continue | 
| Johannes Gijsbers | 4a9faa1 | 2004-08-30 13:29:44 +0000 | [diff] [blame] | 822 | if not checkfuncname(b, frame): | 
|  | 823 | continue | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 824 | # Count every hit when bp is enabled | 
| Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 825 | b.hits += 1 | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 826 | if not b.cond: | 
| Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 827 | # If unconditional, and ignoring go on to next, else break | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 828 | if b.ignore > 0: | 
| Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 829 | b.ignore -= 1 | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 830 | continue | 
|  | 831 | else: | 
| Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 832 | # breakpoint and marker that it's ok to delete if temporary | 
|  | 833 | return (b, True) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 834 | else: | 
|  | 835 | # Conditional bp. | 
|  | 836 | # Ignore count applies only to those bpt hits where the | 
|  | 837 | # condition evaluates to true. | 
|  | 838 | try: | 
| Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 839 | val = eval(b.cond, frame.f_globals, frame.f_locals) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 840 | if val: | 
|  | 841 | if b.ignore > 0: | 
| Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 842 | b.ignore -= 1 | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 843 | # continue | 
|  | 844 | else: | 
| Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 845 | return (b, True) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 846 | # else: | 
|  | 847 | #   continue | 
|  | 848 | except: | 
| Georg Brandl | 9aed6cc | 2010-11-26 12:05:27 +0000 | [diff] [blame] | 849 | # if eval fails, most conservative thing is to stop on | 
|  | 850 | # breakpoint regardless of ignore count.  Don't delete | 
|  | 851 | # temporary, as another hint to user. | 
|  | 852 | return (b, False) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 853 | return (None, None) | 
| Guido van Rossum | d93643f | 1998-09-11 22:38:35 +0000 | [diff] [blame] | 854 |  | 
| Georg Brandl | 2660747 | 2010-11-29 20:12:24 +0000 | [diff] [blame] | 855 |  | 
| Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 856 | # -------------------- testing -------------------- | 
|  | 857 |  | 
|  | 858 | class Tdb(Bdb): | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 859 | def user_call(self, frame, args): | 
|  | 860 | name = frame.f_code.co_name | 
|  | 861 | if not name: name = '???' | 
| Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 862 | print('+++ call', name, args) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 863 | def user_line(self, frame): | 
| Eric S. Raymond | b49f4a4 | 2001-02-09 05:07:04 +0000 | [diff] [blame] | 864 | import linecache | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 865 | name = frame.f_code.co_name | 
|  | 866 | if not name: name = '???' | 
|  | 867 | fn = self.canonic(frame.f_code.co_filename) | 
| Nick Coghlan | f088e5e | 2008-12-14 11:50:48 +0000 | [diff] [blame] | 868 | line = linecache.getline(fn, frame.f_lineno, frame.f_globals) | 
| Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 869 | print('+++', fn, frame.f_lineno, name, ':', line.strip()) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 870 | def user_return(self, frame, retval): | 
| Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 871 | print('+++ return', retval) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 872 | def user_exception(self, frame, exc_stuff): | 
| Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 873 | print('+++ exception', exc_stuff) | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 874 | self.set_continue() | 
| Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 875 |  | 
|  | 876 | def foo(n): | 
| Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 877 | print('foo(', n, ')') | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 878 | x = bar(n*10) | 
| Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 879 | print('bar returned', x) | 
| Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 880 |  | 
|  | 881 | def bar(a): | 
| Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 882 | print('bar(', a, ')') | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 883 | return a/2 | 
| Guido van Rossum | babe2bf | 1992-01-22 22:21:31 +0000 | [diff] [blame] | 884 |  | 
|  | 885 | def test(): | 
| Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 886 | t = Tdb() | 
|  | 887 | t.run('import bdb; bdb.foo(10)') |