Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 7015
b1a3094b33e1
child 7555
24f1bb4c78a3
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.DebugClients.Python.DebugClientBase</h1> 23 <h1>eric6.DebugClients.Python.DebugClientBase</h1>
24
23 <p> 25 <p>
24 Module implementing a debug client base class. 26 Module implementing a debug client base class.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>DebugClientInstance</td></tr> 31 <tr><td>DebugClientInstance</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#DebugClientBase">DebugClientBase</a></td> 38 <td><a href="#DebugClientBase">DebugClientBase</a></td>
34 <td>Class implementing the client side of the debugger.</td> 39 <td>Class implementing the client side of the debugger.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
45
39 <tr> 46 <tr>
40 <td><a href="#DebugClientClose">DebugClientClose</a></td> 47 <td><a href="#DebugClientClose">DebugClientClose</a></td>
41 <td>Replacement for the standard os.close(fd).</td> 48 <td>Replacement for the standard os.close(fd).</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#DebugClientFork">DebugClientFork</a></td> 51 <td><a href="#DebugClientFork">DebugClientFork</a></td>
44 <td>Replacement for the standard os.fork().</td> 52 <td>Replacement for the standard os.fork().</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#DebugClientInput">DebugClientInput</a></td> 55 <td><a href="#DebugClientInput">DebugClientInput</a></td>
47 <td>Replacement for the standard input builtin.</td> 56 <td>Replacement for the standard input builtin.</td>
48 </tr><tr> 57 </tr>
58 <tr>
49 <td><a href="#DebugClientRawInput">DebugClientRawInput</a></td> 59 <td><a href="#DebugClientRawInput">DebugClientRawInput</a></td>
50 <td>Replacement for the standard raw_input builtin.</td> 60 <td>Replacement for the standard raw_input builtin.</td>
51 </tr><tr> 61 </tr>
62 <tr>
52 <td><a href="#DebugClientSetRecursionLimit">DebugClientSetRecursionLimit</a></td> 63 <td><a href="#DebugClientSetRecursionLimit">DebugClientSetRecursionLimit</a></td>
53 <td>Replacement for the standard sys.setrecursionlimit(limit).</td> 64 <td>Replacement for the standard sys.setrecursionlimit(limit).</td>
54 </tr> 65 </tr>
55 </table> 66 </table>
56 <hr /><hr /> 67 <hr />
68 <hr />
57 <a NAME="DebugClientBase" ID="DebugClientBase"></a> 69 <a NAME="DebugClientBase" ID="DebugClientBase"></a>
58 <h2>DebugClientBase</h2> 70 <h2>DebugClientBase</h2>
71
59 <p> 72 <p>
60 Class implementing the client side of the debugger. 73 Class implementing the client side of the debugger.
61 </p><p> 74 </p>
75 <p>
62 It provides access to the Python interpeter from a debugger running in 76 It provides access to the Python interpeter from a debugger running in
63 another process. 77 another process.
64 </p><p> 78 </p>
79 <p>
65 The protocol between the debugger and the client is based on JSONRPC 2.0 80 The protocol between the debugger and the client is based on JSONRPC 2.0
66 PDUs. Each one is sent on a single line, i.e. commands or responses are 81 PDUs. Each one is sent on a single line, i.e. commands or responses are
67 separated by a linefeed character. 82 separated by a linefeed character.
68 </p><p> 83 </p>
84 <p>
69 If the debugger closes the session there is no response from the client. 85 If the debugger closes the session there is no response from the client.
70 The client may close the session at any time as a result of the script 86 The client may close the session at any time as a result of the script
71 being debugged closing or crashing. 87 being debugged closing or crashing.
72 </p><p> 88 </p>
89 <p>
73 <b>Note</b>: This class is meant to be subclassed by individual 90 <b>Note</b>: This class is meant to be subclassed by individual
74 DebugClient classes. Do not instantiate it directly. 91 DebugClient classes. Do not instantiate it directly.
75 </p> 92 </p>
76 <h3>Derived from</h3> 93 <h3>Derived from</h3>
77 object 94 object
78 <h3>Class Attributes</h3> 95 <h3>Class Attributes</h3>
96
79 <table> 97 <table>
80 <tr><td>Indicators</td></tr><tr><td>arrayTypes</td></tr><tr><td>clientCapabilities</td></tr> 98 <tr><td>Indicators</td></tr><tr><td>arrayTypes</td></tr><tr><td>clientCapabilities</td></tr>
81 </table> 99 </table>
82 <h3>Class Methods</h3> 100 <h3>Class Methods</h3>
101
83 <table> 102 <table>
84 <tr><td>None</td></tr> 103 <tr><td>None</td></tr>
85 </table> 104 </table>
86 <h3>Methods</h3> 105 <h3>Methods</h3>
106
87 <table> 107 <table>
108
88 <tr> 109 <tr>
89 <td><a href="#DebugClientBase.__init__">DebugClientBase</a></td> 110 <td><a href="#DebugClientBase.__init__">DebugClientBase</a></td>
90 <td>Constructor</td> 111 <td>Constructor</td>
91 </tr><tr> 112 </tr>
113 <tr>
92 <td><a href="#DebugClientBase.__assembleTestCasesList">__assembleTestCasesList</a></td> 114 <td><a href="#DebugClientBase.__assembleTestCasesList">__assembleTestCasesList</a></td>
93 <td>Private method to assemble a list of test cases included in a test suite.</td> 115 <td>Private method to assemble a list of test cases included in a test suite.</td>
94 </tr><tr> 116 </tr>
117 <tr>
95 <td><a href="#DebugClientBase.__clientCapabilities">__clientCapabilities</a></td> 118 <td><a href="#DebugClientBase.__clientCapabilities">__clientCapabilities</a></td>
96 <td>Private method to determine the clients capabilities.</td> 119 <td>Private method to determine the clients capabilities.</td>
97 </tr><tr> 120 </tr>
121 <tr>
98 <td><a href="#DebugClientBase.__compileFileSource">__compileFileSource</a></td> 122 <td><a href="#DebugClientBase.__compileFileSource">__compileFileSource</a></td>
99 <td>Private method to compile source code read from a file.</td> 123 <td>Private method to compile source code read from a file.</td>
100 </tr><tr> 124 </tr>
125 <tr>
101 <td><a href="#DebugClientBase.__completionList">__completionList</a></td> 126 <td><a href="#DebugClientBase.__completionList">__completionList</a></td>
102 <td>Private slot to handle the request for a commandline completion list.</td> 127 <td>Private slot to handle the request for a commandline completion list.</td>
103 </tr><tr> 128 </tr>
129 <tr>
104 <td><a href="#DebugClientBase.__dumpVariable">__dumpVariable</a></td> 130 <td><a href="#DebugClientBase.__dumpVariable">__dumpVariable</a></td>
105 <td>Private method to return the variables of a frame to the debug server.</td> 131 <td>Private method to return the variables of a frame to the debug server.</td>
106 </tr><tr> 132 </tr>
133 <tr>
107 <td><a href="#DebugClientBase.__dumpVariables">__dumpVariables</a></td> 134 <td><a href="#DebugClientBase.__dumpVariables">__dumpVariables</a></td>
108 <td>Private method to return the variables of a frame to the debug server.</td> 135 <td>Private method to return the variables of a frame to the debug server.</td>
109 </tr><tr> 136 </tr>
137 <tr>
110 <td><a href="#DebugClientBase.__extractIndicators">__extractIndicators</a></td> 138 <td><a href="#DebugClientBase.__extractIndicators">__extractIndicators</a></td>
111 <td>Private method to extract the indicator string from a variable text.</td> 139 <td>Private method to extract the indicator string from a variable text.</td>
112 </tr><tr> 140 </tr>
141 <tr>
113 <td><a href="#DebugClientBase.__formatQtVariable">__formatQtVariable</a></td> 142 <td><a href="#DebugClientBase.__formatQtVariable">__formatQtVariable</a></td>
114 <td>Private method to produce a formatted output of a simple Qt4/Qt5 type.</td> 143 <td>Private method to produce a formatted output of a simple Qt4/Qt5 type.</td>
115 </tr><tr> 144 </tr>
145 <tr>
116 <td><a href="#DebugClientBase.__formatVariablesList">__formatVariablesList</a></td> 146 <td><a href="#DebugClientBase.__formatVariablesList">__formatVariablesList</a></td>
117 <td>Private method to produce a formated variables list.</td> 147 <td>Private method to produce a formated variables list.</td>
118 </tr><tr> 148 </tr>
149 <tr>
119 <td><a href="#DebugClientBase.__generateFilterObjects">__generateFilterObjects</a></td> 150 <td><a href="#DebugClientBase.__generateFilterObjects">__generateFilterObjects</a></td>
120 <td>Private slot to convert a filter string to a list of filter objects.</td> 151 <td>Private slot to convert a filter string to a list of filter objects.</td>
121 </tr><tr> 152 </tr>
153 <tr>
122 <td><a href="#DebugClientBase.__getCompletionList">__getCompletionList</a></td> 154 <td><a href="#DebugClientBase.__getCompletionList">__getCompletionList</a></td>
123 <td>Private method to create a completions list.</td> 155 <td>Private method to create a completions list.</td>
124 </tr><tr> 156 </tr>
157 <tr>
125 <td><a href="#DebugClientBase.__getSysPath">__getSysPath</a></td> 158 <td><a href="#DebugClientBase.__getSysPath">__getSysPath</a></td>
126 <td>Private slot to calculate a path list including the PYTHONPATH environment variable.</td> 159 <td>Private slot to calculate a path list including the PYTHONPATH environment variable.</td>
127 </tr><tr> 160 </tr>
161 <tr>
128 <td><a href="#DebugClientBase.__interact">__interact</a></td> 162 <td><a href="#DebugClientBase.__interact">__interact</a></td>
129 <td>Private method to interact with the debugger.</td> 163 <td>Private method to interact with the debugger.</td>
130 </tr><tr> 164 </tr>
165 <tr>
131 <td><a href="#DebugClientBase.__interceptSignals">__interceptSignals</a></td> 166 <td><a href="#DebugClientBase.__interceptSignals">__interceptSignals</a></td>
132 <td>Private method to intercept common signals.</td> 167 <td>Private method to intercept common signals.</td>
133 </tr><tr> 168 </tr>
169 <tr>
134 <td><a href="#DebugClientBase.__resolveHost">__resolveHost</a></td> 170 <td><a href="#DebugClientBase.__resolveHost">__resolveHost</a></td>
135 <td>Private method to resolve a hostname to an IP address.</td> 171 <td>Private method to resolve a hostname to an IP address.</td>
136 </tr><tr> 172 </tr>
173 <tr>
137 <td><a href="#DebugClientBase.__setCoding">__setCoding</a></td> 174 <td><a href="#DebugClientBase.__setCoding">__setCoding</a></td>
138 <td>Private method to set the coding used by a python file.</td> 175 <td>Private method to set the coding used by a python file.</td>
139 </tr><tr> 176 </tr>
177 <tr>
140 <td><a href="#DebugClientBase.__signalHandler">__signalHandler</a></td> 178 <td><a href="#DebugClientBase.__signalHandler">__signalHandler</a></td>
141 <td>Private method to handle signals.</td> 179 <td>Private method to handle signals.</td>
142 </tr><tr> 180 </tr>
181 <tr>
143 <td><a href="#DebugClientBase.__unhandled_exception">__unhandled_exception</a></td> 182 <td><a href="#DebugClientBase.__unhandled_exception">__unhandled_exception</a></td>
144 <td>Private method called to report an uncaught exception.</td> 183 <td>Private method called to report an uncaught exception.</td>
145 </tr><tr> 184 </tr>
185 <tr>
146 <td><a href="#DebugClientBase.absPath">absPath</a></td> 186 <td><a href="#DebugClientBase.absPath">absPath</a></td>
147 <td>Public method to convert a filename to an absolute name.</td> 187 <td>Public method to convert a filename to an absolute name.</td>
148 </tr><tr> 188 </tr>
189 <tr>
149 <td><a href="#DebugClientBase.close">close</a></td> 190 <td><a href="#DebugClientBase.close">close</a></td>
150 <td>Public method implementing a close method as a replacement for os.close().</td> 191 <td>Public method implementing a close method as a replacement for os.close().</td>
151 </tr><tr> 192 </tr>
193 <tr>
152 <td><a href="#DebugClientBase.connectDebugger">connectDebugger</a></td> 194 <td><a href="#DebugClientBase.connectDebugger">connectDebugger</a></td>
153 <td>Public method to establish a session with the debugger.</td> 195 <td>Public method to establish a session with the debugger.</td>
154 </tr><tr> 196 </tr>
197 <tr>
155 <td><a href="#DebugClientBase.eventLoop">eventLoop</a></td> 198 <td><a href="#DebugClientBase.eventLoop">eventLoop</a></td>
156 <td>Public method implementing our event loop.</td> 199 <td>Public method implementing our event loop.</td>
157 </tr><tr> 200 </tr>
201 <tr>
158 <td><a href="#DebugClientBase.eventPoll">eventPoll</a></td> 202 <td><a href="#DebugClientBase.eventPoll">eventPoll</a></td>
159 <td>Public method to poll for events like 'set break point'.</td> 203 <td>Public method to poll for events like 'set break point'.</td>
160 </tr><tr> 204 </tr>
205 <tr>
161 <td><a href="#DebugClientBase.fork">fork</a></td> 206 <td><a href="#DebugClientBase.fork">fork</a></td>
162 <td>Public method implementing a fork routine deciding which branch to follow.</td> 207 <td>Public method implementing a fork routine deciding which branch to follow.</td>
163 </tr><tr> 208 </tr>
209 <tr>
164 <td><a href="#DebugClientBase.getCoding">getCoding</a></td> 210 <td><a href="#DebugClientBase.getCoding">getCoding</a></td>
165 <td>Public method to return the current coding.</td> 211 <td>Public method to return the current coding.</td>
166 </tr><tr> 212 </tr>
213 <tr>
167 <td><a href="#DebugClientBase.getRunning">getRunning</a></td> 214 <td><a href="#DebugClientBase.getRunning">getRunning</a></td>
168 <td>Public method to return the main script we are currently running.</td> 215 <td>Public method to return the main script we are currently running.</td>
169 </tr><tr> 216 </tr>
217 <tr>
170 <td><a href="#DebugClientBase.handleJsonCommand">handleJsonCommand</a></td> 218 <td><a href="#DebugClientBase.handleJsonCommand">handleJsonCommand</a></td>
171 <td>Public method to handle a command serialized as a JSON string.</td> 219 <td>Public method to handle a command serialized as a JSON string.</td>
172 </tr><tr> 220 </tr>
221 <tr>
173 <td><a href="#DebugClientBase.input">input</a></td> 222 <td><a href="#DebugClientBase.input">input</a></td>
174 <td>Public method to implement input() (Python 2) using the event loop.</td> 223 <td>Public method to implement input() (Python 2) using the event loop.</td>
175 </tr><tr> 224 </tr>
225 <tr>
176 <td><a href="#DebugClientBase.main">main</a></td> 226 <td><a href="#DebugClientBase.main">main</a></td>
177 <td>Public method implementing the main method.</td> 227 <td>Public method implementing the main method.</td>
178 </tr><tr> 228 </tr>
229 <tr>
179 <td><a href="#DebugClientBase.progTerminated">progTerminated</a></td> 230 <td><a href="#DebugClientBase.progTerminated">progTerminated</a></td>
180 <td>Public method to tell the debugger that the program has terminated.</td> 231 <td>Public method to tell the debugger that the program has terminated.</td>
181 </tr><tr> 232 </tr>
233 <tr>
182 <td><a href="#DebugClientBase.raw_input">raw_input</a></td> 234 <td><a href="#DebugClientBase.raw_input">raw_input</a></td>
183 <td>Public method to implement raw_input() / input() using the event loop.</td> 235 <td>Public method to implement raw_input() / input() using the event loop.</td>
184 </tr><tr> 236 </tr>
237 <tr>
185 <td><a href="#DebugClientBase.readReady">readReady</a></td> 238 <td><a href="#DebugClientBase.readReady">readReady</a></td>
186 <td>Public method called when there is data ready to be read.</td> 239 <td>Public method called when there is data ready to be read.</td>
187 </tr><tr> 240 </tr>
241 <tr>
188 <td><a href="#DebugClientBase.run_call">run_call</a></td> 242 <td><a href="#DebugClientBase.run_call">run_call</a></td>
189 <td>Public method used to start the remote debugger and call a function.</td> 243 <td>Public method used to start the remote debugger and call a function.</td>
190 </tr><tr> 244 </tr>
245 <tr>
191 <td><a href="#DebugClientBase.sendCallTrace">sendCallTrace</a></td> 246 <td><a href="#DebugClientBase.sendCallTrace">sendCallTrace</a></td>
192 <td>Public method to send a call trace entry.</td> 247 <td>Public method to send a call trace entry.</td>
193 </tr><tr> 248 </tr>
249 <tr>
194 <td><a href="#DebugClientBase.sendClearTemporaryBreakpoint">sendClearTemporaryBreakpoint</a></td> 250 <td><a href="#DebugClientBase.sendClearTemporaryBreakpoint">sendClearTemporaryBreakpoint</a></td>
195 <td>Public method to signal the deletion of a temporary breakpoint.</td> 251 <td>Public method to signal the deletion of a temporary breakpoint.</td>
196 </tr><tr> 252 </tr>
253 <tr>
197 <td><a href="#DebugClientBase.sendClearTemporaryWatch">sendClearTemporaryWatch</a></td> 254 <td><a href="#DebugClientBase.sendClearTemporaryWatch">sendClearTemporaryWatch</a></td>
198 <td>Public method to signal the deletion of a temporary watch expression.</td> 255 <td>Public method to signal the deletion of a temporary watch expression.</td>
199 </tr><tr> 256 </tr>
257 <tr>
200 <td><a href="#DebugClientBase.sendException">sendException</a></td> 258 <td><a href="#DebugClientBase.sendException">sendException</a></td>
201 <td>Public method to send information for an exception.</td> 259 <td>Public method to send information for an exception.</td>
202 </tr><tr> 260 </tr>
261 <tr>
203 <td><a href="#DebugClientBase.sendJsonCommand">sendJsonCommand</a></td> 262 <td><a href="#DebugClientBase.sendJsonCommand">sendJsonCommand</a></td>
204 <td>Public method to send a single command or response to the IDE.</td> 263 <td>Public method to send a single command or response to the IDE.</td>
205 </tr><tr> 264 </tr>
265 <tr>
206 <td><a href="#DebugClientBase.sendPassiveStartup">sendPassiveStartup</a></td> 266 <td><a href="#DebugClientBase.sendPassiveStartup">sendPassiveStartup</a></td>
207 <td>Public method to send the passive start information.</td> 267 <td>Public method to send the passive start information.</td>
208 </tr><tr> 268 </tr>
269 <tr>
209 <td><a href="#DebugClientBase.sendResponseLine">sendResponseLine</a></td> 270 <td><a href="#DebugClientBase.sendResponseLine">sendResponseLine</a></td>
210 <td>Public method to send the current call stack.</td> 271 <td>Public method to send the current call stack.</td>
211 </tr><tr> 272 </tr>
273 <tr>
212 <td><a href="#DebugClientBase.sendSyntaxError">sendSyntaxError</a></td> 274 <td><a href="#DebugClientBase.sendSyntaxError">sendSyntaxError</a></td>
213 <td>Public method to send information for a syntax error.</td> 275 <td>Public method to send information for a syntax error.</td>
214 </tr><tr> 276 </tr>
277 <tr>
215 <td><a href="#DebugClientBase.sessionClose">sessionClose</a></td> 278 <td><a href="#DebugClientBase.sessionClose">sessionClose</a></td>
216 <td>Public method to close the session with the debugger and optionally terminate.</td> 279 <td>Public method to close the session with the debugger and optionally terminate.</td>
217 </tr><tr> 280 </tr>
281 <tr>
218 <td><a href="#DebugClientBase.startDebugger">startDebugger</a></td> 282 <td><a href="#DebugClientBase.startDebugger">startDebugger</a></td>
219 <td>Public method used to start the remote debugger.</td> 283 <td>Public method used to start the remote debugger.</td>
220 </tr><tr> 284 </tr>
285 <tr>
221 <td><a href="#DebugClientBase.startProgInDebugger">startProgInDebugger</a></td> 286 <td><a href="#DebugClientBase.startProgInDebugger">startProgInDebugger</a></td>
222 <td>Public method used to start the remote debugger.</td> 287 <td>Public method used to start the remote debugger.</td>
223 </tr><tr> 288 </tr>
289 <tr>
224 <td><a href="#DebugClientBase.writeReady">writeReady</a></td> 290 <td><a href="#DebugClientBase.writeReady">writeReady</a></td>
225 <td>Public method called when we are ready to write data.</td> 291 <td>Public method called when we are ready to write data.</td>
226 </tr> 292 </tr>
227 </table> 293 </table>
228 <h3>Static Methods</h3> 294 <h3>Static Methods</h3>
295
229 <table> 296 <table>
230 <tr><td>None</td></tr> 297 <tr><td>None</td></tr>
231 </table> 298 </table>
299
232 <a NAME="DebugClientBase.__init__" ID="DebugClientBase.__init__"></a> 300 <a NAME="DebugClientBase.__init__" ID="DebugClientBase.__init__"></a>
233 <h4>DebugClientBase (Constructor)</h4> 301 <h4>DebugClientBase (Constructor)</h4>
234 <b>DebugClientBase</b>(<i></i>) 302 <b>DebugClientBase</b>(<i></i>)
303
235 <p> 304 <p>
236 Constructor 305 Constructor
237 </p><a NAME="DebugClientBase.__assembleTestCasesList" ID="DebugClientBase.__assembleTestCasesList"></a> 306 </p>
307 <a NAME="DebugClientBase.__assembleTestCasesList" ID="DebugClientBase.__assembleTestCasesList"></a>
238 <h4>DebugClientBase.__assembleTestCasesList</h4> 308 <h4>DebugClientBase.__assembleTestCasesList</h4>
239 <b>__assembleTestCasesList</b>(<i>suite, start</i>) 309 <b>__assembleTestCasesList</b>(<i>suite, start</i>)
310
240 <p> 311 <p>
241 Private method to assemble a list of test cases included in a test 312 Private method to assemble a list of test cases included in a test
242 suite. 313 suite.
243 </p><dl> 314 </p>
315 <dl>
316
244 <dt><i>suite</i> (unittest.TestSuite)</dt> 317 <dt><i>suite</i> (unittest.TestSuite)</dt>
245 <dd> 318 <dd>
246 test suite to be inspected 319 test suite to be inspected
247 </dd><dt><i>start</i> (str)</dt> 320 </dd>
321 <dt><i>start</i> (str)</dt>
248 <dd> 322 <dd>
249 name of directory discovery was started at 323 name of directory discovery was started at
250 </dd> 324 </dd>
251 </dl><dl> 325 </dl>
326 <dl>
252 <dt>Returns:</dt> 327 <dt>Returns:</dt>
253 <dd> 328 <dd>
254 list of tuples containing the test case ID, a short description 329 list of tuples containing the test case ID, a short description
255 and the path of the test file name 330 and the path of the test file name
256 </dd> 331 </dd>
257 </dl><dl> 332 </dl>
333 <dl>
258 <dt>Return Type:</dt> 334 <dt>Return Type:</dt>
259 <dd> 335 <dd>
260 list of tuples of (str, str, str) 336 list of tuples of (str, str, str)
261 </dd> 337 </dd>
262 </dl><a NAME="DebugClientBase.__clientCapabilities" ID="DebugClientBase.__clientCapabilities"></a> 338 </dl>
339 <a NAME="DebugClientBase.__clientCapabilities" ID="DebugClientBase.__clientCapabilities"></a>
263 <h4>DebugClientBase.__clientCapabilities</h4> 340 <h4>DebugClientBase.__clientCapabilities</h4>
264 <b>__clientCapabilities</b>(<i></i>) 341 <b>__clientCapabilities</b>(<i></i>)
342
265 <p> 343 <p>
266 Private method to determine the clients capabilities. 344 Private method to determine the clients capabilities.
267 </p><dl> 345 </p>
346 <dl>
268 <dt>Returns:</dt> 347 <dt>Returns:</dt>
269 <dd> 348 <dd>
270 client capabilities (integer) 349 client capabilities (integer)
271 </dd> 350 </dd>
272 </dl><a NAME="DebugClientBase.__compileFileSource" ID="DebugClientBase.__compileFileSource"></a> 351 </dl>
352 <a NAME="DebugClientBase.__compileFileSource" ID="DebugClientBase.__compileFileSource"></a>
273 <h4>DebugClientBase.__compileFileSource</h4> 353 <h4>DebugClientBase.__compileFileSource</h4>
274 <b>__compileFileSource</b>(<i>filename, mode='exec'</i>) 354 <b>__compileFileSource</b>(<i>filename, mode='exec'</i>)
355
275 <p> 356 <p>
276 Private method to compile source code read from a file. 357 Private method to compile source code read from a file.
277 </p><dl> 358 </p>
359 <dl>
360
278 <dt><i>filename</i></dt> 361 <dt><i>filename</i></dt>
279 <dd> 362 <dd>
280 name of the source file (string) 363 name of the source file (string)
281 </dd><dt><i>mode</i></dt> 364 </dd>
365 <dt><i>mode</i></dt>
282 <dd> 366 <dd>
283 kind of code to be generated (string, exec or eval) 367 kind of code to be generated (string, exec or eval)
284 </dd> 368 </dd>
285 </dl><dl> 369 </dl>
370 <dl>
286 <dt>Returns:</dt> 371 <dt>Returns:</dt>
287 <dd> 372 <dd>
288 compiled code object (None in case of errors) 373 compiled code object (None in case of errors)
289 </dd> 374 </dd>
290 </dl><a NAME="DebugClientBase.__completionList" ID="DebugClientBase.__completionList"></a> 375 </dl>
376 <a NAME="DebugClientBase.__completionList" ID="DebugClientBase.__completionList"></a>
291 <h4>DebugClientBase.__completionList</h4> 377 <h4>DebugClientBase.__completionList</h4>
292 <b>__completionList</b>(<i>text</i>) 378 <b>__completionList</b>(<i>text</i>)
379
293 <p> 380 <p>
294 Private slot to handle the request for a commandline completion list. 381 Private slot to handle the request for a commandline completion list.
295 </p><dl> 382 </p>
383 <dl>
384
296 <dt><i>text</i></dt> 385 <dt><i>text</i></dt>
297 <dd> 386 <dd>
298 the text to be completed (string) 387 the text to be completed (string)
299 </dd> 388 </dd>
300 </dl><a NAME="DebugClientBase.__dumpVariable" ID="DebugClientBase.__dumpVariable"></a> 389 </dl>
390 <a NAME="DebugClientBase.__dumpVariable" ID="DebugClientBase.__dumpVariable"></a>
301 <h4>DebugClientBase.__dumpVariable</h4> 391 <h4>DebugClientBase.__dumpVariable</h4>
302 <b>__dumpVariable</b>(<i>var, frmnr, scope, filterList</i>) 392 <b>__dumpVariable</b>(<i>var, frmnr, scope, filterList</i>)
393
303 <p> 394 <p>
304 Private method to return the variables of a frame to the debug server. 395 Private method to return the variables of a frame to the debug server.
305 </p><dl> 396 </p>
397 <dl>
398
306 <dt><i>var</i> (list of strings)</dt> 399 <dt><i>var</i> (list of strings)</dt>
307 <dd> 400 <dd>
308 list encoded name of the requested variable 401 list encoded name of the requested variable
309 </dd><dt><i>frmnr</i> (int)</dt> 402 </dd>
403 <dt><i>frmnr</i> (int)</dt>
310 <dd> 404 <dd>
311 distance of frame reported on. 0 is the current frame 405 distance of frame reported on. 0 is the current frame
312 </dd><dt><i>scope</i> (int)</dt> 406 </dd>
407 <dt><i>scope</i> (int)</dt>
313 <dd> 408 <dd>
314 1 to report global variables, 0 for local variables 409 1 to report global variables, 0 for local variables
315 </dd><dt><i>filterList</i> (list of int)</dt> 410 </dd>
411 <dt><i>filterList</i> (list of int)</dt>
316 <dd> 412 <dd>
317 the indices of variable types to be filtered 413 the indices of variable types to be filtered
318 </dd> 414 </dd>
319 </dl><a NAME="DebugClientBase.__dumpVariables" ID="DebugClientBase.__dumpVariables"></a> 415 </dl>
416 <a NAME="DebugClientBase.__dumpVariables" ID="DebugClientBase.__dumpVariables"></a>
320 <h4>DebugClientBase.__dumpVariables</h4> 417 <h4>DebugClientBase.__dumpVariables</h4>
321 <b>__dumpVariables</b>(<i>frmnr, scope, filterList</i>) 418 <b>__dumpVariables</b>(<i>frmnr, scope, filterList</i>)
419
322 <p> 420 <p>
323 Private method to return the variables of a frame to the debug server. 421 Private method to return the variables of a frame to the debug server.
324 </p><dl> 422 </p>
423 <dl>
424
325 <dt><i>frmnr</i> (int)</dt> 425 <dt><i>frmnr</i> (int)</dt>
326 <dd> 426 <dd>
327 distance of frame reported on. 0 is the current frame 427 distance of frame reported on. 0 is the current frame
328 </dd><dt><i>scope</i> (int)</dt> 428 </dd>
429 <dt><i>scope</i> (int)</dt>
329 <dd> 430 <dd>
330 1 to report global variables, 0 for local variables 431 1 to report global variables, 0 for local variables
331 </dd><dt><i>filterList</i> (list of int)</dt> 432 </dd>
433 <dt><i>filterList</i> (list of int)</dt>
332 <dd> 434 <dd>
333 the indices of variable types to be filtered 435 the indices of variable types to be filtered
334 </dd> 436 </dd>
335 </dl><a NAME="DebugClientBase.__extractIndicators" ID="DebugClientBase.__extractIndicators"></a> 437 </dl>
438 <a NAME="DebugClientBase.__extractIndicators" ID="DebugClientBase.__extractIndicators"></a>
336 <h4>DebugClientBase.__extractIndicators</h4> 439 <h4>DebugClientBase.__extractIndicators</h4>
337 <b>__extractIndicators</b>(<i>var</i>) 440 <b>__extractIndicators</b>(<i>var</i>)
441
338 <p> 442 <p>
339 Private method to extract the indicator string from a variable text. 443 Private method to extract the indicator string from a variable text.
340 </p><dl> 444 </p>
445 <dl>
446
341 <dt><i>var</i> (str)</dt> 447 <dt><i>var</i> (str)</dt>
342 <dd> 448 <dd>
343 variable text 449 variable text
344 </dd> 450 </dd>
345 </dl><dl> 451 </dl>
452 <dl>
346 <dt>Returns:</dt> 453 <dt>Returns:</dt>
347 <dd> 454 <dd>
348 tuple containing the variable text without indicators and the 455 tuple containing the variable text without indicators and the
349 indicator string 456 indicator string
350 </dd> 457 </dd>
351 </dl><dl> 458 </dl>
459 <dl>
352 <dt>Return Type:</dt> 460 <dt>Return Type:</dt>
353 <dd> 461 <dd>
354 tuple of two str 462 tuple of two str
355 </dd> 463 </dd>
356 </dl><a NAME="DebugClientBase.__formatQtVariable" ID="DebugClientBase.__formatQtVariable"></a> 464 </dl>
465 <a NAME="DebugClientBase.__formatQtVariable" ID="DebugClientBase.__formatQtVariable"></a>
357 <h4>DebugClientBase.__formatQtVariable</h4> 466 <h4>DebugClientBase.__formatQtVariable</h4>
358 <b>__formatQtVariable</b>(<i>value, qttype</i>) 467 <b>__formatQtVariable</b>(<i>value, qttype</i>)
468
359 <p> 469 <p>
360 Private method to produce a formatted output of a simple Qt4/Qt5 type. 470 Private method to produce a formatted output of a simple Qt4/Qt5 type.
361 </p><dl> 471 </p>
472 <dl>
473
362 <dt><i>value</i></dt> 474 <dt><i>value</i></dt>
363 <dd> 475 <dd>
364 variable to be formatted 476 variable to be formatted
365 </dd><dt><i>qttype</i></dt> 477 </dd>
478 <dt><i>qttype</i></dt>
366 <dd> 479 <dd>
367 type of the Qt variable to be formatted (string) 480 type of the Qt variable to be formatted (string)
368 </dd> 481 </dd>
369 </dl><dl> 482 </dl>
483 <dl>
370 <dt>Returns:</dt> 484 <dt>Returns:</dt>
371 <dd> 485 <dd>
372 A tuple consisting of a list of formatted variables. Each 486 A tuple consisting of a list of formatted variables. Each
373 variable entry is a tuple of three elements, the variable name, 487 variable entry is a tuple of three elements, the variable name,
374 its type and value. 488 its type and value.
375 </dd> 489 </dd>
376 </dl><a NAME="DebugClientBase.__formatVariablesList" ID="DebugClientBase.__formatVariablesList"></a> 490 </dl>
491 <a NAME="DebugClientBase.__formatVariablesList" ID="DebugClientBase.__formatVariablesList"></a>
377 <h4>DebugClientBase.__formatVariablesList</h4> 492 <h4>DebugClientBase.__formatVariablesList</h4>
378 <b>__formatVariablesList</b>(<i>dict_, scope, filterList=None</i>) 493 <b>__formatVariablesList</b>(<i>dict_, scope, filterList=None</i>)
494
379 <p> 495 <p>
380 Private method to produce a formated variables list. 496 Private method to produce a formated variables list.
381 </p><p> 497 </p>
498 <p>
382 The dictionary passed in to it is scanned. Variables are 499 The dictionary passed in to it is scanned. Variables are
383 only added to the list, if their type is not contained 500 only added to the list, if their type is not contained
384 in the filter list and their name doesn't match any of the filter 501 in the filter list and their name doesn't match any of the filter
385 expressions. The formated variables list (a list of tuples of 3 502 expressions. The formated variables list (a list of tuples of 3
386 values) is returned. 503 values) is returned.
387 </p><dl> 504 </p>
505 <dl>
506
388 <dt><i>dict_</i> (dict)</dt> 507 <dt><i>dict_</i> (dict)</dt>
389 <dd> 508 <dd>
390 the dictionary to be scanned 509 the dictionary to be scanned
391 </dd><dt><i>scope</i> (int)</dt> 510 </dd>
511 <dt><i>scope</i> (int)</dt>
392 <dd> 512 <dd>
393 1 to filter using the globals filter, 0 using the locals 513 1 to filter using the globals filter, 0 using the locals
394 filter. 514 filter.
395 Variables are only added to the list, if their name do not match 515 Variables are only added to the list, if their name do not match
396 any of the filter expressions. 516 any of the filter expressions.
397 </dd><dt><i>filterList</i> (list of int)</dt> 517 </dd>
518 <dt><i>filterList</i> (list of int)</dt>
398 <dd> 519 <dd>
399 the indices of variable types to be filtered. 520 the indices of variable types to be filtered.
400 Variables are only added to the list, if their type is not 521 Variables are only added to the list, if their type is not
401 contained in the filter list. 522 contained in the filter list.
402 </dd> 523 </dd>
403 </dl><dl> 524 </dl>
525 <dl>
404 <dt>Returns:</dt> 526 <dt>Returns:</dt>
405 <dd> 527 <dd>
406 A tuple consisting of a list of formatted variables. Each 528 A tuple consisting of a list of formatted variables. Each
407 variable entry is a tuple of three elements, the variable name, 529 variable entry is a tuple of three elements, the variable name,
408 its type and value. 530 its type and value.
409 </dd> 531 </dd>
410 </dl><dl> 532 </dl>
533 <dl>
411 <dt>Return Type:</dt> 534 <dt>Return Type:</dt>
412 <dd> 535 <dd>
413 list of tuple of (str, str, str) 536 list of tuple of (str, str, str)
414 </dd> 537 </dd>
415 </dl><a NAME="DebugClientBase.__generateFilterObjects" ID="DebugClientBase.__generateFilterObjects"></a> 538 </dl>
539 <a NAME="DebugClientBase.__generateFilterObjects" ID="DebugClientBase.__generateFilterObjects"></a>
416 <h4>DebugClientBase.__generateFilterObjects</h4> 540 <h4>DebugClientBase.__generateFilterObjects</h4>
417 <b>__generateFilterObjects</b>(<i>scope, filterString</i>) 541 <b>__generateFilterObjects</b>(<i>scope, filterString</i>)
542
418 <p> 543 <p>
419 Private slot to convert a filter string to a list of filter objects. 544 Private slot to convert a filter string to a list of filter objects.
420 </p><dl> 545 </p>
546 <dl>
547
421 <dt><i>scope</i></dt> 548 <dt><i>scope</i></dt>
422 <dd> 549 <dd>
423 1 to generate filter for global variables, 0 for local 550 1 to generate filter for global variables, 0 for local
424 variables (int) 551 variables (int)
425 </dd><dt><i>filterString</i></dt> 552 </dd>
553 <dt><i>filterString</i></dt>
426 <dd> 554 <dd>
427 string of filter patterns separated by ';' 555 string of filter patterns separated by ';'
428 </dd> 556 </dd>
429 </dl><a NAME="DebugClientBase.__getCompletionList" ID="DebugClientBase.__getCompletionList"></a> 557 </dl>
558 <a NAME="DebugClientBase.__getCompletionList" ID="DebugClientBase.__getCompletionList"></a>
430 <h4>DebugClientBase.__getCompletionList</h4> 559 <h4>DebugClientBase.__getCompletionList</h4>
431 <b>__getCompletionList</b>(<i>text, completer, completions</i>) 560 <b>__getCompletionList</b>(<i>text, completer, completions</i>)
561
432 <p> 562 <p>
433 Private method to create a completions list. 563 Private method to create a completions list.
434 </p><dl> 564 </p>
565 <dl>
566
435 <dt><i>text</i></dt> 567 <dt><i>text</i></dt>
436 <dd> 568 <dd>
437 text to complete (string) 569 text to complete (string)
438 </dd><dt><i>completer</i></dt> 570 </dd>
571 <dt><i>completer</i></dt>
439 <dd> 572 <dd>
440 completer methode 573 completer methode
441 </dd><dt><i>completions</i></dt> 574 </dd>
575 <dt><i>completions</i></dt>
442 <dd> 576 <dd>
443 set where to add new completions strings (set) 577 set where to add new completions strings (set)
444 </dd> 578 </dd>
445 </dl><a NAME="DebugClientBase.__getSysPath" ID="DebugClientBase.__getSysPath"></a> 579 </dl>
580 <a NAME="DebugClientBase.__getSysPath" ID="DebugClientBase.__getSysPath"></a>
446 <h4>DebugClientBase.__getSysPath</h4> 581 <h4>DebugClientBase.__getSysPath</h4>
447 <b>__getSysPath</b>(<i>firstEntry</i>) 582 <b>__getSysPath</b>(<i>firstEntry</i>)
583
448 <p> 584 <p>
449 Private slot to calculate a path list including the PYTHONPATH 585 Private slot to calculate a path list including the PYTHONPATH
450 environment variable. 586 environment variable.
451 </p><dl> 587 </p>
588 <dl>
589
452 <dt><i>firstEntry</i></dt> 590 <dt><i>firstEntry</i></dt>
453 <dd> 591 <dd>
454 entry to be put first in sys.path (string) 592 entry to be put first in sys.path (string)
455 </dd> 593 </dd>
456 </dl><dl> 594 </dl>
595 <dl>
457 <dt>Returns:</dt> 596 <dt>Returns:</dt>
458 <dd> 597 <dd>
459 path list for use as sys.path (list of strings) 598 path list for use as sys.path (list of strings)
460 </dd> 599 </dd>
461 </dl><a NAME="DebugClientBase.__interact" ID="DebugClientBase.__interact"></a> 600 </dl>
601 <a NAME="DebugClientBase.__interact" ID="DebugClientBase.__interact"></a>
462 <h4>DebugClientBase.__interact</h4> 602 <h4>DebugClientBase.__interact</h4>
463 <b>__interact</b>(<i></i>) 603 <b>__interact</b>(<i></i>)
604
464 <p> 605 <p>
465 Private method to interact with the debugger. 606 Private method to interact with the debugger.
466 </p><a NAME="DebugClientBase.__interceptSignals" ID="DebugClientBase.__interceptSignals"></a> 607 </p>
608 <a NAME="DebugClientBase.__interceptSignals" ID="DebugClientBase.__interceptSignals"></a>
467 <h4>DebugClientBase.__interceptSignals</h4> 609 <h4>DebugClientBase.__interceptSignals</h4>
468 <b>__interceptSignals</b>(<i></i>) 610 <b>__interceptSignals</b>(<i></i>)
611
469 <p> 612 <p>
470 Private method to intercept common signals. 613 Private method to intercept common signals.
471 </p><a NAME="DebugClientBase.__resolveHost" ID="DebugClientBase.__resolveHost"></a> 614 </p>
615 <a NAME="DebugClientBase.__resolveHost" ID="DebugClientBase.__resolveHost"></a>
472 <h4>DebugClientBase.__resolveHost</h4> 616 <h4>DebugClientBase.__resolveHost</h4>
473 <b>__resolveHost</b>(<i>host</i>) 617 <b>__resolveHost</b>(<i>host</i>)
618
474 <p> 619 <p>
475 Private method to resolve a hostname to an IP address. 620 Private method to resolve a hostname to an IP address.
476 </p><dl> 621 </p>
622 <dl>
623
477 <dt><i>host</i></dt> 624 <dt><i>host</i></dt>
478 <dd> 625 <dd>
479 hostname of the debug server (string) 626 hostname of the debug server (string)
480 </dd> 627 </dd>
481 </dl><dl> 628 </dl>
629 <dl>
482 <dt>Returns:</dt> 630 <dt>Returns:</dt>
483 <dd> 631 <dd>
484 IP address (string) 632 IP address (string)
485 </dd> 633 </dd>
486 </dl><a NAME="DebugClientBase.__setCoding" ID="DebugClientBase.__setCoding"></a> 634 </dl>
635 <a NAME="DebugClientBase.__setCoding" ID="DebugClientBase.__setCoding"></a>
487 <h4>DebugClientBase.__setCoding</h4> 636 <h4>DebugClientBase.__setCoding</h4>
488 <b>__setCoding</b>(<i>filename</i>) 637 <b>__setCoding</b>(<i>filename</i>)
638
489 <p> 639 <p>
490 Private method to set the coding used by a python file. 640 Private method to set the coding used by a python file.
491 </p><dl> 641 </p>
642 <dl>
643
492 <dt><i>filename</i></dt> 644 <dt><i>filename</i></dt>
493 <dd> 645 <dd>
494 name of the file to inspect (string) 646 name of the file to inspect (string)
495 </dd> 647 </dd>
496 </dl><a NAME="DebugClientBase.__signalHandler" ID="DebugClientBase.__signalHandler"></a> 648 </dl>
649 <a NAME="DebugClientBase.__signalHandler" ID="DebugClientBase.__signalHandler"></a>
497 <h4>DebugClientBase.__signalHandler</h4> 650 <h4>DebugClientBase.__signalHandler</h4>
498 <b>__signalHandler</b>(<i>signalNumber, stackFrame</i>) 651 <b>__signalHandler</b>(<i>signalNumber, stackFrame</i>)
652
499 <p> 653 <p>
500 Private method to handle signals. 654 Private method to handle signals.
501 </p><dl> 655 </p>
656 <dl>
657
502 <dt><i>signalNumber</i> (int)</dt> 658 <dt><i>signalNumber</i> (int)</dt>
503 <dd> 659 <dd>
504 number of the signal to be handled 660 number of the signal to be handled
505 </dd><dt><i>stackFrame</i> (frame object)</dt> 661 </dd>
662 <dt><i>stackFrame</i> (frame object)</dt>
506 <dd> 663 <dd>
507 current stack frame 664 current stack frame
508 </dd> 665 </dd>
509 </dl><a NAME="DebugClientBase.__unhandled_exception" ID="DebugClientBase.__unhandled_exception"></a> 666 </dl>
667 <a NAME="DebugClientBase.__unhandled_exception" ID="DebugClientBase.__unhandled_exception"></a>
510 <h4>DebugClientBase.__unhandled_exception</h4> 668 <h4>DebugClientBase.__unhandled_exception</h4>
511 <b>__unhandled_exception</b>(<i>exctype, excval, exctb</i>) 669 <b>__unhandled_exception</b>(<i>exctype, excval, exctb</i>)
670
512 <p> 671 <p>
513 Private method called to report an uncaught exception. 672 Private method called to report an uncaught exception.
514 </p><dl> 673 </p>
674 <dl>
675
515 <dt><i>exctype</i></dt> 676 <dt><i>exctype</i></dt>
516 <dd> 677 <dd>
517 the type of the exception 678 the type of the exception
518 </dd><dt><i>excval</i></dt> 679 </dd>
680 <dt><i>excval</i></dt>
519 <dd> 681 <dd>
520 data about the exception 682 data about the exception
521 </dd><dt><i>exctb</i></dt> 683 </dd>
684 <dt><i>exctb</i></dt>
522 <dd> 685 <dd>
523 traceback for the exception 686 traceback for the exception
524 </dd> 687 </dd>
525 </dl><a NAME="DebugClientBase.absPath" ID="DebugClientBase.absPath"></a> 688 </dl>
689 <a NAME="DebugClientBase.absPath" ID="DebugClientBase.absPath"></a>
526 <h4>DebugClientBase.absPath</h4> 690 <h4>DebugClientBase.absPath</h4>
527 <b>absPath</b>(<i>fn</i>) 691 <b>absPath</b>(<i>fn</i>)
692
528 <p> 693 <p>
529 Public method to convert a filename to an absolute name. 694 Public method to convert a filename to an absolute name.
530 </p><p> 695 </p>
696 <p>
531 sys.path is used as a set of possible prefixes. The name stays 697 sys.path is used as a set of possible prefixes. The name stays
532 relative if a file could not be found. 698 relative if a file could not be found.
533 </p><dl> 699 </p>
700 <dl>
701
534 <dt><i>fn</i></dt> 702 <dt><i>fn</i></dt>
535 <dd> 703 <dd>
536 filename (string) 704 filename (string)
537 </dd> 705 </dd>
538 </dl><dl> 706 </dl>
707 <dl>
539 <dt>Returns:</dt> 708 <dt>Returns:</dt>
540 <dd> 709 <dd>
541 the converted filename (string) 710 the converted filename (string)
542 </dd> 711 </dd>
543 </dl><a NAME="DebugClientBase.close" ID="DebugClientBase.close"></a> 712 </dl>
713 <a NAME="DebugClientBase.close" ID="DebugClientBase.close"></a>
544 <h4>DebugClientBase.close</h4> 714 <h4>DebugClientBase.close</h4>
545 <b>close</b>(<i>fd</i>) 715 <b>close</b>(<i>fd</i>)
716
546 <p> 717 <p>
547 Public method implementing a close method as a replacement for 718 Public method implementing a close method as a replacement for
548 os.close(). 719 os.close().
549 </p><p> 720 </p>
721 <p>
550 It prevents the debugger connections from being closed. 722 It prevents the debugger connections from being closed.
551 </p><dl> 723 </p>
724 <dl>
725
552 <dt><i>fd</i></dt> 726 <dt><i>fd</i></dt>
553 <dd> 727 <dd>
554 file descriptor to be closed (integer) 728 file descriptor to be closed (integer)
555 </dd> 729 </dd>
556 </dl><a NAME="DebugClientBase.connectDebugger" ID="DebugClientBase.connectDebugger"></a> 730 </dl>
731 <a NAME="DebugClientBase.connectDebugger" ID="DebugClientBase.connectDebugger"></a>
557 <h4>DebugClientBase.connectDebugger</h4> 732 <h4>DebugClientBase.connectDebugger</h4>
558 <b>connectDebugger</b>(<i>port, remoteAddress=None, redirect=True</i>) 733 <b>connectDebugger</b>(<i>port, remoteAddress=None, redirect=True</i>)
734
559 <p> 735 <p>
560 Public method to establish a session with the debugger. 736 Public method to establish a session with the debugger.
561 </p><p> 737 </p>
738 <p>
562 It opens a network connection to the debugger, connects it to stdin, 739 It opens a network connection to the debugger, connects it to stdin,
563 stdout and stderr and saves these file objects in case the application 740 stdout and stderr and saves these file objects in case the application
564 being debugged redirects them itself. 741 being debugged redirects them itself.
565 </p><dl> 742 </p>
743 <dl>
744
566 <dt><i>port</i></dt> 745 <dt><i>port</i></dt>
567 <dd> 746 <dd>
568 the port number to connect to (int) 747 the port number to connect to (int)
569 </dd><dt><i>remoteAddress</i></dt> 748 </dd>
749 <dt><i>remoteAddress</i></dt>
570 <dd> 750 <dd>
571 the network address of the debug server host 751 the network address of the debug server host
572 (string) 752 (string)
573 </dd><dt><i>redirect</i></dt> 753 </dd>
754 <dt><i>redirect</i></dt>
574 <dd> 755 <dd>
575 flag indicating redirection of stdin, stdout and 756 flag indicating redirection of stdin, stdout and
576 stderr (boolean) 757 stderr (boolean)
577 </dd> 758 </dd>
578 </dl><a NAME="DebugClientBase.eventLoop" ID="DebugClientBase.eventLoop"></a> 759 </dl>
760 <a NAME="DebugClientBase.eventLoop" ID="DebugClientBase.eventLoop"></a>
579 <h4>DebugClientBase.eventLoop</h4> 761 <h4>DebugClientBase.eventLoop</h4>
580 <b>eventLoop</b>(<i>disablePolling=False</i>) 762 <b>eventLoop</b>(<i>disablePolling=False</i>)
763
581 <p> 764 <p>
582 Public method implementing our event loop. 765 Public method implementing our event loop.
583 </p><dl> 766 </p>
767 <dl>
768
584 <dt><i>disablePolling</i></dt> 769 <dt><i>disablePolling</i></dt>
585 <dd> 770 <dd>
586 flag indicating to enter an event loop with 771 flag indicating to enter an event loop with
587 polling disabled (boolean) 772 polling disabled (boolean)
588 </dd> 773 </dd>
589 </dl><a NAME="DebugClientBase.eventPoll" ID="DebugClientBase.eventPoll"></a> 774 </dl>
775 <a NAME="DebugClientBase.eventPoll" ID="DebugClientBase.eventPoll"></a>
590 <h4>DebugClientBase.eventPoll</h4> 776 <h4>DebugClientBase.eventPoll</h4>
591 <b>eventPoll</b>(<i></i>) 777 <b>eventPoll</b>(<i></i>)
778
592 <p> 779 <p>
593 Public method to poll for events like 'set break point'. 780 Public method to poll for events like 'set break point'.
594 </p><a NAME="DebugClientBase.fork" ID="DebugClientBase.fork"></a> 781 </p>
782 <a NAME="DebugClientBase.fork" ID="DebugClientBase.fork"></a>
595 <h4>DebugClientBase.fork</h4> 783 <h4>DebugClientBase.fork</h4>
596 <b>fork</b>(<i></i>) 784 <b>fork</b>(<i></i>)
785
597 <p> 786 <p>
598 Public method implementing a fork routine deciding which branch 787 Public method implementing a fork routine deciding which branch
599 to follow. 788 to follow.
600 </p><dl> 789 </p>
790 <dl>
601 <dt>Returns:</dt> 791 <dt>Returns:</dt>
602 <dd> 792 <dd>
603 process ID (integer) 793 process ID (integer)
604 </dd> 794 </dd>
605 </dl><a NAME="DebugClientBase.getCoding" ID="DebugClientBase.getCoding"></a> 795 </dl>
796 <a NAME="DebugClientBase.getCoding" ID="DebugClientBase.getCoding"></a>
606 <h4>DebugClientBase.getCoding</h4> 797 <h4>DebugClientBase.getCoding</h4>
607 <b>getCoding</b>(<i></i>) 798 <b>getCoding</b>(<i></i>)
799
608 <p> 800 <p>
609 Public method to return the current coding. 801 Public method to return the current coding.
610 </p><dl> 802 </p>
803 <dl>
611 <dt>Returns:</dt> 804 <dt>Returns:</dt>
612 <dd> 805 <dd>
613 codec name (string) 806 codec name (string)
614 </dd> 807 </dd>
615 </dl><a NAME="DebugClientBase.getRunning" ID="DebugClientBase.getRunning"></a> 808 </dl>
809 <a NAME="DebugClientBase.getRunning" ID="DebugClientBase.getRunning"></a>
616 <h4>DebugClientBase.getRunning</h4> 810 <h4>DebugClientBase.getRunning</h4>
617 <b>getRunning</b>(<i></i>) 811 <b>getRunning</b>(<i></i>)
812
618 <p> 813 <p>
619 Public method to return the main script we are currently running. 814 Public method to return the main script we are currently running.
620 </p><dl> 815 </p>
816 <dl>
621 <dt>Returns:</dt> 817 <dt>Returns:</dt>
622 <dd> 818 <dd>
623 flag indicating a running debug session (boolean) 819 flag indicating a running debug session (boolean)
624 </dd> 820 </dd>
625 </dl><a NAME="DebugClientBase.handleJsonCommand" ID="DebugClientBase.handleJsonCommand"></a> 821 </dl>
822 <a NAME="DebugClientBase.handleJsonCommand" ID="DebugClientBase.handleJsonCommand"></a>
626 <h4>DebugClientBase.handleJsonCommand</h4> 823 <h4>DebugClientBase.handleJsonCommand</h4>
627 <b>handleJsonCommand</b>(<i>jsonStr</i>) 824 <b>handleJsonCommand</b>(<i>jsonStr</i>)
825
628 <p> 826 <p>
629 Public method to handle a command serialized as a JSON string. 827 Public method to handle a command serialized as a JSON string.
630 </p><dl> 828 </p>
829 <dl>
830
631 <dt><i>jsonStr</i> (str)</dt> 831 <dt><i>jsonStr</i> (str)</dt>
632 <dd> 832 <dd>
633 string containing the command received from the IDE 833 string containing the command received from the IDE
634 </dd> 834 </dd>
635 </dl><a NAME="DebugClientBase.input" ID="DebugClientBase.input"></a> 835 </dl>
836 <a NAME="DebugClientBase.input" ID="DebugClientBase.input"></a>
636 <h4>DebugClientBase.input</h4> 837 <h4>DebugClientBase.input</h4>
637 <b>input</b>(<i>prompt</i>) 838 <b>input</b>(<i>prompt</i>)
839
638 <p> 840 <p>
639 Public method to implement input() (Python 2) using the event loop. 841 Public method to implement input() (Python 2) using the event loop.
640 </p><dl> 842 </p>
843 <dl>
844
641 <dt><i>prompt</i></dt> 845 <dt><i>prompt</i></dt>
642 <dd> 846 <dd>
643 the prompt to be shown (string) 847 the prompt to be shown (string)
644 </dd> 848 </dd>
645 </dl><dl> 849 </dl>
850 <dl>
646 <dt>Returns:</dt> 851 <dt>Returns:</dt>
647 <dd> 852 <dd>
648 the entered string evaluated as a Python expresion 853 the entered string evaluated as a Python expresion
649 </dd> 854 </dd>
650 </dl><a NAME="DebugClientBase.main" ID="DebugClientBase.main"></a> 855 </dl>
856 <a NAME="DebugClientBase.main" ID="DebugClientBase.main"></a>
651 <h4>DebugClientBase.main</h4> 857 <h4>DebugClientBase.main</h4>
652 <b>main</b>(<i></i>) 858 <b>main</b>(<i></i>)
859
653 <p> 860 <p>
654 Public method implementing the main method. 861 Public method implementing the main method.
655 </p><a NAME="DebugClientBase.progTerminated" ID="DebugClientBase.progTerminated"></a> 862 </p>
863 <a NAME="DebugClientBase.progTerminated" ID="DebugClientBase.progTerminated"></a>
656 <h4>DebugClientBase.progTerminated</h4> 864 <h4>DebugClientBase.progTerminated</h4>
657 <b>progTerminated</b>(<i>status, message=""</i>) 865 <b>progTerminated</b>(<i>status, message=""</i>)
866
658 <p> 867 <p>
659 Public method to tell the debugger that the program has terminated. 868 Public method to tell the debugger that the program has terminated.
660 </p><dl> 869 </p>
870 <dl>
871
661 <dt><i>status</i> (int)</dt> 872 <dt><i>status</i> (int)</dt>
662 <dd> 873 <dd>
663 return status 874 return status
664 </dd><dt><i>message</i> (str)</dt> 875 </dd>
876 <dt><i>message</i> (str)</dt>
665 <dd> 877 <dd>
666 status message 878 status message
667 </dd> 879 </dd>
668 </dl><a NAME="DebugClientBase.raw_input" ID="DebugClientBase.raw_input"></a> 880 </dl>
881 <a NAME="DebugClientBase.raw_input" ID="DebugClientBase.raw_input"></a>
669 <h4>DebugClientBase.raw_input</h4> 882 <h4>DebugClientBase.raw_input</h4>
670 <b>raw_input</b>(<i>prompt, echo</i>) 883 <b>raw_input</b>(<i>prompt, echo</i>)
884
671 <p> 885 <p>
672 Public method to implement raw_input() / input() using the event loop. 886 Public method to implement raw_input() / input() using the event loop.
673 </p><dl> 887 </p>
888 <dl>
889
674 <dt><i>prompt</i></dt> 890 <dt><i>prompt</i></dt>
675 <dd> 891 <dd>
676 the prompt to be shown (string) 892 the prompt to be shown (string)
677 </dd><dt><i>echo</i></dt> 893 </dd>
894 <dt><i>echo</i></dt>
678 <dd> 895 <dd>
679 Flag indicating echoing of the input (boolean) 896 Flag indicating echoing of the input (boolean)
680 </dd> 897 </dd>
681 </dl><dl> 898 </dl>
899 <dl>
682 <dt>Returns:</dt> 900 <dt>Returns:</dt>
683 <dd> 901 <dd>
684 the entered string 902 the entered string
685 </dd> 903 </dd>
686 </dl><a NAME="DebugClientBase.readReady" ID="DebugClientBase.readReady"></a> 904 </dl>
905 <a NAME="DebugClientBase.readReady" ID="DebugClientBase.readReady"></a>
687 <h4>DebugClientBase.readReady</h4> 906 <h4>DebugClientBase.readReady</h4>
688 <b>readReady</b>(<i>stream</i>) 907 <b>readReady</b>(<i>stream</i>)
908
689 <p> 909 <p>
690 Public method called when there is data ready to be read. 910 Public method called when there is data ready to be read.
691 </p><dl> 911 </p>
912 <dl>
913
692 <dt><i>stream</i></dt> 914 <dt><i>stream</i></dt>
693 <dd> 915 <dd>
694 file like object that has data to be written 916 file like object that has data to be written
695 </dd> 917 </dd>
696 </dl><dl> 918 </dl>
919 <dl>
697 <dt>Returns:</dt> 920 <dt>Returns:</dt>
698 <dd> 921 <dd>
699 flag indicating an error condition 922 flag indicating an error condition
700 </dd> 923 </dd>
701 </dl><dl> 924 </dl>
925 <dl>
702 <dt>Return Type:</dt> 926 <dt>Return Type:</dt>
703 <dd> 927 <dd>
704 bool 928 bool
705 </dd> 929 </dd>
706 </dl><a NAME="DebugClientBase.run_call" ID="DebugClientBase.run_call"></a> 930 </dl>
931 <a NAME="DebugClientBase.run_call" ID="DebugClientBase.run_call"></a>
707 <h4>DebugClientBase.run_call</h4> 932 <h4>DebugClientBase.run_call</h4>
708 <b>run_call</b>(<i>scriptname, func, *args</i>) 933 <b>run_call</b>(<i>scriptname, func, *args</i>)
934
709 <p> 935 <p>
710 Public method used to start the remote debugger and call a function. 936 Public method used to start the remote debugger and call a function.
711 </p><dl> 937 </p>
938 <dl>
939
712 <dt><i>scriptname</i></dt> 940 <dt><i>scriptname</i></dt>
713 <dd> 941 <dd>
714 name of the script to be debugged (string) 942 name of the script to be debugged (string)
715 </dd><dt><i>func</i></dt> 943 </dd>
944 <dt><i>func</i></dt>
716 <dd> 945 <dd>
717 function to be called 946 function to be called
718 </dd><dt><i>*args</i></dt> 947 </dd>
948 <dt><i>*args</i></dt>
719 <dd> 949 <dd>
720 arguments being passed to func 950 arguments being passed to func
721 </dd> 951 </dd>
722 </dl><dl> 952 </dl>
953 <dl>
723 <dt>Returns:</dt> 954 <dt>Returns:</dt>
724 <dd> 955 <dd>
725 result of the function call 956 result of the function call
726 </dd> 957 </dd>
727 </dl><a NAME="DebugClientBase.sendCallTrace" ID="DebugClientBase.sendCallTrace"></a> 958 </dl>
959 <a NAME="DebugClientBase.sendCallTrace" ID="DebugClientBase.sendCallTrace"></a>
728 <h4>DebugClientBase.sendCallTrace</h4> 960 <h4>DebugClientBase.sendCallTrace</h4>
729 <b>sendCallTrace</b>(<i>event, fromInfo, toInfo</i>) 961 <b>sendCallTrace</b>(<i>event, fromInfo, toInfo</i>)
962
730 <p> 963 <p>
731 Public method to send a call trace entry. 964 Public method to send a call trace entry.
732 </p><dl> 965 </p>
966 <dl>
967
733 <dt><i>event</i> (str)</dt> 968 <dt><i>event</i> (str)</dt>
734 <dd> 969 <dd>
735 trace event (call or return) 970 trace event (call or return)
736 </dd><dt><i>fromInfo</i> (dict with 'filename', 'linenumber' and 'codename')</dt> 971 </dd>
972 <dt><i>fromInfo</i> (dict with 'filename', 'linenumber' and 'codename')</dt>
737 <dd> 973 <dd>
738 dictionary containing the origin info 974 dictionary containing the origin info
739 as keys 975 as keys
740 </dd><dt><i>toInfo</i> (dict with 'filename', 'linenumber' and 'codename')</dt> 976 </dd>
977 <dt><i>toInfo</i> (dict with 'filename', 'linenumber' and 'codename')</dt>
741 <dd> 978 <dd>
742 dictionary containing the target info 979 dictionary containing the target info
743 as keys 980 as keys
744 </dd> 981 </dd>
745 </dl><a NAME="DebugClientBase.sendClearTemporaryBreakpoint" ID="DebugClientBase.sendClearTemporaryBreakpoint"></a> 982 </dl>
983 <a NAME="DebugClientBase.sendClearTemporaryBreakpoint" ID="DebugClientBase.sendClearTemporaryBreakpoint"></a>
746 <h4>DebugClientBase.sendClearTemporaryBreakpoint</h4> 984 <h4>DebugClientBase.sendClearTemporaryBreakpoint</h4>
747 <b>sendClearTemporaryBreakpoint</b>(<i>filename, lineno</i>) 985 <b>sendClearTemporaryBreakpoint</b>(<i>filename, lineno</i>)
986
748 <p> 987 <p>
749 Public method to signal the deletion of a temporary breakpoint. 988 Public method to signal the deletion of a temporary breakpoint.
750 </p><dl> 989 </p>
990 <dl>
991
751 <dt><i>filename</i> (str)</dt> 992 <dt><i>filename</i> (str)</dt>
752 <dd> 993 <dd>
753 name of the file the bp belongs to 994 name of the file the bp belongs to
754 </dd><dt><i>lineno</i> (int)</dt> 995 </dd>
996 <dt><i>lineno</i> (int)</dt>
755 <dd> 997 <dd>
756 linenumber of the bp 998 linenumber of the bp
757 </dd> 999 </dd>
758 </dl><a NAME="DebugClientBase.sendClearTemporaryWatch" ID="DebugClientBase.sendClearTemporaryWatch"></a> 1000 </dl>
1001 <a NAME="DebugClientBase.sendClearTemporaryWatch" ID="DebugClientBase.sendClearTemporaryWatch"></a>
759 <h4>DebugClientBase.sendClearTemporaryWatch</h4> 1002 <h4>DebugClientBase.sendClearTemporaryWatch</h4>
760 <b>sendClearTemporaryWatch</b>(<i>condition</i>) 1003 <b>sendClearTemporaryWatch</b>(<i>condition</i>)
1004
761 <p> 1005 <p>
762 Public method to signal the deletion of a temporary watch expression. 1006 Public method to signal the deletion of a temporary watch expression.
763 </p><dl> 1007 </p>
1008 <dl>
1009
764 <dt><i>condition</i> (str)</dt> 1010 <dt><i>condition</i> (str)</dt>
765 <dd> 1011 <dd>
766 condition of the watch expression to be cleared 1012 condition of the watch expression to be cleared
767 </dd> 1013 </dd>
768 </dl><a NAME="DebugClientBase.sendException" ID="DebugClientBase.sendException"></a> 1014 </dl>
1015 <a NAME="DebugClientBase.sendException" ID="DebugClientBase.sendException"></a>
769 <h4>DebugClientBase.sendException</h4> 1016 <h4>DebugClientBase.sendException</h4>
770 <b>sendException</b>(<i>exceptionType, exceptionMessage, stack</i>) 1017 <b>sendException</b>(<i>exceptionType, exceptionMessage, stack</i>)
1018
771 <p> 1019 <p>
772 Public method to send information for an exception. 1020 Public method to send information for an exception.
773 </p><dl> 1021 </p>
1022 <dl>
1023
774 <dt><i>exceptionType</i> (str)</dt> 1024 <dt><i>exceptionType</i> (str)</dt>
775 <dd> 1025 <dd>
776 type of exception raised 1026 type of exception raised
777 </dd><dt><i>exceptionMessage</i> (str)</dt> 1027 </dd>
1028 <dt><i>exceptionMessage</i> (str)</dt>
778 <dd> 1029 <dd>
779 message of the exception 1030 message of the exception
780 </dd><dt><i>stack</i> (list)</dt> 1031 </dd>
1032 <dt><i>stack</i> (list)</dt>
781 <dd> 1033 <dd>
782 stack trace information 1034 stack trace information
783 </dd> 1035 </dd>
784 </dl><a NAME="DebugClientBase.sendJsonCommand" ID="DebugClientBase.sendJsonCommand"></a> 1036 </dl>
1037 <a NAME="DebugClientBase.sendJsonCommand" ID="DebugClientBase.sendJsonCommand"></a>
785 <h4>DebugClientBase.sendJsonCommand</h4> 1038 <h4>DebugClientBase.sendJsonCommand</h4>
786 <b>sendJsonCommand</b>(<i>method, params</i>) 1039 <b>sendJsonCommand</b>(<i>method, params</i>)
1040
787 <p> 1041 <p>
788 Public method to send a single command or response to the IDE. 1042 Public method to send a single command or response to the IDE.
789 </p><dl> 1043 </p>
1044 <dl>
1045
790 <dt><i>method</i> (str)</dt> 1046 <dt><i>method</i> (str)</dt>
791 <dd> 1047 <dd>
792 command or response command name to be sent 1048 command or response command name to be sent
793 </dd><dt><i>params</i> (dict)</dt> 1049 </dd>
1050 <dt><i>params</i> (dict)</dt>
794 <dd> 1051 <dd>
795 dictionary of named parameters for the command or 1052 dictionary of named parameters for the command or
796 response 1053 response
797 </dd> 1054 </dd>
798 </dl><a NAME="DebugClientBase.sendPassiveStartup" ID="DebugClientBase.sendPassiveStartup"></a> 1055 </dl>
1056 <a NAME="DebugClientBase.sendPassiveStartup" ID="DebugClientBase.sendPassiveStartup"></a>
799 <h4>DebugClientBase.sendPassiveStartup</h4> 1057 <h4>DebugClientBase.sendPassiveStartup</h4>
800 <b>sendPassiveStartup</b>(<i>filename, exceptions</i>) 1058 <b>sendPassiveStartup</b>(<i>filename, exceptions</i>)
1059
801 <p> 1060 <p>
802 Public method to send the passive start information. 1061 Public method to send the passive start information.
803 </p><dl> 1062 </p>
1063 <dl>
1064
804 <dt><i>filename</i> (str)</dt> 1065 <dt><i>filename</i> (str)</dt>
805 <dd> 1066 <dd>
806 name of the script 1067 name of the script
807 </dd><dt><i>exceptions</i> (bool)</dt> 1068 </dd>
1069 <dt><i>exceptions</i> (bool)</dt>
808 <dd> 1070 <dd>
809 flag to enable exception reporting of the IDE 1071 flag to enable exception reporting of the IDE
810 </dd> 1072 </dd>
811 </dl><a NAME="DebugClientBase.sendResponseLine" ID="DebugClientBase.sendResponseLine"></a> 1073 </dl>
1074 <a NAME="DebugClientBase.sendResponseLine" ID="DebugClientBase.sendResponseLine"></a>
812 <h4>DebugClientBase.sendResponseLine</h4> 1075 <h4>DebugClientBase.sendResponseLine</h4>
813 <b>sendResponseLine</b>(<i>stack</i>) 1076 <b>sendResponseLine</b>(<i>stack</i>)
1077
814 <p> 1078 <p>
815 Public method to send the current call stack. 1079 Public method to send the current call stack.
816 </p><dl> 1080 </p>
1081 <dl>
1082
817 <dt><i>stack</i> (list)</dt> 1083 <dt><i>stack</i> (list)</dt>
818 <dd> 1084 <dd>
819 call stack 1085 call stack
820 </dd> 1086 </dd>
821 </dl><a NAME="DebugClientBase.sendSyntaxError" ID="DebugClientBase.sendSyntaxError"></a> 1087 </dl>
1088 <a NAME="DebugClientBase.sendSyntaxError" ID="DebugClientBase.sendSyntaxError"></a>
822 <h4>DebugClientBase.sendSyntaxError</h4> 1089 <h4>DebugClientBase.sendSyntaxError</h4>
823 <b>sendSyntaxError</b>(<i>message, filename, lineno, charno</i>) 1090 <b>sendSyntaxError</b>(<i>message, filename, lineno, charno</i>)
1091
824 <p> 1092 <p>
825 Public method to send information for a syntax error. 1093 Public method to send information for a syntax error.
826 </p><dl> 1094 </p>
1095 <dl>
1096
827 <dt><i>message</i> (str)</dt> 1097 <dt><i>message</i> (str)</dt>
828 <dd> 1098 <dd>
829 syntax error message 1099 syntax error message
830 </dd><dt><i>filename</i> (str)</dt> 1100 </dd>
1101 <dt><i>filename</i> (str)</dt>
831 <dd> 1102 <dd>
832 name of the faulty file 1103 name of the faulty file
833 </dd><dt><i>lineno</i> (int)</dt> 1104 </dd>
1105 <dt><i>lineno</i> (int)</dt>
834 <dd> 1106 <dd>
835 line number info 1107 line number info
836 </dd><dt><i>charno</i> (int)</dt> 1108 </dd>
1109 <dt><i>charno</i> (int)</dt>
837 <dd> 1110 <dd>
838 character number info 1111 character number info
839 </dd> 1112 </dd>
840 </dl><a NAME="DebugClientBase.sessionClose" ID="DebugClientBase.sessionClose"></a> 1113 </dl>
1114 <a NAME="DebugClientBase.sessionClose" ID="DebugClientBase.sessionClose"></a>
841 <h4>DebugClientBase.sessionClose</h4> 1115 <h4>DebugClientBase.sessionClose</h4>
842 <b>sessionClose</b>(<i>terminate=True</i>) 1116 <b>sessionClose</b>(<i>terminate=True</i>)
1117
843 <p> 1118 <p>
844 Public method to close the session with the debugger and optionally 1119 Public method to close the session with the debugger and optionally
845 terminate. 1120 terminate.
846 </p><dl> 1121 </p>
1122 <dl>
1123
847 <dt><i>terminate</i></dt> 1124 <dt><i>terminate</i></dt>
848 <dd> 1125 <dd>
849 flag indicating to terminate (boolean) 1126 flag indicating to terminate (boolean)
850 </dd> 1127 </dd>
851 </dl><a NAME="DebugClientBase.startDebugger" ID="DebugClientBase.startDebugger"></a> 1128 </dl>
1129 <a NAME="DebugClientBase.startDebugger" ID="DebugClientBase.startDebugger"></a>
852 <h4>DebugClientBase.startDebugger</h4> 1130 <h4>DebugClientBase.startDebugger</h4>
853 <b>startDebugger</b>(<i>filename=None, host=None, port=None, enableTrace=True, exceptions=True, tracePython=False, redirect=True</i>) 1131 <b>startDebugger</b>(<i>filename=None, host=None, port=None, enableTrace=True, exceptions=True, tracePython=False, redirect=True</i>)
1132
854 <p> 1133 <p>
855 Public method used to start the remote debugger. 1134 Public method used to start the remote debugger.
856 </p><dl> 1135 </p>
1136 <dl>
1137
857 <dt><i>filename</i></dt> 1138 <dt><i>filename</i></dt>
858 <dd> 1139 <dd>
859 the program to be debugged (string) 1140 the program to be debugged (string)
860 </dd><dt><i>host</i></dt> 1141 </dd>
1142 <dt><i>host</i></dt>
861 <dd> 1143 <dd>
862 hostname of the debug server (string) 1144 hostname of the debug server (string)
863 </dd><dt><i>port</i></dt> 1145 </dd>
1146 <dt><i>port</i></dt>
864 <dd> 1147 <dd>
865 portnumber of the debug server (int) 1148 portnumber of the debug server (int)
866 </dd><dt><i>enableTrace</i></dt> 1149 </dd>
1150 <dt><i>enableTrace</i></dt>
867 <dd> 1151 <dd>
868 flag to enable the tracing function (boolean) 1152 flag to enable the tracing function (boolean)
869 </dd><dt><i>exceptions</i></dt> 1153 </dd>
1154 <dt><i>exceptions</i></dt>
870 <dd> 1155 <dd>
871 flag to enable exception reporting of the IDE 1156 flag to enable exception reporting of the IDE
872 (boolean) 1157 (boolean)
873 </dd><dt><i>tracePython</i></dt> 1158 </dd>
1159 <dt><i>tracePython</i></dt>
874 <dd> 1160 <dd>
875 flag to enable tracing into the Python library 1161 flag to enable tracing into the Python library
876 (boolean) 1162 (boolean)
877 </dd><dt><i>redirect</i></dt> 1163 </dd>
1164 <dt><i>redirect</i></dt>
878 <dd> 1165 <dd>
879 flag indicating redirection of stdin, stdout and 1166 flag indicating redirection of stdin, stdout and
880 stderr (boolean) 1167 stderr (boolean)
881 </dd> 1168 </dd>
882 </dl><a NAME="DebugClientBase.startProgInDebugger" ID="DebugClientBase.startProgInDebugger"></a> 1169 </dl>
1170 <a NAME="DebugClientBase.startProgInDebugger" ID="DebugClientBase.startProgInDebugger"></a>
883 <h4>DebugClientBase.startProgInDebugger</h4> 1171 <h4>DebugClientBase.startProgInDebugger</h4>
884 <b>startProgInDebugger</b>(<i>progargs, wd='', host=None, port=None, exceptions=True, tracePython=False, redirect=True</i>) 1172 <b>startProgInDebugger</b>(<i>progargs, wd='', host=None, port=None, exceptions=True, tracePython=False, redirect=True</i>)
1173
885 <p> 1174 <p>
886 Public method used to start the remote debugger. 1175 Public method used to start the remote debugger.
887 </p><dl> 1176 </p>
1177 <dl>
1178
888 <dt><i>progargs</i></dt> 1179 <dt><i>progargs</i></dt>
889 <dd> 1180 <dd>
890 commandline for the program to be debugged 1181 commandline for the program to be debugged
891 (list of strings) 1182 (list of strings)
892 </dd><dt><i>wd</i></dt> 1183 </dd>
1184 <dt><i>wd</i></dt>
893 <dd> 1185 <dd>
894 working directory for the program execution (string) 1186 working directory for the program execution (string)
895 </dd><dt><i>host</i></dt> 1187 </dd>
1188 <dt><i>host</i></dt>
896 <dd> 1189 <dd>
897 hostname of the debug server (string) 1190 hostname of the debug server (string)
898 </dd><dt><i>port</i></dt> 1191 </dd>
1192 <dt><i>port</i></dt>
899 <dd> 1193 <dd>
900 portnumber of the debug server (int) 1194 portnumber of the debug server (int)
901 </dd><dt><i>exceptions</i></dt> 1195 </dd>
1196 <dt><i>exceptions</i></dt>
902 <dd> 1197 <dd>
903 flag to enable exception reporting of the IDE 1198 flag to enable exception reporting of the IDE
904 (boolean) 1199 (boolean)
905 </dd><dt><i>tracePython</i></dt> 1200 </dd>
1201 <dt><i>tracePython</i></dt>
906 <dd> 1202 <dd>
907 flag to enable tracing into the Python library 1203 flag to enable tracing into the Python library
908 (boolean) 1204 (boolean)
909 </dd><dt><i>redirect</i></dt> 1205 </dd>
1206 <dt><i>redirect</i></dt>
910 <dd> 1207 <dd>
911 flag indicating redirection of stdin, stdout and 1208 flag indicating redirection of stdin, stdout and
912 stderr (boolean) 1209 stderr (boolean)
913 </dd> 1210 </dd>
914 </dl><a NAME="DebugClientBase.writeReady" ID="DebugClientBase.writeReady"></a> 1211 </dl>
1212 <a NAME="DebugClientBase.writeReady" ID="DebugClientBase.writeReady"></a>
915 <h4>DebugClientBase.writeReady</h4> 1213 <h4>DebugClientBase.writeReady</h4>
916 <b>writeReady</b>(<i>stream</i>) 1214 <b>writeReady</b>(<i>stream</i>)
1215
917 <p> 1216 <p>
918 Public method called when we are ready to write data. 1217 Public method called when we are ready to write data.
919 </p><dl> 1218 </p>
1219 <dl>
1220
920 <dt><i>stream</i></dt> 1221 <dt><i>stream</i></dt>
921 <dd> 1222 <dd>
922 file like object that has data to be written 1223 file like object that has data to be written
923 </dd> 1224 </dd>
924 </dl> 1225 </dl>
925 <div align="right"><a href="#top">Up</a></div> 1226 <div align="right"><a href="#top">Up</a></div>
926 <hr /><hr /> 1227 <hr />
1228 <hr />
927 <a NAME="DebugClientClose" ID="DebugClientClose"></a> 1229 <a NAME="DebugClientClose" ID="DebugClientClose"></a>
928 <h2>DebugClientClose</h2> 1230 <h2>DebugClientClose</h2>
929 <b>DebugClientClose</b>(<i>fd</i>) 1231 <b>DebugClientClose</b>(<i>fd</i>)
1232
930 <p> 1233 <p>
931 Replacement for the standard os.close(fd). 1234 Replacement for the standard os.close(fd).
932 </p><dl> 1235 </p>
1236 <dl>
1237
933 <dt><i>fd</i></dt> 1238 <dt><i>fd</i></dt>
934 <dd> 1239 <dd>
935 open file descriptor to be closed (integer) 1240 open file descriptor to be closed (integer)
936 </dd> 1241 </dd>
937 </dl> 1242 </dl>
938 <div align="right"><a href="#top">Up</a></div> 1243 <div align="right"><a href="#top">Up</a></div>
939 <hr /><hr /> 1244 <hr />
1245 <hr />
940 <a NAME="DebugClientFork" ID="DebugClientFork"></a> 1246 <a NAME="DebugClientFork" ID="DebugClientFork"></a>
941 <h2>DebugClientFork</h2> 1247 <h2>DebugClientFork</h2>
942 <b>DebugClientFork</b>(<i></i>) 1248 <b>DebugClientFork</b>(<i></i>)
1249
943 <p> 1250 <p>
944 Replacement for the standard os.fork(). 1251 Replacement for the standard os.fork().
945 </p><dl> 1252 </p>
1253 <dl>
946 <dt>Returns:</dt> 1254 <dt>Returns:</dt>
947 <dd> 1255 <dd>
948 result of the fork() call 1256 result of the fork() call
949 </dd> 1257 </dd>
950 </dl> 1258 </dl>
951 <div align="right"><a href="#top">Up</a></div> 1259 <div align="right"><a href="#top">Up</a></div>
952 <hr /><hr /> 1260 <hr />
1261 <hr />
953 <a NAME="DebugClientInput" ID="DebugClientInput"></a> 1262 <a NAME="DebugClientInput" ID="DebugClientInput"></a>
954 <h2>DebugClientInput</h2> 1263 <h2>DebugClientInput</h2>
955 <b>DebugClientInput</b>(<i>prompt="", echo=True</i>) 1264 <b>DebugClientInput</b>(<i>prompt="", echo=True</i>)
1265
956 <p> 1266 <p>
957 Replacement for the standard input builtin. 1267 Replacement for the standard input builtin.
958 </p><p> 1268 </p>
1269 <p>
959 This function works with the split debugger. 1270 This function works with the split debugger.
960 </p><dl> 1271 </p>
1272 <dl>
1273
961 <dt><i>prompt</i></dt> 1274 <dt><i>prompt</i></dt>
962 <dd> 1275 <dd>
963 prompt to be shown (string) 1276 prompt to be shown (string)
964 </dd><dt><i>echo</i></dt> 1277 </dd>
1278 <dt><i>echo</i></dt>
965 <dd> 1279 <dd>
966 flag indicating to echo the output (boolean) 1280 flag indicating to echo the output (boolean)
967 </dd> 1281 </dd>
968 </dl><dl> 1282 </dl>
1283 <dl>
969 <dt>Returns:</dt> 1284 <dt>Returns:</dt>
970 <dd> 1285 <dd>
971 result of the input() call 1286 result of the input() call
972 </dd> 1287 </dd>
973 </dl> 1288 </dl>
974 <div align="right"><a href="#top">Up</a></div> 1289 <div align="right"><a href="#top">Up</a></div>
975 <hr /><hr /> 1290 <hr />
1291 <hr />
976 <a NAME="DebugClientRawInput" ID="DebugClientRawInput"></a> 1292 <a NAME="DebugClientRawInput" ID="DebugClientRawInput"></a>
977 <h2>DebugClientRawInput</h2> 1293 <h2>DebugClientRawInput</h2>
978 <b>DebugClientRawInput</b>(<i>prompt="", echo=True</i>) 1294 <b>DebugClientRawInput</b>(<i>prompt="", echo=True</i>)
1295
979 <p> 1296 <p>
980 Replacement for the standard raw_input builtin. 1297 Replacement for the standard raw_input builtin.
981 </p><p> 1298 </p>
1299 <p>
982 This function works with the split debugger. 1300 This function works with the split debugger.
983 </p><dl> 1301 </p>
1302 <dl>
1303
984 <dt><i>prompt</i></dt> 1304 <dt><i>prompt</i></dt>
985 <dd> 1305 <dd>
986 prompt to be shown. (string) 1306 prompt to be shown. (string)
987 </dd><dt><i>echo</i></dt> 1307 </dd>
1308 <dt><i>echo</i></dt>
988 <dd> 1309 <dd>
989 flag indicating echoing of the input (boolean) 1310 flag indicating echoing of the input (boolean)
990 </dd> 1311 </dd>
991 </dl><dl> 1312 </dl>
1313 <dl>
992 <dt>Returns:</dt> 1314 <dt>Returns:</dt>
993 <dd> 1315 <dd>
994 result of the raw_input() call 1316 result of the raw_input() call
995 </dd> 1317 </dd>
996 </dl> 1318 </dl>
997 <div align="right"><a href="#top">Up</a></div> 1319 <div align="right"><a href="#top">Up</a></div>
998 <hr /><hr /> 1320 <hr />
1321 <hr />
999 <a NAME="DebugClientSetRecursionLimit" ID="DebugClientSetRecursionLimit"></a> 1322 <a NAME="DebugClientSetRecursionLimit" ID="DebugClientSetRecursionLimit"></a>
1000 <h2>DebugClientSetRecursionLimit</h2> 1323 <h2>DebugClientSetRecursionLimit</h2>
1001 <b>DebugClientSetRecursionLimit</b>(<i>limit</i>) 1324 <b>DebugClientSetRecursionLimit</b>(<i>limit</i>)
1325
1002 <p> 1326 <p>
1003 Replacement for the standard sys.setrecursionlimit(limit). 1327 Replacement for the standard sys.setrecursionlimit(limit).
1004 </p><dl> 1328 </p>
1329 <dl>
1330
1005 <dt><i>limit</i></dt> 1331 <dt><i>limit</i></dt>
1006 <dd> 1332 <dd>
1007 recursion limit (integer) 1333 recursion limit (integer)
1008 </dd> 1334 </dd>
1009 </dl> 1335 </dl>

Mercurial Repository: eric

eric ide

mercurial