Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DebugClients.Python.DebugBase.html
Documentation/Source/eric5.DebugClients.Python.DebugBase.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.DebugClients.Python.DebugBase</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.DebugClients.Python.DebugBase</h1> | |
| 12 <p> | |
| 13 Module implementing the debug base class. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>gRecursionLimit</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#DebugBase">DebugBase</a></td> | |
| 23 <td>Class implementing base class of the debugger.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr> | |
| 29 <td><a href="#printerr">printerr</a></td> | |
| 30 <td>Module function used for debugging the debug client.</td> | |
| 31 </tr><tr> | |
| 32 <td><a href="#setRecursionLimit">setRecursionLimit</a></td> | |
| 33 <td>Module function to set the recursion limit.</td> | |
| 34 </tr> | |
| 35 </table> | |
| 36 <hr /><hr /> | |
| 37 <a NAME="DebugBase" ID="DebugBase"></a> | |
| 38 <h2>DebugBase</h2> | |
| 39 <p> | |
| 40 Class implementing base class of the debugger. | |
| 41 </p><p> | |
| 42 Provides simple wrapper methods around bdb for the 'owning' client to | |
| 43 call to step etc. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 bdb.Bdb | |
| 47 <h3>Class Attributes</h3> | |
| 48 <table> | |
| 49 <tr><td>None</td></tr> | |
| 50 </table> | |
| 51 <h3>Methods</h3> | |
| 52 <table> | |
| 53 <tr> | |
| 54 <td><a href="#DebugBase.__init__">DebugBase</a></td> | |
| 55 <td>Constructor</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#DebugBase.__do_clear">__do_clear</a></td> | |
| 58 <td>Private method called to clear a temporary breakpoint.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#DebugBase.__do_clearWatch">__do_clearWatch</a></td> | |
| 61 <td>Private method called to clear a temporary watch expression.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#DebugBase.__effective">__effective</a></td> | |
| 64 <td>Private method to determine, if a watch expression is effective.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#DebugBase.__extract_stack">__extract_stack</a></td> | |
| 67 <td>Private member to return a list of stack frames.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#DebugBase.__skip_it">__skip_it</a></td> | |
| 70 <td>Private method to filter out debugger files.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#DebugBase.break_anywhere">break_anywhere</a></td> | |
| 73 <td>Reimplemented from bdb.py to do some special things.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#DebugBase.break_here">break_here</a></td> | |
| 76 <td>Reimplemented from bdb.py to fix the filename from the frame.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#DebugBase.clear_watch">clear_watch</a></td> | |
| 79 <td>Public method to clear a watch expression.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#DebugBase.dispatch_exception">dispatch_exception</a></td> | |
| 82 <td>Reimplemented from bdb.py to always call user_exception.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#DebugBase.dispatch_line">dispatch_line</a></td> | |
| 85 <td>Reimplemented from bdb.py to do some special things.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#DebugBase.dispatch_return">dispatch_return</a></td> | |
| 88 <td>Reimplemented from bdb.py to handle passive mode cleanly.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#DebugBase.fix_frame_filename">fix_frame_filename</a></td> | |
| 91 <td>Public method used to fixup the filename for a given frame.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#DebugBase.getCurrentFrame">getCurrentFrame</a></td> | |
| 94 <td>Public method to return the current frame.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#DebugBase.getEvent">getEvent</a></td> | |
| 97 <td>Public method to return the last debugger event.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#DebugBase.getStack">getStack</a></td> | |
| 100 <td>Public method to get the stack.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#DebugBase.get_break">get_break</a></td> | |
| 103 <td>Reimplemented from bdb.py to get the first breakpoint of a particular line.</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#DebugBase.get_watch">get_watch</a></td> | |
| 106 <td>Public method to get a watch expression.</td> | |
| 107 </tr><tr> | |
| 108 <td><a href="#DebugBase.go">go</a></td> | |
| 109 <td>Public method to resume the thread.</td> | |
| 110 </tr><tr> | |
| 111 <td><a href="#DebugBase.isBroken">isBroken</a></td> | |
| 112 <td>Public method to return the broken state of the debugger.</td> | |
| 113 </tr><tr> | |
| 114 <td><a href="#DebugBase.profile">profile</a></td> | |
| 115 <td>Public method used to trace some stuff independant of the debugger trace function.</td> | |
| 116 </tr><tr> | |
| 117 <td><a href="#DebugBase.setRecursionDepth">setRecursionDepth</a></td> | |
| 118 <td>Public method to determine the current recursion depth.</td> | |
| 119 </tr><tr> | |
| 120 <td><a href="#DebugBase.set_continue">set_continue</a></td> | |
| 121 <td>Reimplemented from bdb.py to always get informed of exceptions.</td> | |
| 122 </tr><tr> | |
| 123 <td><a href="#DebugBase.set_quit">set_quit</a></td> | |
| 124 <td>Public method to quit.</td> | |
| 125 </tr><tr> | |
| 126 <td><a href="#DebugBase.set_trace">set_trace</a></td> | |
| 127 <td>Overridden method of bdb.py to do some special setup.</td> | |
| 128 </tr><tr> | |
| 129 <td><a href="#DebugBase.set_watch">set_watch</a></td> | |
| 130 <td>Public method to set a watch expression.</td> | |
| 131 </tr><tr> | |
| 132 <td><a href="#DebugBase.step">step</a></td> | |
| 133 <td>Public method to perform a step operation in this thread.</td> | |
| 134 </tr><tr> | |
| 135 <td><a href="#DebugBase.stepOut">stepOut</a></td> | |
| 136 <td>Public method to perform a step out of the current call.</td> | |
| 137 </tr><tr> | |
| 138 <td><a href="#DebugBase.stop_here">stop_here</a></td> | |
| 139 <td>Reimplemented to filter out debugger files.</td> | |
| 140 </tr><tr> | |
| 141 <td><a href="#DebugBase.trace_dispatch">trace_dispatch</a></td> | |
| 142 <td>Reimplemented from bdb.py to do some special things.</td> | |
| 143 </tr><tr> | |
| 144 <td><a href="#DebugBase.user_exception">user_exception</a></td> | |
| 145 <td>Reimplemented to report an exception to the debug server.</td> | |
| 146 </tr><tr> | |
| 147 <td><a href="#DebugBase.user_line">user_line</a></td> | |
| 148 <td>Reimplemented to handle the program about to execute a particular line.</td> | |
| 149 </tr><tr> | |
| 150 <td><a href="#DebugBase.user_return">user_return</a></td> | |
| 151 <td>Reimplemented to report program termination to the debug server.</td> | |
| 152 </tr> | |
| 153 </table> | |
| 154 <a NAME="DebugBase.__init__" ID="DebugBase.__init__"></a> | |
| 155 <h4>DebugBase (Constructor)</h4> | |
| 156 <b>DebugBase</b>(<i>dbgClient</i>) | |
| 157 <p> | |
| 158 Constructor | |
| 159 </p><dl> | |
| 160 <dt><i>dbgClient</i></dt> | |
| 161 <dd> | |
| 162 the owning client | |
| 163 </dd> | |
| 164 </dl><a NAME="DebugBase.__do_clear" ID="DebugBase.__do_clear"></a> | |
| 165 <h4>DebugBase.__do_clear</h4> | |
| 166 <b>__do_clear</b>(<i>filename, lineno</i>) | |
| 167 <p> | |
| 168 Private method called to clear a temporary breakpoint. | |
| 169 </p><dl> | |
| 170 <dt><i>filename</i></dt> | |
| 171 <dd> | |
| 172 name of the file the bp belongs to | |
| 173 </dd><dt><i>lineno</i></dt> | |
| 174 <dd> | |
| 175 linenumber of the bp | |
| 176 </dd> | |
| 177 </dl><a NAME="DebugBase.__do_clearWatch" ID="DebugBase.__do_clearWatch"></a> | |
| 178 <h4>DebugBase.__do_clearWatch</h4> | |
| 179 <b>__do_clearWatch</b>(<i>cond</i>) | |
| 180 <p> | |
| 181 Private method called to clear a temporary watch expression. | |
| 182 </p><dl> | |
| 183 <dt><i>cond</i></dt> | |
| 184 <dd> | |
| 185 expression of the watch expression to be cleared (string) | |
| 186 </dd> | |
| 187 </dl><a NAME="DebugBase.__effective" ID="DebugBase.__effective"></a> | |
| 188 <h4>DebugBase.__effective</h4> | |
| 189 <b>__effective</b>(<i>frame</i>) | |
| 190 <p> | |
| 191 Private method to determine, if a watch expression is effective. | |
| 192 </p><dl> | |
| 193 <dt><i>frame</i></dt> | |
| 194 <dd> | |
| 195 the current execution frame | |
| 196 </dd> | |
| 197 </dl><dl> | |
| 198 <dt>Returns:</dt> | |
| 199 <dd> | |
| 200 tuple of watch expression and a flag to indicate, that a temporary | |
| 201 watch expression may be deleted (bdb.Breakpoint, boolean) | |
| 202 </dd> | |
| 203 </dl><a NAME="DebugBase.__extract_stack" ID="DebugBase.__extract_stack"></a> | |
| 204 <h4>DebugBase.__extract_stack</h4> | |
| 205 <b>__extract_stack</b>(<i>exctb</i>) | |
| 206 <p> | |
| 207 Private member to return a list of stack frames. | |
| 208 </p><dl> | |
| 209 <dt><i>exctb</i></dt> | |
| 210 <dd> | |
| 211 exception traceback | |
| 212 </dd> | |
| 213 </dl><dl> | |
| 214 <dt>Returns:</dt> | |
| 215 <dd> | |
| 216 list of stack frames | |
| 217 </dd> | |
| 218 </dl><a NAME="DebugBase.__skip_it" ID="DebugBase.__skip_it"></a> | |
| 219 <h4>DebugBase.__skip_it</h4> | |
| 220 <b>__skip_it</b>(<i>frame</i>) | |
| 221 <p> | |
| 222 Private method to filter out debugger files. | |
| 223 </p><p> | |
| 224 Tracing is turned off for files that are part of the | |
| 225 debugger that are called from the application being debugged. | |
| 226 </p><dl> | |
| 227 <dt><i>frame</i></dt> | |
| 228 <dd> | |
| 229 the frame object | |
| 230 </dd> | |
| 231 </dl><dl> | |
| 232 <dt>Returns:</dt> | |
| 233 <dd> | |
| 234 flag indicating whether the debugger should skip this frame | |
| 235 </dd> | |
| 236 </dl><a NAME="DebugBase.break_anywhere" ID="DebugBase.break_anywhere"></a> | |
| 237 <h4>DebugBase.break_anywhere</h4> | |
| 238 <b>break_anywhere</b>(<i>frame</i>) | |
| 239 <p> | |
| 240 Reimplemented from bdb.py to do some special things. | |
| 241 </p><p> | |
| 242 These speciality is to fix the filename from the frame | |
| 243 (see fix_frame_filename for more info). | |
| 244 </p><dl> | |
| 245 <dt><i>frame</i></dt> | |
| 246 <dd> | |
| 247 the frame object | |
| 248 </dd> | |
| 249 </dl><dl> | |
| 250 <dt>Returns:</dt> | |
| 251 <dd> | |
| 252 flag indicating the break status (boolean) | |
| 253 </dd> | |
| 254 </dl><a NAME="DebugBase.break_here" ID="DebugBase.break_here"></a> | |
| 255 <h4>DebugBase.break_here</h4> | |
| 256 <b>break_here</b>(<i>frame</i>) | |
| 257 <p> | |
| 258 Reimplemented from bdb.py to fix the filename from the frame. | |
| 259 </p><p> | |
| 260 See fix_frame_filename for more info. | |
| 261 </p><dl> | |
| 262 <dt><i>frame</i></dt> | |
| 263 <dd> | |
| 264 the frame object | |
| 265 </dd> | |
| 266 </dl><dl> | |
| 267 <dt>Returns:</dt> | |
| 268 <dd> | |
| 269 flag indicating the break status (boolean) | |
| 270 </dd> | |
| 271 </dl><a NAME="DebugBase.clear_watch" ID="DebugBase.clear_watch"></a> | |
| 272 <h4>DebugBase.clear_watch</h4> | |
| 273 <b>clear_watch</b>(<i>cond</i>) | |
| 274 <p> | |
| 275 Public method to clear a watch expression. | |
| 276 </p><dl> | |
| 277 <dt><i>cond</i></dt> | |
| 278 <dd> | |
| 279 expression of the watch expression to be cleared (string) | |
| 280 </dd> | |
| 281 </dl><a NAME="DebugBase.dispatch_exception" ID="DebugBase.dispatch_exception"></a> | |
| 282 <h4>DebugBase.dispatch_exception</h4> | |
| 283 <b>dispatch_exception</b>(<i>frame, arg</i>) | |
| 284 <p> | |
| 285 Reimplemented from bdb.py to always call user_exception. | |
| 286 </p><dl> | |
| 287 <dt><i>frame</i></dt> | |
| 288 <dd> | |
| 289 The current stack frame. | |
| 290 </dd><dt><i>arg</i></dt> | |
| 291 <dd> | |
| 292 The arguments | |
| 293 </dd> | |
| 294 </dl><dl> | |
| 295 <dt>Returns:</dt> | |
| 296 <dd> | |
| 297 local trace function | |
| 298 </dd> | |
| 299 </dl><a NAME="DebugBase.dispatch_line" ID="DebugBase.dispatch_line"></a> | |
| 300 <h4>DebugBase.dispatch_line</h4> | |
| 301 <b>dispatch_line</b>(<i>frame</i>) | |
| 302 <p> | |
| 303 Reimplemented from bdb.py to do some special things. | |
| 304 </p><p> | |
| 305 This speciality is to check the connection to the debug server | |
| 306 for new events (i.e. new breakpoints) while we are going through | |
| 307 the code. | |
| 308 </p><dl> | |
| 309 <dt><i>frame</i></dt> | |
| 310 <dd> | |
| 311 The current stack frame. | |
| 312 </dd> | |
| 313 </dl><dl> | |
| 314 <dt>Returns:</dt> | |
| 315 <dd> | |
| 316 local trace function | |
| 317 </dd> | |
| 318 </dl><a NAME="DebugBase.dispatch_return" ID="DebugBase.dispatch_return"></a> | |
| 319 <h4>DebugBase.dispatch_return</h4> | |
| 320 <b>dispatch_return</b>(<i>frame, arg</i>) | |
| 321 <p> | |
| 322 Reimplemented from bdb.py to handle passive mode cleanly. | |
| 323 </p><dl> | |
| 324 <dt><i>frame</i></dt> | |
| 325 <dd> | |
| 326 The current stack frame. | |
| 327 </dd><dt><i>arg</i></dt> | |
| 328 <dd> | |
| 329 The arguments | |
| 330 </dd> | |
| 331 </dl><dl> | |
| 332 <dt>Returns:</dt> | |
| 333 <dd> | |
| 334 local trace function | |
| 335 </dd> | |
| 336 </dl><a NAME="DebugBase.fix_frame_filename" ID="DebugBase.fix_frame_filename"></a> | |
| 337 <h4>DebugBase.fix_frame_filename</h4> | |
| 338 <b>fix_frame_filename</b>(<i>frame</i>) | |
| 339 <p> | |
| 340 Public method used to fixup the filename for a given frame. | |
| 341 </p><p> | |
| 342 The logic employed here is that if a module was loaded | |
| 343 from a .pyc file, then the correct .py to operate with | |
| 344 should be in the same path as the .pyc. The reason this | |
| 345 logic is needed is that when a .pyc file is generated, the | |
| 346 filename embedded and thus what is readable in the code object | |
| 347 of the frame object is the fully qualified filepath when the | |
| 348 pyc is generated. If files are moved from machine to machine | |
| 349 this can break debugging as the .pyc will refer to the .py | |
| 350 on the original machine. Another case might be sharing | |
| 351 code over a network... This logic deals with that. | |
| 352 </p><dl> | |
| 353 <dt><i>frame</i></dt> | |
| 354 <dd> | |
| 355 the frame object | |
| 356 </dd> | |
| 357 </dl><a NAME="DebugBase.getCurrentFrame" ID="DebugBase.getCurrentFrame"></a> | |
| 358 <h4>DebugBase.getCurrentFrame</h4> | |
| 359 <b>getCurrentFrame</b>(<i></i>) | |
| 360 <p> | |
| 361 Public method to return the current frame. | |
| 362 </p><dl> | |
| 363 <dt>Returns:</dt> | |
| 364 <dd> | |
| 365 the current frame | |
| 366 </dd> | |
| 367 </dl><a NAME="DebugBase.getEvent" ID="DebugBase.getEvent"></a> | |
| 368 <h4>DebugBase.getEvent</h4> | |
| 369 <b>getEvent</b>(<i></i>) | |
| 370 <p> | |
| 371 Public method to return the last debugger event. | |
| 372 </p><dl> | |
| 373 <dt>Returns:</dt> | |
| 374 <dd> | |
| 375 last debugger event (string) | |
| 376 </dd> | |
| 377 </dl><a NAME="DebugBase.getStack" ID="DebugBase.getStack"></a> | |
| 378 <h4>DebugBase.getStack</h4> | |
| 379 <b>getStack</b>(<i></i>) | |
| 380 <p> | |
| 381 Public method to get the stack. | |
| 382 </p><dl> | |
| 383 <dt>Returns:</dt> | |
| 384 <dd> | |
| 385 list of lists with file name (string), line number (integer) | |
| 386 and function name (string) | |
| 387 </dd> | |
| 388 </dl><a NAME="DebugBase.get_break" ID="DebugBase.get_break"></a> | |
| 389 <h4>DebugBase.get_break</h4> | |
| 390 <b>get_break</b>(<i>filename, lineno</i>) | |
| 391 <p> | |
| 392 Reimplemented from bdb.py to get the first breakpoint of a particular line. | |
| 393 </p><p> | |
| 394 Because eric5 supports only one breakpoint per line, this overwritten | |
| 395 method will return this one and only breakpoint. | |
| 396 </p><dl> | |
| 397 <dt><i>filename</i></dt> | |
| 398 <dd> | |
| 399 the filename of the bp to retrieve (string) | |
| 400 </dd><dt><i>ineno</i></dt> | |
| 401 <dd> | |
| 402 the linenumber of the bp to retrieve (integer) | |
| 403 </dd> | |
| 404 </dl><dl> | |
| 405 <dt>Returns:</dt> | |
| 406 <dd> | |
| 407 breakpoint or None, if there is no bp | |
| 408 </dd> | |
| 409 </dl><a NAME="DebugBase.get_watch" ID="DebugBase.get_watch"></a> | |
| 410 <h4>DebugBase.get_watch</h4> | |
| 411 <b>get_watch</b>(<i>cond</i>) | |
| 412 <p> | |
| 413 Public method to get a watch expression. | |
| 414 </p><dl> | |
| 415 <dt><i>cond</i></dt> | |
| 416 <dd> | |
| 417 expression of the watch expression to be cleared (string) | |
| 418 </dd> | |
| 419 </dl><a NAME="DebugBase.go" ID="DebugBase.go"></a> | |
| 420 <h4>DebugBase.go</h4> | |
| 421 <b>go</b>(<i>special</i>) | |
| 422 <p> | |
| 423 Public method to resume the thread. | |
| 424 </p><p> | |
| 425 It resumes the thread stopping only at breakpoints or exceptions. | |
| 426 </p><dl> | |
| 427 <dt><i>special</i></dt> | |
| 428 <dd> | |
| 429 flag indicating a special continue operation | |
| 430 </dd> | |
| 431 </dl><a NAME="DebugBase.isBroken" ID="DebugBase.isBroken"></a> | |
| 432 <h4>DebugBase.isBroken</h4> | |
| 433 <b>isBroken</b>(<i></i>) | |
| 434 <p> | |
| 435 Public method to return the broken state of the debugger. | |
| 436 </p><dl> | |
| 437 <dt>Returns:</dt> | |
| 438 <dd> | |
| 439 flag indicating the broken state (boolean) | |
| 440 </dd> | |
| 441 </dl><a NAME="DebugBase.profile" ID="DebugBase.profile"></a> | |
| 442 <h4>DebugBase.profile</h4> | |
| 443 <b>profile</b>(<i>frame, event, arg</i>) | |
| 444 <p> | |
| 445 Public method used to trace some stuff independant of the debugger | |
| 446 trace function. | |
| 447 </p><dl> | |
| 448 <dt><i>frame</i></dt> | |
| 449 <dd> | |
| 450 The current stack frame. | |
| 451 </dd><dt><i>event</i></dt> | |
| 452 <dd> | |
| 453 The trace event (string) | |
| 454 </dd><dt><i>arg</i></dt> | |
| 455 <dd> | |
| 456 The arguments | |
| 457 </dd> | |
| 458 </dl><a NAME="DebugBase.setRecursionDepth" ID="DebugBase.setRecursionDepth"></a> | |
| 459 <h4>DebugBase.setRecursionDepth</h4> | |
| 460 <b>setRecursionDepth</b>(<i>frame</i>) | |
| 461 <p> | |
| 462 Public method to determine the current recursion depth. | |
| 463 </p><dl> | |
| 464 <dt><i>frame</i></dt> | |
| 465 <dd> | |
| 466 The current stack frame. | |
| 467 </dd> | |
| 468 </dl><a NAME="DebugBase.set_continue" ID="DebugBase.set_continue"></a> | |
| 469 <h4>DebugBase.set_continue</h4> | |
| 470 <b>set_continue</b>(<i>special</i>) | |
| 471 <p> | |
| 472 Reimplemented from bdb.py to always get informed of exceptions. | |
| 473 </p><dl> | |
| 474 <dt><i>special</i></dt> | |
| 475 <dd> | |
| 476 flag indicating a special continue operation | |
| 477 </dd> | |
| 478 </dl><a NAME="DebugBase.set_quit" ID="DebugBase.set_quit"></a> | |
| 479 <h4>DebugBase.set_quit</h4> | |
| 480 <b>set_quit</b>(<i></i>) | |
| 481 <p> | |
| 482 Public method to quit. | |
| 483 </p><p> | |
| 484 It wraps call to bdb to clear the current frame properly. | |
| 485 </p><a NAME="DebugBase.set_trace" ID="DebugBase.set_trace"></a> | |
| 486 <h4>DebugBase.set_trace</h4> | |
| 487 <b>set_trace</b>(<i>frame = None</i>) | |
| 488 <p> | |
| 489 Overridden method of bdb.py to do some special setup. | |
| 490 </p><dl> | |
| 491 <dt><i>frame</i></dt> | |
| 492 <dd> | |
| 493 frame to start debugging from | |
| 494 </dd> | |
| 495 </dl><a NAME="DebugBase.set_watch" ID="DebugBase.set_watch"></a> | |
| 496 <h4>DebugBase.set_watch</h4> | |
| 497 <b>set_watch</b>(<i>cond, temporary=0</i>) | |
| 498 <p> | |
| 499 Public method to set a watch expression. | |
| 500 </p><dl> | |
| 501 <dt><i>cond</i></dt> | |
| 502 <dd> | |
| 503 expression of the watch expression (string) | |
| 504 </dd><dt><i>temporary</i></dt> | |
| 505 <dd> | |
| 506 flag indicating a temporary watch expression (boolean) | |
| 507 </dd> | |
| 508 </dl><a NAME="DebugBase.step" ID="DebugBase.step"></a> | |
| 509 <h4>DebugBase.step</h4> | |
| 510 <b>step</b>(<i>traceMode</i>) | |
| 511 <p> | |
| 512 Public method to perform a step operation in this thread. | |
| 513 </p><dl> | |
| 514 <dt><i>traceMode</i></dt> | |
| 515 <dd> | |
| 516 If it is non-zero, then the step is a step into, | |
| 517 otherwise it is a step over. | |
| 518 </dd> | |
| 519 </dl><a NAME="DebugBase.stepOut" ID="DebugBase.stepOut"></a> | |
| 520 <h4>DebugBase.stepOut</h4> | |
| 521 <b>stepOut</b>(<i></i>) | |
| 522 <p> | |
| 523 Public method to perform a step out of the current call. | |
| 524 </p><a NAME="DebugBase.stop_here" ID="DebugBase.stop_here"></a> | |
| 525 <h4>DebugBase.stop_here</h4> | |
| 526 <b>stop_here</b>(<i>frame</i>) | |
| 527 <p> | |
| 528 Reimplemented to filter out debugger files. | |
| 529 </p><p> | |
| 530 Tracing is turned off for files that are part of the | |
| 531 debugger that are called from the application being debugged. | |
| 532 </p><dl> | |
| 533 <dt><i>frame</i></dt> | |
| 534 <dd> | |
| 535 the frame object | |
| 536 </dd> | |
| 537 </dl><dl> | |
| 538 <dt>Returns:</dt> | |
| 539 <dd> | |
| 540 flag indicating whether the debugger should stop here | |
| 541 </dd> | |
| 542 </dl><a NAME="DebugBase.trace_dispatch" ID="DebugBase.trace_dispatch"></a> | |
| 543 <h4>DebugBase.trace_dispatch</h4> | |
| 544 <b>trace_dispatch</b>(<i>frame, event, arg</i>) | |
| 545 <p> | |
| 546 Reimplemented from bdb.py to do some special things. | |
| 547 </p><p> | |
| 548 This specialty is to check the connection to the debug server | |
| 549 for new events (i.e. new breakpoints) while we are going through | |
| 550 the code. | |
| 551 </p><dl> | |
| 552 <dt><i>frame</i></dt> | |
| 553 <dd> | |
| 554 The current stack frame. | |
| 555 </dd><dt><i>event</i></dt> | |
| 556 <dd> | |
| 557 The trace event (string) | |
| 558 </dd><dt><i>arg</i></dt> | |
| 559 <dd> | |
| 560 The arguments | |
| 561 </dd> | |
| 562 </dl><dl> | |
| 563 <dt>Returns:</dt> | |
| 564 <dd> | |
| 565 local trace function | |
| 566 </dd> | |
| 567 </dl><a NAME="DebugBase.user_exception" ID="DebugBase.user_exception"></a> | |
| 568 <h4>DebugBase.user_exception</h4> | |
| 569 <b>user_exception</b>(<i>frame, (exctype, excval, exctb), unhandled=0</i>) | |
| 570 <p> | |
| 571 Reimplemented to report an exception to the debug server. | |
| 572 </p><dl> | |
| 573 <dt><i>frame</i></dt> | |
| 574 <dd> | |
| 575 the frame object | |
| 576 </dd><dt><i>exctype</i></dt> | |
| 577 <dd> | |
| 578 the type of the exception | |
| 579 </dd><dt><i>excval</i></dt> | |
| 580 <dd> | |
| 581 data about the exception | |
| 582 </dd><dt><i>exctb</i></dt> | |
| 583 <dd> | |
| 584 traceback for the exception | |
| 585 </dd><dt><i>unhandled</i></dt> | |
| 586 <dd> | |
| 587 flag indicating an uncaught exception | |
| 588 </dd> | |
| 589 </dl><a NAME="DebugBase.user_line" ID="DebugBase.user_line"></a> | |
| 590 <h4>DebugBase.user_line</h4> | |
| 591 <b>user_line</b>(<i>frame</i>) | |
| 592 <p> | |
| 593 Reimplemented to handle the program about to execute a particular line. | |
| 594 </p><dl> | |
| 595 <dt><i>frame</i></dt> | |
| 596 <dd> | |
| 597 the frame object | |
| 598 </dd> | |
| 599 </dl><a NAME="DebugBase.user_return" ID="DebugBase.user_return"></a> | |
| 600 <h4>DebugBase.user_return</h4> | |
| 601 <b>user_return</b>(<i>frame, retval</i>) | |
| 602 <p> | |
| 603 Reimplemented to report program termination to the debug server. | |
| 604 </p><dl> | |
| 605 <dt><i>frame</i></dt> | |
| 606 <dd> | |
| 607 the frame object | |
| 608 </dd><dt><i>retval</i></dt> | |
| 609 <dd> | |
| 610 the return value of the program | |
| 611 </dd> | |
| 612 </dl> | |
| 613 <div align="right"><a href="#top">Up</a></div> | |
| 614 <hr /><hr /> | |
| 615 <a NAME="printerr" ID="printerr"></a> | |
| 616 <h2>printerr</h2> | |
| 617 <b>printerr</b>(<i>s</i>) | |
| 618 <p> | |
| 619 Module function used for debugging the debug client. | |
| 620 </p><dl> | |
| 621 <dt><i>s</i></dt> | |
| 622 <dd> | |
| 623 data to be printed | |
| 624 </dd> | |
| 625 </dl> | |
| 626 <div align="right"><a href="#top">Up</a></div> | |
| 627 <hr /><hr /> | |
| 628 <a NAME="setRecursionLimit" ID="setRecursionLimit"></a> | |
| 629 <h2>setRecursionLimit</h2> | |
| 630 <b>setRecursionLimit</b>(<i>limit</i>) | |
| 631 <p> | |
| 632 Module function to set the recursion limit. | |
| 633 </p><dl> | |
| 634 <dt><i>limit</i></dt> | |
| 635 <dd> | |
| 636 recursion limit (integer) | |
| 637 </dd> | |
| 638 </dl> | |
| 639 <div align="right"><a href="#top">Up</a></div> | |
| 640 <hr /> | |
| 641 </body></html> |
