Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Debugger.DebuggerInterfacePython.html
Documentation/Source/eric5.Debugger.DebuggerInterfacePython.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 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.Debugger.DebuggerInterfacePython</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.Debugger.DebuggerInterfacePython</h1> | |
| 12 <p> | |
| 13 Module implementing the Python debugger interface for the debug server. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>ClientDefaultCapabilities</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#DebuggerInterfacePython">DebuggerInterfacePython</a></td> | |
| 23 <td>Class implementing the Python debugger interface for the debug server.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr> | |
| 29 <td><a href="#getRegistryData">getRegistryData</a></td> | |
| 30 <td>Module function to get characterising data for the debugger interface.</td> | |
| 31 </tr> | |
| 32 </table> | |
| 33 <hr /><hr /> | |
| 34 <a NAME="DebuggerInterfacePython" ID="DebuggerInterfacePython"></a> | |
| 35 <h2>DebuggerInterfacePython</h2> | |
| 36 <p> | |
| 37 Class implementing the Python debugger interface for the debug server. | |
| 38 </p> | |
| 39 <h3>Derived from</h3> | |
| 40 QObject | |
| 41 <h3>Class Attributes</h3> | |
| 42 <table> | |
| 43 <tr><td>None</td></tr> | |
| 44 </table> | |
| 45 <h3>Methods</h3> | |
| 46 <table> | |
| 47 <tr> | |
| 48 <td><a href="#DebuggerInterfacePython.__init__">DebuggerInterfacePython</a></td> | |
| 49 <td>Constructor</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#DebuggerInterfacePython.__askForkTo">__askForkTo</a></td> | |
| 52 <td>Private method to ask the user which branch of a fork to follow.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#DebuggerInterfacePython.__identityTranslation">__identityTranslation</a></td> | |
| 55 <td>Private method to perform the identity path translation.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#DebuggerInterfacePython.__parseClientLine">__parseClientLine</a></td> | |
| 58 <td>Private method to handle data from the client.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#DebuggerInterfacePython.__remoteTranslation">__remoteTranslation</a></td> | |
| 61 <td>Private method to perform the path translation.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#DebuggerInterfacePython.__sendCommand">__sendCommand</a></td> | |
| 64 <td>Private method to send a single line command to the client.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#DebuggerInterfacePython.__startProcess">__startProcess</a></td> | |
| 67 <td>Private method to start the debugger client process.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#DebuggerInterfacePython.flush">flush</a></td> | |
| 70 <td>Public slot to flush the queue.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#DebuggerInterfacePython.getClientCapabilities">getClientCapabilities</a></td> | |
| 73 <td>Public method to retrieve the debug clients capabilities.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#DebuggerInterfacePython.isConnected">isConnected</a></td> | |
| 76 <td>Public method to test, if a debug client has connected.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#DebuggerInterfacePython.newConnection">newConnection</a></td> | |
| 79 <td>Public slot to handle a new connection.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#DebuggerInterfacePython.remoteBanner">remoteBanner</a></td> | |
| 82 <td>Public slot to get the banner info of the remote client.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#DebuggerInterfacePython.remoteBreakpoint">remoteBreakpoint</a></td> | |
| 85 <td>Public method to set or clear a breakpoint.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#DebuggerInterfacePython.remoteBreakpointEnable">remoteBreakpointEnable</a></td> | |
| 88 <td>Public method to enable or disable a breakpoint.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#DebuggerInterfacePython.remoteBreakpointIgnore">remoteBreakpointIgnore</a></td> | |
| 91 <td>Public method to ignore a breakpoint the next couple of occurrences.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#DebuggerInterfacePython.remoteCapabilities">remoteCapabilities</a></td> | |
| 94 <td>Public slot to get the debug clients capabilities.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#DebuggerInterfacePython.remoteClientSetFilter">remoteClientSetFilter</a></td> | |
| 97 <td>Public method to set a variables filter list.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#DebuggerInterfacePython.remoteClientVariable">remoteClientVariable</a></td> | |
| 100 <td>Public method to request the variables of the debugged program.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#DebuggerInterfacePython.remoteClientVariables">remoteClientVariables</a></td> | |
| 103 <td>Public method to request the variables of the debugged program.</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#DebuggerInterfacePython.remoteCompletion">remoteCompletion</a></td> | |
| 106 <td>Public slot to get the a list of possible commandline completions from the remote client.</td> | |
| 107 </tr><tr> | |
| 108 <td><a href="#DebuggerInterfacePython.remoteContinue">remoteContinue</a></td> | |
| 109 <td>Public method to continue the debugged program.</td> | |
| 110 </tr><tr> | |
| 111 <td><a href="#DebuggerInterfacePython.remoteCoverage">remoteCoverage</a></td> | |
| 112 <td>Public method to load a new program to collect coverage data.</td> | |
| 113 </tr><tr> | |
| 114 <td><a href="#DebuggerInterfacePython.remoteEnvironment">remoteEnvironment</a></td> | |
| 115 <td>Public method to set the environment for a program to debug, run, ...</td> | |
| 116 </tr><tr> | |
| 117 <td><a href="#DebuggerInterfacePython.remoteEval">remoteEval</a></td> | |
| 118 <td>Public method to evaluate arg in the current context of the debugged program.</td> | |
| 119 </tr><tr> | |
| 120 <td><a href="#DebuggerInterfacePython.remoteExec">remoteExec</a></td> | |
| 121 <td>Public method to execute stmt in the current context of the debugged program.</td> | |
| 122 </tr><tr> | |
| 123 <td><a href="#DebuggerInterfacePython.remoteLoad">remoteLoad</a></td> | |
| 124 <td>Public method to load a new program to debug.</td> | |
| 125 </tr><tr> | |
| 126 <td><a href="#DebuggerInterfacePython.remoteProfile">remoteProfile</a></td> | |
| 127 <td>Public method to load a new program to collect profiling data.</td> | |
| 128 </tr><tr> | |
| 129 <td><a href="#DebuggerInterfacePython.remoteRawInput">remoteRawInput</a></td> | |
| 130 <td>Public method to send the raw input to the debugged program.</td> | |
| 131 </tr><tr> | |
| 132 <td><a href="#DebuggerInterfacePython.remoteRun">remoteRun</a></td> | |
| 133 <td>Public method to load a new program to run.</td> | |
| 134 </tr><tr> | |
| 135 <td><a href="#DebuggerInterfacePython.remoteSetThread">remoteSetThread</a></td> | |
| 136 <td>Public method to request to set the given thread as current thread.</td> | |
| 137 </tr><tr> | |
| 138 <td><a href="#DebuggerInterfacePython.remoteStatement">remoteStatement</a></td> | |
| 139 <td>Public method to execute a Python statement.</td> | |
| 140 </tr><tr> | |
| 141 <td><a href="#DebuggerInterfacePython.remoteStep">remoteStep</a></td> | |
| 142 <td>Public method to single step the debugged program.</td> | |
| 143 </tr><tr> | |
| 144 <td><a href="#DebuggerInterfacePython.remoteStepOut">remoteStepOut</a></td> | |
| 145 <td>Public method to step out the debugged program.</td> | |
| 146 </tr><tr> | |
| 147 <td><a href="#DebuggerInterfacePython.remoteStepOver">remoteStepOver</a></td> | |
| 148 <td>Public method to step over the debugged program.</td> | |
| 149 </tr><tr> | |
| 150 <td><a href="#DebuggerInterfacePython.remoteStepQuit">remoteStepQuit</a></td> | |
| 151 <td>Public method to stop the debugged program.</td> | |
| 152 </tr><tr> | |
| 153 <td><a href="#DebuggerInterfacePython.remoteThreadList">remoteThreadList</a></td> | |
| 154 <td>Public method to request the list of threads from the client.</td> | |
| 155 </tr><tr> | |
| 156 <td><a href="#DebuggerInterfacePython.remoteUTPrepare">remoteUTPrepare</a></td> | |
| 157 <td>Public method to prepare a new unittest run.</td> | |
| 158 </tr><tr> | |
| 159 <td><a href="#DebuggerInterfacePython.remoteUTRun">remoteUTRun</a></td> | |
| 160 <td>Public method to start a unittest run.</td> | |
| 161 </tr><tr> | |
| 162 <td><a href="#DebuggerInterfacePython.remoteUTStop">remoteUTStop</a></td> | |
| 163 <td>Public method to stop a unittest run.</td> | |
| 164 </tr><tr> | |
| 165 <td><a href="#DebuggerInterfacePython.remoteWatchpoint">remoteWatchpoint</a></td> | |
| 166 <td>Public method to set or clear a watch expression.</td> | |
| 167 </tr><tr> | |
| 168 <td><a href="#DebuggerInterfacePython.remoteWatchpointEnable">remoteWatchpointEnable</a></td> | |
| 169 <td>Public method to enable or disable a watch expression.</td> | |
| 170 </tr><tr> | |
| 171 <td><a href="#DebuggerInterfacePython.remoteWatchpointIgnore">remoteWatchpointIgnore</a></td> | |
| 172 <td>Public method to ignore a watch expression the next couple of occurrences.</td> | |
| 173 </tr><tr> | |
| 174 <td><a href="#DebuggerInterfacePython.shutdown">shutdown</a></td> | |
| 175 <td>Public method to cleanly shut down.</td> | |
| 176 </tr><tr> | |
| 177 <td><a href="#DebuggerInterfacePython.startRemote">startRemote</a></td> | |
| 178 <td>Public method to start a remote Python interpreter.</td> | |
| 179 </tr><tr> | |
| 180 <td><a href="#DebuggerInterfacePython.startRemoteForProject">startRemoteForProject</a></td> | |
| 181 <td>Public method to start a remote Python interpreter for a project.</td> | |
| 182 </tr> | |
| 183 </table> | |
| 184 <a NAME="DebuggerInterfacePython.__init__" ID="DebuggerInterfacePython.__init__"></a> | |
| 185 <h4>DebuggerInterfacePython (Constructor)</h4> | |
| 186 <b>DebuggerInterfacePython</b>(<i>debugServer, passive</i>) | |
| 187 <p> | |
| 188 Constructor | |
| 189 </p><dl> | |
| 190 <dt><i>debugServer</i></dt> | |
| 191 <dd> | |
| 192 reference to the debug server (DebugServer) | |
| 193 </dd><dt><i>passive</i></dt> | |
| 194 <dd> | |
| 195 flag indicating passive connection mode (boolean) | |
| 196 </dd> | |
| 197 </dl><a NAME="DebuggerInterfacePython.__askForkTo" ID="DebuggerInterfacePython.__askForkTo"></a> | |
| 198 <h4>DebuggerInterfacePython.__askForkTo</h4> | |
| 199 <b>__askForkTo</b>(<i></i>) | |
| 200 <p> | |
| 201 Private method to ask the user which branch of a fork to follow. | |
| 202 </p><a NAME="DebuggerInterfacePython.__identityTranslation" ID="DebuggerInterfacePython.__identityTranslation"></a> | |
| 203 <h4>DebuggerInterfacePython.__identityTranslation</h4> | |
| 204 <b>__identityTranslation</b>(<i>fn, remote2local = True</i>) | |
| 205 <p> | |
| 206 Private method to perform the identity path translation. | |
| 207 </p><dl> | |
| 208 <dt><i>fn</i></dt> | |
| 209 <dd> | |
| 210 filename to be translated (string) | |
| 211 </dd><dt><i>remote2local</i></dt> | |
| 212 <dd> | |
| 213 flag indicating the direction of translation | |
| 214 (False = local to remote, True = remote to local [default]) | |
| 215 </dd> | |
| 216 </dl><dl> | |
| 217 <dt>Returns:</dt> | |
| 218 <dd> | |
| 219 translated filename (string) | |
| 220 </dd> | |
| 221 </dl><a NAME="DebuggerInterfacePython.__parseClientLine" ID="DebuggerInterfacePython.__parseClientLine"></a> | |
| 222 <h4>DebuggerInterfacePython.__parseClientLine</h4> | |
| 223 <b>__parseClientLine</b>(<i></i>) | |
| 224 <p> | |
| 225 Private method to handle data from the client. | |
| 226 </p><a NAME="DebuggerInterfacePython.__remoteTranslation" ID="DebuggerInterfacePython.__remoteTranslation"></a> | |
| 227 <h4>DebuggerInterfacePython.__remoteTranslation</h4> | |
| 228 <b>__remoteTranslation</b>(<i>fn, remote2local = True</i>) | |
| 229 <p> | |
| 230 Private method to perform the path translation. | |
| 231 </p><dl> | |
| 232 <dt><i>fn</i></dt> | |
| 233 <dd> | |
| 234 filename to be translated (string) | |
| 235 </dd><dt><i>remote2local</i></dt> | |
| 236 <dd> | |
| 237 flag indicating the direction of translation | |
| 238 (False = local to remote, True = remote to local [default]) | |
| 239 </dd> | |
| 240 </dl><dl> | |
| 241 <dt>Returns:</dt> | |
| 242 <dd> | |
| 243 translated filename (string) | |
| 244 </dd> | |
| 245 </dl><a NAME="DebuggerInterfacePython.__sendCommand" ID="DebuggerInterfacePython.__sendCommand"></a> | |
| 246 <h4>DebuggerInterfacePython.__sendCommand</h4> | |
| 247 <b>__sendCommand</b>(<i>cmd</i>) | |
| 248 <p> | |
| 249 Private method to send a single line command to the client. | |
| 250 </p><dl> | |
| 251 <dt><i>cmd</i></dt> | |
| 252 <dd> | |
| 253 command to send to the debug client (string) | |
| 254 </dd> | |
| 255 </dl><a NAME="DebuggerInterfacePython.__startProcess" ID="DebuggerInterfacePython.__startProcess"></a> | |
| 256 <h4>DebuggerInterfacePython.__startProcess</h4> | |
| 257 <b>__startProcess</b>(<i>program, arguments, environment = None</i>) | |
| 258 <p> | |
| 259 Private method to start the debugger client process. | |
| 260 </p><dl> | |
| 261 <dt><i>program</i></dt> | |
| 262 <dd> | |
| 263 name of the executable to start (string) | |
| 264 </dd><dt><i>arguments</i></dt> | |
| 265 <dd> | |
| 266 arguments to be passed to the program (list of string) | |
| 267 </dd><dt><i>environment</i></dt> | |
| 268 <dd> | |
| 269 dictionary of environment settings to pass (dict of string) | |
| 270 </dd> | |
| 271 </dl><dl> | |
| 272 <dt>Returns:</dt> | |
| 273 <dd> | |
| 274 the process object (QProcess) or None | |
| 275 </dd> | |
| 276 </dl><a NAME="DebuggerInterfacePython.flush" ID="DebuggerInterfacePython.flush"></a> | |
| 277 <h4>DebuggerInterfacePython.flush</h4> | |
| 278 <b>flush</b>(<i></i>) | |
| 279 <p> | |
| 280 Public slot to flush the queue. | |
| 281 </p><a NAME="DebuggerInterfacePython.getClientCapabilities" ID="DebuggerInterfacePython.getClientCapabilities"></a> | |
| 282 <h4>DebuggerInterfacePython.getClientCapabilities</h4> | |
| 283 <b>getClientCapabilities</b>(<i></i>) | |
| 284 <p> | |
| 285 Public method to retrieve the debug clients capabilities. | |
| 286 </p><dl> | |
| 287 <dt>Returns:</dt> | |
| 288 <dd> | |
| 289 debug client capabilities (integer) | |
| 290 </dd> | |
| 291 </dl><a NAME="DebuggerInterfacePython.isConnected" ID="DebuggerInterfacePython.isConnected"></a> | |
| 292 <h4>DebuggerInterfacePython.isConnected</h4> | |
| 293 <b>isConnected</b>(<i></i>) | |
| 294 <p> | |
| 295 Public method to test, if a debug client has connected. | |
| 296 </p><dl> | |
| 297 <dt>Returns:</dt> | |
| 298 <dd> | |
| 299 flag indicating the connection status (boolean) | |
| 300 </dd> | |
| 301 </dl><a NAME="DebuggerInterfacePython.newConnection" ID="DebuggerInterfacePython.newConnection"></a> | |
| 302 <h4>DebuggerInterfacePython.newConnection</h4> | |
| 303 <b>newConnection</b>(<i>sock</i>) | |
| 304 <p> | |
| 305 Public slot to handle a new connection. | |
| 306 </p><dl> | |
| 307 <dt><i>sockreference</i></dt> | |
| 308 <dd> | |
| 309 to the socket object (QTcpSocket) | |
| 310 </dd> | |
| 311 </dl><dl> | |
| 312 <dt>Returns:</dt> | |
| 313 <dd> | |
| 314 flag indicating success (boolean) | |
| 315 </dd> | |
| 316 </dl><a NAME="DebuggerInterfacePython.remoteBanner" ID="DebuggerInterfacePython.remoteBanner"></a> | |
| 317 <h4>DebuggerInterfacePython.remoteBanner</h4> | |
| 318 <b>remoteBanner</b>(<i></i>) | |
| 319 <p> | |
| 320 Public slot to get the banner info of the remote client. | |
| 321 </p><a NAME="DebuggerInterfacePython.remoteBreakpoint" ID="DebuggerInterfacePython.remoteBreakpoint"></a> | |
| 322 <h4>DebuggerInterfacePython.remoteBreakpoint</h4> | |
| 323 <b>remoteBreakpoint</b>(<i>fn, line, set, cond = None, temp = False</i>) | |
| 324 <p> | |
| 325 Public method to set or clear a breakpoint. | |
| 326 </p><dl> | |
| 327 <dt><i>fn</i></dt> | |
| 328 <dd> | |
| 329 filename the breakpoint belongs to (string) | |
| 330 </dd><dt><i>line</i></dt> | |
| 331 <dd> | |
| 332 linenumber of the breakpoint (int) | |
| 333 </dd><dt><i>set</i></dt> | |
| 334 <dd> | |
| 335 flag indicating setting or resetting a breakpoint (boolean) | |
| 336 </dd><dt><i>cond</i></dt> | |
| 337 <dd> | |
| 338 condition of the breakpoint (string) | |
| 339 </dd><dt><i>temp</i></dt> | |
| 340 <dd> | |
| 341 flag indicating a temporary breakpoint (boolean) | |
| 342 </dd> | |
| 343 </dl><a NAME="DebuggerInterfacePython.remoteBreakpointEnable" ID="DebuggerInterfacePython.remoteBreakpointEnable"></a> | |
| 344 <h4>DebuggerInterfacePython.remoteBreakpointEnable</h4> | |
| 345 <b>remoteBreakpointEnable</b>(<i>fn, line, enable</i>) | |
| 346 <p> | |
| 347 Public method to enable or disable a breakpoint. | |
| 348 </p><dl> | |
| 349 <dt><i>fn</i></dt> | |
| 350 <dd> | |
| 351 filename the breakpoint belongs to (string) | |
| 352 </dd><dt><i>line</i></dt> | |
| 353 <dd> | |
| 354 linenumber of the breakpoint (int) | |
| 355 </dd><dt><i>enable</i></dt> | |
| 356 <dd> | |
| 357 flag indicating enabling or disabling a breakpoint (boolean) | |
| 358 </dd> | |
| 359 </dl><a NAME="DebuggerInterfacePython.remoteBreakpointIgnore" ID="DebuggerInterfacePython.remoteBreakpointIgnore"></a> | |
| 360 <h4>DebuggerInterfacePython.remoteBreakpointIgnore</h4> | |
| 361 <b>remoteBreakpointIgnore</b>(<i>fn, line, count</i>) | |
| 362 <p> | |
| 363 Public method to ignore a breakpoint the next couple of occurrences. | |
| 364 </p><dl> | |
| 365 <dt><i>fn</i></dt> | |
| 366 <dd> | |
| 367 filename the breakpoint belongs to (string) | |
| 368 </dd><dt><i>line</i></dt> | |
| 369 <dd> | |
| 370 linenumber of the breakpoint (int) | |
| 371 </dd><dt><i>count</i></dt> | |
| 372 <dd> | |
| 373 number of occurrences to ignore (int) | |
| 374 </dd> | |
| 375 </dl><a NAME="DebuggerInterfacePython.remoteCapabilities" ID="DebuggerInterfacePython.remoteCapabilities"></a> | |
| 376 <h4>DebuggerInterfacePython.remoteCapabilities</h4> | |
| 377 <b>remoteCapabilities</b>(<i></i>) | |
| 378 <p> | |
| 379 Public slot to get the debug clients capabilities. | |
| 380 </p><a NAME="DebuggerInterfacePython.remoteClientSetFilter" ID="DebuggerInterfacePython.remoteClientSetFilter"></a> | |
| 381 <h4>DebuggerInterfacePython.remoteClientSetFilter</h4> | |
| 382 <b>remoteClientSetFilter</b>(<i>scope, filter</i>) | |
| 383 <p> | |
| 384 Public method to set a variables filter list. | |
| 385 </p><dl> | |
| 386 <dt><i>scope</i></dt> | |
| 387 <dd> | |
| 388 the scope of the variables (0 = local, 1 = global) | |
| 389 </dd><dt><i>filter</i></dt> | |
| 390 <dd> | |
| 391 regexp string for variable names to filter out (string) | |
| 392 </dd> | |
| 393 </dl><a NAME="DebuggerInterfacePython.remoteClientVariable" ID="DebuggerInterfacePython.remoteClientVariable"></a> | |
| 394 <h4>DebuggerInterfacePython.remoteClientVariable</h4> | |
| 395 <b>remoteClientVariable</b>(<i>scope, filter, var, framenr = 0</i>) | |
| 396 <p> | |
| 397 Public method to request the variables of the debugged program. | |
| 398 </p><dl> | |
| 399 <dt><i>scope</i></dt> | |
| 400 <dd> | |
| 401 the scope of the variables (0 = local, 1 = global) | |
| 402 </dd><dt><i>filter</i></dt> | |
| 403 <dd> | |
| 404 list of variable types to filter out (list of int) | |
| 405 </dd><dt><i>var</i></dt> | |
| 406 <dd> | |
| 407 list encoded name of variable to retrieve (string) | |
| 408 </dd><dt><i>framenr</i></dt> | |
| 409 <dd> | |
| 410 framenumber of the variables to retrieve (int) | |
| 411 </dd> | |
| 412 </dl><a NAME="DebuggerInterfacePython.remoteClientVariables" ID="DebuggerInterfacePython.remoteClientVariables"></a> | |
| 413 <h4>DebuggerInterfacePython.remoteClientVariables</h4> | |
| 414 <b>remoteClientVariables</b>(<i>scope, filter, framenr = 0</i>) | |
| 415 <p> | |
| 416 Public method to request the variables of the debugged program. | |
| 417 </p><dl> | |
| 418 <dt><i>scope</i></dt> | |
| 419 <dd> | |
| 420 the scope of the variables (0 = local, 1 = global) | |
| 421 </dd><dt><i>filter</i></dt> | |
| 422 <dd> | |
| 423 list of variable types to filter out (list of int) | |
| 424 </dd><dt><i>framenr</i></dt> | |
| 425 <dd> | |
| 426 framenumber of the variables to retrieve (int) | |
| 427 </dd> | |
| 428 </dl><a NAME="DebuggerInterfacePython.remoteCompletion" ID="DebuggerInterfacePython.remoteCompletion"></a> | |
| 429 <h4>DebuggerInterfacePython.remoteCompletion</h4> | |
| 430 <b>remoteCompletion</b>(<i>text</i>) | |
| 431 <p> | |
| 432 Public slot to get the a list of possible commandline completions | |
| 433 from the remote client. | |
| 434 </p><dl> | |
| 435 <dt><i>text</i></dt> | |
| 436 <dd> | |
| 437 the text to be completed (string) | |
| 438 </dd> | |
| 439 </dl><a NAME="DebuggerInterfacePython.remoteContinue" ID="DebuggerInterfacePython.remoteContinue"></a> | |
| 440 <h4>DebuggerInterfacePython.remoteContinue</h4> | |
| 441 <b>remoteContinue</b>(<i>special = False</i>) | |
| 442 <p> | |
| 443 Public method to continue the debugged program. | |
| 444 </p><dl> | |
| 445 <dt><i>special</i></dt> | |
| 446 <dd> | |
| 447 flag indicating a special continue operation (boolean) | |
| 448 </dd> | |
| 449 </dl><a NAME="DebuggerInterfacePython.remoteCoverage" ID="DebuggerInterfacePython.remoteCoverage"></a> | |
| 450 <h4>DebuggerInterfacePython.remoteCoverage</h4> | |
| 451 <b>remoteCoverage</b>(<i>fn, argv, wd, erase = False</i>) | |
| 452 <p> | |
| 453 Public method to load a new program to collect coverage data. | |
| 454 </p><dl> | |
| 455 <dt><i>fn</i></dt> | |
| 456 <dd> | |
| 457 the filename to run (string) | |
| 458 </dd><dt><i>argv</i></dt> | |
| 459 <dd> | |
| 460 the commandline arguments to pass to the program (string) | |
| 461 </dd><dt><i>wd</i></dt> | |
| 462 <dd> | |
| 463 the working directory for the program (string) | |
| 464 </dd><dt><i>erase=</i></dt> | |
| 465 <dd> | |
| 466 flag indicating that coverage info should be | |
| 467 cleared first (boolean) | |
| 468 </dd> | |
| 469 </dl><a NAME="DebuggerInterfacePython.remoteEnvironment" ID="DebuggerInterfacePython.remoteEnvironment"></a> | |
| 470 <h4>DebuggerInterfacePython.remoteEnvironment</h4> | |
| 471 <b>remoteEnvironment</b>(<i>env</i>) | |
| 472 <p> | |
| 473 Public method to set the environment for a program to debug, run, ... | |
| 474 </p><dl> | |
| 475 <dt><i>env</i></dt> | |
| 476 <dd> | |
| 477 environment settings (dictionary) | |
| 478 </dd> | |
| 479 </dl><a NAME="DebuggerInterfacePython.remoteEval" ID="DebuggerInterfacePython.remoteEval"></a> | |
| 480 <h4>DebuggerInterfacePython.remoteEval</h4> | |
| 481 <b>remoteEval</b>(<i>arg</i>) | |
| 482 <p> | |
| 483 Public method to evaluate arg in the current context of the debugged program. | |
| 484 </p><dl> | |
| 485 <dt><i>arg</i></dt> | |
| 486 <dd> | |
| 487 the arguments to evaluate (string) | |
| 488 </dd> | |
| 489 </dl><a NAME="DebuggerInterfacePython.remoteExec" ID="DebuggerInterfacePython.remoteExec"></a> | |
| 490 <h4>DebuggerInterfacePython.remoteExec</h4> | |
| 491 <b>remoteExec</b>(<i>stmt</i>) | |
| 492 <p> | |
| 493 Public method to execute stmt in the current context of the debugged program. | |
| 494 </p><dl> | |
| 495 <dt><i>stmt</i></dt> | |
| 496 <dd> | |
| 497 statement to execute (string) | |
| 498 </dd> | |
| 499 </dl><a NAME="DebuggerInterfacePython.remoteLoad" ID="DebuggerInterfacePython.remoteLoad"></a> | |
| 500 <h4>DebuggerInterfacePython.remoteLoad</h4> | |
| 501 <b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter = False, autoContinue = True, autoFork = False, forkChild = False</i>) | |
| 502 <p> | |
| 503 Public method to load a new program to debug. | |
| 504 </p><dl> | |
| 505 <dt><i>fn</i></dt> | |
| 506 <dd> | |
| 507 the filename to debug (string) | |
| 508 </dd><dt><i>argv</i></dt> | |
| 509 <dd> | |
| 510 the commandline arguments to pass to the program (string) | |
| 511 </dd><dt><i>wd</i></dt> | |
| 512 <dd> | |
| 513 the working directory for the program (string) | |
| 514 </dd><dt><i>traceInterpreter=</i></dt> | |
| 515 <dd> | |
| 516 flag indicating if the interpreter library should be | |
| 517 traced as well (boolean) | |
| 518 </dd><dt><i>autoContinue=</i></dt> | |
| 519 <dd> | |
| 520 flag indicating, that the debugger should not stop | |
| 521 at the first executable line (boolean) | |
| 522 </dd><dt><i>autoFork=</i></dt> | |
| 523 <dd> | |
| 524 flag indicating the automatic fork mode (boolean) | |
| 525 </dd><dt><i>forkChild=</i></dt> | |
| 526 <dd> | |
| 527 flag indicating to debug the child after forking (boolean) | |
| 528 </dd> | |
| 529 </dl><a NAME="DebuggerInterfacePython.remoteProfile" ID="DebuggerInterfacePython.remoteProfile"></a> | |
| 530 <h4>DebuggerInterfacePython.remoteProfile</h4> | |
| 531 <b>remoteProfile</b>(<i>fn, argv, wd, erase = False</i>) | |
| 532 <p> | |
| 533 Public method to load a new program to collect profiling data. | |
| 534 </p><dl> | |
| 535 <dt><i>fn</i></dt> | |
| 536 <dd> | |
| 537 the filename to run (string) | |
| 538 </dd><dt><i>argv</i></dt> | |
| 539 <dd> | |
| 540 the commandline arguments to pass to the program (string) | |
| 541 </dd><dt><i>wd</i></dt> | |
| 542 <dd> | |
| 543 the working directory for the program (string) | |
| 544 </dd><dt><i>erase=</i></dt> | |
| 545 <dd> | |
| 546 flag indicating that timing info should be cleared first (boolean) | |
| 547 </dd> | |
| 548 </dl><a NAME="DebuggerInterfacePython.remoteRawInput" ID="DebuggerInterfacePython.remoteRawInput"></a> | |
| 549 <h4>DebuggerInterfacePython.remoteRawInput</h4> | |
| 550 <b>remoteRawInput</b>(<i>s</i>) | |
| 551 <p> | |
| 552 Public method to send the raw input to the debugged program. | |
| 553 </p><dl> | |
| 554 <dt><i>s</i></dt> | |
| 555 <dd> | |
| 556 the raw input (string) | |
| 557 </dd> | |
| 558 </dl><a NAME="DebuggerInterfacePython.remoteRun" ID="DebuggerInterfacePython.remoteRun"></a> | |
| 559 <h4>DebuggerInterfacePython.remoteRun</h4> | |
| 560 <b>remoteRun</b>(<i>fn, argv, wd</i>) | |
| 561 <p> | |
| 562 Public method to load a new program to run. | |
| 563 </p><dl> | |
| 564 <dt><i>fn</i></dt> | |
| 565 <dd> | |
| 566 the filename to run (string) | |
| 567 </dd><dt><i>argv</i></dt> | |
| 568 <dd> | |
| 569 the commandline arguments to pass to the program (string) | |
| 570 </dd><dt><i>wd</i></dt> | |
| 571 <dd> | |
| 572 the working directory for the program (string) | |
| 573 </dd> | |
| 574 </dl><a NAME="DebuggerInterfacePython.remoteSetThread" ID="DebuggerInterfacePython.remoteSetThread"></a> | |
| 575 <h4>DebuggerInterfacePython.remoteSetThread</h4> | |
| 576 <b>remoteSetThread</b>(<i>tid</i>) | |
| 577 <p> | |
| 578 Public method to request to set the given thread as current thread. | |
| 579 </p><dl> | |
| 580 <dt><i>tid</i></dt> | |
| 581 <dd> | |
| 582 id of the thread (integer) | |
| 583 </dd> | |
| 584 </dl><a NAME="DebuggerInterfacePython.remoteStatement" ID="DebuggerInterfacePython.remoteStatement"></a> | |
| 585 <h4>DebuggerInterfacePython.remoteStatement</h4> | |
| 586 <b>remoteStatement</b>(<i>stmt</i>) | |
| 587 <p> | |
| 588 Public method to execute a Python statement. | |
| 589 </p><dl> | |
| 590 <dt><i>stmt</i></dt> | |
| 591 <dd> | |
| 592 the Python statement to execute (string). It | |
| 593 should not have a trailing newline. | |
| 594 </dd> | |
| 595 </dl><a NAME="DebuggerInterfacePython.remoteStep" ID="DebuggerInterfacePython.remoteStep"></a> | |
| 596 <h4>DebuggerInterfacePython.remoteStep</h4> | |
| 597 <b>remoteStep</b>(<i></i>) | |
| 598 <p> | |
| 599 Public method to single step the debugged program. | |
| 600 </p><a NAME="DebuggerInterfacePython.remoteStepOut" ID="DebuggerInterfacePython.remoteStepOut"></a> | |
| 601 <h4>DebuggerInterfacePython.remoteStepOut</h4> | |
| 602 <b>remoteStepOut</b>(<i></i>) | |
| 603 <p> | |
| 604 Public method to step out the debugged program. | |
| 605 </p><a NAME="DebuggerInterfacePython.remoteStepOver" ID="DebuggerInterfacePython.remoteStepOver"></a> | |
| 606 <h4>DebuggerInterfacePython.remoteStepOver</h4> | |
| 607 <b>remoteStepOver</b>(<i></i>) | |
| 608 <p> | |
| 609 Public method to step over the debugged program. | |
| 610 </p><a NAME="DebuggerInterfacePython.remoteStepQuit" ID="DebuggerInterfacePython.remoteStepQuit"></a> | |
| 611 <h4>DebuggerInterfacePython.remoteStepQuit</h4> | |
| 612 <b>remoteStepQuit</b>(<i></i>) | |
| 613 <p> | |
| 614 Public method to stop the debugged program. | |
| 615 </p><a NAME="DebuggerInterfacePython.remoteThreadList" ID="DebuggerInterfacePython.remoteThreadList"></a> | |
| 616 <h4>DebuggerInterfacePython.remoteThreadList</h4> | |
| 617 <b>remoteThreadList</b>(<i></i>) | |
| 618 <p> | |
| 619 Public method to request the list of threads from the client. | |
| 620 </p><a NAME="DebuggerInterfacePython.remoteUTPrepare" ID="DebuggerInterfacePython.remoteUTPrepare"></a> | |
| 621 <h4>DebuggerInterfacePython.remoteUTPrepare</h4> | |
| 622 <b>remoteUTPrepare</b>(<i>fn, tn, tfn, cov, covname, coverase</i>) | |
| 623 <p> | |
| 624 Public method to prepare a new unittest run. | |
| 625 </p><dl> | |
| 626 <dt><i>fn</i></dt> | |
| 627 <dd> | |
| 628 the filename to load (string) | |
| 629 </dd><dt><i>tn</i></dt> | |
| 630 <dd> | |
| 631 the testname to load (string) | |
| 632 </dd><dt><i>tfn</i></dt> | |
| 633 <dd> | |
| 634 the test function name to load tests from (string) | |
| 635 </dd><dt><i>cov</i></dt> | |
| 636 <dd> | |
| 637 flag indicating collection of coverage data is requested | |
| 638 </dd><dt><i>covname</i></dt> | |
| 639 <dd> | |
| 640 filename to be used to assemble the coverage caches | |
| 641 filename | |
| 642 </dd><dt><i>coverase</i></dt> | |
| 643 <dd> | |
| 644 flag indicating erasure of coverage data is requested | |
| 645 </dd> | |
| 646 </dl><a NAME="DebuggerInterfacePython.remoteUTRun" ID="DebuggerInterfacePython.remoteUTRun"></a> | |
| 647 <h4>DebuggerInterfacePython.remoteUTRun</h4> | |
| 648 <b>remoteUTRun</b>(<i></i>) | |
| 649 <p> | |
| 650 Public method to start a unittest run. | |
| 651 </p><a NAME="DebuggerInterfacePython.remoteUTStop" ID="DebuggerInterfacePython.remoteUTStop"></a> | |
| 652 <h4>DebuggerInterfacePython.remoteUTStop</h4> | |
| 653 <b>remoteUTStop</b>(<i></i>) | |
| 654 <p> | |
| 655 Public method to stop a unittest run. | |
| 656 </p><a NAME="DebuggerInterfacePython.remoteWatchpoint" ID="DebuggerInterfacePython.remoteWatchpoint"></a> | |
| 657 <h4>DebuggerInterfacePython.remoteWatchpoint</h4> | |
| 658 <b>remoteWatchpoint</b>(<i>cond, set, temp = False</i>) | |
| 659 <p> | |
| 660 Public method to set or clear a watch expression. | |
| 661 </p><dl> | |
| 662 <dt><i>cond</i></dt> | |
| 663 <dd> | |
| 664 expression of the watch expression (string) | |
| 665 </dd><dt><i>set</i></dt> | |
| 666 <dd> | |
| 667 flag indicating setting or resetting a watch expression (boolean) | |
| 668 </dd><dt><i>temp</i></dt> | |
| 669 <dd> | |
| 670 flag indicating a temporary watch expression (boolean) | |
| 671 </dd> | |
| 672 </dl><a NAME="DebuggerInterfacePython.remoteWatchpointEnable" ID="DebuggerInterfacePython.remoteWatchpointEnable"></a> | |
| 673 <h4>DebuggerInterfacePython.remoteWatchpointEnable</h4> | |
| 674 <b>remoteWatchpointEnable</b>(<i>cond, enable</i>) | |
| 675 <p> | |
| 676 Public method to enable or disable a watch expression. | |
| 677 </p><dl> | |
| 678 <dt><i>cond</i></dt> | |
| 679 <dd> | |
| 680 expression of the watch expression (string) | |
| 681 </dd><dt><i>enable</i></dt> | |
| 682 <dd> | |
| 683 flag indicating enabling or disabling a watch expression (boolean) | |
| 684 </dd> | |
| 685 </dl><a NAME="DebuggerInterfacePython.remoteWatchpointIgnore" ID="DebuggerInterfacePython.remoteWatchpointIgnore"></a> | |
| 686 <h4>DebuggerInterfacePython.remoteWatchpointIgnore</h4> | |
| 687 <b>remoteWatchpointIgnore</b>(<i>cond, count</i>) | |
| 688 <p> | |
| 689 Public method to ignore a watch expression the next couple of occurrences. | |
| 690 </p><dl> | |
| 691 <dt><i>cond</i></dt> | |
| 692 <dd> | |
| 693 expression of the watch expression (string) | |
| 694 </dd><dt><i>count</i></dt> | |
| 695 <dd> | |
| 696 number of occurrences to ignore (int) | |
| 697 </dd> | |
| 698 </dl><a NAME="DebuggerInterfacePython.shutdown" ID="DebuggerInterfacePython.shutdown"></a> | |
| 699 <h4>DebuggerInterfacePython.shutdown</h4> | |
| 700 <b>shutdown</b>(<i></i>) | |
| 701 <p> | |
| 702 Public method to cleanly shut down. | |
| 703 </p><p> | |
| 704 It closes our socket and shuts down | |
| 705 the debug client. (Needed on Win OS) | |
| 706 </p><a NAME="DebuggerInterfacePython.startRemote" ID="DebuggerInterfacePython.startRemote"></a> | |
| 707 <h4>DebuggerInterfacePython.startRemote</h4> | |
| 708 <b>startRemote</b>(<i>port, runInConsole</i>) | |
| 709 <p> | |
| 710 Public method to start a remote Python interpreter. | |
| 711 </p><dl> | |
| 712 <dt><i>port</i></dt> | |
| 713 <dd> | |
| 714 portnumber the debug server is listening on (integer) | |
| 715 </dd><dt><i>runInConsole</i></dt> | |
| 716 <dd> | |
| 717 flag indicating to start the debugger in a | |
| 718 console window (boolean) | |
| 719 </dd> | |
| 720 </dl><dl> | |
| 721 <dt>Returns:</dt> | |
| 722 <dd> | |
| 723 client process object (QProcess) and a flag to indicate | |
| 724 a network connection (boolean) | |
| 725 </dd> | |
| 726 </dl><a NAME="DebuggerInterfacePython.startRemoteForProject" ID="DebuggerInterfacePython.startRemoteForProject"></a> | |
| 727 <h4>DebuggerInterfacePython.startRemoteForProject</h4> | |
| 728 <b>startRemoteForProject</b>(<i>port, runInConsole</i>) | |
| 729 <p> | |
| 730 Public method to start a remote Python interpreter for a project. | |
| 731 </p><dl> | |
| 732 <dt><i>port</i></dt> | |
| 733 <dd> | |
| 734 portnumber the debug server is listening on (integer) | |
| 735 </dd><dt><i>runInConsole</i></dt> | |
| 736 <dd> | |
| 737 flag indicating to start the debugger in a | |
| 738 console window (boolean) | |
| 739 </dd> | |
| 740 </dl><dl> | |
| 741 <dt>Returns:</dt> | |
| 742 <dd> | |
| 743 client process object (QProcess) and a flag to indicate | |
| 744 a network connection (boolean) | |
| 745 </dd> | |
| 746 </dl> | |
| 747 <div align="right"><a href="#top">Up</a></div> | |
| 748 <hr /><hr /> | |
| 749 <a NAME="getRegistryData" ID="getRegistryData"></a> | |
| 750 <h2>getRegistryData</h2> | |
| 751 <b>getRegistryData</b>(<i></i>) | |
| 752 <p> | |
| 753 Module function to get characterising data for the debugger interface. | |
| 754 </p><dl> | |
| 755 <dt>Returns:</dt> | |
| 756 <dd> | |
| 757 list of the following data. Client type (string), client | |
| 758 capabilities (integer), client type association (list of strings) | |
| 759 </dd> | |
| 760 </dl> | |
| 761 <div align="right"><a href="#top">Up</a></div> | |
| 762 <hr /> | |
| 763 </body></html> |
