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

changeset 7887
c1588f5a83e9
parent 7707
6abcf4275d0e
child 7898
1bcd6d4df182
equal deleted inserted replaced
7885:3e4605cc3541 7887:c1588f5a83e9
80 <tr> 80 <tr>
81 <td><a href="#DebuggerInterfacePython.__init__">DebuggerInterfacePython</a></td> 81 <td><a href="#DebuggerInterfacePython.__init__">DebuggerInterfacePython</a></td>
82 <td>Constructor</td> 82 <td>Constructor</td>
83 </tr> 83 </tr>
84 <tr> 84 <tr>
85 <td><a href="#DebuggerInterfacePython.__askForkTo">__askForkTo</a></td> 85 <td><a href="#DebuggerInterfacePython.__assignDebuggerId">__assignDebuggerId</a></td>
86 <td>Private method to ask the user which branch of a fork to follow.</td> 86 <td>Private method to set the debugger id for a recent debugger connection attempt.</td>
87 </tr>
88 <tr>
89 <td><a href="#DebuggerInterfacePython.__flush">__flush</a></td>
90 <td>Private slot to flush the queue.</td>
87 </tr> 91 </tr>
88 <tr> 92 <tr>
89 <td><a href="#DebuggerInterfacePython.__handleJsonCommand">__handleJsonCommand</a></td> 93 <td><a href="#DebuggerInterfacePython.__handleJsonCommand">__handleJsonCommand</a></td>
90 <td>Private method to handle a command or response serialized as a JSON string.</td> 94 <td>Private method to handle a command or response serialized as a JSON string.</td>
91 </tr> 95 </tr>
104 <tr> 108 <tr>
105 <td><a href="#DebuggerInterfacePython.__sendJsonCommand">__sendJsonCommand</a></td> 109 <td><a href="#DebuggerInterfacePython.__sendJsonCommand">__sendJsonCommand</a></td>
106 <td>Private method to send a single command to the client.</td> 110 <td>Private method to send a single command to the client.</td>
107 </tr> 111 </tr>
108 <tr> 112 <tr>
113 <td><a href="#DebuggerInterfacePython.__shutdownSocket">__shutdownSocket</a></td>
114 <td>Private slot to shut down a socket.</td>
115 </tr>
116 <tr>
117 <td><a href="#DebuggerInterfacePython.__socketDisconnected">__socketDisconnected</a></td>
118 <td>Private slot handling a socket disconnecting.</td>
119 </tr>
120 <tr>
109 <td><a href="#DebuggerInterfacePython.__startProcess">__startProcess</a></td> 121 <td><a href="#DebuggerInterfacePython.__startProcess">__startProcess</a></td>
110 <td>Private method to start the debugger client process.</td> 122 <td>Private method to start the debugger client process.</td>
111 </tr> 123 </tr>
112 <tr> 124 <tr>
113 <td><a href="#DebuggerInterfacePython.__writeJsonCommandToSocket">__writeJsonCommandToSocket</a></td> 125 <td><a href="#DebuggerInterfacePython.__writeJsonCommandToSocket">__writeJsonCommandToSocket</a></td>
114 <td>Private method to write a JSON command to the socket.</td> 126 <td>Private method to write a JSON command to the socket.</td>
115 </tr> 127 </tr>
116 <tr> 128 <tr>
117 <td><a href="#DebuggerInterfacePython.flush">flush</a></td>
118 <td>Public slot to flush the queue.</td>
119 </tr>
120 <tr>
121 <td><a href="#DebuggerInterfacePython.getClientCapabilities">getClientCapabilities</a></td> 129 <td><a href="#DebuggerInterfacePython.getClientCapabilities">getClientCapabilities</a></td>
122 <td>Public method to retrieve the debug clients capabilities.</td> 130 <td>Public method to retrieve the debug clients capabilities.</td>
123 </tr> 131 </tr>
124 <tr> 132 <tr>
133 <td><a href="#DebuggerInterfacePython.getDebuggerIds">getDebuggerIds</a></td>
134 <td>Public method to return the IDs of the connected debugger backends.</td>
135 </tr>
136 <tr>
125 <td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td> 137 <td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td>
126 <td>Public method to test, if a debug client has connected.</td> 138 <td>Public method to test, if a debug client has connected.</td>
127 </tr> 139 </tr>
128 <tr> 140 <tr>
129 <td><a href="#DebuggerInterfacePython.newConnection">newConnection</a></td> 141 <td><a href="#DebuggerInterfacePython.newConnection">newConnection</a></td>
156 <tr> 168 <tr>
157 <td><a href="#DebuggerInterfacePython.remoteClientSetFilter">remoteClientSetFilter</a></td> 169 <td><a href="#DebuggerInterfacePython.remoteClientSetFilter">remoteClientSetFilter</a></td>
158 <td>Public method to set a variables filter list.</td> 170 <td>Public method to set a variables filter list.</td>
159 </tr> 171 </tr>
160 <tr> 172 <tr>
173 <td><a href="#DebuggerInterfacePython.remoteClientStack">remoteClientStack</a></td>
174 <td>Public method to request the stack of the main thread.</td>
175 </tr>
176 <tr>
161 <td><a href="#DebuggerInterfacePython.remoteClientVariable">remoteClientVariable</a></td> 177 <td><a href="#DebuggerInterfacePython.remoteClientVariable">remoteClientVariable</a></td>
162 <td>Public method to request the variables of the debugged program.</td> 178 <td>Public method to request the variables of the debugged program.</td>
163 </tr> 179 </tr>
164 <tr> 180 <tr>
165 <td><a href="#DebuggerInterfacePython.remoteClientVariables">remoteClientVariables</a></td> 181 <td><a href="#DebuggerInterfacePython.remoteClientVariables">remoteClientVariables</a></td>
186 <td>Public method to load a new program to debug.</td> 202 <td>Public method to load a new program to debug.</td>
187 </tr> 203 </tr>
188 <tr> 204 <tr>
189 <td><a href="#DebuggerInterfacePython.remoteMoveIP">remoteMoveIP</a></td> 205 <td><a href="#DebuggerInterfacePython.remoteMoveIP">remoteMoveIP</a></td>
190 <td>Public method to move the instruction pointer to a different line.</td> 206 <td>Public method to move the instruction pointer to a different line.</td>
207 </tr>
208 <tr>
209 <td><a href="#DebuggerInterfacePython.remoteNoDebugList">remoteNoDebugList</a></td>
210 <td>Public method to set a list of programs not to be debugged.</td>
191 </tr> 211 </tr>
192 <tr> 212 <tr>
193 <td><a href="#DebuggerInterfacePython.remoteProfile">remoteProfile</a></td> 213 <td><a href="#DebuggerInterfacePython.remoteProfile">remoteProfile</a></td>
194 <td>Public method to load a new program to collect profiling data.</td> 214 <td>Public method to load a new program to collect profiling data.</td>
195 </tr> 215 </tr>
296 <dt><i>passive</i> (bool)</dt> 316 <dt><i>passive</i> (bool)</dt>
297 <dd> 317 <dd>
298 flag indicating passive connection mode 318 flag indicating passive connection mode
299 </dd> 319 </dd>
300 </dl> 320 </dl>
301 <a NAME="DebuggerInterfacePython.__askForkTo" ID="DebuggerInterfacePython.__askForkTo"></a> 321 <a NAME="DebuggerInterfacePython.__assignDebuggerId" ID="DebuggerInterfacePython.__assignDebuggerId"></a>
302 <h4>DebuggerInterfacePython.__askForkTo</h4> 322 <h4>DebuggerInterfacePython.__assignDebuggerId</h4>
303 <b>__askForkTo</b>(<i></i>) 323 <b>__assignDebuggerId</b>(<i>sock, debuggerId</i>)
304 324
305 <p> 325 <p>
306 Private method to ask the user which branch of a fork to follow. 326 Private method to set the debugger id for a recent debugger connection
327 attempt.
328 </p>
329 <dl>
330
331 <dt><i>sock</i> (QTcpSocket)</dt>
332 <dd>
333 reference to the socket object
334 </dd>
335 <dt><i>debuggerId</i> (str)</dt>
336 <dd>
337 id of the connected debug client
338 </dd>
339 </dl>
340 <a NAME="DebuggerInterfacePython.__flush" ID="DebuggerInterfacePython.__flush"></a>
341 <h4>DebuggerInterfacePython.__flush</h4>
342 <b>__flush</b>(<i></i>)
343
344 <p>
345 Private slot to flush the queue.
307 </p> 346 </p>
308 <a NAME="DebuggerInterfacePython.__handleJsonCommand" ID="DebuggerInterfacePython.__handleJsonCommand"></a> 347 <a NAME="DebuggerInterfacePython.__handleJsonCommand" ID="DebuggerInterfacePython.__handleJsonCommand"></a>
309 <h4>DebuggerInterfacePython.__handleJsonCommand</h4> 348 <h4>DebuggerInterfacePython.__handleJsonCommand</h4>
310 <b>__handleJsonCommand</b>(<i>jsonStr</i>) 349 <b>__handleJsonCommand</b>(<i>jsonStr, sock</i>)
311 350
312 <p> 351 <p>
313 Private method to handle a command or response serialized as a 352 Private method to handle a command or response serialized as a
314 JSON string. 353 JSON string.
315 </p> 354 </p>
317 356
318 <dt><i>jsonStr</i> (str)</dt> 357 <dt><i>jsonStr</i> (str)</dt>
319 <dd> 358 <dd>
320 string containing the command or response received 359 string containing the command or response received
321 from the debug backend 360 from the debug backend
361 </dd>
362 <dt><i>sock</i> (QTcpSocket)</dt>
363 <dd>
364 reference to the socket the data was received from
322 </dd> 365 </dd>
323 </dl> 366 </dl>
324 <a NAME="DebuggerInterfacePython.__identityTranslation" ID="DebuggerInterfacePython.__identityTranslation"></a> 367 <a NAME="DebuggerInterfacePython.__identityTranslation" ID="DebuggerInterfacePython.__identityTranslation"></a>
325 <h4>DebuggerInterfacePython.__identityTranslation</h4> 368 <h4>DebuggerInterfacePython.__identityTranslation</h4>
326 <b>__identityTranslation</b>(<i>fn, remote2local=True</i>) 369 <b>__identityTranslation</b>(<i>fn, remote2local=True</i>)
328 <p> 371 <p>
329 Private method to perform the identity path translation. 372 Private method to perform the identity path translation.
330 </p> 373 </p>
331 <dl> 374 <dl>
332 375
333 <dt><i>fn</i></dt> 376 <dt><i>fn</i> (str)</dt>
334 <dd> 377 <dd>
335 filename to be translated (string) 378 filename to be translated
336 </dd> 379 </dd>
337 <dt><i>remote2local</i></dt> 380 <dt><i>remote2local</i> (bool)</dt>
338 <dd> 381 <dd>
339 flag indicating the direction of translation 382 flag indicating the direction of translation
340 (False = local to remote, True = remote to local [default]) 383 (False = local to remote, True = remote to local [default])
341 </dd> 384 </dd>
342 </dl> 385 </dl>
343 <dl> 386 <dl>
344 <dt>Returns:</dt> 387 <dt>Returns:</dt>
345 <dd> 388 <dd>
346 translated filename (string) 389 translated filename
390 </dd>
391 </dl>
392 <dl>
393 <dt>Return Type:</dt>
394 <dd>
395 str
347 </dd> 396 </dd>
348 </dl> 397 </dl>
349 <a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a> 398 <a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a>
350 <h4>DebuggerInterfacePython.__parseClientLine</h4> 399 <h4>DebuggerInterfacePython.__parseClientLine</h4>
351 <b>__parseClientLine</b>(<i></i>) 400 <b>__parseClientLine</b>(<i>sock</i>)
352 401
353 <p> 402 <p>
354 Private method to handle data from the client. 403 Private method to handle data from the client.
355 </p> 404 </p>
405 <dl>
406
407 <dt><i>sock</i> (QTcpSocket)</dt>
408 <dd>
409 reference to the socket to read data from
410 </dd>
411 </dl>
356 <a NAME="DebuggerInterfacePython.__remoteTranslation" ID="DebuggerInterfacePython.__remoteTranslation"></a> 412 <a NAME="DebuggerInterfacePython.__remoteTranslation" ID="DebuggerInterfacePython.__remoteTranslation"></a>
357 <h4>DebuggerInterfacePython.__remoteTranslation</h4> 413 <h4>DebuggerInterfacePython.__remoteTranslation</h4>
358 <b>__remoteTranslation</b>(<i>fn, remote2local=True</i>) 414 <b>__remoteTranslation</b>(<i>fn, remote2local=True</i>)
359 415
360 <p> 416 <p>
361 Private method to perform the path translation. 417 Private method to perform the path translation.
362 </p> 418 </p>
363 <dl> 419 <dl>
364 420
365 <dt><i>fn</i></dt> 421 <dt><i>fn</i> (str)</dt>
366 <dd> 422 <dd>
367 filename to be translated (string) 423 filename to be translated
368 </dd> 424 </dd>
369 <dt><i>remote2local</i></dt> 425 <dt><i>remote2local</i> (bool)</dt>
370 <dd> 426 <dd>
371 flag indicating the direction of translation 427 flag indicating the direction of translation
372 (False = local to remote, True = remote to local [default]) 428 (False = local to remote, True = remote to local [default])
373 </dd> 429 </dd>
374 </dl> 430 </dl>
375 <dl> 431 <dl>
376 <dt>Returns:</dt> 432 <dt>Returns:</dt>
377 <dd> 433 <dd>
378 translated filename (string) 434 translated filename
435 </dd>
436 </dl>
437 <dl>
438 <dt>Return Type:</dt>
439 <dd>
440 str
379 </dd> 441 </dd>
380 </dl> 442 </dl>
381 <a NAME="DebuggerInterfacePython.__sendJsonCommand" ID="DebuggerInterfacePython.__sendJsonCommand"></a> 443 <a NAME="DebuggerInterfacePython.__sendJsonCommand" ID="DebuggerInterfacePython.__sendJsonCommand"></a>
382 <h4>DebuggerInterfacePython.__sendJsonCommand</h4> 444 <h4>DebuggerInterfacePython.__sendJsonCommand</h4>
383 <b>__sendJsonCommand</b>(<i>command, params</i>) 445 <b>__sendJsonCommand</b>(<i>command, params, debuggerId="", sock=None</i>)
384 446
385 <p> 447 <p>
386 Private method to send a single command to the client. 448 Private method to send a single command to the client.
387 </p> 449 </p>
388 <dl> 450 <dl>
392 command name to be sent 454 command name to be sent
393 </dd> 455 </dd>
394 <dt><i>params</i> (dict)</dt> 456 <dt><i>params</i> (dict)</dt>
395 <dd> 457 <dd>
396 dictionary of named parameters for the command 458 dictionary of named parameters for the command
459 </dd>
460 <dt><i>debuggerId</i> (str)</dt>
461 <dd>
462 id of the debug client to send the command to
463 </dd>
464 <dt><i>sock</i> (QTcpSocket)</dt>
465 <dd>
466 reference to the socket object to be used (only used if
467 debuggerId is not given)
468 </dd>
469 </dl>
470 <a NAME="DebuggerInterfacePython.__shutdownSocket" ID="DebuggerInterfacePython.__shutdownSocket"></a>
471 <h4>DebuggerInterfacePython.__shutdownSocket</h4>
472 <b>__shutdownSocket</b>(<i>sock</i>)
473
474 <p>
475 Private slot to shut down a socket.
476 </p>
477 <dl>
478
479 <dt><i>sock</i> (QTcpSocket)</dt>
480 <dd>
481 reference to the socket
482 </dd>
483 </dl>
484 <a NAME="DebuggerInterfacePython.__socketDisconnected" ID="DebuggerInterfacePython.__socketDisconnected"></a>
485 <h4>DebuggerInterfacePython.__socketDisconnected</h4>
486 <b>__socketDisconnected</b>(<i>sock</i>)
487
488 <p>
489 Private slot handling a socket disconnecting.
490 </p>
491 <dl>
492
493 <dt><i>sock</i> (QTcpSocket)</dt>
494 <dd>
495 reference to the disconnected socket
397 </dd> 496 </dd>
398 </dl> 497 </dl>
399 <a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a> 498 <a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a>
400 <h4>DebuggerInterfacePython.__startProcess</h4> 499 <h4>DebuggerInterfacePython.__startProcess</h4>
401 <b>__startProcess</b>(<i>program, arguments, environment=None, workingDir=None</i>) 500 <b>__startProcess</b>(<i>program, arguments, environment=None, workingDir=None</i>)
434 QProcess or None 533 QProcess or None
435 </dd> 534 </dd>
436 </dl> 535 </dl>
437 <a NAME="DebuggerInterfacePython.__writeJsonCommandToSocket" ID="DebuggerInterfacePython.__writeJsonCommandToSocket"></a> 536 <a NAME="DebuggerInterfacePython.__writeJsonCommandToSocket" ID="DebuggerInterfacePython.__writeJsonCommandToSocket"></a>
438 <h4>DebuggerInterfacePython.__writeJsonCommandToSocket</h4> 537 <h4>DebuggerInterfacePython.__writeJsonCommandToSocket</h4>
439 <b>__writeJsonCommandToSocket</b>(<i>cmd</i>) 538 <b>__writeJsonCommandToSocket</b>(<i>cmd, sock</i>)
440 539
441 <p> 540 <p>
442 Private method to write a JSON command to the socket. 541 Private method to write a JSON command to the socket.
443 </p> 542 </p>
444 <dl> 543 <dl>
445 544
446 <dt><i>cmd</i> (str)</dt> 545 <dt><i>cmd</i> (str)</dt>
447 <dd> 546 <dd>
448 JSON command to be sent 547 JSON command to be sent
449 </dd> 548 </dd>
450 </dl> 549 <dt><i>sock</i> (QTcpSocket)</dt>
451 <a NAME="DebuggerInterfacePython.flush" ID="DebuggerInterfacePython.flush"></a> 550 <dd>
452 <h4>DebuggerInterfacePython.flush</h4> 551 reference to the socket to write to
453 <b>flush</b>(<i></i>) 552 </dd>
454 553 </dl>
455 <p>
456 Public slot to flush the queue.
457 </p>
458 <a NAME="DebuggerInterfacePython.getClientCapabilities" ID="DebuggerInterfacePython.getClientCapabilities"></a> 554 <a NAME="DebuggerInterfacePython.getClientCapabilities" ID="DebuggerInterfacePython.getClientCapabilities"></a>
459 <h4>DebuggerInterfacePython.getClientCapabilities</h4> 555 <h4>DebuggerInterfacePython.getClientCapabilities</h4>
460 <b>getClientCapabilities</b>(<i></i>) 556 <b>getClientCapabilities</b>(<i></i>)
461 557
462 <p> 558 <p>
463 Public method to retrieve the debug clients capabilities. 559 Public method to retrieve the debug clients capabilities.
464 </p> 560 </p>
465 <dl> 561 <dl>
466 <dt>Returns:</dt> 562 <dt>Returns:</dt>
467 <dd> 563 <dd>
468 debug client capabilities (integer) 564 debug client capabilities
565 </dd>
566 </dl>
567 <dl>
568 <dt>Return Type:</dt>
569 <dd>
570 int
571 </dd>
572 </dl>
573 <a NAME="DebuggerInterfacePython.getDebuggerIds" ID="DebuggerInterfacePython.getDebuggerIds"></a>
574 <h4>DebuggerInterfacePython.getDebuggerIds</h4>
575 <b>getDebuggerIds</b>(<i></i>)
576
577 <p>
578 Public method to return the IDs of the connected debugger backends.
579 </p>
580 <dl>
581 <dt>Returns:</dt>
582 <dd>
583 list of connected debugger backend IDs
584 </dd>
585 </dl>
586 <dl>
587 <dt>Return Type:</dt>
588 <dd>
589 list of str
469 </dd> 590 </dd>
470 </dl> 591 </dl>
471 <a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a> 592 <a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a>
472 <h4>DebuggerInterfacePython.isConnected</h4> 593 <h4>DebuggerInterfacePython.isConnected</h4>
473 <b>isConnected</b>(<i></i>) 594 <b>isConnected</b>(<i></i>)
476 Public method to test, if a debug client has connected. 597 Public method to test, if a debug client has connected.
477 </p> 598 </p>
478 <dl> 599 <dl>
479 <dt>Returns:</dt> 600 <dt>Returns:</dt>
480 <dd> 601 <dd>
481 flag indicating the connection status (boolean) 602 flag indicating the connection status
603 </dd>
604 </dl>
605 <dl>
606 <dt>Return Type:</dt>
607 <dd>
608 bool
482 </dd> 609 </dd>
483 </dl> 610 </dl>
484 <a NAME="DebuggerInterfacePython.newConnection" ID="DebuggerInterfacePython.newConnection"></a> 611 <a NAME="DebuggerInterfacePython.newConnection" ID="DebuggerInterfacePython.newConnection"></a>
485 <h4>DebuggerInterfacePython.newConnection</h4> 612 <h4>DebuggerInterfacePython.newConnection</h4>
486 <b>newConnection</b>(<i>sock</i>) 613 <b>newConnection</b>(<i>sock</i>)
488 <p> 615 <p>
489 Public slot to handle a new connection. 616 Public slot to handle a new connection.
490 </p> 617 </p>
491 <dl> 618 <dl>
492 619
493 <dt><i>sock</i></dt> 620 <dt><i>sock</i> (QTcpSocket)</dt>
494 <dd> 621 <dd>
495 reference to the socket object (QTcpSocket) 622 reference to the socket object
496 </dd> 623 </dd>
497 </dl> 624 </dl>
498 <dl> 625 <dl>
499 <dt>Returns:</dt> 626 <dt>Returns:</dt>
500 <dd> 627 <dd>
501 flag indicating success (boolean) 628 flag indicating success
629 </dd>
630 </dl>
631 <dl>
632 <dt>Return Type:</dt>
633 <dd>
634 bool
502 </dd> 635 </dd>
503 </dl> 636 </dl>
504 <a NAME="DebuggerInterfacePython.remoteBanner" ID="DebuggerInterfacePython.remoteBanner"></a> 637 <a NAME="DebuggerInterfacePython.remoteBanner" ID="DebuggerInterfacePython.remoteBanner"></a>
505 <h4>DebuggerInterfacePython.remoteBanner</h4> 638 <h4>DebuggerInterfacePython.remoteBanner</h4>
506 <b>remoteBanner</b>(<i></i>) 639 <b>remoteBanner</b>(<i></i>)
508 <p> 641 <p>
509 Public slot to get the banner info of the remote client. 642 Public slot to get the banner info of the remote client.
510 </p> 643 </p>
511 <a NAME="DebuggerInterfacePython.remoteBreakpoint" ID="DebuggerInterfacePython.remoteBreakpoint"></a> 644 <a NAME="DebuggerInterfacePython.remoteBreakpoint" ID="DebuggerInterfacePython.remoteBreakpoint"></a>
512 <h4>DebuggerInterfacePython.remoteBreakpoint</h4> 645 <h4>DebuggerInterfacePython.remoteBreakpoint</h4>
513 <b>remoteBreakpoint</b>(<i>fn, line, setBreakpoint, cond=None, temp=False</i>) 646 <b>remoteBreakpoint</b>(<i>debuggerId, fn, line, setBreakpoint, cond=None, temp=False</i>)
514 647
515 <p> 648 <p>
516 Public method to set or clear a breakpoint. 649 Public method to set or clear a breakpoint.
517 </p> 650 </p>
518 <dl> 651 <dl>
519 652
520 <dt><i>fn</i></dt> 653 <dt><i>debuggerId</i> (str)</dt>
521 <dd> 654 <dd>
522 filename the breakpoint belongs to (string) 655 ID of the debugger backend
523 </dd> 656 </dd>
524 <dt><i>line</i></dt> 657 <dt><i>fn</i> (str)</dt>
525 <dd> 658 <dd>
526 linenumber of the breakpoint (int) 659 filename the breakpoint belongs to
527 </dd> 660 </dd>
528 <dt><i>setBreakpoint</i></dt> 661 <dt><i>line</i> (int)</dt>
529 <dd> 662 <dd>
530 flag indicating setting or resetting a 663 linenumber of the breakpoint
531 breakpoint (boolean) 664 </dd>
532 </dd> 665 <dt><i>setBreakpoint</i> (bool)</dt>
533 <dt><i>cond</i></dt> 666 <dd>
534 <dd> 667 flag indicating setting or resetting a breakpoint
535 condition of the breakpoint (string) 668 </dd>
536 </dd> 669 <dt><i>cond</i> (str)</dt>
537 <dt><i>temp</i></dt> 670 <dd>
538 <dd> 671 condition of the breakpoint
539 flag indicating a temporary breakpoint (boolean) 672 </dd>
673 <dt><i>temp</i> (bool)</dt>
674 <dd>
675 flag indicating a temporary breakpoint
540 </dd> 676 </dd>
541 </dl> 677 </dl>
542 <a NAME="DebuggerInterfacePython.remoteBreakpointEnable" ID="DebuggerInterfacePython.remoteBreakpointEnable"></a> 678 <a NAME="DebuggerInterfacePython.remoteBreakpointEnable" ID="DebuggerInterfacePython.remoteBreakpointEnable"></a>
543 <h4>DebuggerInterfacePython.remoteBreakpointEnable</h4> 679 <h4>DebuggerInterfacePython.remoteBreakpointEnable</h4>
544 <b>remoteBreakpointEnable</b>(<i>fn, line, enable</i>) 680 <b>remoteBreakpointEnable</b>(<i>debuggerId, fn, line, enable</i>)
545 681
546 <p> 682 <p>
547 Public method to enable or disable a breakpoint. 683 Public method to enable or disable a breakpoint.
548 </p> 684 </p>
549 <dl> 685 <dl>
550 686
551 <dt><i>fn</i></dt> 687 <dt><i>debuggerId</i> (str)</dt>
552 <dd> 688 <dd>
553 filename the breakpoint belongs to (string) 689 ID of the debugger backend
554 </dd> 690 </dd>
555 <dt><i>line</i></dt> 691 <dt><i>fn</i> (str)</dt>
556 <dd> 692 <dd>
557 linenumber of the breakpoint (int) 693 filename the breakpoint belongs to
558 </dd> 694 </dd>
559 <dt><i>enable</i></dt> 695 <dt><i>line</i> (int)</dt>
696 <dd>
697 linenumber of the breakpoint
698 </dd>
699 <dt><i>enable</i> (bool)</dt>
560 <dd> 700 <dd>
561 flag indicating enabling or disabling a breakpoint 701 flag indicating enabling or disabling a breakpoint
562 (boolean)
563 </dd> 702 </dd>
564 </dl> 703 </dl>
565 <a NAME="DebuggerInterfacePython.remoteBreakpointIgnore" ID="DebuggerInterfacePython.remoteBreakpointIgnore"></a> 704 <a NAME="DebuggerInterfacePython.remoteBreakpointIgnore" ID="DebuggerInterfacePython.remoteBreakpointIgnore"></a>
566 <h4>DebuggerInterfacePython.remoteBreakpointIgnore</h4> 705 <h4>DebuggerInterfacePython.remoteBreakpointIgnore</h4>
567 <b>remoteBreakpointIgnore</b>(<i>fn, line, count</i>) 706 <b>remoteBreakpointIgnore</b>(<i>debuggerId, fn, line, count</i>)
568 707
569 <p> 708 <p>
570 Public method to ignore a breakpoint the next couple of occurrences. 709 Public method to ignore a breakpoint the next couple of occurrences.
571 </p> 710 </p>
572 <dl> 711 <dl>
573 712
574 <dt><i>fn</i></dt> 713 <dt><i>debuggerId</i> (str)</dt>
575 <dd> 714 <dd>
576 filename the breakpoint belongs to (string) 715 ID of the debugger backend
577 </dd> 716 </dd>
578 <dt><i>line</i></dt> 717 <dt><i>fn</i> (str)</dt>
579 <dd> 718 <dd>
580 linenumber of the breakpoint (int) 719 filename the breakpoint belongs to
581 </dd> 720 </dd>
582 <dt><i>count</i></dt> 721 <dt><i>line</i> (int)</dt>
583 <dd> 722 <dd>
584 number of occurrences to ignore (int) 723 linenumber of the breakpoint
724 </dd>
725 <dt><i>count</i> (int)</dt>
726 <dd>
727 number of occurrences to ignore
585 </dd> 728 </dd>
586 </dl> 729 </dl>
587 <a NAME="DebuggerInterfacePython.remoteCapabilities" ID="DebuggerInterfacePython.remoteCapabilities"></a> 730 <a NAME="DebuggerInterfacePython.remoteCapabilities" ID="DebuggerInterfacePython.remoteCapabilities"></a>
588 <h4>DebuggerInterfacePython.remoteCapabilities</h4> 731 <h4>DebuggerInterfacePython.remoteCapabilities</h4>
589 <b>remoteCapabilities</b>(<i></i>) 732 <b>remoteCapabilities</b>(<i>debuggerId</i>)
590 733
591 <p> 734 <p>
592 Public slot to get the debug clients capabilities. 735 Public slot to get the debug clients capabilities.
593 </p> 736 </p>
737 <dl>
738
739 <dt><i>debuggerId</i> (str)</dt>
740 <dd>
741 ID of the debugger backend
742 </dd>
743 </dl>
594 <a NAME="DebuggerInterfacePython.remoteClientDisassembly" ID="DebuggerInterfacePython.remoteClientDisassembly"></a> 744 <a NAME="DebuggerInterfacePython.remoteClientDisassembly" ID="DebuggerInterfacePython.remoteClientDisassembly"></a>
595 <h4>DebuggerInterfacePython.remoteClientDisassembly</h4> 745 <h4>DebuggerInterfacePython.remoteClientDisassembly</h4>
596 <b>remoteClientDisassembly</b>(<i></i>) 746 <b>remoteClientDisassembly</b>(<i>debuggerId</i>)
597 747
598 <p> 748 <p>
599 Public method to ask the client for the latest traceback disassembly. 749 Public method to ask the client for the latest traceback disassembly.
600 </p> 750 </p>
751 <dl>
752
753 <dt><i>debuggerId</i> (str)</dt>
754 <dd>
755 ID of the debugger backend
756 </dd>
757 </dl>
601 <a NAME="DebuggerInterfacePython.remoteClientSetFilter" ID="DebuggerInterfacePython.remoteClientSetFilter"></a> 758 <a NAME="DebuggerInterfacePython.remoteClientSetFilter" ID="DebuggerInterfacePython.remoteClientSetFilter"></a>
602 <h4>DebuggerInterfacePython.remoteClientSetFilter</h4> 759 <h4>DebuggerInterfacePython.remoteClientSetFilter</h4>
603 <b>remoteClientSetFilter</b>(<i>scope, filterStr</i>) 760 <b>remoteClientSetFilter</b>(<i>debuggerId, scope, filterStr</i>)
604 761
605 <p> 762 <p>
606 Public method to set a variables filter list. 763 Public method to set a variables filter list.
607 </p> 764 </p>
608 <dl> 765 <dl>
609 766
610 <dt><i>scope</i></dt> 767 <dt><i>debuggerId</i> (str)</dt>
768 <dd>
769 ID of the debugger backend
770 </dd>
771 <dt><i>scope</i> (int)</dt>
611 <dd> 772 <dd>
612 the scope of the variables (0 = local, 1 = global) 773 the scope of the variables (0 = local, 1 = global)
613 </dd> 774 </dd>
614 <dt><i>filterStr</i></dt> 775 <dt><i>filterStr</i> (str)</dt>
615 <dd> 776 <dd>
616 regexp string for variable names to filter out 777 regexp string for variable names to filter out
617 (string) 778 </dd>
779 </dl>
780 <a NAME="DebuggerInterfacePython.remoteClientStack" ID="DebuggerInterfacePython.remoteClientStack"></a>
781 <h4>DebuggerInterfacePython.remoteClientStack</h4>
782 <b>remoteClientStack</b>(<i>debuggerId</i>)
783
784 <p>
785 Public method to request the stack of the main thread.
786 </p>
787 <dl>
788
789 <dt><i>debuggerId</i> (str)</dt>
790 <dd>
791 ID of the debugger backend
618 </dd> 792 </dd>
619 </dl> 793 </dl>
620 <a NAME="DebuggerInterfacePython.remoteClientVariable" ID="DebuggerInterfacePython.remoteClientVariable"></a> 794 <a NAME="DebuggerInterfacePython.remoteClientVariable" ID="DebuggerInterfacePython.remoteClientVariable"></a>
621 <h4>DebuggerInterfacePython.remoteClientVariable</h4> 795 <h4>DebuggerInterfacePython.remoteClientVariable</h4>
622 <b>remoteClientVariable</b>(<i>scope, filterList, var, framenr=0, maxSize=0</i>) 796 <b>remoteClientVariable</b>(<i>debuggerId, scope, filterList, var, framenr=0, maxSize=0</i>)
623 797
624 <p> 798 <p>
625 Public method to request the variables of the debugged program. 799 Public method to request the variables of the debugged program.
626 </p> 800 </p>
627 <dl> 801 <dl>
628 802
803 <dt><i>debuggerId</i> (str)</dt>
804 <dd>
805 ID of the debugger backend
806 </dd>
629 <dt><i>scope</i> (int)</dt> 807 <dt><i>scope</i> (int)</dt>
630 <dd> 808 <dd>
631 the scope of the variables (0 = local, 1 = global) 809 the scope of the variables (0 = local, 1 = global)
632 </dd> 810 </dd>
633 <dt><i>filterList</i> (list of int)</dt> 811 <dt><i>filterList</i> (list of str)</dt>
634 <dd> 812 <dd>
635 list of variable types to filter out 813 list of variable types to filter out
636 </dd> 814 </dd>
637 <dt><i>var</i> (list of str)</dt> 815 <dt><i>var</i> (list of str)</dt>
638 <dd> 816 <dd>
649 be given (@@TOO_BIG_TO_SHOW@@). 827 be given (@@TOO_BIG_TO_SHOW@@).
650 </dd> 828 </dd>
651 </dl> 829 </dl>
652 <a NAME="DebuggerInterfacePython.remoteClientVariables" ID="DebuggerInterfacePython.remoteClientVariables"></a> 830 <a NAME="DebuggerInterfacePython.remoteClientVariables" ID="DebuggerInterfacePython.remoteClientVariables"></a>
653 <h4>DebuggerInterfacePython.remoteClientVariables</h4> 831 <h4>DebuggerInterfacePython.remoteClientVariables</h4>
654 <b>remoteClientVariables</b>(<i>scope, filterList, framenr=0, maxSize=0</i>) 832 <b>remoteClientVariables</b>(<i>debuggerId, scope, filterList, framenr=0, maxSize=0</i>)
655 833
656 <p> 834 <p>
657 Public method to request the variables of the debugged program. 835 Public method to request the variables of the debugged program.
658 </p> 836 </p>
659 <dl> 837 <dl>
660 838
839 <dt><i>debuggerId</i> (str)</dt>
840 <dd>
841 ID of the debugger backend
842 </dd>
661 <dt><i>scope</i> (int)</dt> 843 <dt><i>scope</i> (int)</dt>
662 <dd> 844 <dd>
663 the scope of the variables (0 = local, 1 = global) 845 the scope of the variables (0 = local, 1 = global)
664 </dd> 846 </dd>
665 <dt><i>filterList</i> (list of int)</dt> 847 <dt><i>filterList</i> (list of str)</dt>
666 <dd> 848 <dd>
667 list of variable types to filter out 849 list of variable types to filter out
668 </dd> 850 </dd>
669 <dt><i>framenr</i> (int)</dt> 851 <dt><i>framenr</i> (int)</dt>
670 <dd> 852 <dd>
677 be given (@@TOO_BIG_TO_SHOW@@). 859 be given (@@TOO_BIG_TO_SHOW@@).
678 </dd> 860 </dd>
679 </dl> 861 </dl>
680 <a NAME="DebuggerInterfacePython.remoteCompletion" ID="DebuggerInterfacePython.remoteCompletion"></a> 862 <a NAME="DebuggerInterfacePython.remoteCompletion" ID="DebuggerInterfacePython.remoteCompletion"></a>
681 <h4>DebuggerInterfacePython.remoteCompletion</h4> 863 <h4>DebuggerInterfacePython.remoteCompletion</h4>
682 <b>remoteCompletion</b>(<i>text</i>) 864 <b>remoteCompletion</b>(<i>debuggerId, text</i>)
683 865
684 <p> 866 <p>
685 Public slot to get the a list of possible commandline completions 867 Public slot to get the a list of possible commandline completions
686 from the remote client. 868 from the remote client.
687 </p> 869 </p>
688 <dl> 870 <dl>
689 871
690 <dt><i>text</i></dt> 872 <dt><i>debuggerId</i> (str)</dt>
691 <dd> 873 <dd>
692 the text to be completed (string) 874 ID of the debugger backend
875 </dd>
876 <dt><i>text</i> (str)</dt>
877 <dd>
878 the text to be completed
693 </dd> 879 </dd>
694 </dl> 880 </dl>
695 <a NAME="DebuggerInterfacePython.remoteContinue" ID="DebuggerInterfacePython.remoteContinue"></a> 881 <a NAME="DebuggerInterfacePython.remoteContinue" ID="DebuggerInterfacePython.remoteContinue"></a>
696 <h4>DebuggerInterfacePython.remoteContinue</h4> 882 <h4>DebuggerInterfacePython.remoteContinue</h4>
697 <b>remoteContinue</b>(<i>special=False</i>) 883 <b>remoteContinue</b>(<i>debuggerId, special=False</i>)
698 884
699 <p> 885 <p>
700 Public method to continue the debugged program. 886 Public method to continue the debugged program.
701 </p> 887 </p>
702 <dl> 888 <dl>
703 889
704 <dt><i>special</i></dt> 890 <dt><i>debuggerId</i> (str)</dt>
891 <dd>
892 ID of the debugger backend
893 </dd>
894 <dt><i>special</i> (bool)</dt>
705 <dd> 895 <dd>
706 flag indicating a special continue operation 896 flag indicating a special continue operation
707 </dd> 897 </dd>
708 </dl> 898 </dl>
709 <a NAME="DebuggerInterfacePython.remoteCoverage" ID="DebuggerInterfacePython.remoteCoverage"></a> 899 <a NAME="DebuggerInterfacePython.remoteCoverage" ID="DebuggerInterfacePython.remoteCoverage"></a>
713 <p> 903 <p>
714 Public method to load a new program to collect coverage data. 904 Public method to load a new program to collect coverage data.
715 </p> 905 </p>
716 <dl> 906 <dl>
717 907
718 <dt><i>fn</i></dt> 908 <dt><i>fn</i> (str)</dt>
719 <dd> 909 <dd>
720 the filename to run (string) 910 the filename to run
721 </dd> 911 </dd>
722 <dt><i>argv</i></dt> 912 <dt><i>argv</i> (str)</dt>
723 <dd> 913 <dd>
724 the commandline arguments to pass to the program (string) 914 the commandline arguments to pass to the program
725 </dd> 915 </dd>
726 <dt><i>wd</i></dt> 916 <dt><i>wd</i> (str)</dt>
727 <dd> 917 <dd>
728 the working directory for the program (string) 918 the working directory for the program
729 </dd> 919 </dd>
730 <dt><i>erase=</i></dt> 920 <dt><i>erase</i> (bool)</dt>
731 <dd> 921 <dd>
732 flag indicating that coverage info should be 922 flag indicating that coverage info should be
733 cleared first (boolean) 923 cleared first
734 </dd> 924 </dd>
735 </dl> 925 </dl>
736 <a NAME="DebuggerInterfacePython.remoteEnvironment" ID="DebuggerInterfacePython.remoteEnvironment"></a> 926 <a NAME="DebuggerInterfacePython.remoteEnvironment" ID="DebuggerInterfacePython.remoteEnvironment"></a>
737 <h4>DebuggerInterfacePython.remoteEnvironment</h4> 927 <h4>DebuggerInterfacePython.remoteEnvironment</h4>
738 <b>remoteEnvironment</b>(<i>env</i>) 928 <b>remoteEnvironment</b>(<i>env</i>)
740 <p> 930 <p>
741 Public method to set the environment for a program to debug, run, ... 931 Public method to set the environment for a program to debug, run, ...
742 </p> 932 </p>
743 <dl> 933 <dl>
744 934
745 <dt><i>env</i></dt> 935 <dt><i>env</i> (dict)</dt>
746 <dd> 936 <dd>
747 environment settings (dictionary) 937 environment settings
748 </dd> 938 </dd>
749 </dl> 939 </dl>
750 <a NAME="DebuggerInterfacePython.remoteLoad" ID="DebuggerInterfacePython.remoteLoad"></a> 940 <a NAME="DebuggerInterfacePython.remoteLoad" ID="DebuggerInterfacePython.remoteLoad"></a>
751 <h4>DebuggerInterfacePython.remoteLoad</h4> 941 <h4>DebuggerInterfacePython.remoteLoad</h4>
752 <b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter=False, autoContinue=True, autoFork=False, forkChild=False</i>) 942 <b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter=False, autoContinue=True, enableMultiprocess=False</i>)
753 943
754 <p> 944 <p>
755 Public method to load a new program to debug. 945 Public method to load a new program to debug.
756 </p> 946 </p>
757 <dl> 947 <dl>
758 948
759 <dt><i>fn</i></dt> 949 <dt><i>fn</i> (str)</dt>
760 <dd> 950 <dd>
761 the filename to debug (string) 951 the filename to debug
762 </dd> 952 </dd>
763 <dt><i>argv</i></dt> 953 <dt><i>argv</i> (str)</dt>
764 <dd> 954 <dd>
765 the commandline arguments to pass to the program (string) 955 the commandline arguments to pass to the program
766 </dd> 956 </dd>
767 <dt><i>wd</i></dt> 957 <dt><i>wd</i> (str)</dt>
768 <dd> 958 <dd>
769 the working directory for the program (string) 959 the working directory for the program
770 </dd> 960 </dd>
771 <dt><i>traceInterpreter=</i></dt> 961 <dt><i>traceInterpreter</i> (bool)</dt>
772 <dd> 962 <dd>
773 flag indicating if the interpreter library 963 flag indicating if the interpreter library
774 should be traced as well (boolean) 964 should be traced as well
775 </dd> 965 </dd>
776 <dt><i>autoContinue=</i></dt> 966 <dt><i>autoContinue</i> (bool)</dt>
777 <dd> 967 <dd>
778 flag indicating, that the debugger should not 968 flag indicating, that the debugger should not
779 stop at the first executable line (boolean) 969 stop at the first executable line
780 </dd> 970 </dd>
781 <dt><i>autoFork=</i></dt> 971 <dt><i>enableMultiprocess</i> (bool)</dt>
782 <dd> 972 <dd>
783 flag indicating the automatic fork mode (boolean) 973 flag indicating to perform multiprocess
784 </dd> 974 debugging
785 <dt><i>forkChild=</i></dt>
786 <dd>
787 flag indicating to debug the child after forking
788 (boolean)
789 </dd> 975 </dd>
790 </dl> 976 </dl>
791 <a NAME="DebuggerInterfacePython.remoteMoveIP" ID="DebuggerInterfacePython.remoteMoveIP"></a> 977 <a NAME="DebuggerInterfacePython.remoteMoveIP" ID="DebuggerInterfacePython.remoteMoveIP"></a>
792 <h4>DebuggerInterfacePython.remoteMoveIP</h4> 978 <h4>DebuggerInterfacePython.remoteMoveIP</h4>
793 <b>remoteMoveIP</b>(<i>line</i>) 979 <b>remoteMoveIP</b>(<i>debuggerId, line</i>)
794 980
795 <p> 981 <p>
796 Public method to move the instruction pointer to a different line. 982 Public method to move the instruction pointer to a different line.
797 </p> 983 </p>
798 <dl> 984 <dl>
799 985
800 <dt><i>line</i></dt> 986 <dt><i>debuggerId</i> (str)</dt>
987 <dd>
988 ID of the debugger backend
989 </dd>
990 <dt><i>line</i> (int)</dt>
801 <dd> 991 <dd>
802 the new line, where execution should be continued 992 the new line, where execution should be continued
993 </dd>
994 </dl>
995 <a NAME="DebuggerInterfacePython.remoteNoDebugList" ID="DebuggerInterfacePython.remoteNoDebugList"></a>
996 <h4>DebuggerInterfacePython.remoteNoDebugList</h4>
997 <b>remoteNoDebugList</b>(<i>debuggerId, noDebugList</i>)
998
999 <p>
1000 Public method to set a list of programs not to be debugged.
1001 </p>
1002 <p>
1003 The programs given in the list will not be run under the control
1004 of the multi process debugger.
1005 </p>
1006 <dl>
1007
1008 <dt><i>debuggerId</i> (str)</dt>
1009 <dd>
1010 ID of the debugger backend
1011 </dd>
1012 <dt><i>noDebugList</i> (list of str)</dt>
1013 <dd>
1014 list of Python programs not to be debugged
803 </dd> 1015 </dd>
804 </dl> 1016 </dl>
805 <a NAME="DebuggerInterfacePython.remoteProfile" ID="DebuggerInterfacePython.remoteProfile"></a> 1017 <a NAME="DebuggerInterfacePython.remoteProfile" ID="DebuggerInterfacePython.remoteProfile"></a>
806 <h4>DebuggerInterfacePython.remoteProfile</h4> 1018 <h4>DebuggerInterfacePython.remoteProfile</h4>
807 <b>remoteProfile</b>(<i>fn, argv, wd, erase=False</i>) 1019 <b>remoteProfile</b>(<i>fn, argv, wd, erase=False</i>)
809 <p> 1021 <p>
810 Public method to load a new program to collect profiling data. 1022 Public method to load a new program to collect profiling data.
811 </p> 1023 </p>
812 <dl> 1024 <dl>
813 1025
814 <dt><i>fn</i></dt> 1026 <dt><i>fn</i> (str)</dt>
815 <dd> 1027 <dd>
816 the filename to run (string) 1028 the filename to run
817 </dd> 1029 </dd>
818 <dt><i>argv</i></dt> 1030 <dt><i>argv</i> (str)</dt>
819 <dd> 1031 <dd>
820 the commandline arguments to pass to the program (string) 1032 the commandline arguments to pass to the program
821 </dd> 1033 </dd>
822 <dt><i>wd</i></dt> 1034 <dt><i>wd</i> (str)</dt>
823 <dd> 1035 <dd>
824 the working directory for the program (string) 1036 the working directory for the program
825 </dd> 1037 </dd>
826 <dt><i>erase=</i></dt> 1038 <dt><i>erase</i> (bool)</dt>
827 <dd> 1039 <dd>
828 flag indicating that timing info should be cleared 1040 flag indicating that timing info should be cleared
829 first (boolean) 1041 first
830 </dd> 1042 </dd>
831 </dl> 1043 </dl>
832 <a NAME="DebuggerInterfacePython.remoteRawInput" ID="DebuggerInterfacePython.remoteRawInput"></a> 1044 <a NAME="DebuggerInterfacePython.remoteRawInput" ID="DebuggerInterfacePython.remoteRawInput"></a>
833 <h4>DebuggerInterfacePython.remoteRawInput</h4> 1045 <h4>DebuggerInterfacePython.remoteRawInput</h4>
834 <b>remoteRawInput</b>(<i>s</i>) 1046 <b>remoteRawInput</b>(<i>debuggerId, inputString</i>)
835 1047
836 <p> 1048 <p>
837 Public method to send the raw input to the debugged program. 1049 Public method to send the raw input to the debugged program.
838 </p> 1050 </p>
839 <dl> 1051 <dl>
840 1052
841 <dt><i>s</i></dt> 1053 <dt><i>debuggerId</i> (str)</dt>
842 <dd> 1054 <dd>
843 the raw input (string) 1055 ID of the debugger backend
1056 </dd>
1057 <dt><i>inputString</i> (str)</dt>
1058 <dd>
1059 the raw input
844 </dd> 1060 </dd>
845 </dl> 1061 </dl>
846 <a NAME="DebuggerInterfacePython.remoteRun" ID="DebuggerInterfacePython.remoteRun"></a> 1062 <a NAME="DebuggerInterfacePython.remoteRun" ID="DebuggerInterfacePython.remoteRun"></a>
847 <h4>DebuggerInterfacePython.remoteRun</h4> 1063 <h4>DebuggerInterfacePython.remoteRun</h4>
848 <b>remoteRun</b>(<i>fn, argv, wd, autoFork=False, forkChild=False</i>) 1064 <b>remoteRun</b>(<i>fn, argv, wd</i>)
849 1065
850 <p> 1066 <p>
851 Public method to load a new program to run. 1067 Public method to load a new program to run.
852 </p> 1068 </p>
853 <dl> 1069 <dl>
854 1070
855 <dt><i>fn</i></dt> 1071 <dt><i>fn</i> (str)</dt>
856 <dd> 1072 <dd>
857 the filename to run (string) 1073 the filename to run
858 </dd> 1074 </dd>
859 <dt><i>argv</i></dt> 1075 <dt><i>argv</i> (str)</dt>
860 <dd> 1076 <dd>
861 the commandline arguments to pass to the program (string) 1077 the commandline arguments to pass to the program
862 </dd> 1078 </dd>
863 <dt><i>wd</i></dt> 1079 <dt><i>wd</i> (str)</dt>
864 <dd> 1080 <dd>
865 the working directory for the program (string) 1081 the working directory for the program
866 </dd>
867 <dt><i>autoFork=</i></dt>
868 <dd>
869 flag indicating the automatic fork mode (boolean)
870 </dd>
871 <dt><i>forkChild=</i></dt>
872 <dd>
873 flag indicating to debug the child after forking
874 (boolean)
875 </dd> 1082 </dd>
876 </dl> 1083 </dl>
877 <a NAME="DebuggerInterfacePython.remoteSetThread" ID="DebuggerInterfacePython.remoteSetThread"></a> 1084 <a NAME="DebuggerInterfacePython.remoteSetThread" ID="DebuggerInterfacePython.remoteSetThread"></a>
878 <h4>DebuggerInterfacePython.remoteSetThread</h4> 1085 <h4>DebuggerInterfacePython.remoteSetThread</h4>
879 <b>remoteSetThread</b>(<i>tid</i>) 1086 <b>remoteSetThread</b>(<i>debuggerId, tid</i>)
880 1087
881 <p> 1088 <p>
882 Public method to request to set the given thread as current thread. 1089 Public method to request to set the given thread as current thread.
883 </p> 1090 </p>
884 <dl> 1091 <dl>
885 1092
886 <dt><i>tid</i></dt> 1093 <dt><i>debuggerId</i> (str)</dt>
887 <dd> 1094 <dd>
888 id of the thread (integer) 1095 ID of the debugger backend
1096 </dd>
1097 <dt><i>tid</i> (int)</dt>
1098 <dd>
1099 id of the thread
889 </dd> 1100 </dd>
890 </dl> 1101 </dl>
891 <a NAME="DebuggerInterfacePython.remoteStatement" ID="DebuggerInterfacePython.remoteStatement"></a> 1102 <a NAME="DebuggerInterfacePython.remoteStatement" ID="DebuggerInterfacePython.remoteStatement"></a>
892 <h4>DebuggerInterfacePython.remoteStatement</h4> 1103 <h4>DebuggerInterfacePython.remoteStatement</h4>
893 <b>remoteStatement</b>(<i>stmt</i>) 1104 <b>remoteStatement</b>(<i>debuggerId, stmt</i>)
894 1105
895 <p> 1106 <p>
896 Public method to execute a Python statement. 1107 Public method to execute a Python statement.
897 </p> 1108 </p>
898 <dl> 1109 <dl>
899 1110
900 <dt><i>stmt</i></dt> 1111 <dt><i>debuggerId</i> (str)</dt>
901 <dd> 1112 <dd>
902 the Python statement to execute (string). It 1113 ID of the debugger backend
903 should not have a trailing newline. 1114 </dd>
1115 <dt><i>stmt</i> (str)</dt>
1116 <dd>
1117 the Python statement to execute.
904 </dd> 1118 </dd>
905 </dl> 1119 </dl>
906 <a NAME="DebuggerInterfacePython.remoteStep" ID="DebuggerInterfacePython.remoteStep"></a> 1120 <a NAME="DebuggerInterfacePython.remoteStep" ID="DebuggerInterfacePython.remoteStep"></a>
907 <h4>DebuggerInterfacePython.remoteStep</h4> 1121 <h4>DebuggerInterfacePython.remoteStep</h4>
908 <b>remoteStep</b>(<i></i>) 1122 <b>remoteStep</b>(<i>debuggerId</i>)
909 1123
910 <p> 1124 <p>
911 Public method to single step the debugged program. 1125 Public method to single step the debugged program.
912 </p> 1126 </p>
1127 <dl>
1128
1129 <dt><i>debuggerId</i> (str)</dt>
1130 <dd>
1131 ID of the debugger backend
1132 </dd>
1133 </dl>
913 <a NAME="DebuggerInterfacePython.remoteStepOut" ID="DebuggerInterfacePython.remoteStepOut"></a> 1134 <a NAME="DebuggerInterfacePython.remoteStepOut" ID="DebuggerInterfacePython.remoteStepOut"></a>
914 <h4>DebuggerInterfacePython.remoteStepOut</h4> 1135 <h4>DebuggerInterfacePython.remoteStepOut</h4>
915 <b>remoteStepOut</b>(<i></i>) 1136 <b>remoteStepOut</b>(<i>debuggerId</i>)
916 1137
917 <p> 1138 <p>
918 Public method to step out the debugged program. 1139 Public method to step out the debugged program.
919 </p> 1140 </p>
1141 <dl>
1142
1143 <dt><i>debuggerId</i> (str)</dt>
1144 <dd>
1145 ID of the debugger backend
1146 </dd>
1147 </dl>
920 <a NAME="DebuggerInterfacePython.remoteStepOver" ID="DebuggerInterfacePython.remoteStepOver"></a> 1148 <a NAME="DebuggerInterfacePython.remoteStepOver" ID="DebuggerInterfacePython.remoteStepOver"></a>
921 <h4>DebuggerInterfacePython.remoteStepOver</h4> 1149 <h4>DebuggerInterfacePython.remoteStepOver</h4>
922 <b>remoteStepOver</b>(<i></i>) 1150 <b>remoteStepOver</b>(<i>debuggerId</i>)
923 1151
924 <p> 1152 <p>
925 Public method to step over the debugged program. 1153 Public method to step over the debugged program.
926 </p> 1154 </p>
1155 <dl>
1156
1157 <dt><i>debuggerId</i> (str)</dt>
1158 <dd>
1159 ID of the debugger backend
1160 </dd>
1161 </dl>
927 <a NAME="DebuggerInterfacePython.remoteStepQuit" ID="DebuggerInterfacePython.remoteStepQuit"></a> 1162 <a NAME="DebuggerInterfacePython.remoteStepQuit" ID="DebuggerInterfacePython.remoteStepQuit"></a>
928 <h4>DebuggerInterfacePython.remoteStepQuit</h4> 1163 <h4>DebuggerInterfacePython.remoteStepQuit</h4>
929 <b>remoteStepQuit</b>(<i></i>) 1164 <b>remoteStepQuit</b>(<i>debuggerId</i>)
930 1165
931 <p> 1166 <p>
932 Public method to stop the debugged program. 1167 Public method to stop the debugged program.
933 </p> 1168 </p>
1169 <dl>
1170
1171 <dt><i>debuggerId</i> (str)</dt>
1172 <dd>
1173 ID of the debugger backend
1174 </dd>
1175 </dl>
934 <a NAME="DebuggerInterfacePython.remoteThreadList" ID="DebuggerInterfacePython.remoteThreadList"></a> 1176 <a NAME="DebuggerInterfacePython.remoteThreadList" ID="DebuggerInterfacePython.remoteThreadList"></a>
935 <h4>DebuggerInterfacePython.remoteThreadList</h4> 1177 <h4>DebuggerInterfacePython.remoteThreadList</h4>
936 <b>remoteThreadList</b>(<i></i>) 1178 <b>remoteThreadList</b>(<i>debuggerId</i>)
937 1179
938 <p> 1180 <p>
939 Public method to request the list of threads from the client. 1181 Public method to request the list of threads from the client.
940 </p> 1182 </p>
1183 <dl>
1184
1185 <dt><i>debuggerId</i> (str)</dt>
1186 <dd>
1187 ID of the debugger backend
1188 </dd>
1189 </dl>
941 <a NAME="DebuggerInterfacePython.remoteUTDiscover" ID="DebuggerInterfacePython.remoteUTDiscover"></a> 1190 <a NAME="DebuggerInterfacePython.remoteUTDiscover" ID="DebuggerInterfacePython.remoteUTDiscover"></a>
942 <h4>DebuggerInterfacePython.remoteUTDiscover</h4> 1191 <h4>DebuggerInterfacePython.remoteUTDiscover</h4>
943 <b>remoteUTDiscover</b>(<i>syspath, workdir, discoveryStart</i>) 1192 <b>remoteUTDiscover</b>(<i>syspath, workdir, discoveryStart</i>)
944 1193
945 <p> 1194 <p>
1050 <p> 1299 <p>
1051 Public method to stop a unittest run. 1300 Public method to stop a unittest run.
1052 </p> 1301 </p>
1053 <a NAME="DebuggerInterfacePython.remoteWatchpoint" ID="DebuggerInterfacePython.remoteWatchpoint"></a> 1302 <a NAME="DebuggerInterfacePython.remoteWatchpoint" ID="DebuggerInterfacePython.remoteWatchpoint"></a>
1054 <h4>DebuggerInterfacePython.remoteWatchpoint</h4> 1303 <h4>DebuggerInterfacePython.remoteWatchpoint</h4>
1055 <b>remoteWatchpoint</b>(<i>cond, setWatch, temp=False</i>) 1304 <b>remoteWatchpoint</b>(<i>debuggerId, cond, setWatch, temp=False</i>)
1056 1305
1057 <p> 1306 <p>
1058 Public method to set or clear a watch expression. 1307 Public method to set or clear a watch expression.
1059 </p> 1308 </p>
1060 <dl> 1309 <dl>
1061 1310
1062 <dt><i>cond</i></dt> 1311 <dt><i>debuggerId</i> (str)</dt>
1063 <dd> 1312 <dd>
1064 expression of the watch expression (string) 1313 ID of the debugger backend
1065 </dd> 1314 </dd>
1066 <dt><i>setWatch</i></dt> 1315 <dt><i>cond</i> (str)</dt>
1316 <dd>
1317 expression of the watch expression
1318 </dd>
1319 <dt><i>setWatch</i> (bool)</dt>
1067 <dd> 1320 <dd>
1068 flag indicating setting or resetting a watch expression 1321 flag indicating setting or resetting a watch expression
1069 (boolean) 1322 </dd>
1070 </dd> 1323 <dt><i>temp</i> (bool)</dt>
1071 <dt><i>temp</i></dt> 1324 <dd>
1072 <dd> 1325 flag indicating a temporary watch expression
1073 flag indicating a temporary watch expression (boolean)
1074 </dd> 1326 </dd>
1075 </dl> 1327 </dl>
1076 <a NAME="DebuggerInterfacePython.remoteWatchpointEnable" ID="DebuggerInterfacePython.remoteWatchpointEnable"></a> 1328 <a NAME="DebuggerInterfacePython.remoteWatchpointEnable" ID="DebuggerInterfacePython.remoteWatchpointEnable"></a>
1077 <h4>DebuggerInterfacePython.remoteWatchpointEnable</h4> 1329 <h4>DebuggerInterfacePython.remoteWatchpointEnable</h4>
1078 <b>remoteWatchpointEnable</b>(<i>cond, enable</i>) 1330 <b>remoteWatchpointEnable</b>(<i>debuggerId, cond, enable</i>)
1079 1331
1080 <p> 1332 <p>
1081 Public method to enable or disable a watch expression. 1333 Public method to enable or disable a watch expression.
1082 </p> 1334 </p>
1083 <dl> 1335 <dl>
1084 1336
1085 <dt><i>cond</i></dt> 1337 <dt><i>debuggerId</i> (str)</dt>
1086 <dd> 1338 <dd>
1087 expression of the watch expression (string) 1339 ID of the debugger backend
1088 </dd> 1340 </dd>
1089 <dt><i>enable</i></dt> 1341 <dt><i>cond</i> (str)</dt>
1342 <dd>
1343 expression of the watch expression
1344 </dd>
1345 <dt><i>enable</i> (bool)</dt>
1090 <dd> 1346 <dd>
1091 flag indicating enabling or disabling a watch expression 1347 flag indicating enabling or disabling a watch expression
1092 (boolean)
1093 </dd> 1348 </dd>
1094 </dl> 1349 </dl>
1095 <a NAME="DebuggerInterfacePython.remoteWatchpointIgnore" ID="DebuggerInterfacePython.remoteWatchpointIgnore"></a> 1350 <a NAME="DebuggerInterfacePython.remoteWatchpointIgnore" ID="DebuggerInterfacePython.remoteWatchpointIgnore"></a>
1096 <h4>DebuggerInterfacePython.remoteWatchpointIgnore</h4> 1351 <h4>DebuggerInterfacePython.remoteWatchpointIgnore</h4>
1097 <b>remoteWatchpointIgnore</b>(<i>cond, count</i>) 1352 <b>remoteWatchpointIgnore</b>(<i>debuggerId, cond, count</i>)
1098 1353
1099 <p> 1354 <p>
1100 Public method to ignore a watch expression the next couple of 1355 Public method to ignore a watch expression the next couple of
1101 occurrences. 1356 occurrences.
1102 </p> 1357 </p>
1103 <dl> 1358 <dl>
1104 1359
1105 <dt><i>cond</i></dt> 1360 <dt><i>debuggerId</i> (str)</dt>
1106 <dd> 1361 <dd>
1107 expression of the watch expression (string) 1362 ID of the debugger backend
1108 </dd> 1363 </dd>
1109 <dt><i>count</i></dt> 1364 <dt><i>cond</i> (str)</dt>
1110 <dd> 1365 <dd>
1111 number of occurrences to ignore (int) 1366 expression of the watch expression
1367 </dd>
1368 <dt><i>count</i> (int)</dt>
1369 <dd>
1370 number of occurrences to ignore
1112 </dd> 1371 </dd>
1113 </dl> 1372 </dl>
1114 <a NAME="DebuggerInterfacePython.setCallTraceEnabled" ID="DebuggerInterfacePython.setCallTraceEnabled"></a> 1373 <a NAME="DebuggerInterfacePython.setCallTraceEnabled" ID="DebuggerInterfacePython.setCallTraceEnabled"></a>
1115 <h4>DebuggerInterfacePython.setCallTraceEnabled</h4> 1374 <h4>DebuggerInterfacePython.setCallTraceEnabled</h4>
1116 <b>setCallTraceEnabled</b>(<i>on</i>) 1375 <b>setCallTraceEnabled</b>(<i>debuggerId, on</i>)
1117 1376
1118 <p> 1377 <p>
1119 Public method to set the call trace state. 1378 Public method to set the call trace state.
1120 </p> 1379 </p>
1121 <dl> 1380 <dl>
1122 1381
1123 <dt><i>on</i></dt> 1382 <dt><i>debuggerId</i> (str)</dt>
1124 <dd> 1383 <dd>
1125 flag indicating to enable the call trace function (boolean) 1384 ID of the debugger backend
1385 </dd>
1386 <dt><i>on</i> (bool)</dt>
1387 <dd>
1388 flag indicating to enable the call trace function
1126 </dd> 1389 </dd>
1127 </dl> 1390 </dl>
1128 <a NAME="DebuggerInterfacePython.shutdown" ID="DebuggerInterfacePython.shutdown"></a> 1391 <a NAME="DebuggerInterfacePython.shutdown" ID="DebuggerInterfacePython.shutdown"></a>
1129 <h4>DebuggerInterfacePython.shutdown</h4> 1392 <h4>DebuggerInterfacePython.shutdown</h4>
1130 <b>shutdown</b>(<i></i>) 1393 <b>shutdown</b>(<i></i>)
1131 1394
1132 <p> 1395 <p>
1133 Public method to cleanly shut down. 1396 Public method to cleanly shut down.
1134 </p> 1397 </p>
1135 <p> 1398 <p>
1136 It closes our socket and shuts down 1399 It closes our sockets and shuts down the debug clients.
1137 the debug client. (Needed on Win OS) 1400 (Needed on Win OS)
1138 </p> 1401 </p>
1139 <a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a> 1402 <a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a>
1140 <h4>DebuggerInterfacePython.startRemote</h4> 1403 <h4>DebuggerInterfacePython.startRemote</h4>
1141 <b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None</i>) 1404 <b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None</i>)
1142 1405

eric ide

mercurial