Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Debugger.DebuggerInterfacePython.html

src/eric7/Documentation/Source/eric7.Debugger.DebuggerInterfacePython.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9097
213951c41dcd
child 9236
db53a9efe7ef
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Debugger.DebuggerInterfacePython</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Debugger.DebuggerInterfacePython</h1>
10
11 <p>
12 Module implementing the Python3 debugger interface for the debug server.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>ClientDefaultCapabilities</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#DebuggerInterfacePython">DebuggerInterfacePython</a></td>
25 <td>Class implementing the debugger interface for the debug server for Python 3.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31
32 <tr>
33 <td><a href="#createDebuggerInterfacePython3">createDebuggerInterfacePython3</a></td>
34 <td>Module function to create a debugger interface instance.</td>
35 </tr>
36 <tr>
37 <td><a href="#getRegistryData">getRegistryData</a></td>
38 <td>Module function to get characterizing data for the supported debugger interfaces.</td>
39 </tr>
40 </table>
41 <hr />
42 <hr />
43 <a NAME="DebuggerInterfacePython" ID="DebuggerInterfacePython"></a>
44 <h2>DebuggerInterfacePython</h2>
45
46 <p>
47 Class implementing the debugger interface for the debug server for
48 Python 3.
49 </p>
50 <h3>Derived from</h3>
51 QObject
52 <h3>Class Attributes</h3>
53
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Class Methods</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Methods</h3>
63
64 <table>
65
66 <tr>
67 <td><a href="#DebuggerInterfacePython.__init__">DebuggerInterfacePython</a></td>
68 <td>Constructor</td>
69 </tr>
70 <tr>
71 <td><a href="#DebuggerInterfacePython.__assignDebuggerId">__assignDebuggerId</a></td>
72 <td>Private method to set the debugger id for a recent debugger connection attempt.</td>
73 </tr>
74 <tr>
75 <td><a href="#DebuggerInterfacePython.__flush">__flush</a></td>
76 <td>Private slot to flush the queue.</td>
77 </tr>
78 <tr>
79 <td><a href="#DebuggerInterfacePython.__handleJsonCommand">__handleJsonCommand</a></td>
80 <td>Private method to handle a command or response serialized as a JSON string.</td>
81 </tr>
82 <tr>
83 <td><a href="#DebuggerInterfacePython.__identityTranslation">__identityTranslation</a></td>
84 <td>Private method to perform the identity path translation.</td>
85 </tr>
86 <tr>
87 <td><a href="#DebuggerInterfacePython.__parseClientLine">__parseClientLine</a></td>
88 <td>Private method to handle data from the client.</td>
89 </tr>
90 <tr>
91 <td><a href="#DebuggerInterfacePython.__remoteTranslation">__remoteTranslation</a></td>
92 <td>Private method to perform the path translation.</td>
93 </tr>
94 <tr>
95 <td><a href="#DebuggerInterfacePython.__sendJsonCommand">__sendJsonCommand</a></td>
96 <td>Private method to send a single command to the client.</td>
97 </tr>
98 <tr>
99 <td><a href="#DebuggerInterfacePython.__shutdownSocket">__shutdownSocket</a></td>
100 <td>Private slot to shut down a socket.</td>
101 </tr>
102 <tr>
103 <td><a href="#DebuggerInterfacePython.__socketDisconnected">__socketDisconnected</a></td>
104 <td>Private slot handling a socket disconnecting.</td>
105 </tr>
106 <tr>
107 <td><a href="#DebuggerInterfacePython.__startProcess">__startProcess</a></td>
108 <td>Private method to start the debugger client process.</td>
109 </tr>
110 <tr>
111 <td><a href="#DebuggerInterfacePython.__writeJsonCommandToSocket">__writeJsonCommandToSocket</a></td>
112 <td>Private method to write a JSON command to the socket.</td>
113 </tr>
114 <tr>
115 <td><a href="#DebuggerInterfacePython.getClientCapabilities">getClientCapabilities</a></td>
116 <td>Public method to retrieve the debug clients capabilities.</td>
117 </tr>
118 <tr>
119 <td><a href="#DebuggerInterfacePython.getDebuggerIds">getDebuggerIds</a></td>
120 <td>Public method to return the IDs of the connected debugger backends.</td>
121 </tr>
122 <tr>
123 <td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td>
124 <td>Public method to test, if a debug client has connected.</td>
125 </tr>
126 <tr>
127 <td><a href="#DebuggerInterfacePython.newConnection">newConnection</a></td>
128 <td>Public slot to handle a new connection.</td>
129 </tr>
130 <tr>
131 <td><a href="#DebuggerInterfacePython.remoteBanner">remoteBanner</a></td>
132 <td>Public slot to get the banner info of the remote client.</td>
133 </tr>
134 <tr>
135 <td><a href="#DebuggerInterfacePython.remoteBreakpoint">remoteBreakpoint</a></td>
136 <td>Public method to set or clear a breakpoint.</td>
137 </tr>
138 <tr>
139 <td><a href="#DebuggerInterfacePython.remoteBreakpointEnable">remoteBreakpointEnable</a></td>
140 <td>Public method to enable or disable a breakpoint.</td>
141 </tr>
142 <tr>
143 <td><a href="#DebuggerInterfacePython.remoteBreakpointIgnore">remoteBreakpointIgnore</a></td>
144 <td>Public method to ignore a breakpoint the next couple of occurrences.</td>
145 </tr>
146 <tr>
147 <td><a href="#DebuggerInterfacePython.remoteCapabilities">remoteCapabilities</a></td>
148 <td>Public slot to get the debug clients capabilities.</td>
149 </tr>
150 <tr>
151 <td><a href="#DebuggerInterfacePython.remoteClientDisassembly">remoteClientDisassembly</a></td>
152 <td>Public method to ask the client for the latest traceback disassembly.</td>
153 </tr>
154 <tr>
155 <td><a href="#DebuggerInterfacePython.remoteClientSetFilter">remoteClientSetFilter</a></td>
156 <td>Public method to set a variables filter list.</td>
157 </tr>
158 <tr>
159 <td><a href="#DebuggerInterfacePython.remoteClientStack">remoteClientStack</a></td>
160 <td>Public method to request the stack of the main thread.</td>
161 </tr>
162 <tr>
163 <td><a href="#DebuggerInterfacePython.remoteClientVariable">remoteClientVariable</a></td>
164 <td>Public method to request the variables of the debugged program.</td>
165 </tr>
166 <tr>
167 <td><a href="#DebuggerInterfacePython.remoteClientVariables">remoteClientVariables</a></td>
168 <td>Public method to request the variables of the debugged program.</td>
169 </tr>
170 <tr>
171 <td><a href="#DebuggerInterfacePython.remoteCompletion">remoteCompletion</a></td>
172 <td>Public slot to get the a list of possible commandline completions from the remote client.</td>
173 </tr>
174 <tr>
175 <td><a href="#DebuggerInterfacePython.remoteContinue">remoteContinue</a></td>
176 <td>Public method to continue the debugged program.</td>
177 </tr>
178 <tr>
179 <td><a href="#DebuggerInterfacePython.remoteContinueUntil">remoteContinueUntil</a></td>
180 <td>Public method to continue the debugged program to the given line or until returning from the current frame.</td>
181 </tr>
182 <tr>
183 <td><a href="#DebuggerInterfacePython.remoteCoverage">remoteCoverage</a></td>
184 <td>Public method to load a new program to collect coverage data.</td>
185 </tr>
186 <tr>
187 <td><a href="#DebuggerInterfacePython.remoteEnvironment">remoteEnvironment</a></td>
188 <td>Public method to set the environment for a program to debug, run, ...</td>
189 </tr>
190 <tr>
191 <td><a href="#DebuggerInterfacePython.remoteLoad">remoteLoad</a></td>
192 <td>Public method to load a new program to debug.</td>
193 </tr>
194 <tr>
195 <td><a href="#DebuggerInterfacePython.remoteMoveIP">remoteMoveIP</a></td>
196 <td>Public method to move the instruction pointer to a different line.</td>
197 </tr>
198 <tr>
199 <td><a href="#DebuggerInterfacePython.remoteNoDebugList">remoteNoDebugList</a></td>
200 <td>Public method to set a list of programs not to be debugged.</td>
201 </tr>
202 <tr>
203 <td><a href="#DebuggerInterfacePython.remoteProfile">remoteProfile</a></td>
204 <td>Public method to load a new program to collect profiling data.</td>
205 </tr>
206 <tr>
207 <td><a href="#DebuggerInterfacePython.remoteRawInput">remoteRawInput</a></td>
208 <td>Public method to send the raw input to the debugged program.</td>
209 </tr>
210 <tr>
211 <td><a href="#DebuggerInterfacePython.remoteRun">remoteRun</a></td>
212 <td>Public method to load a new program to run.</td>
213 </tr>
214 <tr>
215 <td><a href="#DebuggerInterfacePython.remoteSetThread">remoteSetThread</a></td>
216 <td>Public method to request to set the given thread as current thread.</td>
217 </tr>
218 <tr>
219 <td><a href="#DebuggerInterfacePython.remoteStatement">remoteStatement</a></td>
220 <td>Public method to execute a Python statement.</td>
221 </tr>
222 <tr>
223 <td><a href="#DebuggerInterfacePython.remoteStep">remoteStep</a></td>
224 <td>Public method to single step the debugged program.</td>
225 </tr>
226 <tr>
227 <td><a href="#DebuggerInterfacePython.remoteStepOut">remoteStepOut</a></td>
228 <td>Public method to step out the debugged program.</td>
229 </tr>
230 <tr>
231 <td><a href="#DebuggerInterfacePython.remoteStepOver">remoteStepOver</a></td>
232 <td>Public method to step over the debugged program.</td>
233 </tr>
234 <tr>
235 <td><a href="#DebuggerInterfacePython.remoteStepQuit">remoteStepQuit</a></td>
236 <td>Public method to stop the debugged program.</td>
237 </tr>
238 <tr>
239 <td><a href="#DebuggerInterfacePython.remoteThreadList">remoteThreadList</a></td>
240 <td>Public method to request the list of threads from the client.</td>
241 </tr>
242 <tr>
243 <td><a href="#DebuggerInterfacePython.remoteWatchpoint">remoteWatchpoint</a></td>
244 <td>Public method to set or clear a watch expression.</td>
245 </tr>
246 <tr>
247 <td><a href="#DebuggerInterfacePython.remoteWatchpointEnable">remoteWatchpointEnable</a></td>
248 <td>Public method to enable or disable a watch expression.</td>
249 </tr>
250 <tr>
251 <td><a href="#DebuggerInterfacePython.remoteWatchpointIgnore">remoteWatchpointIgnore</a></td>
252 <td>Public method to ignore a watch expression the next couple of occurrences.</td>
253 </tr>
254 <tr>
255 <td><a href="#DebuggerInterfacePython.setCallTraceEnabled">setCallTraceEnabled</a></td>
256 <td>Public method to set the call trace state.</td>
257 </tr>
258 <tr>
259 <td><a href="#DebuggerInterfacePython.shutdown">shutdown</a></td>
260 <td>Public method to cleanly shut down.</td>
261 </tr>
262 <tr>
263 <td><a href="#DebuggerInterfacePython.startRemote">startRemote</a></td>
264 <td>Public method to start a remote Python interpreter.</td>
265 </tr>
266 <tr>
267 <td><a href="#DebuggerInterfacePython.startRemoteForProject">startRemoteForProject</a></td>
268 <td>Public method to start a remote Python interpreter for a project.</td>
269 </tr>
270 </table>
271 <h3>Static Methods</h3>
272
273 <table>
274 <tr><td>None</td></tr>
275 </table>
276
277 <a NAME="DebuggerInterfacePython.__init__" ID="DebuggerInterfacePython.__init__"></a>
278 <h4>DebuggerInterfacePython (Constructor)</h4>
279 <b>DebuggerInterfacePython</b>(<i>debugServer, passive</i>)
280
281 <p>
282 Constructor
283 </p>
284 <dl>
285
286 <dt><i>debugServer</i> (DebugServer)</dt>
287 <dd>
288 reference to the debug server
289 </dd>
290 <dt><i>passive</i> (bool)</dt>
291 <dd>
292 flag indicating passive connection mode
293 </dd>
294 </dl>
295 <a NAME="DebuggerInterfacePython.__assignDebuggerId" ID="DebuggerInterfacePython.__assignDebuggerId"></a>
296 <h4>DebuggerInterfacePython.__assignDebuggerId</h4>
297 <b>__assignDebuggerId</b>(<i>sock, debuggerId</i>)
298
299 <p>
300 Private method to set the debugger id for a recent debugger connection
301 attempt.
302 </p>
303 <dl>
304
305 <dt><i>sock</i> (QTcpSocket)</dt>
306 <dd>
307 reference to the socket object
308 </dd>
309 <dt><i>debuggerId</i> (str)</dt>
310 <dd>
311 id of the connected debug client
312 </dd>
313 </dl>
314 <a NAME="DebuggerInterfacePython.__flush" ID="DebuggerInterfacePython.__flush"></a>
315 <h4>DebuggerInterfacePython.__flush</h4>
316 <b>__flush</b>(<i></i>)
317
318 <p>
319 Private slot to flush the queue.
320 </p>
321 <a NAME="DebuggerInterfacePython.__handleJsonCommand" ID="DebuggerInterfacePython.__handleJsonCommand"></a>
322 <h4>DebuggerInterfacePython.__handleJsonCommand</h4>
323 <b>__handleJsonCommand</b>(<i>jsonStr, sock</i>)
324
325 <p>
326 Private method to handle a command or response serialized as a
327 JSON string.
328 </p>
329 <dl>
330
331 <dt><i>jsonStr</i> (str)</dt>
332 <dd>
333 string containing the command or response received
334 from the debug backend
335 </dd>
336 <dt><i>sock</i> (QTcpSocket)</dt>
337 <dd>
338 reference to the socket the data was received from
339 </dd>
340 </dl>
341 <a NAME="DebuggerInterfacePython.__identityTranslation" ID="DebuggerInterfacePython.__identityTranslation"></a>
342 <h4>DebuggerInterfacePython.__identityTranslation</h4>
343 <b>__identityTranslation</b>(<i>fn, remote2local=True</i>)
344
345 <p>
346 Private method to perform the identity path translation.
347 </p>
348 <dl>
349
350 <dt><i>fn</i> (str)</dt>
351 <dd>
352 filename to be translated
353 </dd>
354 <dt><i>remote2local</i> (bool)</dt>
355 <dd>
356 flag indicating the direction of translation
357 (False = local to remote, True = remote to local [default])
358 </dd>
359 </dl>
360 <dl>
361 <dt>Return:</dt>
362 <dd>
363 translated filename
364 </dd>
365 </dl>
366 <dl>
367 <dt>Return Type:</dt>
368 <dd>
369 str
370 </dd>
371 </dl>
372 <a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a>
373 <h4>DebuggerInterfacePython.__parseClientLine</h4>
374 <b>__parseClientLine</b>(<i>sock</i>)
375
376 <p>
377 Private method to handle data from the client.
378 </p>
379 <dl>
380
381 <dt><i>sock</i> (QTcpSocket)</dt>
382 <dd>
383 reference to the socket to read data from
384 </dd>
385 </dl>
386 <a NAME="DebuggerInterfacePython.__remoteTranslation" ID="DebuggerInterfacePython.__remoteTranslation"></a>
387 <h4>DebuggerInterfacePython.__remoteTranslation</h4>
388 <b>__remoteTranslation</b>(<i>fn, remote2local=True</i>)
389
390 <p>
391 Private method to perform the path translation.
392 </p>
393 <dl>
394
395 <dt><i>fn</i> (str)</dt>
396 <dd>
397 filename to be translated
398 </dd>
399 <dt><i>remote2local</i> (bool)</dt>
400 <dd>
401 flag indicating the direction of translation
402 (False = local to remote, True = remote to local [default])
403 </dd>
404 </dl>
405 <dl>
406 <dt>Return:</dt>
407 <dd>
408 translated filename
409 </dd>
410 </dl>
411 <dl>
412 <dt>Return Type:</dt>
413 <dd>
414 str
415 </dd>
416 </dl>
417 <a NAME="DebuggerInterfacePython.__sendJsonCommand" ID="DebuggerInterfacePython.__sendJsonCommand"></a>
418 <h4>DebuggerInterfacePython.__sendJsonCommand</h4>
419 <b>__sendJsonCommand</b>(<i>command, params, debuggerId="", sock=None</i>)
420
421 <p>
422 Private method to send a single command to the client.
423 </p>
424 <dl>
425
426 <dt><i>command</i> (str)</dt>
427 <dd>
428 command name to be sent
429 </dd>
430 <dt><i>params</i> (dict)</dt>
431 <dd>
432 dictionary of named parameters for the command
433 </dd>
434 <dt><i>debuggerId</i> (str)</dt>
435 <dd>
436 id of the debug client to send the command to
437 </dd>
438 <dt><i>sock</i> (QTcpSocket)</dt>
439 <dd>
440 reference to the socket object to be used (only used if
441 debuggerId is not given)
442 </dd>
443 </dl>
444 <a NAME="DebuggerInterfacePython.__shutdownSocket" ID="DebuggerInterfacePython.__shutdownSocket"></a>
445 <h4>DebuggerInterfacePython.__shutdownSocket</h4>
446 <b>__shutdownSocket</b>(<i>sock</i>)
447
448 <p>
449 Private slot to shut down a socket.
450 </p>
451 <dl>
452
453 <dt><i>sock</i> (QTcpSocket)</dt>
454 <dd>
455 reference to the socket
456 </dd>
457 </dl>
458 <a NAME="DebuggerInterfacePython.__socketDisconnected" ID="DebuggerInterfacePython.__socketDisconnected"></a>
459 <h4>DebuggerInterfacePython.__socketDisconnected</h4>
460 <b>__socketDisconnected</b>(<i>sock</i>)
461
462 <p>
463 Private slot handling a socket disconnecting.
464 </p>
465 <dl>
466
467 <dt><i>sock</i> (QTcpSocket)</dt>
468 <dd>
469 reference to the disconnected socket
470 </dd>
471 </dl>
472 <a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a>
473 <h4>DebuggerInterfacePython.__startProcess</h4>
474 <b>__startProcess</b>(<i>program, arguments, environment=None, workingDir=None</i>)
475
476 <p>
477 Private method to start the debugger client process.
478 </p>
479 <dl>
480
481 <dt><i>program</i> (str)</dt>
482 <dd>
483 name of the executable to start
484 </dd>
485 <dt><i>arguments</i> (list of str)</dt>
486 <dd>
487 arguments to be passed to the program
488 </dd>
489 <dt><i>environment</i> (dict of str)</dt>
490 <dd>
491 dictionary of environment settings to pass
492 </dd>
493 <dt><i>workingDir</i> (str)</dt>
494 <dd>
495 directory to start the debugger client in
496 </dd>
497 </dl>
498 <dl>
499 <dt>Return:</dt>
500 <dd>
501 the process object
502 </dd>
503 </dl>
504 <dl>
505 <dt>Return Type:</dt>
506 <dd>
507 QProcess or None
508 </dd>
509 </dl>
510 <a NAME="DebuggerInterfacePython.__writeJsonCommandToSocket" ID="DebuggerInterfacePython.__writeJsonCommandToSocket"></a>
511 <h4>DebuggerInterfacePython.__writeJsonCommandToSocket</h4>
512 <b>__writeJsonCommandToSocket</b>(<i>cmd, sock</i>)
513
514 <p>
515 Private method to write a JSON command to the socket.
516 </p>
517 <dl>
518
519 <dt><i>cmd</i> (str)</dt>
520 <dd>
521 JSON command to be sent
522 </dd>
523 <dt><i>sock</i> (QTcpSocket)</dt>
524 <dd>
525 reference to the socket to write to
526 </dd>
527 </dl>
528 <a NAME="DebuggerInterfacePython.getClientCapabilities" ID="DebuggerInterfacePython.getClientCapabilities"></a>
529 <h4>DebuggerInterfacePython.getClientCapabilities</h4>
530 <b>getClientCapabilities</b>(<i></i>)
531
532 <p>
533 Public method to retrieve the debug clients capabilities.
534 </p>
535 <dl>
536 <dt>Return:</dt>
537 <dd>
538 debug client capabilities
539 </dd>
540 </dl>
541 <dl>
542 <dt>Return Type:</dt>
543 <dd>
544 int
545 </dd>
546 </dl>
547 <a NAME="DebuggerInterfacePython.getDebuggerIds" ID="DebuggerInterfacePython.getDebuggerIds"></a>
548 <h4>DebuggerInterfacePython.getDebuggerIds</h4>
549 <b>getDebuggerIds</b>(<i></i>)
550
551 <p>
552 Public method to return the IDs of the connected debugger backends.
553 </p>
554 <dl>
555 <dt>Return:</dt>
556 <dd>
557 list of connected debugger backend IDs
558 </dd>
559 </dl>
560 <dl>
561 <dt>Return Type:</dt>
562 <dd>
563 list of str
564 </dd>
565 </dl>
566 <a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a>
567 <h4>DebuggerInterfacePython.isConnected</h4>
568 <b>isConnected</b>(<i></i>)
569
570 <p>
571 Public method to test, if a debug client has connected.
572 </p>
573 <dl>
574 <dt>Return:</dt>
575 <dd>
576 flag indicating the connection status
577 </dd>
578 </dl>
579 <dl>
580 <dt>Return Type:</dt>
581 <dd>
582 bool
583 </dd>
584 </dl>
585 <a NAME="DebuggerInterfacePython.newConnection" ID="DebuggerInterfacePython.newConnection"></a>
586 <h4>DebuggerInterfacePython.newConnection</h4>
587 <b>newConnection</b>(<i>sock</i>)
588
589 <p>
590 Public slot to handle a new connection.
591 </p>
592 <dl>
593
594 <dt><i>sock</i> (QTcpSocket)</dt>
595 <dd>
596 reference to the socket object
597 </dd>
598 </dl>
599 <dl>
600 <dt>Return:</dt>
601 <dd>
602 flag indicating success
603 </dd>
604 </dl>
605 <dl>
606 <dt>Return Type:</dt>
607 <dd>
608 bool
609 </dd>
610 </dl>
611 <a NAME="DebuggerInterfacePython.remoteBanner" ID="DebuggerInterfacePython.remoteBanner"></a>
612 <h4>DebuggerInterfacePython.remoteBanner</h4>
613 <b>remoteBanner</b>(<i></i>)
614
615 <p>
616 Public slot to get the banner info of the remote client.
617 </p>
618 <a NAME="DebuggerInterfacePython.remoteBreakpoint" ID="DebuggerInterfacePython.remoteBreakpoint"></a>
619 <h4>DebuggerInterfacePython.remoteBreakpoint</h4>
620 <b>remoteBreakpoint</b>(<i>debuggerId, fn, line, setBreakpoint, cond=None, temp=False</i>)
621
622 <p>
623 Public method to set or clear a breakpoint.
624 </p>
625 <dl>
626
627 <dt><i>debuggerId</i> (str)</dt>
628 <dd>
629 ID of the debugger backend
630 </dd>
631 <dt><i>fn</i> (str)</dt>
632 <dd>
633 filename the breakpoint belongs to
634 </dd>
635 <dt><i>line</i> (int)</dt>
636 <dd>
637 linenumber of the breakpoint
638 </dd>
639 <dt><i>setBreakpoint</i> (bool)</dt>
640 <dd>
641 flag indicating setting or resetting a breakpoint
642 </dd>
643 <dt><i>cond</i> (str)</dt>
644 <dd>
645 condition of the breakpoint
646 </dd>
647 <dt><i>temp</i> (bool)</dt>
648 <dd>
649 flag indicating a temporary breakpoint
650 </dd>
651 </dl>
652 <a NAME="DebuggerInterfacePython.remoteBreakpointEnable" ID="DebuggerInterfacePython.remoteBreakpointEnable"></a>
653 <h4>DebuggerInterfacePython.remoteBreakpointEnable</h4>
654 <b>remoteBreakpointEnable</b>(<i>debuggerId, fn, line, enable</i>)
655
656 <p>
657 Public method to enable or disable a breakpoint.
658 </p>
659 <dl>
660
661 <dt><i>debuggerId</i> (str)</dt>
662 <dd>
663 ID of the debugger backend
664 </dd>
665 <dt><i>fn</i> (str)</dt>
666 <dd>
667 filename the breakpoint belongs to
668 </dd>
669 <dt><i>line</i> (int)</dt>
670 <dd>
671 linenumber of the breakpoint
672 </dd>
673 <dt><i>enable</i> (bool)</dt>
674 <dd>
675 flag indicating enabling or disabling a breakpoint
676 </dd>
677 </dl>
678 <a NAME="DebuggerInterfacePython.remoteBreakpointIgnore" ID="DebuggerInterfacePython.remoteBreakpointIgnore"></a>
679 <h4>DebuggerInterfacePython.remoteBreakpointIgnore</h4>
680 <b>remoteBreakpointIgnore</b>(<i>debuggerId, fn, line, count</i>)
681
682 <p>
683 Public method to ignore a breakpoint the next couple of occurrences.
684 </p>
685 <dl>
686
687 <dt><i>debuggerId</i> (str)</dt>
688 <dd>
689 ID of the debugger backend
690 </dd>
691 <dt><i>fn</i> (str)</dt>
692 <dd>
693 filename the breakpoint belongs to
694 </dd>
695 <dt><i>line</i> (int)</dt>
696 <dd>
697 linenumber of the breakpoint
698 </dd>
699 <dt><i>count</i> (int)</dt>
700 <dd>
701 number of occurrences to ignore
702 </dd>
703 </dl>
704 <a NAME="DebuggerInterfacePython.remoteCapabilities" ID="DebuggerInterfacePython.remoteCapabilities"></a>
705 <h4>DebuggerInterfacePython.remoteCapabilities</h4>
706 <b>remoteCapabilities</b>(<i>debuggerId</i>)
707
708 <p>
709 Public slot to get the debug clients capabilities.
710 </p>
711 <dl>
712
713 <dt><i>debuggerId</i> (str)</dt>
714 <dd>
715 ID of the debugger backend
716 </dd>
717 </dl>
718 <a NAME="DebuggerInterfacePython.remoteClientDisassembly" ID="DebuggerInterfacePython.remoteClientDisassembly"></a>
719 <h4>DebuggerInterfacePython.remoteClientDisassembly</h4>
720 <b>remoteClientDisassembly</b>(<i>debuggerId</i>)
721
722 <p>
723 Public method to ask the client for the latest traceback disassembly.
724 </p>
725 <dl>
726
727 <dt><i>debuggerId</i> (str)</dt>
728 <dd>
729 ID of the debugger backend
730 </dd>
731 </dl>
732 <a NAME="DebuggerInterfacePython.remoteClientSetFilter" ID="DebuggerInterfacePython.remoteClientSetFilter"></a>
733 <h4>DebuggerInterfacePython.remoteClientSetFilter</h4>
734 <b>remoteClientSetFilter</b>(<i>debuggerId, scope, filterStr</i>)
735
736 <p>
737 Public method to set a variables filter list.
738 </p>
739 <dl>
740
741 <dt><i>debuggerId</i> (str)</dt>
742 <dd>
743 ID of the debugger backend
744 </dd>
745 <dt><i>scope</i> (int)</dt>
746 <dd>
747 the scope of the variables (0 = local, 1 = global)
748 </dd>
749 <dt><i>filterStr</i> (str)</dt>
750 <dd>
751 regexp string for variable names to filter out
752 </dd>
753 </dl>
754 <a NAME="DebuggerInterfacePython.remoteClientStack" ID="DebuggerInterfacePython.remoteClientStack"></a>
755 <h4>DebuggerInterfacePython.remoteClientStack</h4>
756 <b>remoteClientStack</b>(<i>debuggerId</i>)
757
758 <p>
759 Public method to request the stack of the main thread.
760 </p>
761 <dl>
762
763 <dt><i>debuggerId</i> (str)</dt>
764 <dd>
765 ID of the debugger backend
766 </dd>
767 </dl>
768 <a NAME="DebuggerInterfacePython.remoteClientVariable" ID="DebuggerInterfacePython.remoteClientVariable"></a>
769 <h4>DebuggerInterfacePython.remoteClientVariable</h4>
770 <b>remoteClientVariable</b>(<i>debuggerId, scope, filterList, var, framenr=0, maxSize=0</i>)
771
772 <p>
773 Public method to request the variables of the debugged program.
774 </p>
775 <dl>
776
777 <dt><i>debuggerId</i> (str)</dt>
778 <dd>
779 ID of the debugger backend
780 </dd>
781 <dt><i>scope</i> (int)</dt>
782 <dd>
783 the scope of the variables (0 = local, 1 = global)
784 </dd>
785 <dt><i>filterList</i> (list of str)</dt>
786 <dd>
787 list of variable types to filter out
788 </dd>
789 <dt><i>var</i> (list of str)</dt>
790 <dd>
791 list encoded name of variable to retrieve
792 </dd>
793 <dt><i>framenr</i> (int)</dt>
794 <dd>
795 framenumber of the variables to retrieve
796 </dd>
797 <dt><i>maxSize</i> (int)</dt>
798 <dd>
799 maximum size the formatted value of a variable will
800 be shown. If it is bigger than that, a 'too big' indication will
801 be given (@@TOO_BIG_TO_SHOW@@).
802 </dd>
803 </dl>
804 <a NAME="DebuggerInterfacePython.remoteClientVariables" ID="DebuggerInterfacePython.remoteClientVariables"></a>
805 <h4>DebuggerInterfacePython.remoteClientVariables</h4>
806 <b>remoteClientVariables</b>(<i>debuggerId, scope, filterList, framenr=0, maxSize=0</i>)
807
808 <p>
809 Public method to request the variables of the debugged program.
810 </p>
811 <dl>
812
813 <dt><i>debuggerId</i> (str)</dt>
814 <dd>
815 ID of the debugger backend
816 </dd>
817 <dt><i>scope</i> (int)</dt>
818 <dd>
819 the scope of the variables (0 = local, 1 = global)
820 </dd>
821 <dt><i>filterList</i> (list of str)</dt>
822 <dd>
823 list of variable types to filter out
824 </dd>
825 <dt><i>framenr</i> (int)</dt>
826 <dd>
827 framenumber of the variables to retrieve
828 </dd>
829 <dt><i>maxSize</i> (int)</dt>
830 <dd>
831 maximum size the formatted value of a variable will
832 be shown. If it is bigger than that, a 'too big' indication will
833 be given (@@TOO_BIG_TO_SHOW@@).
834 </dd>
835 </dl>
836 <a NAME="DebuggerInterfacePython.remoteCompletion" ID="DebuggerInterfacePython.remoteCompletion"></a>
837 <h4>DebuggerInterfacePython.remoteCompletion</h4>
838 <b>remoteCompletion</b>(<i>debuggerId, text</i>)
839
840 <p>
841 Public slot to get the a list of possible commandline completions
842 from the remote client.
843 </p>
844 <dl>
845
846 <dt><i>debuggerId</i> (str)</dt>
847 <dd>
848 ID of the debugger backend
849 </dd>
850 <dt><i>text</i> (str)</dt>
851 <dd>
852 the text to be completed
853 </dd>
854 </dl>
855 <a NAME="DebuggerInterfacePython.remoteContinue" ID="DebuggerInterfacePython.remoteContinue"></a>
856 <h4>DebuggerInterfacePython.remoteContinue</h4>
857 <b>remoteContinue</b>(<i>debuggerId, special=False</i>)
858
859 <p>
860 Public method to continue the debugged program.
861 </p>
862 <dl>
863
864 <dt><i>debuggerId</i> (str)</dt>
865 <dd>
866 ID of the debugger backend
867 </dd>
868 <dt><i>special</i> (bool)</dt>
869 <dd>
870 flag indicating a special continue operation
871 </dd>
872 </dl>
873 <a NAME="DebuggerInterfacePython.remoteContinueUntil" ID="DebuggerInterfacePython.remoteContinueUntil"></a>
874 <h4>DebuggerInterfacePython.remoteContinueUntil</h4>
875 <b>remoteContinueUntil</b>(<i>debuggerId, line</i>)
876
877 <p>
878 Public method to continue the debugged program to the given line
879 or until returning from the current frame.
880 </p>
881 <dl>
882
883 <dt><i>debuggerId</i> (str)</dt>
884 <dd>
885 ID of the debugger backend
886 </dd>
887 <dt><i>line</i> (int)</dt>
888 <dd>
889 the new line, where execution should be continued to
890 </dd>
891 </dl>
892 <a NAME="DebuggerInterfacePython.remoteCoverage" ID="DebuggerInterfacePython.remoteCoverage"></a>
893 <h4>DebuggerInterfacePython.remoteCoverage</h4>
894 <b>remoteCoverage</b>(<i>fn, argv, wd, erase=False</i>)
895
896 <p>
897 Public method to load a new program to collect coverage data.
898 </p>
899 <dl>
900
901 <dt><i>fn</i> (str)</dt>
902 <dd>
903 the filename to run
904 </dd>
905 <dt><i>argv</i> (str)</dt>
906 <dd>
907 the commandline arguments to pass to the program
908 </dd>
909 <dt><i>wd</i> (str)</dt>
910 <dd>
911 the working directory for the program
912 </dd>
913 <dt><i>erase</i> (bool)</dt>
914 <dd>
915 flag indicating that coverage info should be
916 cleared first
917 </dd>
918 </dl>
919 <a NAME="DebuggerInterfacePython.remoteEnvironment" ID="DebuggerInterfacePython.remoteEnvironment"></a>
920 <h4>DebuggerInterfacePython.remoteEnvironment</h4>
921 <b>remoteEnvironment</b>(<i>env</i>)
922
923 <p>
924 Public method to set the environment for a program to debug, run, ...
925 </p>
926 <dl>
927
928 <dt><i>env</i> (dict)</dt>
929 <dd>
930 environment settings
931 </dd>
932 </dl>
933 <a NAME="DebuggerInterfacePython.remoteLoad" ID="DebuggerInterfacePython.remoteLoad"></a>
934 <h4>DebuggerInterfacePython.remoteLoad</h4>
935 <b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter=False, autoContinue=True, enableMultiprocess=False</i>)
936
937 <p>
938 Public method to load a new program to debug.
939 </p>
940 <dl>
941
942 <dt><i>fn</i> (str)</dt>
943 <dd>
944 the filename to debug
945 </dd>
946 <dt><i>argv</i> (str)</dt>
947 <dd>
948 the commandline arguments to pass to the program
949 </dd>
950 <dt><i>wd</i> (str)</dt>
951 <dd>
952 the working directory for the program
953 </dd>
954 <dt><i>traceInterpreter</i> (bool)</dt>
955 <dd>
956 flag indicating if the interpreter library
957 should be traced as well
958 </dd>
959 <dt><i>autoContinue</i> (bool)</dt>
960 <dd>
961 flag indicating, that the debugger should not
962 stop at the first executable line
963 </dd>
964 <dt><i>enableMultiprocess</i> (bool)</dt>
965 <dd>
966 flag indicating to perform multiprocess
967 debugging
968 </dd>
969 </dl>
970 <a NAME="DebuggerInterfacePython.remoteMoveIP" ID="DebuggerInterfacePython.remoteMoveIP"></a>
971 <h4>DebuggerInterfacePython.remoteMoveIP</h4>
972 <b>remoteMoveIP</b>(<i>debuggerId, line</i>)
973
974 <p>
975 Public method to move the instruction pointer to a different line.
976 </p>
977 <dl>
978
979 <dt><i>debuggerId</i> (str)</dt>
980 <dd>
981 ID of the debugger backend
982 </dd>
983 <dt><i>line</i> (int)</dt>
984 <dd>
985 the new line, where execution should be continued
986 </dd>
987 </dl>
988 <a NAME="DebuggerInterfacePython.remoteNoDebugList" ID="DebuggerInterfacePython.remoteNoDebugList"></a>
989 <h4>DebuggerInterfacePython.remoteNoDebugList</h4>
990 <b>remoteNoDebugList</b>(<i>debuggerId, noDebugList</i>)
991
992 <p>
993 Public method to set a list of programs not to be debugged.
994 </p>
995 <p>
996 The programs given in the list will not be run under the control
997 of the multi process debugger.
998 </p>
999 <dl>
1000
1001 <dt><i>debuggerId</i> (str)</dt>
1002 <dd>
1003 ID of the debugger backend
1004 </dd>
1005 <dt><i>noDebugList</i> (list of str)</dt>
1006 <dd>
1007 list of Python programs not to be debugged
1008 </dd>
1009 </dl>
1010 <a NAME="DebuggerInterfacePython.remoteProfile" ID="DebuggerInterfacePython.remoteProfile"></a>
1011 <h4>DebuggerInterfacePython.remoteProfile</h4>
1012 <b>remoteProfile</b>(<i>fn, argv, wd, erase=False</i>)
1013
1014 <p>
1015 Public method to load a new program to collect profiling data.
1016 </p>
1017 <dl>
1018
1019 <dt><i>fn</i> (str)</dt>
1020 <dd>
1021 the filename to run
1022 </dd>
1023 <dt><i>argv</i> (str)</dt>
1024 <dd>
1025 the commandline arguments to pass to the program
1026 </dd>
1027 <dt><i>wd</i> (str)</dt>
1028 <dd>
1029 the working directory for the program
1030 </dd>
1031 <dt><i>erase</i> (bool)</dt>
1032 <dd>
1033 flag indicating that timing info should be cleared
1034 first
1035 </dd>
1036 </dl>
1037 <a NAME="DebuggerInterfacePython.remoteRawInput" ID="DebuggerInterfacePython.remoteRawInput"></a>
1038 <h4>DebuggerInterfacePython.remoteRawInput</h4>
1039 <b>remoteRawInput</b>(<i>debuggerId, inputString</i>)
1040
1041 <p>
1042 Public method to send the raw input to the debugged program.
1043 </p>
1044 <dl>
1045
1046 <dt><i>debuggerId</i> (str)</dt>
1047 <dd>
1048 ID of the debugger backend
1049 </dd>
1050 <dt><i>inputString</i> (str)</dt>
1051 <dd>
1052 the raw input
1053 </dd>
1054 </dl>
1055 <a NAME="DebuggerInterfacePython.remoteRun" ID="DebuggerInterfacePython.remoteRun"></a>
1056 <h4>DebuggerInterfacePython.remoteRun</h4>
1057 <b>remoteRun</b>(<i>fn, argv, wd</i>)
1058
1059 <p>
1060 Public method to load a new program to run.
1061 </p>
1062 <dl>
1063
1064 <dt><i>fn</i> (str)</dt>
1065 <dd>
1066 the filename to run
1067 </dd>
1068 <dt><i>argv</i> (str)</dt>
1069 <dd>
1070 the commandline arguments to pass to the program
1071 </dd>
1072 <dt><i>wd</i> (str)</dt>
1073 <dd>
1074 the working directory for the program
1075 </dd>
1076 </dl>
1077 <a NAME="DebuggerInterfacePython.remoteSetThread" ID="DebuggerInterfacePython.remoteSetThread"></a>
1078 <h4>DebuggerInterfacePython.remoteSetThread</h4>
1079 <b>remoteSetThread</b>(<i>debuggerId, tid</i>)
1080
1081 <p>
1082 Public method to request to set the given thread as current thread.
1083 </p>
1084 <dl>
1085
1086 <dt><i>debuggerId</i> (str)</dt>
1087 <dd>
1088 ID of the debugger backend
1089 </dd>
1090 <dt><i>tid</i> (int)</dt>
1091 <dd>
1092 id of the thread
1093 </dd>
1094 </dl>
1095 <a NAME="DebuggerInterfacePython.remoteStatement" ID="DebuggerInterfacePython.remoteStatement"></a>
1096 <h4>DebuggerInterfacePython.remoteStatement</h4>
1097 <b>remoteStatement</b>(<i>debuggerId, stmt</i>)
1098
1099 <p>
1100 Public method to execute a Python statement.
1101 </p>
1102 <dl>
1103
1104 <dt><i>debuggerId</i> (str)</dt>
1105 <dd>
1106 ID of the debugger backend
1107 </dd>
1108 <dt><i>stmt</i> (str)</dt>
1109 <dd>
1110 the Python statement to execute.
1111 </dd>
1112 </dl>
1113 <a NAME="DebuggerInterfacePython.remoteStep" ID="DebuggerInterfacePython.remoteStep"></a>
1114 <h4>DebuggerInterfacePython.remoteStep</h4>
1115 <b>remoteStep</b>(<i>debuggerId</i>)
1116
1117 <p>
1118 Public method to single step the debugged program.
1119 </p>
1120 <dl>
1121
1122 <dt><i>debuggerId</i> (str)</dt>
1123 <dd>
1124 ID of the debugger backend
1125 </dd>
1126 </dl>
1127 <a NAME="DebuggerInterfacePython.remoteStepOut" ID="DebuggerInterfacePython.remoteStepOut"></a>
1128 <h4>DebuggerInterfacePython.remoteStepOut</h4>
1129 <b>remoteStepOut</b>(<i>debuggerId</i>)
1130
1131 <p>
1132 Public method to step out the debugged program.
1133 </p>
1134 <dl>
1135
1136 <dt><i>debuggerId</i> (str)</dt>
1137 <dd>
1138 ID of the debugger backend
1139 </dd>
1140 </dl>
1141 <a NAME="DebuggerInterfacePython.remoteStepOver" ID="DebuggerInterfacePython.remoteStepOver"></a>
1142 <h4>DebuggerInterfacePython.remoteStepOver</h4>
1143 <b>remoteStepOver</b>(<i>debuggerId</i>)
1144
1145 <p>
1146 Public method to step over the debugged program.
1147 </p>
1148 <dl>
1149
1150 <dt><i>debuggerId</i> (str)</dt>
1151 <dd>
1152 ID of the debugger backend
1153 </dd>
1154 </dl>
1155 <a NAME="DebuggerInterfacePython.remoteStepQuit" ID="DebuggerInterfacePython.remoteStepQuit"></a>
1156 <h4>DebuggerInterfacePython.remoteStepQuit</h4>
1157 <b>remoteStepQuit</b>(<i>debuggerId</i>)
1158
1159 <p>
1160 Public method to stop the debugged program.
1161 </p>
1162 <dl>
1163
1164 <dt><i>debuggerId</i> (str)</dt>
1165 <dd>
1166 ID of the debugger backend
1167 </dd>
1168 </dl>
1169 <a NAME="DebuggerInterfacePython.remoteThreadList" ID="DebuggerInterfacePython.remoteThreadList"></a>
1170 <h4>DebuggerInterfacePython.remoteThreadList</h4>
1171 <b>remoteThreadList</b>(<i>debuggerId</i>)
1172
1173 <p>
1174 Public method to request the list of threads from the client.
1175 </p>
1176 <dl>
1177
1178 <dt><i>debuggerId</i> (str)</dt>
1179 <dd>
1180 ID of the debugger backend
1181 </dd>
1182 </dl>
1183 <a NAME="DebuggerInterfacePython.remoteWatchpoint" ID="DebuggerInterfacePython.remoteWatchpoint"></a>
1184 <h4>DebuggerInterfacePython.remoteWatchpoint</h4>
1185 <b>remoteWatchpoint</b>(<i>debuggerId, cond, setWatch, temp=False</i>)
1186
1187 <p>
1188 Public method to set or clear a watch expression.
1189 </p>
1190 <dl>
1191
1192 <dt><i>debuggerId</i> (str)</dt>
1193 <dd>
1194 ID of the debugger backend
1195 </dd>
1196 <dt><i>cond</i> (str)</dt>
1197 <dd>
1198 expression of the watch expression
1199 </dd>
1200 <dt><i>setWatch</i> (bool)</dt>
1201 <dd>
1202 flag indicating setting or resetting a watch expression
1203 </dd>
1204 <dt><i>temp</i> (bool)</dt>
1205 <dd>
1206 flag indicating a temporary watch expression
1207 </dd>
1208 </dl>
1209 <a NAME="DebuggerInterfacePython.remoteWatchpointEnable" ID="DebuggerInterfacePython.remoteWatchpointEnable"></a>
1210 <h4>DebuggerInterfacePython.remoteWatchpointEnable</h4>
1211 <b>remoteWatchpointEnable</b>(<i>debuggerId, cond, enable</i>)
1212
1213 <p>
1214 Public method to enable or disable a watch expression.
1215 </p>
1216 <dl>
1217
1218 <dt><i>debuggerId</i> (str)</dt>
1219 <dd>
1220 ID of the debugger backend
1221 </dd>
1222 <dt><i>cond</i> (str)</dt>
1223 <dd>
1224 expression of the watch expression
1225 </dd>
1226 <dt><i>enable</i> (bool)</dt>
1227 <dd>
1228 flag indicating enabling or disabling a watch expression
1229 </dd>
1230 </dl>
1231 <a NAME="DebuggerInterfacePython.remoteWatchpointIgnore" ID="DebuggerInterfacePython.remoteWatchpointIgnore"></a>
1232 <h4>DebuggerInterfacePython.remoteWatchpointIgnore</h4>
1233 <b>remoteWatchpointIgnore</b>(<i>debuggerId, cond, count</i>)
1234
1235 <p>
1236 Public method to ignore a watch expression the next couple of
1237 occurrences.
1238 </p>
1239 <dl>
1240
1241 <dt><i>debuggerId</i> (str)</dt>
1242 <dd>
1243 ID of the debugger backend
1244 </dd>
1245 <dt><i>cond</i> (str)</dt>
1246 <dd>
1247 expression of the watch expression
1248 </dd>
1249 <dt><i>count</i> (int)</dt>
1250 <dd>
1251 number of occurrences to ignore
1252 </dd>
1253 </dl>
1254 <a NAME="DebuggerInterfacePython.setCallTraceEnabled" ID="DebuggerInterfacePython.setCallTraceEnabled"></a>
1255 <h4>DebuggerInterfacePython.setCallTraceEnabled</h4>
1256 <b>setCallTraceEnabled</b>(<i>debuggerId, on</i>)
1257
1258 <p>
1259 Public method to set the call trace state.
1260 </p>
1261 <dl>
1262
1263 <dt><i>debuggerId</i> (str)</dt>
1264 <dd>
1265 ID of the debugger backend
1266 </dd>
1267 <dt><i>on</i> (bool)</dt>
1268 <dd>
1269 flag indicating to enable the call trace function
1270 </dd>
1271 </dl>
1272 <a NAME="DebuggerInterfacePython.shutdown" ID="DebuggerInterfacePython.shutdown"></a>
1273 <h4>DebuggerInterfacePython.shutdown</h4>
1274 <b>shutdown</b>(<i></i>)
1275
1276 <p>
1277 Public method to cleanly shut down.
1278 </p>
1279 <p>
1280 It closes our sockets and shuts down the debug clients.
1281 (Needed on Win OS)
1282 </p>
1283 <a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a>
1284 <h4>DebuggerInterfacePython.startRemote</h4>
1285 <b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None</i>)
1286
1287 <p>
1288 Public method to start a remote Python interpreter.
1289 </p>
1290 <dl>
1291
1292 <dt><i>port</i> (int)</dt>
1293 <dd>
1294 port number the debug server is listening on
1295 </dd>
1296 <dt><i>runInConsole</i> (bool)</dt>
1297 <dd>
1298 flag indicating to start the debugger in a
1299 console window
1300 </dd>
1301 <dt><i>venvName</i> (str)</dt>
1302 <dd>
1303 name of the virtual environment to be used
1304 </dd>
1305 <dt><i>originalPathString</i> (str)</dt>
1306 <dd>
1307 original PATH environment variable
1308 </dd>
1309 <dt><i>workingDir</i> (str)</dt>
1310 <dd>
1311 directory to start the debugger client in
1312 </dd>
1313 <dt><i>configOverride</i> (dict)</dt>
1314 <dd>
1315 dictionary containing the global config override
1316 data
1317 </dd>
1318 </dl>
1319 <dl>
1320 <dt>Return:</dt>
1321 <dd>
1322 client process object, a flag to indicate a network connection
1323 and the name of the interpreter in case of a local execution
1324 </dd>
1325 </dl>
1326 <dl>
1327 <dt>Return Type:</dt>
1328 <dd>
1329 tuple of (QProcess, bool, str)
1330 </dd>
1331 </dl>
1332 <a NAME="DebuggerInterfacePython.startRemoteForProject" ID="DebuggerInterfacePython.startRemoteForProject"></a>
1333 <h4>DebuggerInterfacePython.startRemoteForProject</h4>
1334 <b>startRemoteForProject</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None</i>)
1335
1336 <p>
1337 Public method to start a remote Python interpreter for a project.
1338 </p>
1339 <dl>
1340
1341 <dt><i>port</i> (int)</dt>
1342 <dd>
1343 port number the debug server is listening on
1344 </dd>
1345 <dt><i>runInConsole</i> (bool)</dt>
1346 <dd>
1347 flag indicating to start the debugger in a
1348 console window
1349 </dd>
1350 <dt><i>venvName</i> (str)</dt>
1351 <dd>
1352 name of the virtual environment to be used
1353 </dd>
1354 <dt><i>originalPathString</i> (str)</dt>
1355 <dd>
1356 original PATH environment variable
1357 </dd>
1358 <dt><i>workingDir</i> (str)</dt>
1359 <dd>
1360 directory to start the debugger client in
1361 </dd>
1362 <dt><i>configOverride</i> (dict)</dt>
1363 <dd>
1364 dictionary containing the global config override
1365 data
1366 </dd>
1367 </dl>
1368 <dl>
1369 <dt>Return:</dt>
1370 <dd>
1371 client process object, a flag to indicate a network connection
1372 and the name of the interpreter in case of a local execution
1373 </dd>
1374 </dl>
1375 <dl>
1376 <dt>Return Type:</dt>
1377 <dd>
1378 tuple of (QProcess, bool, str)
1379 </dd>
1380 </dl>
1381 <div align="right"><a href="#top">Up</a></div>
1382 <hr />
1383 <hr />
1384 <a NAME="createDebuggerInterfacePython3" ID="createDebuggerInterfacePython3"></a>
1385 <h2>createDebuggerInterfacePython3</h2>
1386 <b>createDebuggerInterfacePython3</b>(<i>debugServer, passive</i>)
1387
1388 <p>
1389 Module function to create a debugger interface instance.
1390 </p>
1391 <p>
1392
1393 </p>
1394 <dl>
1395
1396 <dt><i>debugServer</i> (DebugServer)</dt>
1397 <dd>
1398 reference to the debug server
1399 </dd>
1400 <dt><i>passive</i> (bool)</dt>
1401 <dd>
1402 flag indicating passive connection mode
1403 </dd>
1404 </dl>
1405 <dl>
1406 <dt>Return:</dt>
1407 <dd>
1408 instantiated debugger interface
1409 </dd>
1410 </dl>
1411 <dl>
1412 <dt>Return Type:</dt>
1413 <dd>
1414 DebuggerInterfacePython
1415 </dd>
1416 </dl>
1417 <div align="right"><a href="#top">Up</a></div>
1418 <hr />
1419 <hr />
1420 <a NAME="getRegistryData" ID="getRegistryData"></a>
1421 <h2>getRegistryData</h2>
1422 <b>getRegistryData</b>(<i></i>)
1423
1424 <p>
1425 Module function to get characterizing data for the supported debugger
1426 interfaces.
1427 </p>
1428 <dl>
1429 <dt>Return:</dt>
1430 <dd>
1431 list of tuples containing the client type, the client capabilities,
1432 the client file type associations and a reference to the creation
1433 function
1434 </dd>
1435 </dl>
1436 <dl>
1437 <dt>Return Type:</dt>
1438 <dd>
1439 list of tuple of (str, int, list of str, function)
1440 </dd>
1441 </dl>
1442 <div align="right"><a href="#top">Up</a></div>
1443 <hr />
1444 </body></html>

Mercurial Repository: eric

eric ide

mercurial