|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.DebugClients.Python.eric4dbgstub</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.DebugClients.Python.eric4dbgstub</h1> |
|
12 <p> |
|
13 Module implementing a debugger stub for remote debugging. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>__scriptname</td></tr><tr><td>debugger</td></tr><tr><td>ericpath</td></tr><tr><td>modDir</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr><td>None</td></tr> |
|
22 </table> |
|
23 <h3>Functions</h3> |
|
24 <table> |
|
25 <tr> |
|
26 <td><a href="#initDebugger">initDebugger</a></td> |
|
27 <td>Module function to initialize a debugger for remote debugging.</td> |
|
28 </tr><tr> |
|
29 <td><a href="#runcall">runcall</a></td> |
|
30 <td>Module function mimicing the Pdb interface.</td> |
|
31 </tr><tr> |
|
32 <td><a href="#setScriptname">setScriptname</a></td> |
|
33 <td>Module function to set the scriptname to be reported back to the IDE.</td> |
|
34 </tr><tr> |
|
35 <td><a href="#startDebugger">startDebugger</a></td> |
|
36 <td>Module function used to start the remote debugger.</td> |
|
37 </tr> |
|
38 </table> |
|
39 <hr /><hr /> |
|
40 <a NAME="initDebugger" ID="initDebugger"></a> |
|
41 <h2>initDebugger</h2> |
|
42 <b>initDebugger</b>(<i>kind = "standard"</i>) |
|
43 <p> |
|
44 Module function to initialize a debugger for remote debugging. |
|
45 </p><dl> |
|
46 <dt><i>kind</i></dt> |
|
47 <dd> |
|
48 type of debugger ("standard" or "threads") |
|
49 </dd> |
|
50 </dl><dl> |
|
51 <dt>Returns:</dt> |
|
52 <dd> |
|
53 flag indicating success (boolean) |
|
54 </dd> |
|
55 </dl> |
|
56 <div align="right"><a href="#top">Up</a></div> |
|
57 <hr /><hr /> |
|
58 <a NAME="runcall" ID="runcall"></a> |
|
59 <h2>runcall</h2> |
|
60 <b>runcall</b>(<i>func, *args</i>) |
|
61 <p> |
|
62 Module function mimicing the Pdb interface. |
|
63 </p><dl> |
|
64 <dt><i>func</i></dt> |
|
65 <dd> |
|
66 function to be called (function object) |
|
67 </dd><dt><i>*args</i></dt> |
|
68 <dd> |
|
69 arguments being passed to func |
|
70 </dd> |
|
71 </dl><dl> |
|
72 <dt>Returns:</dt> |
|
73 <dd> |
|
74 the function result |
|
75 </dd> |
|
76 </dl> |
|
77 <div align="right"><a href="#top">Up</a></div> |
|
78 <hr /><hr /> |
|
79 <a NAME="setScriptname" ID="setScriptname"></a> |
|
80 <h2>setScriptname</h2> |
|
81 <b>setScriptname</b>(<i>name</i>) |
|
82 <p> |
|
83 Module function to set the scriptname to be reported back to the IDE. |
|
84 </p><dl> |
|
85 <dt><i>name</i></dt> |
|
86 <dd> |
|
87 absolute pathname of the script (string) |
|
88 </dd> |
|
89 </dl> |
|
90 <div align="right"><a href="#top">Up</a></div> |
|
91 <hr /><hr /> |
|
92 <a NAME="startDebugger" ID="startDebugger"></a> |
|
93 <h2>startDebugger</h2> |
|
94 <b>startDebugger</b>(<i>enableTrace = True, exceptions = True, tracePython = False, redirect = True</i>) |
|
95 <p> |
|
96 Module function used to start the remote debugger. |
|
97 </p><dl> |
|
98 <dt><i>enableTrace=</i></dt> |
|
99 <dd> |
|
100 flag to enable the tracing function (boolean) |
|
101 </dd><dt><i>exceptions=</i></dt> |
|
102 <dd> |
|
103 flag to enable exception reporting of the IDE (boolean) |
|
104 </dd><dt><i>tracePython=</i></dt> |
|
105 <dd> |
|
106 flag to enable tracing into the Python library (boolean) |
|
107 </dd><dt><i>redirect=</i></dt> |
|
108 <dd> |
|
109 flag indicating redirection of stdin, stdout and stderr (boolean) |
|
110 </dd> |
|
111 </dl> |
|
112 <div align="right"><a href="#top">Up</a></div> |
|
113 <hr /> |
|
114 </body></html> |