Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric4.Debugger.DebuggerInterfacePython.html

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

Mercurial Repository: eric

eric ide

mercurial