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