Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.Debugger.DebuggerInterfacePython3.html

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

Mercurial Repository: eric

eric ide

mercurial