5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.Debugger.DebuggerInterfacePython</h1> |
9 <h1>eric7.Debugger.DebuggerInterfacePython</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing the Python3 debugger interface for the debug server. |
11 Module implementing the Python3 debugger interface for the debug server. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
|
16 <table> |
15 <table> |
17 <tr><td>ClientDefaultCapabilities</td></tr> |
16 <tr><td>ClientDefaultCapabilities</td></tr> |
18 </table> |
17 </table> |
|
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
|
21 <table> |
20 <table> |
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#DebuggerInterfacePython">DebuggerInterfacePython</a></td> |
22 <td><a href="#DebuggerInterfacePython">DebuggerInterfacePython</a></td> |
25 <td>Class implementing the debugger interface for the debug server for Python 3.</td> |
23 <td>Class implementing the debugger interface for the debug server for Python 3.</td> |
26 </tr> |
24 </tr> |
27 </table> |
25 </table> |
|
26 |
28 <h3>Functions</h3> |
27 <h3>Functions</h3> |
29 |
|
30 <table> |
28 <table> |
31 |
|
32 <tr> |
29 <tr> |
33 <td><a href="#createDebuggerInterfacePython3">createDebuggerInterfacePython3</a></td> |
30 <td><a href="#createDebuggerInterfacePython3">createDebuggerInterfacePython3</a></td> |
34 <td>Module function to create a debugger interface instance.</td> |
31 <td>Module function to create a debugger interface instance.</td> |
35 </tr> |
32 </tr> |
36 <tr> |
33 <tr> |
37 <td><a href="#getRegistryData">getRegistryData</a></td> |
34 <td><a href="#getRegistryData">getRegistryData</a></td> |
38 <td>Module function to get characterizing data for the supported debugger interfaces.</td> |
35 <td>Module function to get characterizing data for the supported debugger interfaces.</td> |
39 </tr> |
36 </tr> |
40 </table> |
37 </table> |
|
38 |
41 <hr /> |
39 <hr /> |
42 <hr /> |
40 <hr /> |
43 <a NAME="DebuggerInterfacePython" ID="DebuggerInterfacePython"></a> |
41 <a NAME="DebuggerInterfacePython" ID="DebuggerInterfacePython"></a> |
44 <h2>DebuggerInterfacePython</h2> |
42 <h2>DebuggerInterfacePython</h2> |
45 |
|
46 <p> |
43 <p> |
47 Class implementing the debugger interface for the debug server for |
44 Class implementing the debugger interface for the debug server for |
48 Python 3. |
45 Python 3. |
49 </p> |
46 </p> |
|
47 |
50 <h3>Derived from</h3> |
48 <h3>Derived from</h3> |
51 QObject |
49 QObject |
52 <h3>Class Attributes</h3> |
50 <h3>Class Attributes</h3> |
53 |
|
54 <table> |
51 <table> |
55 <tr><td>None</td></tr> |
52 <tr><td>None</td></tr> |
56 </table> |
53 </table> |
|
54 |
57 <h3>Class Methods</h3> |
55 <h3>Class Methods</h3> |
58 |
|
59 <table> |
56 <table> |
60 <tr><td>None</td></tr> |
57 <tr><td>None</td></tr> |
61 </table> |
58 </table> |
|
59 |
62 <h3>Methods</h3> |
60 <h3>Methods</h3> |
63 |
|
64 <table> |
61 <table> |
65 |
|
66 <tr> |
62 <tr> |
67 <td><a href="#DebuggerInterfacePython.__init__">DebuggerInterfacePython</a></td> |
63 <td><a href="#DebuggerInterfacePython.__init__">DebuggerInterfacePython</a></td> |
68 <td>Constructor</td> |
64 <td>Constructor</td> |
69 </tr> |
65 </tr> |
70 <tr> |
66 <tr> |
270 <tr> |
266 <tr> |
271 <td><a href="#DebuggerInterfacePython.startRemoteForProject">startRemoteForProject</a></td> |
267 <td><a href="#DebuggerInterfacePython.startRemoteForProject">startRemoteForProject</a></td> |
272 <td>Public method to start a remote Python interpreter for a project.</td> |
268 <td>Public method to start a remote Python interpreter for a project.</td> |
273 </tr> |
269 </tr> |
274 </table> |
270 </table> |
|
271 |
275 <h3>Static Methods</h3> |
272 <h3>Static Methods</h3> |
276 |
|
277 <table> |
273 <table> |
278 <tr><td>None</td></tr> |
274 <tr><td>None</td></tr> |
279 </table> |
275 </table> |
280 |
276 |
|
277 |
281 <a NAME="DebuggerInterfacePython.__init__" ID="DebuggerInterfacePython.__init__"></a> |
278 <a NAME="DebuggerInterfacePython.__init__" ID="DebuggerInterfacePython.__init__"></a> |
282 <h4>DebuggerInterfacePython (Constructor)</h4> |
279 <h4>DebuggerInterfacePython (Constructor)</h4> |
283 <b>DebuggerInterfacePython</b>(<i>debugServer, passive</i>) |
280 <b>DebuggerInterfacePython</b>(<i>debugServer, passive</i>) |
284 |
|
285 <p> |
281 <p> |
286 Constructor |
282 Constructor |
287 </p> |
283 </p> |
|
284 |
288 <dl> |
285 <dl> |
289 |
286 |
290 <dt><i>debugServer</i> (DebugServer)</dt> |
287 <dt><i>debugServer</i> (DebugServer)</dt> |
291 <dd> |
288 <dd> |
292 reference to the debug server |
289 reference to the debug server |
335 </dd> |
332 </dd> |
336 </dl> |
333 </dl> |
337 <a NAME="DebuggerInterfacePython.__flush" ID="DebuggerInterfacePython.__flush"></a> |
334 <a NAME="DebuggerInterfacePython.__flush" ID="DebuggerInterfacePython.__flush"></a> |
338 <h4>DebuggerInterfacePython.__flush</h4> |
335 <h4>DebuggerInterfacePython.__flush</h4> |
339 <b>__flush</b>(<i></i>) |
336 <b>__flush</b>(<i></i>) |
340 |
|
341 <p> |
337 <p> |
342 Private slot to flush the queue. |
338 Private slot to flush the queue. |
343 </p> |
339 </p> |
|
340 |
344 <a NAME="DebuggerInterfacePython.__handleJsonCommand" ID="DebuggerInterfacePython.__handleJsonCommand"></a> |
341 <a NAME="DebuggerInterfacePython.__handleJsonCommand" ID="DebuggerInterfacePython.__handleJsonCommand"></a> |
345 <h4>DebuggerInterfacePython.__handleJsonCommand</h4> |
342 <h4>DebuggerInterfacePython.__handleJsonCommand</h4> |
346 <b>__handleJsonCommand</b>(<i>jsonStr, sock</i>) |
343 <b>__handleJsonCommand</b>(<i>jsonStr, sock</i>) |
347 |
|
348 <p> |
344 <p> |
349 Private method to handle a command or response serialized as a |
345 Private method to handle a command or response serialized as a |
350 JSON string. |
346 JSON string. |
351 </p> |
347 </p> |
|
348 |
352 <dl> |
349 <dl> |
353 |
350 |
354 <dt><i>jsonStr</i> (str)</dt> |
351 <dt><i>jsonStr</i> (str)</dt> |
355 <dd> |
352 <dd> |
356 string containing the command or response received |
353 string containing the command or response received |
393 </dd> |
390 </dd> |
394 </dl> |
391 </dl> |
395 <a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a> |
392 <a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a> |
396 <h4>DebuggerInterfacePython.__parseClientLine</h4> |
393 <h4>DebuggerInterfacePython.__parseClientLine</h4> |
397 <b>__parseClientLine</b>(<i>sock</i>) |
394 <b>__parseClientLine</b>(<i>sock</i>) |
398 |
|
399 <p> |
395 <p> |
400 Private method to handle data from the client. |
396 Private method to handle data from the client. |
401 </p> |
397 </p> |
|
398 |
402 <dl> |
399 <dl> |
403 |
400 |
404 <dt><i>sock</i> (QTcpSocket)</dt> |
401 <dt><i>sock</i> (QTcpSocket)</dt> |
405 <dd> |
402 <dd> |
406 reference to the socket to read data from |
403 reference to the socket to read data from |
407 </dd> |
404 </dd> |
408 </dl> |
405 </dl> |
409 <a NAME="DebuggerInterfacePython.__remoteTranslation" ID="DebuggerInterfacePython.__remoteTranslation"></a> |
406 <a NAME="DebuggerInterfacePython.__remoteTranslation" ID="DebuggerInterfacePython.__remoteTranslation"></a> |
410 <h4>DebuggerInterfacePython.__remoteTranslation</h4> |
407 <h4>DebuggerInterfacePython.__remoteTranslation</h4> |
411 <b>__remoteTranslation</b>(<i>fn, remote2local=True</i>) |
408 <b>__remoteTranslation</b>(<i>fn, remote2local=True</i>) |
412 |
|
413 <p> |
409 <p> |
414 Private method to perform the path translation. |
410 Private method to perform the path translation. |
415 </p> |
411 </p> |
|
412 |
416 <dl> |
413 <dl> |
417 |
414 |
418 <dt><i>fn</i> (str)</dt> |
415 <dt><i>fn</i> (str)</dt> |
419 <dd> |
416 <dd> |
420 filename to be translated |
417 filename to be translated |
438 </dd> |
435 </dd> |
439 </dl> |
436 </dl> |
440 <a NAME="DebuggerInterfacePython.__sendJsonCommand" ID="DebuggerInterfacePython.__sendJsonCommand"></a> |
437 <a NAME="DebuggerInterfacePython.__sendJsonCommand" ID="DebuggerInterfacePython.__sendJsonCommand"></a> |
441 <h4>DebuggerInterfacePython.__sendJsonCommand</h4> |
438 <h4>DebuggerInterfacePython.__sendJsonCommand</h4> |
442 <b>__sendJsonCommand</b>(<i>command, params, debuggerId="", sock=None</i>) |
439 <b>__sendJsonCommand</b>(<i>command, params, debuggerId="", sock=None</i>) |
443 |
|
444 <p> |
440 <p> |
445 Private method to send a single command to the client. |
441 Private method to send a single command to the client. |
446 </p> |
442 </p> |
|
443 |
447 <dl> |
444 <dl> |
448 |
445 |
449 <dt><i>command</i> (str)</dt> |
446 <dt><i>command</i> (str)</dt> |
450 <dd> |
447 <dd> |
451 command name to be sent |
448 command name to be sent |
465 </dd> |
462 </dd> |
466 </dl> |
463 </dl> |
467 <a NAME="DebuggerInterfacePython.__shutdownSocket" ID="DebuggerInterfacePython.__shutdownSocket"></a> |
464 <a NAME="DebuggerInterfacePython.__shutdownSocket" ID="DebuggerInterfacePython.__shutdownSocket"></a> |
468 <h4>DebuggerInterfacePython.__shutdownSocket</h4> |
465 <h4>DebuggerInterfacePython.__shutdownSocket</h4> |
469 <b>__shutdownSocket</b>(<i>sock</i>) |
466 <b>__shutdownSocket</b>(<i>sock</i>) |
470 |
|
471 <p> |
467 <p> |
472 Private slot to shut down a socket. |
468 Private slot to shut down a socket. |
473 </p> |
469 </p> |
|
470 |
474 <dl> |
471 <dl> |
475 |
472 |
476 <dt><i>sock</i> (QTcpSocket)</dt> |
473 <dt><i>sock</i> (QTcpSocket)</dt> |
477 <dd> |
474 <dd> |
478 reference to the socket |
475 reference to the socket |
479 </dd> |
476 </dd> |
480 </dl> |
477 </dl> |
481 <a NAME="DebuggerInterfacePython.__socketDisconnected" ID="DebuggerInterfacePython.__socketDisconnected"></a> |
478 <a NAME="DebuggerInterfacePython.__socketDisconnected" ID="DebuggerInterfacePython.__socketDisconnected"></a> |
482 <h4>DebuggerInterfacePython.__socketDisconnected</h4> |
479 <h4>DebuggerInterfacePython.__socketDisconnected</h4> |
483 <b>__socketDisconnected</b>(<i>sock</i>) |
480 <b>__socketDisconnected</b>(<i>sock</i>) |
484 |
|
485 <p> |
481 <p> |
486 Private slot handling a socket disconnecting. |
482 Private slot handling a socket disconnecting. |
487 </p> |
483 </p> |
|
484 |
488 <dl> |
485 <dl> |
489 |
486 |
490 <dt><i>sock</i> (QTcpSocket)</dt> |
487 <dt><i>sock</i> (QTcpSocket)</dt> |
491 <dd> |
488 <dd> |
492 reference to the disconnected socket |
489 reference to the disconnected socket |
493 </dd> |
490 </dd> |
494 </dl> |
491 </dl> |
495 <a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a> |
492 <a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a> |
496 <h4>DebuggerInterfacePython.__startProcess</h4> |
493 <h4>DebuggerInterfacePython.__startProcess</h4> |
497 <b>__startProcess</b>(<i>program, arguments, environment=None, workingDir=None</i>) |
494 <b>__startProcess</b>(<i>program, arguments, environment=None, workingDir=None</i>) |
498 |
|
499 <p> |
495 <p> |
500 Private method to start the debugger client process. |
496 Private method to start the debugger client process. |
501 </p> |
497 </p> |
|
498 |
502 <dl> |
499 <dl> |
503 |
500 |
504 <dt><i>program</i> (str)</dt> |
501 <dt><i>program</i> (str)</dt> |
505 <dd> |
502 <dd> |
506 name of the executable to start |
503 name of the executable to start |
632 </dd> |
629 </dd> |
633 </dl> |
630 </dl> |
634 <a NAME="DebuggerInterfacePython.remoteBanner" ID="DebuggerInterfacePython.remoteBanner"></a> |
631 <a NAME="DebuggerInterfacePython.remoteBanner" ID="DebuggerInterfacePython.remoteBanner"></a> |
635 <h4>DebuggerInterfacePython.remoteBanner</h4> |
632 <h4>DebuggerInterfacePython.remoteBanner</h4> |
636 <b>remoteBanner</b>(<i></i>) |
633 <b>remoteBanner</b>(<i></i>) |
637 |
|
638 <p> |
634 <p> |
639 Public slot to get the banner info of the remote client. |
635 Public slot to get the banner info of the remote client. |
640 </p> |
636 </p> |
|
637 |
641 <a NAME="DebuggerInterfacePython.remoteBreakpoint" ID="DebuggerInterfacePython.remoteBreakpoint"></a> |
638 <a NAME="DebuggerInterfacePython.remoteBreakpoint" ID="DebuggerInterfacePython.remoteBreakpoint"></a> |
642 <h4>DebuggerInterfacePython.remoteBreakpoint</h4> |
639 <h4>DebuggerInterfacePython.remoteBreakpoint</h4> |
643 <b>remoteBreakpoint</b>(<i>debuggerId, fn, line, setBreakpoint, cond=None, temp=False</i>) |
640 <b>remoteBreakpoint</b>(<i>debuggerId, fn, line, setBreakpoint, cond=None, temp=False</i>) |
644 |
|
645 <p> |
641 <p> |
646 Public method to set or clear a breakpoint. |
642 Public method to set or clear a breakpoint. |
647 </p> |
643 </p> |
|
644 |
648 <dl> |
645 <dl> |
649 |
646 |
650 <dt><i>debuggerId</i> (str)</dt> |
647 <dt><i>debuggerId</i> (str)</dt> |
651 <dd> |
648 <dd> |
652 ID of the debugger backend |
649 ID of the debugger backend |
673 </dd> |
670 </dd> |
674 </dl> |
671 </dl> |
675 <a NAME="DebuggerInterfacePython.remoteBreakpointEnable" ID="DebuggerInterfacePython.remoteBreakpointEnable"></a> |
672 <a NAME="DebuggerInterfacePython.remoteBreakpointEnable" ID="DebuggerInterfacePython.remoteBreakpointEnable"></a> |
676 <h4>DebuggerInterfacePython.remoteBreakpointEnable</h4> |
673 <h4>DebuggerInterfacePython.remoteBreakpointEnable</h4> |
677 <b>remoteBreakpointEnable</b>(<i>debuggerId, fn, line, enable</i>) |
674 <b>remoteBreakpointEnable</b>(<i>debuggerId, fn, line, enable</i>) |
678 |
|
679 <p> |
675 <p> |
680 Public method to enable or disable a breakpoint. |
676 Public method to enable or disable a breakpoint. |
681 </p> |
677 </p> |
|
678 |
682 <dl> |
679 <dl> |
683 |
680 |
684 <dt><i>debuggerId</i> (str)</dt> |
681 <dt><i>debuggerId</i> (str)</dt> |
685 <dd> |
682 <dd> |
686 ID of the debugger backend |
683 ID of the debugger backend |
699 </dd> |
696 </dd> |
700 </dl> |
697 </dl> |
701 <a NAME="DebuggerInterfacePython.remoteBreakpointIgnore" ID="DebuggerInterfacePython.remoteBreakpointIgnore"></a> |
698 <a NAME="DebuggerInterfacePython.remoteBreakpointIgnore" ID="DebuggerInterfacePython.remoteBreakpointIgnore"></a> |
702 <h4>DebuggerInterfacePython.remoteBreakpointIgnore</h4> |
699 <h4>DebuggerInterfacePython.remoteBreakpointIgnore</h4> |
703 <b>remoteBreakpointIgnore</b>(<i>debuggerId, fn, line, count</i>) |
700 <b>remoteBreakpointIgnore</b>(<i>debuggerId, fn, line, count</i>) |
704 |
|
705 <p> |
701 <p> |
706 Public method to ignore a breakpoint the next couple of occurrences. |
702 Public method to ignore a breakpoint the next couple of occurrences. |
707 </p> |
703 </p> |
|
704 |
708 <dl> |
705 <dl> |
709 |
706 |
710 <dt><i>debuggerId</i> (str)</dt> |
707 <dt><i>debuggerId</i> (str)</dt> |
711 <dd> |
708 <dd> |
712 ID of the debugger backend |
709 ID of the debugger backend |
725 </dd> |
722 </dd> |
726 </dl> |
723 </dl> |
727 <a NAME="DebuggerInterfacePython.remoteCapabilities" ID="DebuggerInterfacePython.remoteCapabilities"></a> |
724 <a NAME="DebuggerInterfacePython.remoteCapabilities" ID="DebuggerInterfacePython.remoteCapabilities"></a> |
728 <h4>DebuggerInterfacePython.remoteCapabilities</h4> |
725 <h4>DebuggerInterfacePython.remoteCapabilities</h4> |
729 <b>remoteCapabilities</b>(<i>debuggerId</i>) |
726 <b>remoteCapabilities</b>(<i>debuggerId</i>) |
730 |
|
731 <p> |
727 <p> |
732 Public slot to get the debug clients capabilities. |
728 Public slot to get the debug clients capabilities. |
733 </p> |
729 </p> |
|
730 |
734 <dl> |
731 <dl> |
735 |
732 |
736 <dt><i>debuggerId</i> (str)</dt> |
733 <dt><i>debuggerId</i> (str)</dt> |
737 <dd> |
734 <dd> |
738 ID of the debugger backend |
735 ID of the debugger backend |
739 </dd> |
736 </dd> |
740 </dl> |
737 </dl> |
741 <a NAME="DebuggerInterfacePython.remoteClientDisassembly" ID="DebuggerInterfacePython.remoteClientDisassembly"></a> |
738 <a NAME="DebuggerInterfacePython.remoteClientDisassembly" ID="DebuggerInterfacePython.remoteClientDisassembly"></a> |
742 <h4>DebuggerInterfacePython.remoteClientDisassembly</h4> |
739 <h4>DebuggerInterfacePython.remoteClientDisassembly</h4> |
743 <b>remoteClientDisassembly</b>(<i>debuggerId</i>) |
740 <b>remoteClientDisassembly</b>(<i>debuggerId</i>) |
744 |
|
745 <p> |
741 <p> |
746 Public method to ask the client for the latest traceback disassembly. |
742 Public method to ask the client for the latest traceback disassembly. |
747 </p> |
743 </p> |
|
744 |
748 <dl> |
745 <dl> |
749 |
746 |
750 <dt><i>debuggerId</i> (str)</dt> |
747 <dt><i>debuggerId</i> (str)</dt> |
751 <dd> |
748 <dd> |
752 ID of the debugger backend |
749 ID of the debugger backend |
753 </dd> |
750 </dd> |
754 </dl> |
751 </dl> |
755 <a NAME="DebuggerInterfacePython.remoteClientSetFilter" ID="DebuggerInterfacePython.remoteClientSetFilter"></a> |
752 <a NAME="DebuggerInterfacePython.remoteClientSetFilter" ID="DebuggerInterfacePython.remoteClientSetFilter"></a> |
756 <h4>DebuggerInterfacePython.remoteClientSetFilter</h4> |
753 <h4>DebuggerInterfacePython.remoteClientSetFilter</h4> |
757 <b>remoteClientSetFilter</b>(<i>debuggerId, scope, filterStr</i>) |
754 <b>remoteClientSetFilter</b>(<i>debuggerId, scope, filterStr</i>) |
758 |
|
759 <p> |
755 <p> |
760 Public method to set a variables filter list. |
756 Public method to set a variables filter list. |
761 </p> |
757 </p> |
|
758 |
762 <dl> |
759 <dl> |
763 |
760 |
764 <dt><i>debuggerId</i> (str)</dt> |
761 <dt><i>debuggerId</i> (str)</dt> |
765 <dd> |
762 <dd> |
766 ID of the debugger backend |
763 ID of the debugger backend |
775 </dd> |
772 </dd> |
776 </dl> |
773 </dl> |
777 <a NAME="DebuggerInterfacePython.remoteClientStack" ID="DebuggerInterfacePython.remoteClientStack"></a> |
774 <a NAME="DebuggerInterfacePython.remoteClientStack" ID="DebuggerInterfacePython.remoteClientStack"></a> |
778 <h4>DebuggerInterfacePython.remoteClientStack</h4> |
775 <h4>DebuggerInterfacePython.remoteClientStack</h4> |
779 <b>remoteClientStack</b>(<i>debuggerId</i>) |
776 <b>remoteClientStack</b>(<i>debuggerId</i>) |
780 |
|
781 <p> |
777 <p> |
782 Public method to request the stack of the main thread. |
778 Public method to request the stack of the main thread. |
783 </p> |
779 </p> |
|
780 |
784 <dl> |
781 <dl> |
785 |
782 |
786 <dt><i>debuggerId</i> (str)</dt> |
783 <dt><i>debuggerId</i> (str)</dt> |
787 <dd> |
784 <dd> |
788 ID of the debugger backend |
785 ID of the debugger backend |
789 </dd> |
786 </dd> |
790 </dl> |
787 </dl> |
791 <a NAME="DebuggerInterfacePython.remoteClientVariable" ID="DebuggerInterfacePython.remoteClientVariable"></a> |
788 <a NAME="DebuggerInterfacePython.remoteClientVariable" ID="DebuggerInterfacePython.remoteClientVariable"></a> |
792 <h4>DebuggerInterfacePython.remoteClientVariable</h4> |
789 <h4>DebuggerInterfacePython.remoteClientVariable</h4> |
793 <b>remoteClientVariable</b>(<i>debuggerId, scope, filterList, var, framenr=0, maxSize=0</i>) |
790 <b>remoteClientVariable</b>(<i>debuggerId, scope, filterList, var, framenr=0, maxSize=0</i>) |
794 |
|
795 <p> |
791 <p> |
796 Public method to request the variables of the debugged program. |
792 Public method to request the variables of the debugged program. |
797 </p> |
793 </p> |
|
794 |
798 <dl> |
795 <dl> |
799 |
796 |
800 <dt><i>debuggerId</i> (str)</dt> |
797 <dt><i>debuggerId</i> (str)</dt> |
801 <dd> |
798 <dd> |
802 ID of the debugger backend |
799 ID of the debugger backend |
825 </dd> |
822 </dd> |
826 </dl> |
823 </dl> |
827 <a NAME="DebuggerInterfacePython.remoteClientVariables" ID="DebuggerInterfacePython.remoteClientVariables"></a> |
824 <a NAME="DebuggerInterfacePython.remoteClientVariables" ID="DebuggerInterfacePython.remoteClientVariables"></a> |
828 <h4>DebuggerInterfacePython.remoteClientVariables</h4> |
825 <h4>DebuggerInterfacePython.remoteClientVariables</h4> |
829 <b>remoteClientVariables</b>(<i>debuggerId, scope, filterList, framenr=0, maxSize=0</i>) |
826 <b>remoteClientVariables</b>(<i>debuggerId, scope, filterList, framenr=0, maxSize=0</i>) |
830 |
|
831 <p> |
827 <p> |
832 Public method to request the variables of the debugged program. |
828 Public method to request the variables of the debugged program. |
833 </p> |
829 </p> |
|
830 |
834 <dl> |
831 <dl> |
835 |
832 |
836 <dt><i>debuggerId</i> (str)</dt> |
833 <dt><i>debuggerId</i> (str)</dt> |
837 <dd> |
834 <dd> |
838 ID of the debugger backend |
835 ID of the debugger backend |
857 </dd> |
854 </dd> |
858 </dl> |
855 </dl> |
859 <a NAME="DebuggerInterfacePython.remoteCompletion" ID="DebuggerInterfacePython.remoteCompletion"></a> |
856 <a NAME="DebuggerInterfacePython.remoteCompletion" ID="DebuggerInterfacePython.remoteCompletion"></a> |
860 <h4>DebuggerInterfacePython.remoteCompletion</h4> |
857 <h4>DebuggerInterfacePython.remoteCompletion</h4> |
861 <b>remoteCompletion</b>(<i>debuggerId, text</i>) |
858 <b>remoteCompletion</b>(<i>debuggerId, text</i>) |
862 |
|
863 <p> |
859 <p> |
864 Public slot to get the a list of possible commandline completions |
860 Public slot to get the a list of possible commandline completions |
865 from the remote client. |
861 from the remote client. |
866 </p> |
862 </p> |
|
863 |
867 <dl> |
864 <dl> |
868 |
865 |
869 <dt><i>debuggerId</i> (str)</dt> |
866 <dt><i>debuggerId</i> (str)</dt> |
870 <dd> |
867 <dd> |
871 ID of the debugger backend |
868 ID of the debugger backend |
894 </dd> |
891 </dd> |
895 </dl> |
892 </dl> |
896 <a NAME="DebuggerInterfacePython.remoteContinueUntil" ID="DebuggerInterfacePython.remoteContinueUntil"></a> |
893 <a NAME="DebuggerInterfacePython.remoteContinueUntil" ID="DebuggerInterfacePython.remoteContinueUntil"></a> |
897 <h4>DebuggerInterfacePython.remoteContinueUntil</h4> |
894 <h4>DebuggerInterfacePython.remoteContinueUntil</h4> |
898 <b>remoteContinueUntil</b>(<i>debuggerId, line</i>) |
895 <b>remoteContinueUntil</b>(<i>debuggerId, line</i>) |
899 |
|
900 <p> |
896 <p> |
901 Public method to continue the debugged program to the given line |
897 Public method to continue the debugged program to the given line |
902 or until returning from the current frame. |
898 or until returning from the current frame. |
903 </p> |
899 </p> |
|
900 |
904 <dl> |
901 <dl> |
905 |
902 |
906 <dt><i>debuggerId</i> (str)</dt> |
903 <dt><i>debuggerId</i> (str)</dt> |
907 <dd> |
904 <dd> |
908 ID of the debugger backend |
905 ID of the debugger backend |
940 </dd> |
937 </dd> |
941 </dl> |
938 </dl> |
942 <a NAME="DebuggerInterfacePython.remoteEnvironment" ID="DebuggerInterfacePython.remoteEnvironment"></a> |
939 <a NAME="DebuggerInterfacePython.remoteEnvironment" ID="DebuggerInterfacePython.remoteEnvironment"></a> |
943 <h4>DebuggerInterfacePython.remoteEnvironment</h4> |
940 <h4>DebuggerInterfacePython.remoteEnvironment</h4> |
944 <b>remoteEnvironment</b>(<i>env</i>) |
941 <b>remoteEnvironment</b>(<i>env</i>) |
945 |
|
946 <p> |
942 <p> |
947 Public method to set the environment for a program to debug, run, ... |
943 Public method to set the environment for a program to debug, run, ... |
948 </p> |
944 </p> |
|
945 |
949 <dl> |
946 <dl> |
950 |
947 |
951 <dt><i>env</i> (dict)</dt> |
948 <dt><i>env</i> (dict)</dt> |
952 <dd> |
949 <dd> |
953 environment settings |
950 environment settings |
954 </dd> |
951 </dd> |
955 </dl> |
952 </dl> |
956 <a NAME="DebuggerInterfacePython.remoteLoad" ID="DebuggerInterfacePython.remoteLoad"></a> |
953 <a NAME="DebuggerInterfacePython.remoteLoad" ID="DebuggerInterfacePython.remoteLoad"></a> |
957 <h4>DebuggerInterfacePython.remoteLoad</h4> |
954 <h4>DebuggerInterfacePython.remoteLoad</h4> |
958 <b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter=False, autoContinue=True, enableMultiprocess=False, reportAllExceptions=False, </i>) |
955 <b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter=False, autoContinue=True, enableMultiprocess=False, reportAllExceptions=False, </i>) |
959 |
|
960 <p> |
956 <p> |
961 Public method to load a new program to debug. |
957 Public method to load a new program to debug. |
962 </p> |
958 </p> |
|
959 |
963 <dl> |
960 <dl> |
964 |
961 |
965 <dt><i>fn</i> (str)</dt> |
962 <dt><i>fn</i> (str)</dt> |
966 <dd> |
963 <dd> |
967 filename to debug |
964 filename to debug |
1014 </dd> |
1011 </dd> |
1015 </dl> |
1012 </dl> |
1016 <a NAME="DebuggerInterfacePython.remoteNoDebugList" ID="DebuggerInterfacePython.remoteNoDebugList"></a> |
1013 <a NAME="DebuggerInterfacePython.remoteNoDebugList" ID="DebuggerInterfacePython.remoteNoDebugList"></a> |
1017 <h4>DebuggerInterfacePython.remoteNoDebugList</h4> |
1014 <h4>DebuggerInterfacePython.remoteNoDebugList</h4> |
1018 <b>remoteNoDebugList</b>(<i>debuggerId, noDebugList</i>) |
1015 <b>remoteNoDebugList</b>(<i>debuggerId, noDebugList</i>) |
1019 |
|
1020 <p> |
1016 <p> |
1021 Public method to set a list of programs not to be debugged. |
1017 Public method to set a list of programs not to be debugged. |
1022 </p> |
1018 </p> |
1023 <p> |
1019 <p> |
1024 The programs given in the list will not be run under the control |
1020 The programs given in the list will not be run under the control |
1025 of the multi process debugger. |
1021 of the multi process debugger. |
1026 </p> |
1022 </p> |
|
1023 |
1027 <dl> |
1024 <dl> |
1028 |
1025 |
1029 <dt><i>debuggerId</i> (str)</dt> |
1026 <dt><i>debuggerId</i> (str)</dt> |
1030 <dd> |
1027 <dd> |
1031 ID of the debugger backend |
1028 ID of the debugger backend |
1139 </dd> |
1136 </dd> |
1140 </dl> |
1137 </dl> |
1141 <a NAME="DebuggerInterfacePython.remoteStep" ID="DebuggerInterfacePython.remoteStep"></a> |
1138 <a NAME="DebuggerInterfacePython.remoteStep" ID="DebuggerInterfacePython.remoteStep"></a> |
1142 <h4>DebuggerInterfacePython.remoteStep</h4> |
1139 <h4>DebuggerInterfacePython.remoteStep</h4> |
1143 <b>remoteStep</b>(<i>debuggerId</i>) |
1140 <b>remoteStep</b>(<i>debuggerId</i>) |
1144 |
|
1145 <p> |
1141 <p> |
1146 Public method to single step the debugged program. |
1142 Public method to single step the debugged program. |
1147 </p> |
1143 </p> |
|
1144 |
1148 <dl> |
1145 <dl> |
1149 |
1146 |
1150 <dt><i>debuggerId</i> (str)</dt> |
1147 <dt><i>debuggerId</i> (str)</dt> |
1151 <dd> |
1148 <dd> |
1152 ID of the debugger backend |
1149 ID of the debugger backend |
1153 </dd> |
1150 </dd> |
1154 </dl> |
1151 </dl> |
1155 <a NAME="DebuggerInterfacePython.remoteStepOut" ID="DebuggerInterfacePython.remoteStepOut"></a> |
1152 <a NAME="DebuggerInterfacePython.remoteStepOut" ID="DebuggerInterfacePython.remoteStepOut"></a> |
1156 <h4>DebuggerInterfacePython.remoteStepOut</h4> |
1153 <h4>DebuggerInterfacePython.remoteStepOut</h4> |
1157 <b>remoteStepOut</b>(<i>debuggerId</i>) |
1154 <b>remoteStepOut</b>(<i>debuggerId</i>) |
1158 |
|
1159 <p> |
1155 <p> |
1160 Public method to step out the debugged program. |
1156 Public method to step out the debugged program. |
1161 </p> |
1157 </p> |
|
1158 |
1162 <dl> |
1159 <dl> |
1163 |
1160 |
1164 <dt><i>debuggerId</i> (str)</dt> |
1161 <dt><i>debuggerId</i> (str)</dt> |
1165 <dd> |
1162 <dd> |
1166 ID of the debugger backend |
1163 ID of the debugger backend |
1167 </dd> |
1164 </dd> |
1168 </dl> |
1165 </dl> |
1169 <a NAME="DebuggerInterfacePython.remoteStepOver" ID="DebuggerInterfacePython.remoteStepOver"></a> |
1166 <a NAME="DebuggerInterfacePython.remoteStepOver" ID="DebuggerInterfacePython.remoteStepOver"></a> |
1170 <h4>DebuggerInterfacePython.remoteStepOver</h4> |
1167 <h4>DebuggerInterfacePython.remoteStepOver</h4> |
1171 <b>remoteStepOver</b>(<i>debuggerId</i>) |
1168 <b>remoteStepOver</b>(<i>debuggerId</i>) |
1172 |
|
1173 <p> |
1169 <p> |
1174 Public method to step over the debugged program. |
1170 Public method to step over the debugged program. |
1175 </p> |
1171 </p> |
|
1172 |
1176 <dl> |
1173 <dl> |
1177 |
1174 |
1178 <dt><i>debuggerId</i> (str)</dt> |
1175 <dt><i>debuggerId</i> (str)</dt> |
1179 <dd> |
1176 <dd> |
1180 ID of the debugger backend |
1177 ID of the debugger backend |
1181 </dd> |
1178 </dd> |
1182 </dl> |
1179 </dl> |
1183 <a NAME="DebuggerInterfacePython.remoteStepQuit" ID="DebuggerInterfacePython.remoteStepQuit"></a> |
1180 <a NAME="DebuggerInterfacePython.remoteStepQuit" ID="DebuggerInterfacePython.remoteStepQuit"></a> |
1184 <h4>DebuggerInterfacePython.remoteStepQuit</h4> |
1181 <h4>DebuggerInterfacePython.remoteStepQuit</h4> |
1185 <b>remoteStepQuit</b>(<i>debuggerId</i>) |
1182 <b>remoteStepQuit</b>(<i>debuggerId</i>) |
1186 |
|
1187 <p> |
1183 <p> |
1188 Public method to stop the debugged program. |
1184 Public method to stop the debugged program. |
1189 </p> |
1185 </p> |
|
1186 |
1190 <dl> |
1187 <dl> |
1191 |
1188 |
1192 <dt><i>debuggerId</i> (str)</dt> |
1189 <dt><i>debuggerId</i> (str)</dt> |
1193 <dd> |
1190 <dd> |
1194 ID of the debugger backend |
1191 ID of the debugger backend |
1195 </dd> |
1192 </dd> |
1196 </dl> |
1193 </dl> |
1197 <a NAME="DebuggerInterfacePython.remoteThreadList" ID="DebuggerInterfacePython.remoteThreadList"></a> |
1194 <a NAME="DebuggerInterfacePython.remoteThreadList" ID="DebuggerInterfacePython.remoteThreadList"></a> |
1198 <h4>DebuggerInterfacePython.remoteThreadList</h4> |
1195 <h4>DebuggerInterfacePython.remoteThreadList</h4> |
1199 <b>remoteThreadList</b>(<i>debuggerId</i>) |
1196 <b>remoteThreadList</b>(<i>debuggerId</i>) |
1200 |
|
1201 <p> |
1197 <p> |
1202 Public method to request the list of threads from the client. |
1198 Public method to request the list of threads from the client. |
1203 </p> |
1199 </p> |
|
1200 |
1204 <dl> |
1201 <dl> |
1205 |
1202 |
1206 <dt><i>debuggerId</i> (str)</dt> |
1203 <dt><i>debuggerId</i> (str)</dt> |
1207 <dd> |
1204 <dd> |
1208 ID of the debugger backend |
1205 ID of the debugger backend |
1209 </dd> |
1206 </dd> |
1210 </dl> |
1207 </dl> |
1211 <a NAME="DebuggerInterfacePython.remoteWatchpoint" ID="DebuggerInterfacePython.remoteWatchpoint"></a> |
1208 <a NAME="DebuggerInterfacePython.remoteWatchpoint" ID="DebuggerInterfacePython.remoteWatchpoint"></a> |
1212 <h4>DebuggerInterfacePython.remoteWatchpoint</h4> |
1209 <h4>DebuggerInterfacePython.remoteWatchpoint</h4> |
1213 <b>remoteWatchpoint</b>(<i>debuggerId, cond, setWatch, temp=False</i>) |
1210 <b>remoteWatchpoint</b>(<i>debuggerId, cond, setWatch, temp=False</i>) |
1214 |
|
1215 <p> |
1211 <p> |
1216 Public method to set or clear a watch expression. |
1212 Public method to set or clear a watch expression. |
1217 </p> |
1213 </p> |
|
1214 |
1218 <dl> |
1215 <dl> |
1219 |
1216 |
1220 <dt><i>debuggerId</i> (str)</dt> |
1217 <dt><i>debuggerId</i> (str)</dt> |
1221 <dd> |
1218 <dd> |
1222 ID of the debugger backend |
1219 ID of the debugger backend |
1298 </dd> |
1295 </dd> |
1299 </dl> |
1296 </dl> |
1300 <a NAME="DebuggerInterfacePython.shutdown" ID="DebuggerInterfacePython.shutdown"></a> |
1297 <a NAME="DebuggerInterfacePython.shutdown" ID="DebuggerInterfacePython.shutdown"></a> |
1301 <h4>DebuggerInterfacePython.shutdown</h4> |
1298 <h4>DebuggerInterfacePython.shutdown</h4> |
1302 <b>shutdown</b>(<i></i>) |
1299 <b>shutdown</b>(<i></i>) |
1303 |
|
1304 <p> |
1300 <p> |
1305 Public method to cleanly shut down. |
1301 Public method to cleanly shut down. |
1306 </p> |
1302 </p> |
1307 <p> |
1303 <p> |
1308 It closes our sockets and shuts down the debug clients. |
1304 It closes our sockets and shuts down the debug clients. |
1309 (Needed on Win OS) |
1305 (Needed on Win OS) |
1310 </p> |
1306 </p> |
|
1307 |
1311 <a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a> |
1308 <a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a> |
1312 <h4>DebuggerInterfacePython.startRemote</h4> |
1309 <h4>DebuggerInterfacePython.startRemote</h4> |
1313 <b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None, </i>) |
1310 <b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None, </i>) |
1314 |
|
1315 <p> |
1311 <p> |
1316 Public method to start a remote Python interpreter. |
1312 Public method to start a remote Python interpreter. |
1317 </p> |
1313 </p> |
|
1314 |
1318 <dl> |
1315 <dl> |
1319 |
1316 |
1320 <dt><i>port</i> (int)</dt> |
1317 <dt><i>port</i> (int)</dt> |
1321 <dd> |
1318 <dd> |
1322 port number the debug server is listening on |
1319 port number the debug server is listening on |
1358 </dd> |
1355 </dd> |
1359 </dl> |
1356 </dl> |
1360 <a NAME="DebuggerInterfacePython.startRemoteForProject" ID="DebuggerInterfacePython.startRemoteForProject"></a> |
1357 <a NAME="DebuggerInterfacePython.startRemoteForProject" ID="DebuggerInterfacePython.startRemoteForProject"></a> |
1361 <h4>DebuggerInterfacePython.startRemoteForProject</h4> |
1358 <h4>DebuggerInterfacePython.startRemoteForProject</h4> |
1362 <b>startRemoteForProject</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None, </i>) |
1359 <b>startRemoteForProject</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None, </i>) |
1363 |
|
1364 <p> |
1360 <p> |
1365 Public method to start a remote Python interpreter for a project. |
1361 Public method to start a remote Python interpreter for a project. |
1366 </p> |
1362 </p> |
|
1363 |
1367 <dl> |
1364 <dl> |
1368 |
1365 |
1369 <dt><i>port</i> (int)</dt> |
1366 <dt><i>port</i> (int)</dt> |
1370 <dd> |
1367 <dd> |
1371 port number the debug server is listening on |
1368 port number the debug server is listening on |