Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 1 | :mod:`bdb` --- Debugger framework |
| 2 | ================================= |
| 3 | |
| 4 | .. module:: bdb |
| 5 | :synopsis: Debugger framework. |
| 6 | |
| 7 | The :mod:`bdb` module handles basic debugger functions, like setting breakpoints |
| 8 | or managing execution via the debugger. |
| 9 | |
| 10 | The following exception is defined: |
| 11 | |
| 12 | .. exception:: BdbQuit |
| 13 | |
| 14 | Exception raised by the :class:`Bdb` class for quitting the debugger. |
| 15 | |
| 16 | |
| 17 | The :mod:`bdb` module also defines two classes: |
| 18 | |
| 19 | .. class:: Breakpoint(self, file, line[, temporary=0[, cond=None [, funcname=None]]]) |
| 20 | |
| 21 | This class implements temporary breakpoints, ignore counts, disabling and |
| 22 | (re-)enabling, and conditionals. |
| 23 | |
| 24 | Breakpoints are indexed by number through a list called :attr:`bpbynumber` |
| 25 | and by ``(file, line)`` pairs through :attr:`bplist`. The former points to a |
| 26 | single instance of class :class:`Breakpoint`. The latter points to a list of |
| 27 | such instances since there may be more than one breakpoint per line. |
| 28 | |
| 29 | When creating a breakpoint, its associated filename should be in canonical |
| 30 | form. If a *funcname* is defined, a breakpoint hit will be counted when the |
| 31 | first line of that function is executed. A conditional breakpoint always |
| 32 | counts a hit. |
| 33 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 34 | :class:`Breakpoint` instances have the following methods: |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 35 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 36 | .. method:: deleteMe() |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 37 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 38 | Delete the breakpoint from the list associated to a file/line. If it is |
| 39 | the last breakpoint in that position, it also deletes the entry for the |
| 40 | file/line. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 41 | |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 42 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 43 | .. method:: enable() |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 44 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 45 | Mark the breakpoint as enabled. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 46 | |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 47 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 48 | .. method:: disable() |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 49 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 50 | Mark the breakpoint as disabled. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 51 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 52 | |
| 53 | .. method:: pprint([out]) |
| 54 | |
| 55 | Print all the information about the breakpoint: |
| 56 | |
| 57 | * The breakpoint number. |
| 58 | * If it is temporary or not. |
| 59 | * Its file,line position. |
| 60 | * The condition that causes a break. |
| 61 | * If it must be ignored the next N times. |
| 62 | * The breakpoint hit count. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 63 | |
| 64 | |
| 65 | .. class:: Bdb() |
| 66 | |
| 67 | The :class:`Bdb` acts as a generic Python debugger base class. |
| 68 | |
| 69 | This class takes care of the details of the trace facility; a derived class |
| 70 | should implement user interaction. The standard debugger class |
| 71 | (:class:`pdb.Pdb`) is an example. |
| 72 | |
| 73 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 74 | The following methods of :class:`Bdb` normally don't need to be overridden. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 75 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 76 | .. method:: canonic(filename) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 77 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 78 | Auxiliary method for getting a filename in a canonical form, that is, as a |
| 79 | case-normalized (on case-insensitive filesystems) absolute path, stripped |
| 80 | of surrounding angle brackets. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 81 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 82 | .. method:: reset() |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 83 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 84 | Set the :attr:`botframe`, :attr:`stopframe`, :attr:`returnframe` and |
| 85 | :attr:`quitting` attributes with values ready to start debugging. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 86 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 87 | .. method:: trace_dispatch(frame, event, arg) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 88 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 89 | This function is installed as the trace function of debugged frames. Its |
| 90 | return value is the new trace function (in most cases, that is, itself). |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 91 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 92 | The default implementation decides how to dispatch a frame, depending on |
| 93 | the type of event (passed as a string) that is about to be executed. |
| 94 | *event* can be one of the following: |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 95 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 96 | * ``"line"``: A new line of code is going to be executed. |
| 97 | * ``"call"``: A function is about to be called, or another code block |
| 98 | entered. |
| 99 | * ``"return"``: A function or other code block is about to return. |
| 100 | * ``"exception"``: An exception has occurred. |
| 101 | * ``"c_call"``: A C function is about to be called. |
| 102 | * ``"c_return"``: A C function has returned. |
| 103 | * ``"c_exception"``: A C function has thrown an exception. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 104 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 105 | For the Python events, specialized functions (see below) are called. For |
| 106 | the C events, no action is taken. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 107 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 108 | The *arg* parameter depends on the previous event. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 109 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 110 | For more information on trace functions, see :ref:`debugger-hooks`. For |
| 111 | more information on code and frame objects, refer to :ref:`types`. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 112 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 113 | .. method:: dispatch_line(frame) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 114 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 115 | If the debugger should stop on the current line, invoke the |
| 116 | :meth:`user_line` method (which should be overridden in subclasses). |
| 117 | Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set |
| 118 | (which can be set from :meth:`user_line`). Return a reference to the |
| 119 | :meth:`trace_dispatch` method for further tracing in that scope. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 120 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 121 | .. method:: dispatch_call(frame, arg) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 122 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 123 | If the debugger should stop on this function call, invoke the |
| 124 | :meth:`user_call` method (which should be overridden in subclasses). |
| 125 | Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set |
| 126 | (which can be set from :meth:`user_call`). Return a reference to the |
| 127 | :meth:`trace_dispatch` method for further tracing in that scope. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 128 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 129 | .. method:: dispatch_return(frame, arg) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 130 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 131 | If the debugger should stop on this function return, invoke the |
| 132 | :meth:`user_return` method (which should be overridden in subclasses). |
| 133 | Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set |
| 134 | (which can be set from :meth:`user_return`). Return a reference to the |
| 135 | :meth:`trace_dispatch` method for further tracing in that scope. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 136 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 137 | .. method:: dispatch_exception(frame, arg) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 138 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 139 | If the debugger should stop at this exception, invokes the |
| 140 | :meth:`user_exception` method (which should be overridden in subclasses). |
| 141 | Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set |
| 142 | (which can be set from :meth:`user_exception`). Return a reference to the |
| 143 | :meth:`trace_dispatch` method for further tracing in that scope. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 144 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 145 | Normally derived classes don't override the following methods, but they may |
| 146 | if they want to redefine the definition of stopping and breakpoints. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 147 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 148 | .. method:: stop_here(frame) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 149 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 150 | This method checks if the *frame* is somewhere below :attr:`botframe` in |
| 151 | the call stack. :attr:`botframe` is the frame in which debugging started. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 152 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 153 | .. method:: break_here(frame) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 154 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 155 | This method checks if there is a breakpoint in the filename and line |
| 156 | belonging to *frame* or, at least, in the current function. If the |
| 157 | breakpoint is a temporary one, this method deletes it. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 158 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 159 | .. method:: break_anywhere(frame) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 160 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 161 | This method checks if there is a breakpoint in the filename of the current |
| 162 | frame. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 163 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 164 | Derived classes should override these methods to gain control over debugger |
| 165 | operation. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 166 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 167 | .. method:: user_call(frame, argument_list) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 168 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 169 | This method is called from :meth:`dispatch_call` when there is the |
| 170 | possibility that a break might be necessary anywhere inside the called |
| 171 | function. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 172 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 173 | .. method:: user_line(frame) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 174 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 175 | This method is called from :meth:`dispatch_line` when either |
| 176 | :meth:`stop_here` or :meth:`break_here` yields True. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 177 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 178 | .. method:: user_return(frame, return_value) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 179 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 180 | This method is called from :meth:`dispatch_return` when :meth:`stop_here` |
| 181 | yields True. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 182 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 183 | .. method:: user_exception(frame, exc_info) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 184 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 185 | This method is called from :meth:`dispatch_exception` when |
| 186 | :meth:`stop_here` yields True. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 187 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 188 | .. method:: do_clear(arg) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 189 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 190 | Handle how a breakpoint must be removed when it is a temporary one. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 191 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 192 | This method must be implemented by derived classes. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 193 | |
| 194 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 195 | Derived classes and clients can call the following methods to affect the |
| 196 | stepping state. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 197 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 198 | .. method:: set_step() |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 199 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 200 | Stop after one line of code. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 201 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 202 | .. method:: set_next(frame) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 203 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 204 | Stop on the next line in or below the given frame. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 205 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 206 | .. method:: set_return(frame) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 207 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 208 | Stop when returning from the given frame. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 209 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 210 | .. method:: set_trace([frame]) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 211 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 212 | Start debugging from *frame*. If *frame* is not specified, debugging |
| 213 | starts from caller's frame. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 214 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 215 | .. method:: set_continue() |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 216 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 217 | Stop only at breakpoints or when finished. If there are no breakpoints, |
| 218 | set the system trace function to None. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 219 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 220 | .. method:: set_quit() |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 221 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 222 | Set the :attr:`quitting` attribute to True. This raises :exc:`BdbQuit` in |
| 223 | the next call to one of the :meth:`dispatch_\*` methods. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 224 | |
| 225 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 226 | Derived classes and clients can call the following methods to manipulate |
| 227 | breakpoints. These methods return a string containing an error message if |
| 228 | something went wrong, or ``None`` if all is well. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 229 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 230 | .. method:: set_break(filename, lineno[, temporary=0[, cond[, funcname]]]) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 231 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 232 | Set a new breakpoint. If the *lineno* line doesn't exist for the |
| 233 | *filename* passed as argument, return an error message. The *filename* |
| 234 | should be in canonical form, as described in the :meth:`canonic` method. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 235 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 236 | .. method:: clear_break(filename, lineno) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 237 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 238 | Delete the breakpoints in *filename* and *lineno*. If none were set, an |
| 239 | error message is returned. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 240 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 241 | .. method:: clear_bpbynumber(arg) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 242 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 243 | Delete the breakpoint which has the index *arg* in the |
| 244 | :attr:`Breakpoint.bpbynumber`. If *arg* is not numeric or out of range, |
| 245 | return an error message. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 246 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 247 | .. method:: clear_all_file_breaks(filename) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 248 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 249 | Delete all breakpoints in *filename*. If none were set, an error message |
| 250 | is returned. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 251 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 252 | .. method:: clear_all_breaks() |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 253 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 254 | Delete all existing breakpoints. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 255 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 256 | .. method:: get_break(filename, lineno) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 257 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 258 | Check if there is a breakpoint for *lineno* of *filename*. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 259 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 260 | .. method:: get_breaks(filename, lineno) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 261 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 262 | Return all breakpoints for *lineno* in *filename*, or an empty list if |
| 263 | none are set. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 264 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 265 | .. method:: get_file_breaks(filename) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 266 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 267 | Return all breakpoints in *filename*, or an empty list if none are set. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 268 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 269 | .. method:: get_all_breaks() |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 270 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 271 | Return all breakpoints that are set. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 272 | |
| 273 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 274 | Derived classes and clients can call the following methods to get a data |
| 275 | structure representing a stack trace. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 276 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 277 | .. method:: get_stack(f, t) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 278 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 279 | Get a list of records for a frame and all higher (calling) and lower |
| 280 | frames, and the size of the higher part. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 281 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 282 | .. method:: format_stack_entry(frame_lineno, [lprefix=': ']) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 283 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 284 | Return a string with information about a stack entry, identified by a |
| 285 | ``(frame, lineno)`` tuple: |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 286 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 287 | * The canonical form of the filename which contains the frame. |
| 288 | * The function name, or ``"<lambda>"``. |
| 289 | * The input arguments. |
| 290 | * The return value. |
| 291 | * The line of code (if it exists). |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 292 | |
| 293 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 294 | The following two methods can be called by clients to use a debugger to debug |
| 295 | a :term:`statement`, given as a string. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 296 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 297 | .. method:: run(cmd, [globals, [locals]]) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 298 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 299 | Debug a statement executed via the :func:`exec` function. *globals* |
| 300 | defaults to :attr:`__main__.__dict__`, *locals* defaults to *globals*. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 301 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 302 | .. method:: runeval(expr, [globals, [locals]]) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 303 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 304 | Debug an expression executed via the :func:`eval` function. *globals* and |
| 305 | *locals* have the same meaning as in :meth:`run`. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 306 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 307 | .. method:: runctx(cmd, globals, locals) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 308 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 309 | For backwards compatibility. Calls the :meth:`run` method. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 310 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 311 | .. method:: runcall(func, *args, **kwds) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 312 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame^] | 313 | Debug a single function call, and return its result. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 314 | |
| 315 | |
| 316 | Finally, the module defines the following functions: |
| 317 | |
| 318 | .. function:: checkfuncname(b, frame) |
| 319 | |
| 320 | Check whether we should break here, depending on the way the breakpoint *b* |
| 321 | was set. |
| 322 | |
| 323 | If it was set via line number, it checks if ``b.line`` is the same as the one |
| 324 | in the frame also passed as argument. If the breakpoint was set via function |
| 325 | name, we have to check we are in the right frame (the right function) and if |
| 326 | we are in its first executable line. |
| 327 | |
| 328 | .. function:: effective(file, line, frame) |
| 329 | |
| 330 | Determine if there is an effective (active) breakpoint at this line of code. |
| 331 | Return breakpoint number or 0 if none. |
| 332 | |
| 333 | Called only if we know there is a breakpoint at this location. Returns the |
| 334 | breakpoint that was triggered and a flag that indicates if it is ok to delete |
| 335 | a temporary breakpoint. |
| 336 | |
| 337 | .. function:: set_trace() |
| 338 | |
| 339 | Starts debugging with a :class:`Bdb` instance from caller's frame. |