Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DebugClients.Python.BreakpointWatch.html
src/eric7/Documentation/Source/eric7.DebugClients.Python.BreakpointWatch.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.DebugClients.Python.BreakpointWatch</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.DebugClients.Python.BreakpointWatch</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the breakpoint and watch class. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#Breakpoint">Breakpoint</a></td> | |
| 25 <td>Breakpoint class.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#Watch">Watch</a></td> | |
| 29 <td>Watch class.</td> | |
| 30 </tr> | |
| 31 </table> | |
| 32 <h3>Functions</h3> | |
| 33 | |
| 34 <table> | |
| 35 <tr><td>None</td></tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="Breakpoint" ID="Breakpoint"></a> | |
| 40 <h2>Breakpoint</h2> | |
| 41 | |
| 42 <p> | |
| 43 Breakpoint class. | |
| 44 </p> | |
| 45 <p> | |
| 46 Implements temporary breakpoints, ignore counts, disabling and | |
| 47 (re)-enabling, and conditionals. | |
| 48 </p> | |
| 49 <p> | |
| 50 Breakpoints are indexed by the file,line tuple using breaks. It | |
| 51 points to a single Breakpoint instance. This is rather different to | |
| 52 the original bdb, since there may be more than one breakpoint per line. | |
| 53 </p> | |
| 54 <p> | |
| 55 To test for a specific line in a file there is another dict breakInFile, | |
| 56 which is indexed only by filename and holds all line numbers where | |
| 57 breakpoints are. | |
| 58 </p> | |
| 59 <h3>Derived from</h3> | |
| 60 None | |
| 61 <h3>Class Attributes</h3> | |
| 62 | |
| 63 <table> | |
| 64 <tr><td>breakInFile</td></tr><tr><td>breakInFrameCache</td></tr><tr><td>breaks</td></tr> | |
| 65 </table> | |
| 66 <h3>Class Methods</h3> | |
| 67 | |
| 68 <table> | |
| 69 <tr><td>None</td></tr> | |
| 70 </table> | |
| 71 <h3>Methods</h3> | |
| 72 | |
| 73 <table> | |
| 74 | |
| 75 <tr> | |
| 76 <td><a href="#Breakpoint.__init__">Breakpoint</a></td> | |
| 77 <td>Constructor</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#Breakpoint.deleteMe">deleteMe</a></td> | |
| 81 <td>Public method to clear this breakpoint.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#Breakpoint.disable">disable</a></td> | |
| 85 <td>Public method to disable this breakpoint.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#Breakpoint.enable">enable</a></td> | |
| 89 <td>Public method to enable this breakpoint.</td> | |
| 90 </tr> | |
| 91 </table> | |
| 92 <h3>Static Methods</h3> | |
| 93 | |
| 94 <table> | |
| 95 | |
| 96 <tr> | |
| 97 <td><a href="#Breakpoint.clear_all_breaks">clear_all_breaks</a></td> | |
| 98 <td>Static method to clear all breakpoints.</td> | |
| 99 </tr> | |
| 100 <tr> | |
| 101 <td><a href="#Breakpoint.clear_break">clear_break</a></td> | |
| 102 <td>Static method reimplemented from bdb.py to clear a breakpoint.</td> | |
| 103 </tr> | |
| 104 <tr> | |
| 105 <td><a href="#Breakpoint.effectiveBreak">effectiveBreak</a></td> | |
| 106 <td>Static method to determine which breakpoint for this filename:lineno is to be acted upon.</td> | |
| 107 </tr> | |
| 108 <tr> | |
| 109 <td><a href="#Breakpoint.get_break">get_break</a></td> | |
| 110 <td>Static method to get the breakpoint of a particular line.</td> | |
| 111 </tr> | |
| 112 </table> | |
| 113 | |
| 114 <a NAME="Breakpoint.__init__" ID="Breakpoint.__init__"></a> | |
| 115 <h4>Breakpoint (Constructor)</h4> | |
| 116 <b>Breakpoint</b>(<i>filename, lineno, temporary=False, cond=None</i>) | |
| 117 | |
| 118 <p> | |
| 119 Constructor | |
| 120 </p> | |
| 121 <dl> | |
| 122 | |
| 123 <dt><i>filename</i> (str)</dt> | |
| 124 <dd> | |
| 125 file name where a breakpoint is set | |
| 126 </dd> | |
| 127 <dt><i>lineno</i> (int)</dt> | |
| 128 <dd> | |
| 129 line number of the breakpoint | |
| 130 </dd> | |
| 131 <dt><i>temporary</i> (bool)</dt> | |
| 132 <dd> | |
| 133 flag to indicate a temporary breakpoint | |
| 134 </dd> | |
| 135 <dt><i>cond</i> (str)</dt> | |
| 136 <dd> | |
| 137 Python expression which dynamically enables this bp | |
| 138 </dd> | |
| 139 </dl> | |
| 140 <a NAME="Breakpoint.deleteMe" ID="Breakpoint.deleteMe"></a> | |
| 141 <h4>Breakpoint.deleteMe</h4> | |
| 142 <b>deleteMe</b>(<i></i>) | |
| 143 | |
| 144 <p> | |
| 145 Public method to clear this breakpoint. | |
| 146 </p> | |
| 147 <a NAME="Breakpoint.disable" ID="Breakpoint.disable"></a> | |
| 148 <h4>Breakpoint.disable</h4> | |
| 149 <b>disable</b>(<i></i>) | |
| 150 | |
| 151 <p> | |
| 152 Public method to disable this breakpoint. | |
| 153 </p> | |
| 154 <a NAME="Breakpoint.enable" ID="Breakpoint.enable"></a> | |
| 155 <h4>Breakpoint.enable</h4> | |
| 156 <b>enable</b>(<i></i>) | |
| 157 | |
| 158 <p> | |
| 159 Public method to enable this breakpoint. | |
| 160 </p> | |
| 161 <a NAME="Breakpoint.clear_all_breaks" ID="Breakpoint.clear_all_breaks"></a> | |
| 162 <h4>Breakpoint.clear_all_breaks (static)</h4> | |
| 163 <b>clear_all_breaks</b>(<i></i>) | |
| 164 | |
| 165 <p> | |
| 166 Static method to clear all breakpoints. | |
| 167 </p> | |
| 168 <a NAME="Breakpoint.clear_break" ID="Breakpoint.clear_break"></a> | |
| 169 <h4>Breakpoint.clear_break (static)</h4> | |
| 170 <b>clear_break</b>(<i>lineno</i>) | |
| 171 | |
| 172 <p> | |
| 173 Static method reimplemented from bdb.py to clear a breakpoint. | |
| 174 </p> | |
| 175 <dl> | |
| 176 | |
| 177 <dt><i>filename</i> (str)</dt> | |
| 178 <dd> | |
| 179 file name of the bp to retrieve | |
| 180 </dd> | |
| 181 <dt><i>lineno</i> (int)</dt> | |
| 182 <dd> | |
| 183 line number of the bp to retrieve | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <a NAME="Breakpoint.effectiveBreak" ID="Breakpoint.effectiveBreak"></a> | |
| 187 <h4>Breakpoint.effectiveBreak (static)</h4> | |
| 188 <b>effectiveBreak</b>(<i>lineno, frame</i>) | |
| 189 | |
| 190 <p> | |
| 191 Static method to determine which breakpoint for this filename:lineno | |
| 192 is to be acted upon. | |
| 193 </p> | |
| 194 <p> | |
| 195 Called only if we know there is a bpt at this | |
| 196 location. Returns breakpoint that was triggered and a flag | |
| 197 that indicates if it is ok to delete a temporary bp. | |
| 198 </p> | |
| 199 <dl> | |
| 200 | |
| 201 <dt><i>filename</i> (str)</dt> | |
| 202 <dd> | |
| 203 file name of the bp to retrieve | |
| 204 </dd> | |
| 205 <dt><i>lineno</i> (int)</dt> | |
| 206 <dd> | |
| 207 line number of the bp to retrieve | |
| 208 </dd> | |
| 209 <dt><i>frame</i> (frame object)</dt> | |
| 210 <dd> | |
| 211 the current execution frame | |
| 212 </dd> | |
| 213 </dl> | |
| 214 <dl> | |
| 215 <dt>Return:</dt> | |
| 216 <dd> | |
| 217 tuple of Breakpoint and a flag to indicate, that a | |
| 218 temporary breakpoint may be deleted | |
| 219 </dd> | |
| 220 </dl> | |
| 221 <dl> | |
| 222 <dt>Return Type:</dt> | |
| 223 <dd> | |
| 224 tuple of Breakpoint, bool | |
| 225 </dd> | |
| 226 </dl> | |
| 227 <a NAME="Breakpoint.get_break" ID="Breakpoint.get_break"></a> | |
| 228 <h4>Breakpoint.get_break (static)</h4> | |
| 229 <b>get_break</b>(<i>lineno</i>) | |
| 230 | |
| 231 <p> | |
| 232 Static method to get the breakpoint of a particular line. | |
| 233 </p> | |
| 234 <p> | |
| 235 Because eric supports only one breakpoint per line, this | |
| 236 method will return only one breakpoint. | |
| 237 </p> | |
| 238 <dl> | |
| 239 | |
| 240 <dt><i>filename</i> (str)</dt> | |
| 241 <dd> | |
| 242 file name of the bp to retrieve | |
| 243 </dd> | |
| 244 <dt><i>lineno</i> (int)</dt> | |
| 245 <dd> | |
| 246 line number of the bp to retrieve | |
| 247 </dd> | |
| 248 </dl> | |
| 249 <dl> | |
| 250 <dt>Return:</dt> | |
| 251 <dd> | |
| 252 Breakpoint or None, if there is no bp | |
| 253 </dd> | |
| 254 </dl> | |
| 255 <dl> | |
| 256 <dt>Return Type:</dt> | |
| 257 <dd> | |
| 258 Breakpoint object or None | |
| 259 </dd> | |
| 260 </dl> | |
| 261 <div align="right"><a href="#top">Up</a></div> | |
| 262 <hr /> | |
| 263 <hr /> | |
| 264 <a NAME="Watch" ID="Watch"></a> | |
| 265 <h2>Watch</h2> | |
| 266 | |
| 267 <p> | |
| 268 Watch class. | |
| 269 </p> | |
| 270 <p> | |
| 271 Implements temporary watches, ignore counts, disabling and | |
| 272 (re)-enabling, and conditionals. | |
| 273 </p> | |
| 274 <h3>Derived from</h3> | |
| 275 None | |
| 276 <h3>Class Attributes</h3> | |
| 277 | |
| 278 <table> | |
| 279 <tr><td>watches</td></tr> | |
| 280 </table> | |
| 281 <h3>Class Methods</h3> | |
| 282 | |
| 283 <table> | |
| 284 <tr><td>None</td></tr> | |
| 285 </table> | |
| 286 <h3>Methods</h3> | |
| 287 | |
| 288 <table> | |
| 289 | |
| 290 <tr> | |
| 291 <td><a href="#Watch.__init__">Watch</a></td> | |
| 292 <td>Constructor</td> | |
| 293 </tr> | |
| 294 <tr> | |
| 295 <td><a href="#Watch.deleteMe">deleteMe</a></td> | |
| 296 <td>Public method to clear this watch expression.</td> | |
| 297 </tr> | |
| 298 <tr> | |
| 299 <td><a href="#Watch.disable">disable</a></td> | |
| 300 <td>Public method to disable this watch.</td> | |
| 301 </tr> | |
| 302 <tr> | |
| 303 <td><a href="#Watch.enable">enable</a></td> | |
| 304 <td>Public method to enable this watch.</td> | |
| 305 </tr> | |
| 306 </table> | |
| 307 <h3>Static Methods</h3> | |
| 308 | |
| 309 <table> | |
| 310 | |
| 311 <tr> | |
| 312 <td><a href="#Watch.clear_all_watches">clear_all_watches</a></td> | |
| 313 <td>Static method to clear all watch expressions.</td> | |
| 314 </tr> | |
| 315 <tr> | |
| 316 <td><a href="#Watch.clear_watch">clear_watch</a></td> | |
| 317 <td>Static method to clear a watch expression.</td> | |
| 318 </tr> | |
| 319 <tr> | |
| 320 <td><a href="#Watch.effectiveWatch">effectiveWatch</a></td> | |
| 321 <td>Static method to determine, if a watch expression is effective.</td> | |
| 322 </tr> | |
| 323 <tr> | |
| 324 <td><a href="#Watch.get_watch">get_watch</a></td> | |
| 325 <td>Static method to get a watch expression.</td> | |
| 326 </tr> | |
| 327 </table> | |
| 328 | |
| 329 <a NAME="Watch.__init__" ID="Watch.__init__"></a> | |
| 330 <h4>Watch (Constructor)</h4> | |
| 331 <b>Watch</b>(<i>cond, compiledCond, flag, temporary=False</i>) | |
| 332 | |
| 333 <p> | |
| 334 Constructor | |
| 335 </p> | |
| 336 <dl> | |
| 337 | |
| 338 <dt><i>cond</i> (str)</dt> | |
| 339 <dd> | |
| 340 condition as string with flag | |
| 341 </dd> | |
| 342 <dt><i>compiledCond</i> (code object)</dt> | |
| 343 <dd> | |
| 344 precompiled condition | |
| 345 </dd> | |
| 346 <dt><i>flag</i> (str)</dt> | |
| 347 <dd> | |
| 348 indicates type of watch (created or changed) | |
| 349 </dd> | |
| 350 <dt><i>temporary</i> (bool)</dt> | |
| 351 <dd> | |
| 352 flag for temporary watches | |
| 353 </dd> | |
| 354 </dl> | |
| 355 <a NAME="Watch.deleteMe" ID="Watch.deleteMe"></a> | |
| 356 <h4>Watch.deleteMe</h4> | |
| 357 <b>deleteMe</b>(<i></i>) | |
| 358 | |
| 359 <p> | |
| 360 Public method to clear this watch expression. | |
| 361 </p> | |
| 362 <a NAME="Watch.disable" ID="Watch.disable"></a> | |
| 363 <h4>Watch.disable</h4> | |
| 364 <b>disable</b>(<i></i>) | |
| 365 | |
| 366 <p> | |
| 367 Public method to disable this watch. | |
| 368 </p> | |
| 369 <a NAME="Watch.enable" ID="Watch.enable"></a> | |
| 370 <h4>Watch.enable</h4> | |
| 371 <b>enable</b>(<i></i>) | |
| 372 | |
| 373 <p> | |
| 374 Public method to enable this watch. | |
| 375 </p> | |
| 376 <a NAME="Watch.clear_all_watches" ID="Watch.clear_all_watches"></a> | |
| 377 <h4>Watch.clear_all_watches (static)</h4> | |
| 378 <b>clear_all_watches</b>(<i></i>) | |
| 379 | |
| 380 <p> | |
| 381 Static method to clear all watch expressions. | |
| 382 </p> | |
| 383 <a NAME="Watch.clear_watch" ID="Watch.clear_watch"></a> | |
| 384 <h4>Watch.clear_watch (static)</h4> | |
| 385 <b>clear_watch</b>(<i></i>) | |
| 386 | |
| 387 <p> | |
| 388 Static method to clear a watch expression. | |
| 389 </p> | |
| 390 <dl> | |
| 391 | |
| 392 <dt><i>cond</i> (str)</dt> | |
| 393 <dd> | |
| 394 expression of the watch expression to be cleared | |
| 395 </dd> | |
| 396 </dl> | |
| 397 <a NAME="Watch.effectiveWatch" ID="Watch.effectiveWatch"></a> | |
| 398 <h4>Watch.effectiveWatch (static)</h4> | |
| 399 <b>effectiveWatch</b>(<i></i>) | |
| 400 | |
| 401 <p> | |
| 402 Static method to determine, if a watch expression is effective. | |
| 403 </p> | |
| 404 <dl> | |
| 405 | |
| 406 <dt><i>frame</i> (frame object)</dt> | |
| 407 <dd> | |
| 408 the current execution frame | |
| 409 </dd> | |
| 410 </dl> | |
| 411 <dl> | |
| 412 <dt>Return:</dt> | |
| 413 <dd> | |
| 414 tuple of watch expression and a flag to indicate, that a | |
| 415 temporary watch expression may be deleted | |
| 416 </dd> | |
| 417 </dl> | |
| 418 <dl> | |
| 419 <dt>Return Type:</dt> | |
| 420 <dd> | |
| 421 tuple of Watch, int | |
| 422 </dd> | |
| 423 </dl> | |
| 424 <a NAME="Watch.get_watch" ID="Watch.get_watch"></a> | |
| 425 <h4>Watch.get_watch (static)</h4> | |
| 426 <b>get_watch</b>(<i></i>) | |
| 427 | |
| 428 <p> | |
| 429 Static method to get a watch expression. | |
| 430 </p> | |
| 431 <dl> | |
| 432 | |
| 433 <dt><i>cond</i> (str)</dt> | |
| 434 <dd> | |
| 435 expression of the watch expression to be cleared | |
| 436 </dd> | |
| 437 </dl> | |
| 438 <dl> | |
| 439 <dt>Return:</dt> | |
| 440 <dd> | |
| 441 reference to the watch point | |
| 442 </dd> | |
| 443 </dl> | |
| 444 <dl> | |
| 445 <dt>Return Type:</dt> | |
| 446 <dd> | |
| 447 Watch or None | |
| 448 </dd> | |
| 449 </dl> | |
| 450 <div align="right"><a href="#top">Up</a></div> | |
| 451 <hr /> | |
| 452 </body></html> |
