src/eric7/Documentation/Source/eric7.DebugClients.Python.BreakpointWatch.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.DebugClients.Python.BreakpointWatch</h1> 9 <h1>eric7.DebugClients.Python.BreakpointWatch</h1>
10
11 <p> 10 <p>
12 Module implementing the breakpoint and watch class. 11 Module implementing the breakpoint and watch class.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#Breakpoint">Breakpoint</a></td> 22 <td><a href="#Breakpoint">Breakpoint</a></td>
25 <td>Breakpoint class.</td> 23 <td>Breakpoint class.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
28 <td><a href="#Watch">Watch</a></td> 26 <td><a href="#Watch">Watch</a></td>
29 <td>Watch class.</td> 27 <td>Watch class.</td>
30 </tr> 28 </tr>
31 </table> 29 </table>
30
32 <h3>Functions</h3> 31 <h3>Functions</h3>
33
34 <table> 32 <table>
35 <tr><td>None</td></tr> 33 <tr><td>None</td></tr>
36 </table> 34 </table>
35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="Breakpoint" ID="Breakpoint"></a> 38 <a NAME="Breakpoint" ID="Breakpoint"></a>
40 <h2>Breakpoint</h2> 39 <h2>Breakpoint</h2>
41
42 <p> 40 <p>
43 Breakpoint class. 41 Breakpoint class.
44 </p> 42 </p>
45 <p> 43 <p>
46 Implements temporary breakpoints, ignore counts, disabling and 44 Implements temporary breakpoints, ignore counts, disabling and
54 <p> 52 <p>
55 To test for a specific line in a file there is another dict breakInFile, 53 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 54 which is indexed only by filename and holds all line numbers where
57 breakpoints are. 55 breakpoints are.
58 </p> 56 </p>
57
59 <h3>Derived from</h3> 58 <h3>Derived from</h3>
60 None 59 None
61 <h3>Class Attributes</h3> 60 <h3>Class Attributes</h3>
62 61 <table>
63 <table> 62 <tr><td>breakInFile</td></tr>
64 <tr><td>breakInFile</td></tr><tr><td>breakInFrameCache</td></tr><tr><td>breaks</td></tr> 63 <tr><td>breakInFrameCache</td></tr>
65 </table> 64 <tr><td>breaks</td></tr>
65 </table>
66
66 <h3>Class Methods</h3> 67 <h3>Class Methods</h3>
67
68 <table> 68 <table>
69 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
70 </table> 70 </table>
71
71 <h3>Methods</h3> 72 <h3>Methods</h3>
72 73 <table>
73 <table>
74
75 <tr> 74 <tr>
76 <td><a href="#Breakpoint.__init__">Breakpoint</a></td> 75 <td><a href="#Breakpoint.__init__">Breakpoint</a></td>
77 <td>Constructor</td> 76 <td>Constructor</td>
78 </tr> 77 </tr>
79 <tr> 78 <tr>
87 <tr> 86 <tr>
88 <td><a href="#Breakpoint.enable">enable</a></td> 87 <td><a href="#Breakpoint.enable">enable</a></td>
89 <td>Public method to enable this breakpoint.</td> 88 <td>Public method to enable this breakpoint.</td>
90 </tr> 89 </tr>
91 </table> 90 </table>
91
92 <h3>Static Methods</h3> 92 <h3>Static Methods</h3>
93 93 <table>
94 <table>
95
96 <tr> 94 <tr>
97 <td><a href="#Breakpoint.clear_all_breaks">clear_all_breaks</a></td> 95 <td><a href="#Breakpoint.clear_all_breaks">clear_all_breaks</a></td>
98 <td>Static method to clear all breakpoints.</td> 96 <td>Static method to clear all breakpoints.</td>
99 </tr> 97 </tr>
100 <tr> 98 <tr>
108 <tr> 106 <tr>
109 <td><a href="#Breakpoint.get_break">get_break</a></td> 107 <td><a href="#Breakpoint.get_break">get_break</a></td>
110 <td>Static method to get the breakpoint of a particular line.</td> 108 <td>Static method to get the breakpoint of a particular line.</td>
111 </tr> 109 </tr>
112 </table> 110 </table>
111
113 112
114 <a NAME="Breakpoint.__init__" ID="Breakpoint.__init__"></a> 113 <a NAME="Breakpoint.__init__" ID="Breakpoint.__init__"></a>
115 <h4>Breakpoint (Constructor)</h4> 114 <h4>Breakpoint (Constructor)</h4>
116 <b>Breakpoint</b>(<i>filename, lineno, temporary=False, cond=None</i>) 115 <b>Breakpoint</b>(<i>filename, lineno, temporary=False, cond=None</i>)
117
118 <p> 116 <p>
119 Constructor 117 Constructor
120 </p> 118 </p>
119
121 <dl> 120 <dl>
122 121
123 <dt><i>filename</i> (str)</dt> 122 <dt><i>filename</i> (str)</dt>
124 <dd> 123 <dd>
125 file name where a breakpoint is set 124 file name where a breakpoint is set
138 </dd> 137 </dd>
139 </dl> 138 </dl>
140 <a NAME="Breakpoint.deleteMe" ID="Breakpoint.deleteMe"></a> 139 <a NAME="Breakpoint.deleteMe" ID="Breakpoint.deleteMe"></a>
141 <h4>Breakpoint.deleteMe</h4> 140 <h4>Breakpoint.deleteMe</h4>
142 <b>deleteMe</b>(<i></i>) 141 <b>deleteMe</b>(<i></i>)
143
144 <p> 142 <p>
145 Public method to clear this breakpoint. 143 Public method to clear this breakpoint.
146 </p> 144 </p>
145
147 <a NAME="Breakpoint.disable" ID="Breakpoint.disable"></a> 146 <a NAME="Breakpoint.disable" ID="Breakpoint.disable"></a>
148 <h4>Breakpoint.disable</h4> 147 <h4>Breakpoint.disable</h4>
149 <b>disable</b>(<i></i>) 148 <b>disable</b>(<i></i>)
150
151 <p> 149 <p>
152 Public method to disable this breakpoint. 150 Public method to disable this breakpoint.
153 </p> 151 </p>
152
154 <a NAME="Breakpoint.enable" ID="Breakpoint.enable"></a> 153 <a NAME="Breakpoint.enable" ID="Breakpoint.enable"></a>
155 <h4>Breakpoint.enable</h4> 154 <h4>Breakpoint.enable</h4>
156 <b>enable</b>(<i></i>) 155 <b>enable</b>(<i></i>)
157
158 <p> 156 <p>
159 Public method to enable this breakpoint. 157 Public method to enable this breakpoint.
160 </p> 158 </p>
159
161 <a NAME="Breakpoint.clear_all_breaks" ID="Breakpoint.clear_all_breaks"></a> 160 <a NAME="Breakpoint.clear_all_breaks" ID="Breakpoint.clear_all_breaks"></a>
162 <h4>Breakpoint.clear_all_breaks (static)</h4> 161 <h4>Breakpoint.clear_all_breaks (static)</h4>
163 <b>clear_all_breaks</b>(<i></i>) 162 <b>clear_all_breaks</b>(<i></i>)
164
165 <p> 163 <p>
166 Static method to clear all breakpoints. 164 Static method to clear all breakpoints.
167 </p> 165 </p>
166
168 <a NAME="Breakpoint.clear_break" ID="Breakpoint.clear_break"></a> 167 <a NAME="Breakpoint.clear_break" ID="Breakpoint.clear_break"></a>
169 <h4>Breakpoint.clear_break (static)</h4> 168 <h4>Breakpoint.clear_break (static)</h4>
170 <b>clear_break</b>(<i>lineno</i>) 169 <b>clear_break</b>(<i>lineno</i>)
171
172 <p> 170 <p>
173 Static method reimplemented from bdb.py to clear a breakpoint. 171 Static method reimplemented from bdb.py to clear a breakpoint.
174 </p> 172 </p>
173
175 <dl> 174 <dl>
176 175
177 <dt><i>filename</i> (str)</dt> 176 <dt><i>filename</i> (str)</dt>
178 <dd> 177 <dd>
179 file name of the bp to retrieve 178 file name of the bp to retrieve
184 </dd> 183 </dd>
185 </dl> 184 </dl>
186 <a NAME="Breakpoint.effectiveBreak" ID="Breakpoint.effectiveBreak"></a> 185 <a NAME="Breakpoint.effectiveBreak" ID="Breakpoint.effectiveBreak"></a>
187 <h4>Breakpoint.effectiveBreak (static)</h4> 186 <h4>Breakpoint.effectiveBreak (static)</h4>
188 <b>effectiveBreak</b>(<i>lineno, frame</i>) 187 <b>effectiveBreak</b>(<i>lineno, frame</i>)
189
190 <p> 188 <p>
191 Static method to determine which breakpoint for this filename:lineno 189 Static method to determine which breakpoint for this filename:lineno
192 is to be acted upon. 190 is to be acted upon.
193 </p> 191 </p>
194 <p> 192 <p>
195 Called only if we know there is a bpt at this 193 Called only if we know there is a bpt at this
196 location. Returns breakpoint that was triggered and a flag 194 location. Returns breakpoint that was triggered and a flag
197 that indicates if it is ok to delete a temporary bp. 195 that indicates if it is ok to delete a temporary bp.
198 </p> 196 </p>
197
199 <dl> 198 <dl>
200 199
201 <dt><i>filename</i> (str)</dt> 200 <dt><i>filename</i> (str)</dt>
202 <dd> 201 <dd>
203 file name of the bp to retrieve 202 file name of the bp to retrieve
225 </dd> 224 </dd>
226 </dl> 225 </dl>
227 <a NAME="Breakpoint.get_break" ID="Breakpoint.get_break"></a> 226 <a NAME="Breakpoint.get_break" ID="Breakpoint.get_break"></a>
228 <h4>Breakpoint.get_break (static)</h4> 227 <h4>Breakpoint.get_break (static)</h4>
229 <b>get_break</b>(<i>lineno</i>) 228 <b>get_break</b>(<i>lineno</i>)
230
231 <p> 229 <p>
232 Static method to get the breakpoint of a particular line. 230 Static method to get the breakpoint of a particular line.
233 </p> 231 </p>
234 <p> 232 <p>
235 Because eric supports only one breakpoint per line, this 233 Because eric supports only one breakpoint per line, this
236 method will return only one breakpoint. 234 method will return only one breakpoint.
237 </p> 235 </p>
236
238 <dl> 237 <dl>
239 238
240 <dt><i>filename</i> (str)</dt> 239 <dt><i>filename</i> (str)</dt>
241 <dd> 240 <dd>
242 file name of the bp to retrieve 241 file name of the bp to retrieve
261 <div align="right"><a href="#top">Up</a></div> 260 <div align="right"><a href="#top">Up</a></div>
262 <hr /> 261 <hr />
263 <hr /> 262 <hr />
264 <a NAME="Watch" ID="Watch"></a> 263 <a NAME="Watch" ID="Watch"></a>
265 <h2>Watch</h2> 264 <h2>Watch</h2>
266
267 <p> 265 <p>
268 Watch class. 266 Watch class.
269 </p> 267 </p>
270 <p> 268 <p>
271 Implements temporary watches, ignore counts, disabling and 269 Implements temporary watches, ignore counts, disabling and
272 (re)-enabling, and conditionals. 270 (re)-enabling, and conditionals.
273 </p> 271 </p>
272
274 <h3>Derived from</h3> 273 <h3>Derived from</h3>
275 None 274 None
276 <h3>Class Attributes</h3> 275 <h3>Class Attributes</h3>
277
278 <table> 276 <table>
279 <tr><td>watches</td></tr> 277 <tr><td>watches</td></tr>
280 </table> 278 </table>
279
281 <h3>Class Methods</h3> 280 <h3>Class Methods</h3>
282
283 <table> 281 <table>
284 <tr><td>None</td></tr> 282 <tr><td>None</td></tr>
285 </table> 283 </table>
284
286 <h3>Methods</h3> 285 <h3>Methods</h3>
287 286 <table>
288 <table>
289
290 <tr> 287 <tr>
291 <td><a href="#Watch.__init__">Watch</a></td> 288 <td><a href="#Watch.__init__">Watch</a></td>
292 <td>Constructor</td> 289 <td>Constructor</td>
293 </tr> 290 </tr>
294 <tr> 291 <tr>
302 <tr> 299 <tr>
303 <td><a href="#Watch.enable">enable</a></td> 300 <td><a href="#Watch.enable">enable</a></td>
304 <td>Public method to enable this watch.</td> 301 <td>Public method to enable this watch.</td>
305 </tr> 302 </tr>
306 </table> 303 </table>
304
307 <h3>Static Methods</h3> 305 <h3>Static Methods</h3>
308 306 <table>
309 <table>
310
311 <tr> 307 <tr>
312 <td><a href="#Watch.clear_all_watches">clear_all_watches</a></td> 308 <td><a href="#Watch.clear_all_watches">clear_all_watches</a></td>
313 <td>Static method to clear all watch expressions.</td> 309 <td>Static method to clear all watch expressions.</td>
314 </tr> 310 </tr>
315 <tr> 311 <tr>
323 <tr> 319 <tr>
324 <td><a href="#Watch.get_watch">get_watch</a></td> 320 <td><a href="#Watch.get_watch">get_watch</a></td>
325 <td>Static method to get a watch expression.</td> 321 <td>Static method to get a watch expression.</td>
326 </tr> 322 </tr>
327 </table> 323 </table>
324
328 325
329 <a NAME="Watch.__init__" ID="Watch.__init__"></a> 326 <a NAME="Watch.__init__" ID="Watch.__init__"></a>
330 <h4>Watch (Constructor)</h4> 327 <h4>Watch (Constructor)</h4>
331 <b>Watch</b>(<i>cond, compiledCond, flag, temporary=False</i>) 328 <b>Watch</b>(<i>cond, compiledCond, flag, temporary=False</i>)
332
333 <p> 329 <p>
334 Constructor 330 Constructor
335 </p> 331 </p>
332
336 <dl> 333 <dl>
337 334
338 <dt><i>cond</i> (str)</dt> 335 <dt><i>cond</i> (str)</dt>
339 <dd> 336 <dd>
340 condition as string with flag 337 condition as string with flag
353 </dd> 350 </dd>
354 </dl> 351 </dl>
355 <a NAME="Watch.deleteMe" ID="Watch.deleteMe"></a> 352 <a NAME="Watch.deleteMe" ID="Watch.deleteMe"></a>
356 <h4>Watch.deleteMe</h4> 353 <h4>Watch.deleteMe</h4>
357 <b>deleteMe</b>(<i></i>) 354 <b>deleteMe</b>(<i></i>)
358
359 <p> 355 <p>
360 Public method to clear this watch expression. 356 Public method to clear this watch expression.
361 </p> 357 </p>
358
362 <a NAME="Watch.disable" ID="Watch.disable"></a> 359 <a NAME="Watch.disable" ID="Watch.disable"></a>
363 <h4>Watch.disable</h4> 360 <h4>Watch.disable</h4>
364 <b>disable</b>(<i></i>) 361 <b>disable</b>(<i></i>)
365
366 <p> 362 <p>
367 Public method to disable this watch. 363 Public method to disable this watch.
368 </p> 364 </p>
365
369 <a NAME="Watch.enable" ID="Watch.enable"></a> 366 <a NAME="Watch.enable" ID="Watch.enable"></a>
370 <h4>Watch.enable</h4> 367 <h4>Watch.enable</h4>
371 <b>enable</b>(<i></i>) 368 <b>enable</b>(<i></i>)
372
373 <p> 369 <p>
374 Public method to enable this watch. 370 Public method to enable this watch.
375 </p> 371 </p>
372
376 <a NAME="Watch.clear_all_watches" ID="Watch.clear_all_watches"></a> 373 <a NAME="Watch.clear_all_watches" ID="Watch.clear_all_watches"></a>
377 <h4>Watch.clear_all_watches (static)</h4> 374 <h4>Watch.clear_all_watches (static)</h4>
378 <b>clear_all_watches</b>(<i></i>) 375 <b>clear_all_watches</b>(<i></i>)
379
380 <p> 376 <p>
381 Static method to clear all watch expressions. 377 Static method to clear all watch expressions.
382 </p> 378 </p>
379
383 <a NAME="Watch.clear_watch" ID="Watch.clear_watch"></a> 380 <a NAME="Watch.clear_watch" ID="Watch.clear_watch"></a>
384 <h4>Watch.clear_watch (static)</h4> 381 <h4>Watch.clear_watch (static)</h4>
385 <b>clear_watch</b>(<i></i>) 382 <b>clear_watch</b>(<i></i>)
386
387 <p> 383 <p>
388 Static method to clear a watch expression. 384 Static method to clear a watch expression.
389 </p> 385 </p>
386
390 <dl> 387 <dl>
391 388
392 <dt><i>cond</i> (str)</dt> 389 <dt><i>cond</i> (str)</dt>
393 <dd> 390 <dd>
394 expression of the watch expression to be cleared 391 expression of the watch expression to be cleared
395 </dd> 392 </dd>
396 </dl> 393 </dl>
397 <a NAME="Watch.effectiveWatch" ID="Watch.effectiveWatch"></a> 394 <a NAME="Watch.effectiveWatch" ID="Watch.effectiveWatch"></a>
398 <h4>Watch.effectiveWatch (static)</h4> 395 <h4>Watch.effectiveWatch (static)</h4>
399 <b>effectiveWatch</b>(<i></i>) 396 <b>effectiveWatch</b>(<i></i>)
400
401 <p> 397 <p>
402 Static method to determine, if a watch expression is effective. 398 Static method to determine, if a watch expression is effective.
403 </p> 399 </p>
400
404 <dl> 401 <dl>
405 402
406 <dt><i>frame</i> (frame object)</dt> 403 <dt><i>frame</i> (frame object)</dt>
407 <dd> 404 <dd>
408 the current execution frame 405 the current execution frame
422 </dd> 419 </dd>
423 </dl> 420 </dl>
424 <a NAME="Watch.get_watch" ID="Watch.get_watch"></a> 421 <a NAME="Watch.get_watch" ID="Watch.get_watch"></a>
425 <h4>Watch.get_watch (static)</h4> 422 <h4>Watch.get_watch (static)</h4>
426 <b>get_watch</b>(<i></i>) 423 <b>get_watch</b>(<i></i>)
427
428 <p> 424 <p>
429 Static method to get a watch expression. 425 Static method to get a watch expression.
430 </p> 426 </p>
427
431 <dl> 428 <dl>
432 429
433 <dt><i>cond</i> (str)</dt> 430 <dt><i>cond</i> (str)</dt>
434 <dd> 431 <dd>
435 expression of the watch expression to be cleared 432 expression of the watch expression to be cleared

eric ide

mercurial