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