Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Debugger.DebuggerInterfacePython.html

Documentation/Source/eric6.Debugger.DebuggerInterfacePython.html

changeset 5141
bc64243b7672
parent 5126
d28b92dabc2b
parent 5140
01484c0afbc6
child 5144
1ab536d25072
equal deleted inserted replaced
5126:d28b92dabc2b 5141:bc64243b7672
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Debugger.DebuggerInterfacePython</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.Debugger.DebuggerInterfacePython</h1>
23 <p>
24 Module implementing the Python debugger interface for the debug server.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>ClientDefaultCapabilities</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#DebuggerInterfacePython">DebuggerInterfacePython</a></td>
34 <td>Class implementing the Python debugger interface for the debug server.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr>
40 <td><a href="#createDebuggerInterfacePython">createDebuggerInterfacePython</a></td>
41 <td>Module function to create a debugger interface instance.</td>
42 </tr><tr>
43 <td><a href="#getRegistryData">getRegistryData</a></td>
44 <td>Module function to get characterizing data for the debugger interface.</td>
45 </tr>
46 </table>
47 <hr /><hr />
48 <a NAME="DebuggerInterfacePython" ID="DebuggerInterfacePython"></a>
49 <h2>DebuggerInterfacePython</h2>
50 <p>
51 Class implementing the Python debugger interface for the debug server.
52 </p>
53 <h3>Derived from</h3>
54 QObject
55 <h3>Class Attributes</h3>
56 <table>
57 <tr><td>None</td></tr>
58 </table>
59 <h3>Class Methods</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Methods</h3>
64 <table>
65 <tr>
66 <td><a href="#DebuggerInterfacePython.__init__">DebuggerInterfacePython</a></td>
67 <td>Constructor</td>
68 </tr><tr>
69 <td><a href="#DebuggerInterfacePython.__askForkTo">__askForkTo</a></td>
70 <td>Private method to ask the user which branch of a fork to follow.</td>
71 </tr><tr>
72 <td><a href="#DebuggerInterfacePython.__identityTranslation">__identityTranslation</a></td>
73 <td>Private method to perform the identity path translation.</td>
74 </tr><tr>
75 <td><a href="#DebuggerInterfacePython.__parseClientLine">__parseClientLine</a></td>
76 <td>Private method to handle data from the client.</td>
77 </tr><tr>
78 <td><a href="#DebuggerInterfacePython.__remoteTranslation">__remoteTranslation</a></td>
79 <td>Private method to perform the path translation.</td>
80 </tr><tr>
81 <td><a href="#DebuggerInterfacePython.__sendCommand">__sendCommand</a></td>
82 <td>Private method to send a single line command to the client.</td>
83 </tr><tr>
84 <td><a href="#DebuggerInterfacePython.__startProcess">__startProcess</a></td>
85 <td>Private method to start the debugger client process.</td>
86 </tr><tr>
87 <td><a href="#DebuggerInterfacePython.flush">flush</a></td>
88 <td>Public slot to flush the queue.</td>
89 </tr><tr>
90 <td><a href="#DebuggerInterfacePython.getClientCapabilities">getClientCapabilities</a></td>
91 <td>Public method to retrieve the debug clients capabilities.</td>
92 </tr><tr>
93 <td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td>
94 <td>Public method to test, if a debug client has connected.</td>
95 </tr><tr>
96 <td><a href="#DebuggerInterfacePython.newConnection">newConnection</a></td>
97 <td>Public slot to handle a new connection.</td>
98 </tr><tr>
99 <td><a href="#DebuggerInterfacePython.remoteBanner">remoteBanner</a></td>
100 <td>Public slot to get the banner info of the remote client.</td>
101 </tr><tr>
102 <td><a href="#DebuggerInterfacePython.remoteBreakpoint">remoteBreakpoint</a></td>
103 <td>Public method to set or clear a breakpoint.</td>
104 </tr><tr>
105 <td><a href="#DebuggerInterfacePython.remoteBreakpointEnable">remoteBreakpointEnable</a></td>
106 <td>Public method to enable or disable a breakpoint.</td>
107 </tr><tr>
108 <td><a href="#DebuggerInterfacePython.remoteBreakpointIgnore">remoteBreakpointIgnore</a></td>
109 <td>Public method to ignore a breakpoint the next couple of occurrences.</td>
110 </tr><tr>
111 <td><a href="#DebuggerInterfacePython.remoteCapabilities">remoteCapabilities</a></td>
112 <td>Public slot to get the debug clients capabilities.</td>
113 </tr><tr>
114 <td><a href="#DebuggerInterfacePython.remoteClientSetFilter">remoteClientSetFilter</a></td>
115 <td>Public method to set a variables filter list.</td>
116 </tr><tr>
117 <td><a href="#DebuggerInterfacePython.remoteClientVariable">remoteClientVariable</a></td>
118 <td>Public method to request the variables of the debugged program.</td>
119 </tr><tr>
120 <td><a href="#DebuggerInterfacePython.remoteClientVariables">remoteClientVariables</a></td>
121 <td>Public method to request the variables of the debugged program.</td>
122 </tr><tr>
123 <td><a href="#DebuggerInterfacePython.remoteCompletion">remoteCompletion</a></td>
124 <td>Public slot to get the a list of possible commandline completions from the remote client.</td>
125 </tr><tr>
126 <td><a href="#DebuggerInterfacePython.remoteContinue">remoteContinue</a></td>
127 <td>Public method to continue the debugged program.</td>
128 </tr><tr>
129 <td><a href="#DebuggerInterfacePython.remoteCoverage">remoteCoverage</a></td>
130 <td>Public method to load a new program to collect coverage data.</td>
131 </tr><tr>
132 <td><a href="#DebuggerInterfacePython.remoteEnvironment">remoteEnvironment</a></td>
133 <td>Public method to set the environment for a program to debug, run, ...</td>
134 </tr><tr>
135 <td><a href="#DebuggerInterfacePython.remoteEval">remoteEval</a></td>
136 <td>Public method to evaluate arg in the current context of the debugged program.</td>
137 </tr><tr>
138 <td><a href="#DebuggerInterfacePython.remoteExec">remoteExec</a></td>
139 <td>Public method to execute stmt in the current context of the debugged program.</td>
140 </tr><tr>
141 <td><a href="#DebuggerInterfacePython.remoteLoad">remoteLoad</a></td>
142 <td>Public method to load a new program to debug.</td>
143 </tr><tr>
144 <td><a href="#DebuggerInterfacePython.remoteProfile">remoteProfile</a></td>
145 <td>Public method to load a new program to collect profiling data.</td>
146 </tr><tr>
147 <td><a href="#DebuggerInterfacePython.remoteRawInput">remoteRawInput</a></td>
148 <td>Public method to send the raw input to the debugged program.</td>
149 </tr><tr>
150 <td><a href="#DebuggerInterfacePython.remoteRun">remoteRun</a></td>
151 <td>Public method to load a new program to run.</td>
152 </tr><tr>
153 <td><a href="#DebuggerInterfacePython.remoteSetThread">remoteSetThread</a></td>
154 <td>Public method to request to set the given thread as current thread.</td>
155 </tr><tr>
156 <td><a href="#DebuggerInterfacePython.remoteStatement">remoteStatement</a></td>
157 <td>Public method to execute a Python statement.</td>
158 </tr><tr>
159 <td><a href="#DebuggerInterfacePython.remoteStep">remoteStep</a></td>
160 <td>Public method to single step the debugged program.</td>
161 </tr><tr>
162 <td><a href="#DebuggerInterfacePython.remoteStepOut">remoteStepOut</a></td>
163 <td>Public method to step out the debugged program.</td>
164 </tr><tr>
165 <td><a href="#DebuggerInterfacePython.remoteStepOver">remoteStepOver</a></td>
166 <td>Public method to step over the debugged program.</td>
167 </tr><tr>
168 <td><a href="#DebuggerInterfacePython.remoteStepQuit">remoteStepQuit</a></td>
169 <td>Public method to stop the debugged program.</td>
170 </tr><tr>
171 <td><a href="#DebuggerInterfacePython.remoteThreadList">remoteThreadList</a></td>
172 <td>Public method to request the list of threads from the client.</td>
173 </tr><tr>
174 <td><a href="#DebuggerInterfacePython.remoteUTPrepare">remoteUTPrepare</a></td>
175 <td>Public method to prepare a new unittest run.</td>
176 </tr><tr>
177 <td><a href="#DebuggerInterfacePython.remoteUTRun">remoteUTRun</a></td>
178 <td>Public method to start a unittest run.</td>
179 </tr><tr>
180 <td><a href="#DebuggerInterfacePython.remoteUTStop">remoteUTStop</a></td>
181 <td>Public method to stop a unittest run.</td>
182 </tr><tr>
183 <td><a href="#DebuggerInterfacePython.remoteWatchpoint">remoteWatchpoint</a></td>
184 <td>Public method to set or clear a watch expression.</td>
185 </tr><tr>
186 <td><a href="#DebuggerInterfacePython.remoteWatchpointEnable">remoteWatchpointEnable</a></td>
187 <td>Public method to enable or disable a watch expression.</td>
188 </tr><tr>
189 <td><a href="#DebuggerInterfacePython.remoteWatchpointIgnore">remoteWatchpointIgnore</a></td>
190 <td>Public method to ignore a watch expression the next couple of occurrences.</td>
191 </tr><tr>
192 <td><a href="#DebuggerInterfacePython.setCallTraceEnabled">setCallTraceEnabled</a></td>
193 <td>Public method to set the call trace state.</td>
194 </tr><tr>
195 <td><a href="#DebuggerInterfacePython.shutdown">shutdown</a></td>
196 <td>Public method to cleanly shut down.</td>
197 </tr><tr>
198 <td><a href="#DebuggerInterfacePython.startRemote">startRemote</a></td>
199 <td>Public method to start a remote Python interpreter.</td>
200 </tr><tr>
201 <td><a href="#DebuggerInterfacePython.startRemoteForProject">startRemoteForProject</a></td>
202 <td>Public method to start a remote Python interpreter for a project.</td>
203 </tr>
204 </table>
205 <h3>Static Methods</h3>
206 <table>
207 <tr><td>None</td></tr>
208 </table>
209 <a NAME="DebuggerInterfacePython.__init__" ID="DebuggerInterfacePython.__init__"></a>
210 <h4>DebuggerInterfacePython (Constructor)</h4>
211 <b>DebuggerInterfacePython</b>(<i>debugServer, passive</i>)
212 <p>
213 Constructor
214 </p><dl>
215 <dt><i>debugServer</i></dt>
216 <dd>
217 reference to the debug server (DebugServer)
218 </dd><dt><i>passive</i></dt>
219 <dd>
220 flag indicating passive connection mode (boolean)
221 </dd>
222 </dl><a NAME="DebuggerInterfacePython.__askForkTo" ID="DebuggerInterfacePython.__askForkTo"></a>
223 <h4>DebuggerInterfacePython.__askForkTo</h4>
224 <b>__askForkTo</b>(<i></i>)
225 <p>
226 Private method to ask the user which branch of a fork to follow.
227 </p><a NAME="DebuggerInterfacePython.__identityTranslation" ID="DebuggerInterfacePython.__identityTranslation"></a>
228 <h4>DebuggerInterfacePython.__identityTranslation</h4>
229 <b>__identityTranslation</b>(<i>fn, remote2local=True</i>)
230 <p>
231 Private method to perform the identity path translation.
232 </p><dl>
233 <dt><i>fn</i></dt>
234 <dd>
235 filename to be translated (string)
236 </dd><dt><i>remote2local</i></dt>
237 <dd>
238 flag indicating the direction of translation
239 (False = local to remote, True = remote to local [default])
240 </dd>
241 </dl><dl>
242 <dt>Returns:</dt>
243 <dd>
244 translated filename (string)
245 </dd>
246 </dl><a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a>
247 <h4>DebuggerInterfacePython.__parseClientLine</h4>
248 <b>__parseClientLine</b>(<i></i>)
249 <p>
250 Private method to handle data from the client.
251 </p><a NAME="DebuggerInterfacePython.__remoteTranslation" ID="DebuggerInterfacePython.__remoteTranslation"></a>
252 <h4>DebuggerInterfacePython.__remoteTranslation</h4>
253 <b>__remoteTranslation</b>(<i>fn, remote2local=True</i>)
254 <p>
255 Private method to perform the path translation.
256 </p><dl>
257 <dt><i>fn</i></dt>
258 <dd>
259 filename to be translated (string)
260 </dd><dt><i>remote2local</i></dt>
261 <dd>
262 flag indicating the direction of translation
263 (False = local to remote, True = remote to local [default])
264 </dd>
265 </dl><dl>
266 <dt>Returns:</dt>
267 <dd>
268 translated filename (string)
269 </dd>
270 </dl><a NAME="DebuggerInterfacePython.__sendCommand" ID="DebuggerInterfacePython.__sendCommand"></a>
271 <h4>DebuggerInterfacePython.__sendCommand</h4>
272 <b>__sendCommand</b>(<i>cmd</i>)
273 <p>
274 Private method to send a single line command to the client.
275 </p><dl>
276 <dt><i>cmd</i></dt>
277 <dd>
278 command to send to the debug client (string)
279 </dd>
280 </dl><a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a>
281 <h4>DebuggerInterfacePython.__startProcess</h4>
282 <b>__startProcess</b>(<i>program, arguments, environment=None</i>)
283 <p>
284 Private method to start the debugger client process.
285 </p><dl>
286 <dt><i>program</i></dt>
287 <dd>
288 name of the executable to start (string)
289 </dd><dt><i>arguments</i></dt>
290 <dd>
291 arguments to be passed to the program (list of string)
292 </dd><dt><i>environment</i></dt>
293 <dd>
294 dictionary of environment settings to pass
295 (dict of string)
296 </dd>
297 </dl><dl>
298 <dt>Returns:</dt>
299 <dd>
300 the process object (QProcess) or None
301 </dd>
302 </dl><a NAME="DebuggerInterfacePython.flush" ID="DebuggerInterfacePython.flush"></a>
303 <h4>DebuggerInterfacePython.flush</h4>
304 <b>flush</b>(<i></i>)
305 <p>
306 Public slot to flush the queue.
307 </p><a NAME="DebuggerInterfacePython.getClientCapabilities" ID="DebuggerInterfacePython.getClientCapabilities"></a>
308 <h4>DebuggerInterfacePython.getClientCapabilities</h4>
309 <b>getClientCapabilities</b>(<i></i>)
310 <p>
311 Public method to retrieve the debug clients capabilities.
312 </p><dl>
313 <dt>Returns:</dt>
314 <dd>
315 debug client capabilities (integer)
316 </dd>
317 </dl><a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a>
318 <h4>DebuggerInterfacePython.isConnected</h4>
319 <b>isConnected</b>(<i></i>)
320 <p>
321 Public method to test, if a debug client has connected.
322 </p><dl>
323 <dt>Returns:</dt>
324 <dd>
325 flag indicating the connection status (boolean)
326 </dd>
327 </dl><a NAME="DebuggerInterfacePython.newConnection" ID="DebuggerInterfacePython.newConnection"></a>
328 <h4>DebuggerInterfacePython.newConnection</h4>
329 <b>newConnection</b>(<i>sock</i>)
330 <p>
331 Public slot to handle a new connection.
332 </p><dl>
333 <dt><i>sock</i></dt>
334 <dd>
335 reference to the socket object (QTcpSocket)
336 </dd>
337 </dl><dl>
338 <dt>Returns:</dt>
339 <dd>
340 flag indicating success (boolean)
341 </dd>
342 </dl><a NAME="DebuggerInterfacePython.remoteBanner" ID="DebuggerInterfacePython.remoteBanner"></a>
343 <h4>DebuggerInterfacePython.remoteBanner</h4>
344 <b>remoteBanner</b>(<i></i>)
345 <p>
346 Public slot to get the banner info of the remote client.
347 </p><a NAME="DebuggerInterfacePython.remoteBreakpoint" ID="DebuggerInterfacePython.remoteBreakpoint"></a>
348 <h4>DebuggerInterfacePython.remoteBreakpoint</h4>
349 <b>remoteBreakpoint</b>(<i>fn, line, set, cond=None, temp=False</i>)
350 <p>
351 Public method to set or clear a breakpoint.
352 </p><dl>
353 <dt><i>fn</i></dt>
354 <dd>
355 filename the breakpoint belongs to (string)
356 </dd><dt><i>line</i></dt>
357 <dd>
358 linenumber of the breakpoint (int)
359 </dd><dt><i>set</i></dt>
360 <dd>
361 flag indicating setting or resetting a breakpoint (boolean)
362 </dd><dt><i>cond</i></dt>
363 <dd>
364 condition of the breakpoint (string)
365 </dd><dt><i>temp</i></dt>
366 <dd>
367 flag indicating a temporary breakpoint (boolean)
368 </dd>
369 </dl><a NAME="DebuggerInterfacePython.remoteBreakpointEnable" ID="DebuggerInterfacePython.remoteBreakpointEnable"></a>
370 <h4>DebuggerInterfacePython.remoteBreakpointEnable</h4>
371 <b>remoteBreakpointEnable</b>(<i>fn, line, enable</i>)
372 <p>
373 Public method to enable or disable a breakpoint.
374 </p><dl>
375 <dt><i>fn</i></dt>
376 <dd>
377 filename the breakpoint belongs to (string)
378 </dd><dt><i>line</i></dt>
379 <dd>
380 linenumber of the breakpoint (int)
381 </dd><dt><i>enable</i></dt>
382 <dd>
383 flag indicating enabling or disabling a breakpoint
384 (boolean)
385 </dd>
386 </dl><a NAME="DebuggerInterfacePython.remoteBreakpointIgnore" ID="DebuggerInterfacePython.remoteBreakpointIgnore"></a>
387 <h4>DebuggerInterfacePython.remoteBreakpointIgnore</h4>
388 <b>remoteBreakpointIgnore</b>(<i>fn, line, count</i>)
389 <p>
390 Public method to ignore a breakpoint the next couple of occurrences.
391 </p><dl>
392 <dt><i>fn</i></dt>
393 <dd>
394 filename the breakpoint belongs to (string)
395 </dd><dt><i>line</i></dt>
396 <dd>
397 linenumber of the breakpoint (int)
398 </dd><dt><i>count</i></dt>
399 <dd>
400 number of occurrences to ignore (int)
401 </dd>
402 </dl><a NAME="DebuggerInterfacePython.remoteCapabilities" ID="DebuggerInterfacePython.remoteCapabilities"></a>
403 <h4>DebuggerInterfacePython.remoteCapabilities</h4>
404 <b>remoteCapabilities</b>(<i></i>)
405 <p>
406 Public slot to get the debug clients capabilities.
407 </p><a NAME="DebuggerInterfacePython.remoteClientSetFilter" ID="DebuggerInterfacePython.remoteClientSetFilter"></a>
408 <h4>DebuggerInterfacePython.remoteClientSetFilter</h4>
409 <b>remoteClientSetFilter</b>(<i>scope, filter</i>)
410 <p>
411 Public method to set a variables filter list.
412 </p><dl>
413 <dt><i>scope</i></dt>
414 <dd>
415 the scope of the variables (0 = local, 1 = global)
416 </dd><dt><i>filter</i></dt>
417 <dd>
418 regexp string for variable names to filter out (string)
419 </dd>
420 </dl><a NAME="DebuggerInterfacePython.remoteClientVariable" ID="DebuggerInterfacePython.remoteClientVariable"></a>
421 <h4>DebuggerInterfacePython.remoteClientVariable</h4>
422 <b>remoteClientVariable</b>(<i>scope, filter, var, framenr=0</i>)
423 <p>
424 Public method to request the variables of the debugged program.
425 </p><dl>
426 <dt><i>scope</i></dt>
427 <dd>
428 the scope of the variables (0 = local, 1 = global)
429 </dd><dt><i>filter</i></dt>
430 <dd>
431 list of variable types to filter out (list of int)
432 </dd><dt><i>var</i></dt>
433 <dd>
434 list encoded name of variable to retrieve (string)
435 </dd><dt><i>framenr</i></dt>
436 <dd>
437 framenumber of the variables to retrieve (int)
438 </dd>
439 </dl><a NAME="DebuggerInterfacePython.remoteClientVariables" ID="DebuggerInterfacePython.remoteClientVariables"></a>
440 <h4>DebuggerInterfacePython.remoteClientVariables</h4>
441 <b>remoteClientVariables</b>(<i>scope, filter, framenr=0</i>)
442 <p>
443 Public method to request the variables of the debugged program.
444 </p><dl>
445 <dt><i>scope</i></dt>
446 <dd>
447 the scope of the variables (0 = local, 1 = global)
448 </dd><dt><i>filter</i></dt>
449 <dd>
450 list of variable types to filter out (list of int)
451 </dd><dt><i>framenr</i></dt>
452 <dd>
453 framenumber of the variables to retrieve (int)
454 </dd>
455 </dl><a NAME="DebuggerInterfacePython.remoteCompletion" ID="DebuggerInterfacePython.remoteCompletion"></a>
456 <h4>DebuggerInterfacePython.remoteCompletion</h4>
457 <b>remoteCompletion</b>(<i>text</i>)
458 <p>
459 Public slot to get the a list of possible commandline completions
460 from the remote client.
461 </p><dl>
462 <dt><i>text</i></dt>
463 <dd>
464 the text to be completed (string)
465 </dd>
466 </dl><a NAME="DebuggerInterfacePython.remoteContinue" ID="DebuggerInterfacePython.remoteContinue"></a>
467 <h4>DebuggerInterfacePython.remoteContinue</h4>
468 <b>remoteContinue</b>(<i>special=False</i>)
469 <p>
470 Public method to continue the debugged program.
471 </p><dl>
472 <dt><i>special</i></dt>
473 <dd>
474 flag indicating a special continue operation (boolean)
475 </dd>
476 </dl><a NAME="DebuggerInterfacePython.remoteCoverage" ID="DebuggerInterfacePython.remoteCoverage"></a>
477 <h4>DebuggerInterfacePython.remoteCoverage</h4>
478 <b>remoteCoverage</b>(<i>fn, argv, wd, erase=False</i>)
479 <p>
480 Public method to load a new program to collect coverage data.
481 </p><dl>
482 <dt><i>fn</i></dt>
483 <dd>
484 the filename to run (string)
485 </dd><dt><i>argv</i></dt>
486 <dd>
487 the commandline arguments to pass to the program (string)
488 </dd><dt><i>wd</i></dt>
489 <dd>
490 the working directory for the program (string)
491 </dd><dt><i>erase=</i></dt>
492 <dd>
493 flag indicating that coverage info should be
494 cleared first (boolean)
495 </dd>
496 </dl><a NAME="DebuggerInterfacePython.remoteEnvironment" ID="DebuggerInterfacePython.remoteEnvironment"></a>
497 <h4>DebuggerInterfacePython.remoteEnvironment</h4>
498 <b>remoteEnvironment</b>(<i>env</i>)
499 <p>
500 Public method to set the environment for a program to debug, run, ...
501 </p><dl>
502 <dt><i>env</i></dt>
503 <dd>
504 environment settings (dictionary)
505 </dd>
506 </dl><a NAME="DebuggerInterfacePython.remoteEval" ID="DebuggerInterfacePython.remoteEval"></a>
507 <h4>DebuggerInterfacePython.remoteEval</h4>
508 <b>remoteEval</b>(<i>arg</i>)
509 <p>
510 Public method to evaluate arg in the current context of the debugged
511 program.
512 </p><dl>
513 <dt><i>arg</i></dt>
514 <dd>
515 the arguments to evaluate (string)
516 </dd>
517 </dl><a NAME="DebuggerInterfacePython.remoteExec" ID="DebuggerInterfacePython.remoteExec"></a>
518 <h4>DebuggerInterfacePython.remoteExec</h4>
519 <b>remoteExec</b>(<i>stmt</i>)
520 <p>
521 Public method to execute stmt in the current context of the debugged
522 program.
523 </p><dl>
524 <dt><i>stmt</i></dt>
525 <dd>
526 statement to execute (string)
527 </dd>
528 </dl><a NAME="DebuggerInterfacePython.remoteLoad" ID="DebuggerInterfacePython.remoteLoad"></a>
529 <h4>DebuggerInterfacePython.remoteLoad</h4>
530 <b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter=False, autoContinue=True, autoFork=False, forkChild=False</i>)
531 <p>
532 Public method to load a new program to debug.
533 </p><dl>
534 <dt><i>fn</i></dt>
535 <dd>
536 the filename to debug (string)
537 </dd><dt><i>argv</i></dt>
538 <dd>
539 the commandline arguments to pass to the program (string)
540 </dd><dt><i>wd</i></dt>
541 <dd>
542 the working directory for the program (string)
543 </dd><dt><i>traceInterpreter=</i></dt>
544 <dd>
545 flag indicating if the interpreter library
546 should be traced as well (boolean)
547 </dd><dt><i>autoContinue=</i></dt>
548 <dd>
549 flag indicating, that the debugger should not
550 stop at the first executable line (boolean)
551 </dd><dt><i>autoFork=</i></dt>
552 <dd>
553 flag indicating the automatic fork mode (boolean)
554 </dd><dt><i>forkChild=</i></dt>
555 <dd>
556 flag indicating to debug the child after forking
557 (boolean)
558 </dd>
559 </dl><a NAME="DebuggerInterfacePython.remoteProfile" ID="DebuggerInterfacePython.remoteProfile"></a>
560 <h4>DebuggerInterfacePython.remoteProfile</h4>
561 <b>remoteProfile</b>(<i>fn, argv, wd, erase=False</i>)
562 <p>
563 Public method to load a new program to collect profiling data.
564 </p><dl>
565 <dt><i>fn</i></dt>
566 <dd>
567 the filename to run (string)
568 </dd><dt><i>argv</i></dt>
569 <dd>
570 the commandline arguments to pass to the program (string)
571 </dd><dt><i>wd</i></dt>
572 <dd>
573 the working directory for the program (string)
574 </dd><dt><i>erase=</i></dt>
575 <dd>
576 flag indicating that timing info should be cleared
577 first (boolean)
578 </dd>
579 </dl><a NAME="DebuggerInterfacePython.remoteRawInput" ID="DebuggerInterfacePython.remoteRawInput"></a>
580 <h4>DebuggerInterfacePython.remoteRawInput</h4>
581 <b>remoteRawInput</b>(<i>s</i>)
582 <p>
583 Public method to send the raw input to the debugged program.
584 </p><dl>
585 <dt><i>s</i></dt>
586 <dd>
587 the raw input (string)
588 </dd>
589 </dl><a NAME="DebuggerInterfacePython.remoteRun" ID="DebuggerInterfacePython.remoteRun"></a>
590 <h4>DebuggerInterfacePython.remoteRun</h4>
591 <b>remoteRun</b>(<i>fn, argv, wd, autoFork=False, forkChild=False</i>)
592 <p>
593 Public method to load a new program to run.
594 </p><dl>
595 <dt><i>fn</i></dt>
596 <dd>
597 the filename to run (string)
598 </dd><dt><i>argv</i></dt>
599 <dd>
600 the commandline arguments to pass to the program (string)
601 </dd><dt><i>wd</i></dt>
602 <dd>
603 the working directory for the program (string)
604 </dd><dt><i>autoFork=</i></dt>
605 <dd>
606 flag indicating the automatic fork mode (boolean)
607 </dd><dt><i>forkChild=</i></dt>
608 <dd>
609 flag indicating to debug the child after forking
610 (boolean)
611 </dd>
612 </dl><a NAME="DebuggerInterfacePython.remoteSetThread" ID="DebuggerInterfacePython.remoteSetThread"></a>
613 <h4>DebuggerInterfacePython.remoteSetThread</h4>
614 <b>remoteSetThread</b>(<i>tid</i>)
615 <p>
616 Public method to request to set the given thread as current thread.
617 </p><dl>
618 <dt><i>tid</i></dt>
619 <dd>
620 id of the thread (integer)
621 </dd>
622 </dl><a NAME="DebuggerInterfacePython.remoteStatement" ID="DebuggerInterfacePython.remoteStatement"></a>
623 <h4>DebuggerInterfacePython.remoteStatement</h4>
624 <b>remoteStatement</b>(<i>stmt</i>)
625 <p>
626 Public method to execute a Python statement.
627 </p><dl>
628 <dt><i>stmt</i></dt>
629 <dd>
630 the Python statement to execute (string). It
631 should not have a trailing newline.
632 </dd>
633 </dl><a NAME="DebuggerInterfacePython.remoteStep" ID="DebuggerInterfacePython.remoteStep"></a>
634 <h4>DebuggerInterfacePython.remoteStep</h4>
635 <b>remoteStep</b>(<i></i>)
636 <p>
637 Public method to single step the debugged program.
638 </p><a NAME="DebuggerInterfacePython.remoteStepOut" ID="DebuggerInterfacePython.remoteStepOut"></a>
639 <h4>DebuggerInterfacePython.remoteStepOut</h4>
640 <b>remoteStepOut</b>(<i></i>)
641 <p>
642 Public method to step out the debugged program.
643 </p><a NAME="DebuggerInterfacePython.remoteStepOver" ID="DebuggerInterfacePython.remoteStepOver"></a>
644 <h4>DebuggerInterfacePython.remoteStepOver</h4>
645 <b>remoteStepOver</b>(<i></i>)
646 <p>
647 Public method to step over the debugged program.
648 </p><a NAME="DebuggerInterfacePython.remoteStepQuit" ID="DebuggerInterfacePython.remoteStepQuit"></a>
649 <h4>DebuggerInterfacePython.remoteStepQuit</h4>
650 <b>remoteStepQuit</b>(<i></i>)
651 <p>
652 Public method to stop the debugged program.
653 </p><a NAME="DebuggerInterfacePython.remoteThreadList" ID="DebuggerInterfacePython.remoteThreadList"></a>
654 <h4>DebuggerInterfacePython.remoteThreadList</h4>
655 <b>remoteThreadList</b>(<i></i>)
656 <p>
657 Public method to request the list of threads from the client.
658 </p><a NAME="DebuggerInterfacePython.remoteUTPrepare" ID="DebuggerInterfacePython.remoteUTPrepare"></a>
659 <h4>DebuggerInterfacePython.remoteUTPrepare</h4>
660 <b>remoteUTPrepare</b>(<i>fn, tn, tfn, failed, cov, covname, coverase</i>)
661 <p>
662 Public method to prepare a new unittest run.
663 </p><dl>
664 <dt><i>fn</i></dt>
665 <dd>
666 the filename to load (string)
667 </dd><dt><i>tn</i></dt>
668 <dd>
669 the testname to load (string)
670 </dd><dt><i>tfn</i></dt>
671 <dd>
672 the test function name to load tests from (string)
673 </dd><dt><i>failed</i></dt>
674 <dd>
675 list of failed test, if only failed test should be run
676 (list of strings)
677 </dd><dt><i>cov</i></dt>
678 <dd>
679 flag indicating collection of coverage data is requested
680 (boolean)
681 </dd><dt><i>covname</i></dt>
682 <dd>
683 filename to be used to assemble the coverage caches
684 filename (string)
685 </dd><dt><i>coverase</i></dt>
686 <dd>
687 flag indicating erasure of coverage data is requested
688 (boolean)
689 </dd>
690 </dl><a NAME="DebuggerInterfacePython.remoteUTRun" ID="DebuggerInterfacePython.remoteUTRun"></a>
691 <h4>DebuggerInterfacePython.remoteUTRun</h4>
692 <b>remoteUTRun</b>(<i></i>)
693 <p>
694 Public method to start a unittest run.
695 </p><a NAME="DebuggerInterfacePython.remoteUTStop" ID="DebuggerInterfacePython.remoteUTStop"></a>
696 <h4>DebuggerInterfacePython.remoteUTStop</h4>
697 <b>remoteUTStop</b>(<i></i>)
698 <p>
699 Public method to stop a unittest run.
700 </p><a NAME="DebuggerInterfacePython.remoteWatchpoint" ID="DebuggerInterfacePython.remoteWatchpoint"></a>
701 <h4>DebuggerInterfacePython.remoteWatchpoint</h4>
702 <b>remoteWatchpoint</b>(<i>cond, set, temp=False</i>)
703 <p>
704 Public method to set or clear a watch expression.
705 </p><dl>
706 <dt><i>cond</i></dt>
707 <dd>
708 expression of the watch expression (string)
709 </dd><dt><i>set</i></dt>
710 <dd>
711 flag indicating setting or resetting a watch expression
712 (boolean)
713 </dd><dt><i>temp</i></dt>
714 <dd>
715 flag indicating a temporary watch expression (boolean)
716 </dd>
717 </dl><a NAME="DebuggerInterfacePython.remoteWatchpointEnable" ID="DebuggerInterfacePython.remoteWatchpointEnable"></a>
718 <h4>DebuggerInterfacePython.remoteWatchpointEnable</h4>
719 <b>remoteWatchpointEnable</b>(<i>cond, enable</i>)
720 <p>
721 Public method to enable or disable a watch expression.
722 </p><dl>
723 <dt><i>cond</i></dt>
724 <dd>
725 expression of the watch expression (string)
726 </dd><dt><i>enable</i></dt>
727 <dd>
728 flag indicating enabling or disabling a watch expression
729 (boolean)
730 </dd>
731 </dl><a NAME="DebuggerInterfacePython.remoteWatchpointIgnore" ID="DebuggerInterfacePython.remoteWatchpointIgnore"></a>
732 <h4>DebuggerInterfacePython.remoteWatchpointIgnore</h4>
733 <b>remoteWatchpointIgnore</b>(<i>cond, count</i>)
734 <p>
735 Public method to ignore a watch expression the next couple of
736 occurrences.
737 </p><dl>
738 <dt><i>cond</i></dt>
739 <dd>
740 expression of the watch expression (string)
741 </dd><dt><i>count</i></dt>
742 <dd>
743 number of occurrences to ignore (int)
744 </dd>
745 </dl><a NAME="DebuggerInterfacePython.setCallTraceEnabled" ID="DebuggerInterfacePython.setCallTraceEnabled"></a>
746 <h4>DebuggerInterfacePython.setCallTraceEnabled</h4>
747 <b>setCallTraceEnabled</b>(<i>on</i>)
748 <p>
749 Public method to set the call trace state.
750 </p><dl>
751 <dt><i>on</i></dt>
752 <dd>
753 flag indicating to enable the call trace function (boolean)
754 </dd>
755 </dl><a NAME="DebuggerInterfacePython.shutdown" ID="DebuggerInterfacePython.shutdown"></a>
756 <h4>DebuggerInterfacePython.shutdown</h4>
757 <b>shutdown</b>(<i></i>)
758 <p>
759 Public method to cleanly shut down.
760 </p><p>
761 It closes our socket and shuts down
762 the debug client. (Needed on Win OS)
763 </p><a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a>
764 <h4>DebuggerInterfacePython.startRemote</h4>
765 <b>startRemote</b>(<i>port, runInConsole</i>)
766 <p>
767 Public method to start a remote Python interpreter.
768 </p><dl>
769 <dt><i>port</i></dt>
770 <dd>
771 portnumber the debug server is listening on (integer)
772 </dd><dt><i>runInConsole</i></dt>
773 <dd>
774 flag indicating to start the debugger in a
775 console window (boolean)
776 </dd>
777 </dl><dl>
778 <dt>Returns:</dt>
779 <dd>
780 client process object (QProcess), a flag to indicate
781 a network connection (boolean) and the name of the interpreter
782 in case of a local execution (string)
783 </dd>
784 </dl><a NAME="DebuggerInterfacePython.startRemoteForProject" ID="DebuggerInterfacePython.startRemoteForProject"></a>
785 <h4>DebuggerInterfacePython.startRemoteForProject</h4>
786 <b>startRemoteForProject</b>(<i>port, runInConsole</i>)
787 <p>
788 Public method to start a remote Python interpreter for a project.
789 </p><dl>
790 <dt><i>port</i></dt>
791 <dd>
792 portnumber the debug server is listening on (integer)
793 </dd><dt><i>runInConsole</i></dt>
794 <dd>
795 flag indicating to start the debugger in a
796 console window (boolean)
797 </dd>
798 </dl><dl>
799 <dt>Returns:</dt>
800 <dd>
801 client process object (QProcess), a flag to indicate
802 a network connection (boolean) and the name of the interpreter
803 in case of a local execution (string)
804 </dd>
805 </dl>
806 <div align="right"><a href="#top">Up</a></div>
807 <hr /><hr />
808 <a NAME="createDebuggerInterfacePython" ID="createDebuggerInterfacePython"></a>
809 <h2>createDebuggerInterfacePython</h2>
810 <b>createDebuggerInterfacePython</b>(<i>debugServer, passive</i>)
811 <p>
812 Module function to create a debugger interface instance.
813 </p><p>
814
815 </p><dl>
816 <dt><i>debugServer</i> (DebugServer)</dt>
817 <dd>
818 reference to the debug server
819 </dd><dt><i>passive</i> (bool)</dt>
820 <dd>
821 flag indicating passive connection mode
822 </dd>
823 </dl><dl>
824 <dt>Returns:</dt>
825 <dd>
826 instantiated debugger interface
827 </dd>
828 </dl><dl>
829 <dt>Return Type:</dt>
830 <dd>
831 DebuggerInterfacePython
832 </dd>
833 </dl>
834 <div align="right"><a href="#top">Up</a></div>
835 <hr /><hr />
836 <a NAME="getRegistryData" ID="getRegistryData"></a>
837 <h2>getRegistryData</h2>
838 <b>getRegistryData</b>(<i></i>)
839 <p>
840 Module function to get characterizing data for the debugger interface.
841 </p><dl>
842 <dt>Returns:</dt>
843 <dd>
844 tuple containing client type, client capabilities, client file
845 type associations and reference to creation function
846 </dd>
847 </dl><dl>
848 <dt>Return Type:</dt>
849 <dd>
850 tuple of (str, int, list of str, function)
851 </dd>
852 </dl>
853 <div align="right"><a href="#top">Up</a></div>
854 <hr />
855 </body></html>

Mercurial Repository: eric

eric ide

mercurial