Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html

eric6/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
child 8215
fc5d68a6889e
equal deleted inserted replaced
7991:866adc8c315b 8043:0acf98cd089a
46 <tr> 46 <tr>
47 <td><a href="#DebugClientClose">DebugClientClose</a></td> 47 <td><a href="#DebugClientClose">DebugClientClose</a></td>
48 <td>Replacement for the standard os.close(fd).</td> 48 <td>Replacement for the standard os.close(fd).</td>
49 </tr> 49 </tr>
50 <tr> 50 <tr>
51 <td><a href="#DebugClientFork">DebugClientFork</a></td>
52 <td>Replacement for the standard os.fork().</td>
53 </tr>
54 <tr>
55 <td><a href="#DebugClientInput">DebugClientInput</a></td> 51 <td><a href="#DebugClientInput">DebugClientInput</a></td>
56 <td>Replacement for the standard input() builtin.</td> 52 <td>Replacement for the standard input() builtin.</td>
57 </tr> 53 </tr>
58 <tr> 54 <tr>
59 <td><a href="#DebugClientSetRecursionLimit">DebugClientSetRecursionLimit</a></td> 55 <td><a href="#DebugClientSetRecursionLimit">DebugClientSetRecursionLimit</a></td>
113 <tr> 109 <tr>
114 <td><a href="#DebugClientBase.__clientCapabilities">__clientCapabilities</a></td> 110 <td><a href="#DebugClientBase.__clientCapabilities">__clientCapabilities</a></td>
115 <td>Private method to determine the clients capabilities.</td> 111 <td>Private method to determine the clients capabilities.</td>
116 </tr> 112 </tr>
117 <tr> 113 <tr>
114 <td><a href="#DebugClientBase.__compileCommand">__compileCommand</a></td>
115 <td>Private method to compile source code.</td>
116 </tr>
117 <tr>
118 <td><a href="#DebugClientBase.__compileFileSource">__compileFileSource</a></td> 118 <td><a href="#DebugClientBase.__compileFileSource">__compileFileSource</a></td>
119 <td>Private method to compile source code read from a file.</td> 119 <td>Private method to compile source code read from a file.</td>
120 </tr> 120 </tr>
121 <tr> 121 <tr>
122 <td><a href="#DebugClientBase.__completionList">__completionList</a></td> 122 <td><a href="#DebugClientBase.__completionList">__completionList</a></td>
197 <tr> 197 <tr>
198 <td><a href="#DebugClientBase.eventPoll">eventPoll</a></td> 198 <td><a href="#DebugClientBase.eventPoll">eventPoll</a></td>
199 <td>Public method to poll for events like 'set break point'.</td> 199 <td>Public method to poll for events like 'set break point'.</td>
200 </tr> 200 </tr>
201 <tr> 201 <tr>
202 <td><a href="#DebugClientBase.fork">fork</a></td>
203 <td>Public method implementing a fork routine deciding which branch to follow.</td>
204 </tr>
205 <tr>
206 <td><a href="#DebugClientBase.getCoding">getCoding</a></td> 202 <td><a href="#DebugClientBase.getCoding">getCoding</a></td>
207 <td>Public method to return the current coding.</td> 203 <td>Public method to return the current coding.</td>
208 </tr> 204 </tr>
209 <tr> 205 <tr>
210 <td><a href="#DebugClientBase.getRunning">getRunning</a></td> 206 <td><a href="#DebugClientBase.getRunning">getRunning</a></td>
245 <tr> 241 <tr>
246 <td><a href="#DebugClientBase.sendClearTemporaryWatch">sendClearTemporaryWatch</a></td> 242 <td><a href="#DebugClientBase.sendClearTemporaryWatch">sendClearTemporaryWatch</a></td>
247 <td>Public method to signal the deletion of a temporary watch expression.</td> 243 <td>Public method to signal the deletion of a temporary watch expression.</td>
248 </tr> 244 </tr>
249 <tr> 245 <tr>
246 <td><a href="#DebugClientBase.sendDebuggerId">sendDebuggerId</a></td>
247 <td>Public method to send the debug client id.</td>
248 </tr>
249 <tr>
250 <td><a href="#DebugClientBase.sendException">sendException</a></td> 250 <td><a href="#DebugClientBase.sendException">sendException</a></td>
251 <td>Public method to send information for an exception.</td> 251 <td>Public method to send information for an exception.</td>
252 </tr> 252 </tr>
253 <tr> 253 <tr>
254 <td><a href="#DebugClientBase.sendJsonCommand">sendJsonCommand</a></td> 254 <td><a href="#DebugClientBase.sendJsonCommand">sendJsonCommand</a></td>
271 <td>Public method to close the session with the debugger and optionally terminate.</td> 271 <td>Public method to close the session with the debugger and optionally terminate.</td>
272 </tr> 272 </tr>
273 <tr> 273 <tr>
274 <td><a href="#DebugClientBase.setDisassembly">setDisassembly</a></td> 274 <td><a href="#DebugClientBase.setDisassembly">setDisassembly</a></td>
275 <td>Public method to store a disassembly of the code object raising an exception.</td> 275 <td>Public method to store a disassembly of the code object raising an exception.</td>
276 </tr>
277 <tr>
278 <td><a href="#DebugClientBase.skipMultiProcessDebugging">skipMultiProcessDebugging</a></td>
279 <td>Public method to check, if the given script is eligible for debugging.</td>
276 </tr> 280 </tr>
277 <tr> 281 <tr>
278 <td><a href="#DebugClientBase.startDebugger">startDebugger</a></td> 282 <td><a href="#DebugClientBase.startDebugger">startDebugger</a></td>
279 <td>Public method used to start the remote debugger.</td> 283 <td>Public method used to start the remote debugger.</td>
280 </tr> 284 </tr>
318 <dd> 322 <dd>
319 name of directory discovery was started at 323 name of directory discovery was started at
320 </dd> 324 </dd>
321 </dl> 325 </dl>
322 <dl> 326 <dl>
323 <dt>Returns:</dt> 327 <dt>Return:</dt>
324 <dd> 328 <dd>
325 list of tuples containing the test case ID, a short description 329 list of tuples containing the test case ID, a short description
326 and the path of the test file name 330 and the path of the test file name
327 </dd> 331 </dd>
328 </dl> 332 </dl>
338 342
339 <p> 343 <p>
340 Private method to determine the clients capabilities. 344 Private method to determine the clients capabilities.
341 </p> 345 </p>
342 <dl> 346 <dl>
343 <dt>Returns:</dt> 347 <dt>Return:</dt>
344 <dd> 348 <dd>
345 client capabilities (integer) 349 client capabilities (integer)
350 </dd>
351 </dl>
352 <a NAME="DebugClientBase.__compileCommand" ID="DebugClientBase.__compileCommand"></a>
353 <h4>DebugClientBase.__compileCommand</h4>
354 <b>__compileCommand</b>(<i>statement, filename="<string>", mode="exec"</i>)
355
356 <p>
357 Private method to compile source code.
358 </p>
359 <dl>
360
361 <dt><i>statement</i> (str)</dt>
362 <dd>
363 source code string to be compiled
364 </dd>
365 <dt><i>filename</i> (str)</dt>
366 <dd>
367 name of the source file
368 </dd>
369 <dt><i>mode</i> (str)</dt>
370 <dd>
371 kind of code to be generated (exec or eval)
372 </dd>
373 </dl>
374 <dl>
375 <dt>Return:</dt>
376 <dd>
377 compiled code object (None in case of errors)
346 </dd> 378 </dd>
347 </dl> 379 </dl>
348 <a NAME="DebugClientBase.__compileFileSource" ID="DebugClientBase.__compileFileSource"></a> 380 <a NAME="DebugClientBase.__compileFileSource" ID="DebugClientBase.__compileFileSource"></a>
349 <h4>DebugClientBase.__compileFileSource</h4> 381 <h4>DebugClientBase.__compileFileSource</h4>
350 <b>__compileFileSource</b>(<i>filename, mode='exec'</i>) 382 <b>__compileFileSource</b>(<i>filename, mode='exec'</i>)
352 <p> 384 <p>
353 Private method to compile source code read from a file. 385 Private method to compile source code read from a file.
354 </p> 386 </p>
355 <dl> 387 <dl>
356 388
357 <dt><i>filename</i></dt> 389 <dt><i>filename</i> (str)</dt>
358 <dd> 390 <dd>
359 name of the source file (string) 391 name of the source file
360 </dd> 392 </dd>
361 <dt><i>mode</i></dt> 393 <dt><i>mode</i> (str)</dt>
362 <dd> 394 <dd>
363 kind of code to be generated (string, exec or eval) 395 kind of code to be generated (exec or eval)
364 </dd> 396 </dd>
365 </dl> 397 </dl>
366 <dl> 398 <dl>
367 <dt>Returns:</dt> 399 <dt>Return:</dt>
368 <dd> 400 <dd>
369 compiled code object (None in case of errors) 401 compiled code object (None in case of errors)
370 </dd> 402 </dd>
371 </dl> 403 </dl>
372 <a NAME="DebugClientBase.__completionList" ID="DebugClientBase.__completionList"></a> 404 <a NAME="DebugClientBase.__completionList" ID="DebugClientBase.__completionList"></a>
390 <p> 422 <p>
391 Private method to return the variables of a frame to the debug server. 423 Private method to return the variables of a frame to the debug server.
392 </p> 424 </p>
393 <dl> 425 <dl>
394 426
395 <dt><i>var</i> (list of strings)</dt> 427 <dt><i>var</i> (list of str)</dt>
396 <dd> 428 <dd>
397 list encoded name of the requested variable 429 list encoded name of the requested variable
398 </dd> 430 </dd>
399 <dt><i>frmnr</i> (int)</dt> 431 <dt><i>frmnr</i> (int)</dt>
400 <dd> 432 <dd>
404 <dd> 436 <dd>
405 1 to report global variables, 0 for local variables 437 1 to report global variables, 0 for local variables
406 </dd> 438 </dd>
407 <dt><i>filterList</i> (list of int)</dt> 439 <dt><i>filterList</i> (list of int)</dt>
408 <dd> 440 <dd>
409 the indices of variable types to be filtered 441 list of variable types to be filtered
410 </dd> 442 </dd>
411 </dl> 443 </dl>
412 <a NAME="DebugClientBase.__dumpVariables" ID="DebugClientBase.__dumpVariables"></a> 444 <a NAME="DebugClientBase.__dumpVariables" ID="DebugClientBase.__dumpVariables"></a>
413 <h4>DebugClientBase.__dumpVariables</h4> 445 <h4>DebugClientBase.__dumpVariables</h4>
414 <b>__dumpVariables</b>(<i>frmnr, scope, filterList</i>) 446 <b>__dumpVariables</b>(<i>frmnr, scope, filterList</i>)
424 </dd> 456 </dd>
425 <dt><i>scope</i> (int)</dt> 457 <dt><i>scope</i> (int)</dt>
426 <dd> 458 <dd>
427 1 to report global variables, 0 for local variables 459 1 to report global variables, 0 for local variables
428 </dd> 460 </dd>
429 <dt><i>filterList</i> (list of int)</dt> 461 <dt><i>filterList</i> (list of str)</dt>
430 <dd> 462 <dd>
431 the indices of variable types to be filtered 463 list of variable types to be filtered
432 </dd> 464 </dd>
433 </dl> 465 </dl>
434 <a NAME="DebugClientBase.__extractIndicators" ID="DebugClientBase.__extractIndicators"></a> 466 <a NAME="DebugClientBase.__extractIndicators" ID="DebugClientBase.__extractIndicators"></a>
435 <h4>DebugClientBase.__extractIndicators</h4> 467 <h4>DebugClientBase.__extractIndicators</h4>
436 <b>__extractIndicators</b>(<i>var</i>) 468 <b>__extractIndicators</b>(<i>var</i>)
444 <dd> 476 <dd>
445 variable text 477 variable text
446 </dd> 478 </dd>
447 </dl> 479 </dl>
448 <dl> 480 <dl>
449 <dt>Returns:</dt> 481 <dt>Return:</dt>
450 <dd> 482 <dd>
451 tuple containing the variable text without indicators and the 483 tuple containing the variable text without indicators and the
452 indicator string 484 indicator string
453 </dd> 485 </dd>
454 </dl> 486 </dl>
475 <dd> 507 <dd>
476 type of the Qt variable to be formatted (string) 508 type of the Qt variable to be formatted (string)
477 </dd> 509 </dd>
478 </dl> 510 </dl>
479 <dl> 511 <dl>
480 <dt>Returns:</dt> 512 <dt>Return:</dt>
481 <dd> 513 <dd>
482 A tuple consisting of a list of formatted variables. Each 514 A tuple consisting of a list of formatted variables. Each
483 variable entry is a tuple of three elements, the variable name, 515 variable entry is a tuple of three elements, the variable name,
484 its type and value. 516 its type and value.
485 </dd> 517 </dd>
509 1 to filter using the globals filter, 0 using the locals 541 1 to filter using the globals filter, 0 using the locals
510 filter. 542 filter.
511 Variables are only added to the list, if their name do not match 543 Variables are only added to the list, if their name do not match
512 any of the filter expressions. 544 any of the filter expressions.
513 </dd> 545 </dd>
514 <dt><i>filterList</i> (list of int)</dt> 546 <dt><i>filterList</i> (list of str)</dt>
515 <dd> 547 <dd>
516 the indices of variable types to be filtered. 548 list of variable types to be filtered.
517 Variables are only added to the list, if their type is not 549 Variables are only added to the list, if their type is not
518 contained in the filter list. 550 contained in the filter list.
519 </dd> 551 </dd>
520 </dl> 552 </dl>
521 <dl> 553 <dl>
522 <dt>Returns:</dt> 554 <dt>Return:</dt>
523 <dd> 555 <dd>
524 A tuple consisting of a list of formatted variables. Each 556 A tuple consisting of a list of formatted variables. Each
525 variable entry is a tuple of three elements, the variable name, 557 variable entry is a tuple of three elements, the variable name,
526 its type and value. 558 its type and value.
527 </dd> 559 </dd>
587 <dd> 619 <dd>
588 entry to be put first in sys.path (string) 620 entry to be put first in sys.path (string)
589 </dd> 621 </dd>
590 </dl> 622 </dl>
591 <dl> 623 <dl>
592 <dt>Returns:</dt> 624 <dt>Return:</dt>
593 <dd> 625 <dd>
594 path list for use as sys.path (list of strings) 626 path list for use as sys.path (list of strings)
595 </dd> 627 </dd>
596 </dl> 628 </dl>
597 <a NAME="DebugClientBase.__interact" ID="DebugClientBase.__interact"></a> 629 <a NAME="DebugClientBase.__interact" ID="DebugClientBase.__interact"></a>
621 <dd> 653 <dd>
622 hostname of the debug server (string) 654 hostname of the debug server (string)
623 </dd> 655 </dd>
624 </dl> 656 </dl>
625 <dl> 657 <dl>
626 <dt>Returns:</dt> 658 <dt>Return:</dt>
627 <dd> 659 <dd>
628 IP address (string) 660 IP address (string)
629 </dd> 661 </dd>
630 </dl> 662 </dl>
631 <a NAME="DebugClientBase.__setCoding" ID="DebugClientBase.__setCoding"></a> 663 <a NAME="DebugClientBase.__setCoding" ID="DebugClientBase.__setCoding"></a>
699 <dd> 731 <dd>
700 filename (string) 732 filename (string)
701 </dd> 733 </dd>
702 </dl> 734 </dl>
703 <dl> 735 <dl>
704 <dt>Returns:</dt> 736 <dt>Return:</dt>
705 <dd> 737 <dd>
706 the converted filename (string) 738 the converted filename (string)
707 </dd> 739 </dd>
708 </dl> 740 </dl>
709 <a NAME="DebugClientBase.close" ID="DebugClientBase.close"></a> 741 <a NAME="DebugClientBase.close" ID="DebugClientBase.close"></a>
724 file descriptor to be closed (integer) 756 file descriptor to be closed (integer)
725 </dd> 757 </dd>
726 </dl> 758 </dl>
727 <a NAME="DebugClientBase.connectDebugger" ID="DebugClientBase.connectDebugger"></a> 759 <a NAME="DebugClientBase.connectDebugger" ID="DebugClientBase.connectDebugger"></a>
728 <h4>DebugClientBase.connectDebugger</h4> 760 <h4>DebugClientBase.connectDebugger</h4>
729 <b>connectDebugger</b>(<i>port, remoteAddress=None, redirect=True</i>) 761 <b>connectDebugger</b>(<i>port, remoteAddress=None, redirect=True, name=""</i>)
730 762
731 <p> 763 <p>
732 Public method to establish a session with the debugger. 764 Public method to establish a session with the debugger.
733 </p> 765 </p>
734 <p> 766 <p>
736 stdout and stderr and saves these file objects in case the application 768 stdout and stderr and saves these file objects in case the application
737 being debugged redirects them itself. 769 being debugged redirects them itself.
738 </p> 770 </p>
739 <dl> 771 <dl>
740 772
741 <dt><i>port</i></dt> 773 <dt><i>port</i> (int)</dt>
742 <dd> 774 <dd>
743 the port number to connect to (int) 775 the port number to connect to
744 </dd> 776 </dd>
745 <dt><i>remoteAddress</i></dt> 777 <dt><i>remoteAddress</i> (str)</dt>
746 <dd> 778 <dd>
747 the network address of the debug server host 779 the network address of the debug server host
748 (string) 780 </dd>
749 </dd> 781 <dt><i>redirect</i> (bool)</dt>
750 <dt><i>redirect</i></dt>
751 <dd> 782 <dd>
752 flag indicating redirection of stdin, stdout and 783 flag indicating redirection of stdin, stdout and
753 stderr (boolean) 784 stderr
785 </dd>
786 <dt><i>name</i> (str)</dt>
787 <dd>
788 name to be attached to the debugger ID
754 </dd> 789 </dd>
755 </dl> 790 </dl>
756 <a NAME="DebugClientBase.eventLoop" ID="DebugClientBase.eventLoop"></a> 791 <a NAME="DebugClientBase.eventLoop" ID="DebugClientBase.eventLoop"></a>
757 <h4>DebugClientBase.eventLoop</h4> 792 <h4>DebugClientBase.eventLoop</h4>
758 <b>eventLoop</b>(<i>disablePolling=False</i>) 793 <b>eventLoop</b>(<i>disablePolling=False</i>)
773 <b>eventPoll</b>(<i></i>) 808 <b>eventPoll</b>(<i></i>)
774 809
775 <p> 810 <p>
776 Public method to poll for events like 'set break point'. 811 Public method to poll for events like 'set break point'.
777 </p> 812 </p>
778 <a NAME="DebugClientBase.fork" ID="DebugClientBase.fork"></a>
779 <h4>DebugClientBase.fork</h4>
780 <b>fork</b>(<i></i>)
781
782 <p>
783 Public method implementing a fork routine deciding which branch
784 to follow.
785 </p>
786 <dl>
787 <dt>Returns:</dt>
788 <dd>
789 process ID (integer)
790 </dd>
791 </dl>
792 <a NAME="DebugClientBase.getCoding" ID="DebugClientBase.getCoding"></a> 813 <a NAME="DebugClientBase.getCoding" ID="DebugClientBase.getCoding"></a>
793 <h4>DebugClientBase.getCoding</h4> 814 <h4>DebugClientBase.getCoding</h4>
794 <b>getCoding</b>(<i></i>) 815 <b>getCoding</b>(<i></i>)
795 816
796 <p> 817 <p>
797 Public method to return the current coding. 818 Public method to return the current coding.
798 </p> 819 </p>
799 <dl> 820 <dl>
800 <dt>Returns:</dt> 821 <dt>Return:</dt>
801 <dd> 822 <dd>
802 codec name (string) 823 codec name (string)
803 </dd> 824 </dd>
804 </dl> 825 </dl>
805 <a NAME="DebugClientBase.getRunning" ID="DebugClientBase.getRunning"></a> 826 <a NAME="DebugClientBase.getRunning" ID="DebugClientBase.getRunning"></a>
808 829
809 <p> 830 <p>
810 Public method to return the main script we are currently running. 831 Public method to return the main script we are currently running.
811 </p> 832 </p>
812 <dl> 833 <dl>
813 <dt>Returns:</dt> 834 <dt>Return:</dt>
814 <dd> 835 <dd>
815 flag indicating a running debug session (boolean) 836 flag indicating a running debug session (boolean)
816 </dd> 837 </dd>
817 </dl> 838 </dl>
818 <a NAME="DebugClientBase.handleJsonCommand" ID="DebugClientBase.handleJsonCommand"></a> 839 <a NAME="DebugClientBase.handleJsonCommand" ID="DebugClientBase.handleJsonCommand"></a>
846 <dd> 867 <dd>
847 Flag indicating echoing of the input (boolean) 868 Flag indicating echoing of the input (boolean)
848 </dd> 869 </dd>
849 </dl> 870 </dl>
850 <dl> 871 <dl>
851 <dt>Returns:</dt> 872 <dt>Return:</dt>
852 <dd> 873 <dd>
853 the entered string 874 the entered string
854 </dd> 875 </dd>
855 </dl> 876 </dl>
856 <a NAME="DebugClientBase.main" ID="DebugClientBase.main"></a> 877 <a NAME="DebugClientBase.main" ID="DebugClientBase.main"></a>
860 <p> 881 <p>
861 Public method implementing the main method. 882 Public method implementing the main method.
862 </p> 883 </p>
863 <a NAME="DebugClientBase.progTerminated" ID="DebugClientBase.progTerminated"></a> 884 <a NAME="DebugClientBase.progTerminated" ID="DebugClientBase.progTerminated"></a>
864 <h4>DebugClientBase.progTerminated</h4> 885 <h4>DebugClientBase.progTerminated</h4>
865 <b>progTerminated</b>(<i>status, message=""</i>) 886 <b>progTerminated</b>(<i>status, message="", closeSession=True</i>)
866 887
867 <p> 888 <p>
868 Public method to tell the debugger that the program has terminated. 889 Public method to tell the debugger that the program has terminated.
869 </p> 890 </p>
870 <dl> 891 <dl>
874 return status 895 return status
875 </dd> 896 </dd>
876 <dt><i>message</i> (str)</dt> 897 <dt><i>message</i> (str)</dt>
877 <dd> 898 <dd>
878 status message 899 status message
900 </dd>
901 <dt><i>closeSession</i> (bool)</dt>
902 <dd>
903 flag indicating to close the debugger session
879 </dd> 904 </dd>
880 </dl> 905 </dl>
881 <a NAME="DebugClientBase.readReady" ID="DebugClientBase.readReady"></a> 906 <a NAME="DebugClientBase.readReady" ID="DebugClientBase.readReady"></a>
882 <h4>DebugClientBase.readReady</h4> 907 <h4>DebugClientBase.readReady</h4>
883 <b>readReady</b>(<i>stream</i>) 908 <b>readReady</b>(<i>stream</i>)
887 </p> 912 </p>
888 <dl> 913 <dl>
889 914
890 <dt><i>stream</i></dt> 915 <dt><i>stream</i></dt>
891 <dd> 916 <dd>
892 file like object that has data to be written 917 file like object that has data to be read
893 </dd> 918 </dd>
894 </dl> 919 </dl>
895 <dl> 920 <dl>
896 <dt>Returns:</dt> 921 <dt>Return:</dt>
897 <dd> 922 <dd>
898 flag indicating an error condition 923 flag indicating an error condition
899 </dd> 924 </dd>
900 </dl> 925 </dl>
901 <dl> 926 <dl>
925 <dd> 950 <dd>
926 arguments being passed to func 951 arguments being passed to func
927 </dd> 952 </dd>
928 </dl> 953 </dl>
929 <dl> 954 <dl>
930 <dt>Returns:</dt> 955 <dt>Return:</dt>
931 <dd> 956 <dd>
932 result of the function call 957 result of the function call
933 </dd> 958 </dd>
934 </dl> 959 </dl>
935 <a NAME="DebugClientBase.sendCallTrace" ID="DebugClientBase.sendCallTrace"></a> 960 <a NAME="DebugClientBase.sendCallTrace" ID="DebugClientBase.sendCallTrace"></a>
986 <dt><i>condition</i> (str)</dt> 1011 <dt><i>condition</i> (str)</dt>
987 <dd> 1012 <dd>
988 condition of the watch expression to be cleared 1013 condition of the watch expression to be cleared
989 </dd> 1014 </dd>
990 </dl> 1015 </dl>
1016 <a NAME="DebugClientBase.sendDebuggerId" ID="DebugClientBase.sendDebuggerId"></a>
1017 <h4>DebugClientBase.sendDebuggerId</h4>
1018 <b>sendDebuggerId</b>(<i>debuggerId</i>)
1019
1020 <p>
1021 Public method to send the debug client id.
1022 </p>
1023 <dl>
1024
1025 <dt><i>debuggerId</i> (str)</dt>
1026 <dd>
1027 id of this debug client instance (made up of
1028 hostname and process ID)
1029 </dd>
1030 </dl>
991 <a NAME="DebugClientBase.sendException" ID="DebugClientBase.sendException"></a> 1031 <a NAME="DebugClientBase.sendException" ID="DebugClientBase.sendException"></a>
992 <h4>DebugClientBase.sendException</h4> 1032 <h4>DebugClientBase.sendException</h4>
993 <b>sendException</b>(<i>exceptionType, exceptionMessage, stack</i>) 1033 <b>sendException</b>(<i>exceptionType, exceptionMessage, stack, threadName</i>)
994 1034
995 <p> 1035 <p>
996 Public method to send information for an exception. 1036 Public method to send information for an exception.
997 </p> 1037 </p>
998 <dl> 1038 <dl>
1006 message of the exception 1046 message of the exception
1007 </dd> 1047 </dd>
1008 <dt><i>stack</i> (list)</dt> 1048 <dt><i>stack</i> (list)</dt>
1009 <dd> 1049 <dd>
1010 stack trace information 1050 stack trace information
1051 </dd>
1052 <dt><i>threadName</i> (str)</dt>
1053 <dd>
1054 name of the thread sending the event
1011 </dd> 1055 </dd>
1012 </dl> 1056 </dl>
1013 <a NAME="DebugClientBase.sendJsonCommand" ID="DebugClientBase.sendJsonCommand"></a> 1057 <a NAME="DebugClientBase.sendJsonCommand" ID="DebugClientBase.sendJsonCommand"></a>
1014 <h4>DebugClientBase.sendJsonCommand</h4> 1058 <h4>DebugClientBase.sendJsonCommand</h4>
1015 <b>sendJsonCommand</b>(<i>method, params</i>) 1059 <b>sendJsonCommand</b>(<i>method, params</i>)
1047 flag to enable exception reporting of the IDE 1091 flag to enable exception reporting of the IDE
1048 </dd> 1092 </dd>
1049 </dl> 1093 </dl>
1050 <a NAME="DebugClientBase.sendResponseLine" ID="DebugClientBase.sendResponseLine"></a> 1094 <a NAME="DebugClientBase.sendResponseLine" ID="DebugClientBase.sendResponseLine"></a>
1051 <h4>DebugClientBase.sendResponseLine</h4> 1095 <h4>DebugClientBase.sendResponseLine</h4>
1052 <b>sendResponseLine</b>(<i>stack</i>) 1096 <b>sendResponseLine</b>(<i>stack, threadName</i>)
1053 1097
1054 <p> 1098 <p>
1055 Public method to send the current call stack. 1099 Public method to send the current call stack.
1056 </p> 1100 </p>
1057 <dl> 1101 <dl>
1058 1102
1059 <dt><i>stack</i> (list)</dt> 1103 <dt><i>stack</i> (list)</dt>
1060 <dd> 1104 <dd>
1061 call stack 1105 call stack
1106 </dd>
1107 <dt><i>threadName</i> (str)</dt>
1108 <dd>
1109 name of the thread sending the event
1062 </dd> 1110 </dd>
1063 </dl> 1111 </dl>
1064 <a NAME="DebugClientBase.sendSyntaxError" ID="DebugClientBase.sendSyntaxError"></a> 1112 <a NAME="DebugClientBase.sendSyntaxError" ID="DebugClientBase.sendSyntaxError"></a>
1065 <h4>DebugClientBase.sendSyntaxError</h4> 1113 <h4>DebugClientBase.sendSyntaxError</h4>
1066 <b>sendSyntaxError</b>(<i>message, filename, lineno, charno</i>) 1114 <b>sendSyntaxError</b>(<i>message, filename, lineno, charno, threadName</i>)
1067 1115
1068 <p> 1116 <p>
1069 Public method to send information for a syntax error. 1117 Public method to send information for a syntax error.
1070 </p> 1118 </p>
1071 <dl> 1119 <dl>
1083 line number info 1131 line number info
1084 </dd> 1132 </dd>
1085 <dt><i>charno</i> (int)</dt> 1133 <dt><i>charno</i> (int)</dt>
1086 <dd> 1134 <dd>
1087 character number info 1135 character number info
1136 </dd>
1137 <dt><i>threadName</i> (str)</dt>
1138 <dd>
1139 name of the thread sending the event
1088 </dd> 1140 </dd>
1089 </dl> 1141 </dl>
1090 <a NAME="DebugClientBase.sessionClose" ID="DebugClientBase.sessionClose"></a> 1142 <a NAME="DebugClientBase.sessionClose" ID="DebugClientBase.sessionClose"></a>
1091 <h4>DebugClientBase.sessionClose</h4> 1143 <h4>DebugClientBase.sessionClose</h4>
1092 <b>sessionClose</b>(<i>terminate=True</i>) 1144 <b>sessionClose</b>(<i>terminate=True</i>)
1115 <dt><i>disassembly</i> (dict)</dt> 1167 <dt><i>disassembly</i> (dict)</dt>
1116 <dd> 1168 <dd>
1117 dictionary containing the disassembly information 1169 dictionary containing the disassembly information
1118 </dd> 1170 </dd>
1119 </dl> 1171 </dl>
1172 <a NAME="DebugClientBase.skipMultiProcessDebugging" ID="DebugClientBase.skipMultiProcessDebugging"></a>
1173 <h4>DebugClientBase.skipMultiProcessDebugging</h4>
1174 <b>skipMultiProcessDebugging</b>(<i>scriptName</i>)
1175
1176 <p>
1177 Public method to check, if the given script is eligible for debugging.
1178 </p>
1179 <dl>
1180
1181 <dt><i>scriptName</i> (str)</dt>
1182 <dd>
1183 name of the script to check
1184 </dd>
1185 </dl>
1186 <dl>
1187 <dt>Return:</dt>
1188 <dd>
1189 flag indicating eligibility
1190 </dd>
1191 </dl>
1192 <dl>
1193 <dt>Return Type:</dt>
1194 <dd>
1195 bool
1196 </dd>
1197 </dl>
1120 <a NAME="DebugClientBase.startDebugger" ID="DebugClientBase.startDebugger"></a> 1198 <a NAME="DebugClientBase.startDebugger" ID="DebugClientBase.startDebugger"></a>
1121 <h4>DebugClientBase.startDebugger</h4> 1199 <h4>DebugClientBase.startDebugger</h4>
1122 <b>startDebugger</b>(<i>filename=None, host=None, port=None, enableTrace=True, exceptions=True, tracePython=False, redirect=True</i>) 1200 <b>startDebugger</b>(<i>filename=None, host=None, port=None, enableTrace=True, exceptions=True, tracePython=False, redirect=True, passive=True, multiprocessSupport=False</i>)
1123 1201
1124 <p> 1202 <p>
1125 Public method used to start the remote debugger. 1203 Public method used to start the remote debugger.
1126 </p> 1204 </p>
1127 <dl> 1205 <dl>
1128 1206
1129 <dt><i>filename</i></dt> 1207 <dt><i>filename</i> (str)</dt>
1130 <dd> 1208 <dd>
1131 the program to be debugged (string) 1209 the program to be debugged
1210 </dd>
1211 <dt><i>host</i> (str)</dt>
1212 <dd>
1213 hostname of the debug server
1214 </dd>
1215 <dt><i>port</i> (int)</dt>
1216 <dd>
1217 portnumber of the debug server
1218 </dd>
1219 <dt><i>enableTrace</i> (bool)</dt>
1220 <dd>
1221 flag to enable the tracing function
1222 </dd>
1223 <dt><i>exceptions</i> (bool)</dt>
1224 <dd>
1225 flag to enable exception reporting of the IDE
1226 </dd>
1227 <dt><i>tracePython</i> (bool)</dt>
1228 <dd>
1229 flag to enable tracing into the Python library
1230 </dd>
1231 <dt><i>redirect</i> (bool)</dt>
1232 <dd>
1233 flag indicating redirection of stdin, stdout and
1234 stderr
1235 </dd>
1236 <dt><i>passive</i> (bool)</dt>
1237 <dd>
1238 flag indicating a passive debugging session
1239 </dd>
1240 <dt><i>multiprocessSupport</i> (bool)</dt>
1241 <dd>
1242 flag indicating to enable multiprocess
1243 debugging support
1244 </dd>
1245 </dl>
1246 <a NAME="DebugClientBase.startProgInDebugger" ID="DebugClientBase.startProgInDebugger"></a>
1247 <h4>DebugClientBase.startProgInDebugger</h4>
1248 <b>startProgInDebugger</b>(<i>progargs, wd='', host=None, port=None, exceptions=True, tracePython=False, redirect=True, passive=True, multiprocessSupport=False, codeStr="", scriptModule=""</i>)
1249
1250 <p>
1251 Public method used to start the remote debugger.
1252 </p>
1253 <dl>
1254
1255 <dt><i>progargs</i></dt>
1256 <dd>
1257 commandline for the program to be debugged
1258 (list of strings)
1259 </dd>
1260 <dt><i>wd</i></dt>
1261 <dd>
1262 working directory for the program execution (string)
1132 </dd> 1263 </dd>
1133 <dt><i>host</i></dt> 1264 <dt><i>host</i></dt>
1134 <dd> 1265 <dd>
1135 hostname of the debug server (string) 1266 hostname of the debug server (string)
1136 </dd> 1267 </dd>
1137 <dt><i>port</i></dt> 1268 <dt><i>port</i></dt>
1138 <dd> 1269 <dd>
1139 portnumber of the debug server (int) 1270 portnumber of the debug server (int)
1140 </dd>
1141 <dt><i>enableTrace</i></dt>
1142 <dd>
1143 flag to enable the tracing function (boolean)
1144 </dd> 1271 </dd>
1145 <dt><i>exceptions</i></dt> 1272 <dt><i>exceptions</i></dt>
1146 <dd> 1273 <dd>
1147 flag to enable exception reporting of the IDE 1274 flag to enable exception reporting of the IDE
1148 (boolean) 1275 (boolean)
1155 <dt><i>redirect</i></dt> 1282 <dt><i>redirect</i></dt>
1156 <dd> 1283 <dd>
1157 flag indicating redirection of stdin, stdout and 1284 flag indicating redirection of stdin, stdout and
1158 stderr (boolean) 1285 stderr (boolean)
1159 </dd> 1286 </dd>
1160 </dl> 1287 <dt><i>passive</i> (bool)</dt>
1161 <a NAME="DebugClientBase.startProgInDebugger" ID="DebugClientBase.startProgInDebugger"></a> 1288 <dd>
1162 <h4>DebugClientBase.startProgInDebugger</h4> 1289 flag indicating a passive debugging session
1163 <b>startProgInDebugger</b>(<i>progargs, wd='', host=None, port=None, exceptions=True, tracePython=False, redirect=True</i>) 1290 </dd>
1164 1291 <dt><i>multiprocessSupport</i> (bool)</dt>
1165 <p> 1292 <dd>
1166 Public method used to start the remote debugger. 1293 flag indicating to enable multiprocess
1167 </p> 1294 debugging support
1168 <dl> 1295 </dd>
1169 1296 <dt><i>codeStr</i> (str)</dt>
1170 <dt><i>progargs</i></dt> 1297 <dd>
1171 <dd> 1298 string containing Python code to execute
1172 commandline for the program to be debugged 1299 </dd>
1173 (list of strings) 1300 <dt><i>scriptModule</i> (str)</dt>
1174 </dd> 1301 <dd>
1175 <dt><i>wd</i></dt> 1302 name of a module to be executed as a script
1176 <dd> 1303 </dd>
1177 working directory for the program execution (string) 1304 </dl>
1178 </dd> 1305 <dl>
1179 <dt><i>host</i></dt> 1306 <dt>Return:</dt>
1180 <dd> 1307 <dd>
1181 hostname of the debug server (string) 1308 exit code of the debugged program
1182 </dd> 1309 </dd>
1183 <dt><i>port</i></dt> 1310 </dl>
1184 <dd> 1311 <dl>
1185 portnumber of the debug server (int) 1312 <dt>Return Type:</dt>
1186 </dd> 1313 <dd>
1187 <dt><i>exceptions</i></dt> 1314 int
1188 <dd>
1189 flag to enable exception reporting of the IDE
1190 (boolean)
1191 </dd>
1192 <dt><i>tracePython</i></dt>
1193 <dd>
1194 flag to enable tracing into the Python library
1195 (boolean)
1196 </dd>
1197 <dt><i>redirect</i></dt>
1198 <dd>
1199 flag indicating redirection of stdin, stdout and
1200 stderr (boolean)
1201 </dd> 1315 </dd>
1202 </dl> 1316 </dl>
1203 <a NAME="DebugClientBase.writeReady" ID="DebugClientBase.writeReady"></a> 1317 <a NAME="DebugClientBase.writeReady" ID="DebugClientBase.writeReady"></a>
1204 <h4>DebugClientBase.writeReady</h4> 1318 <h4>DebugClientBase.writeReady</h4>
1205 <b>writeReady</b>(<i>stream</i>) 1319 <b>writeReady</b>(<i>stream</i>)
1232 </dd> 1346 </dd>
1233 </dl> 1347 </dl>
1234 <div align="right"><a href="#top">Up</a></div> 1348 <div align="right"><a href="#top">Up</a></div>
1235 <hr /> 1349 <hr />
1236 <hr /> 1350 <hr />
1237 <a NAME="DebugClientFork" ID="DebugClientFork"></a>
1238 <h2>DebugClientFork</h2>
1239 <b>DebugClientFork</b>(<i></i>)
1240
1241 <p>
1242 Replacement for the standard os.fork().
1243 </p>
1244 <dl>
1245 <dt>Returns:</dt>
1246 <dd>
1247 result of the fork() call
1248 </dd>
1249 </dl>
1250 <div align="right"><a href="#top">Up</a></div>
1251 <hr />
1252 <hr />
1253 <a NAME="DebugClientInput" ID="DebugClientInput"></a> 1351 <a NAME="DebugClientInput" ID="DebugClientInput"></a>
1254 <h2>DebugClientInput</h2> 1352 <h2>DebugClientInput</h2>
1255 <b>DebugClientInput</b>(<i>prompt=""</i>) 1353 <b>DebugClientInput</b>(<i>prompt=""</i>)
1256 1354
1257 <p> 1355 <p>
1266 <dd> 1364 <dd>
1267 prompt to be shown 1365 prompt to be shown
1268 </dd> 1366 </dd>
1269 </dl> 1367 </dl>
1270 <dl> 1368 <dl>
1271 <dt>Returns:</dt> 1369 <dt>Return:</dt>
1272 <dd> 1370 <dd>
1273 result of the input() call 1371 result of the input() call
1274 </dd> 1372 </dd>
1275 </dl> 1373 </dl>
1276 <dl> 1374 <dl>

Mercurial Repository: eric

eric ide

mercurial