Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.DebugClients.Python.BreakpointWatch.html

Documentation/Source/eric6.DebugClients.Python.BreakpointWatch.html

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

Mercurial Repository: eric

eric ide

mercurial