Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Debugger.DebuggerInterfaceNone.html
src/eric7/Documentation/Source/eric7.Debugger.DebuggerInterfaceNone.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9097
- 213951c41dcd
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Debugger.DebuggerInterfaceNone</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Debugger.DebuggerInterfaceNone</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dummy debugger interface for the debug server. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>ClientDefaultCapabilities</td></tr><tr><td>ClientTypeAssociations</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#DebuggerInterfaceNone">DebuggerInterfaceNone</a></td> | |
| 25 <td>Class implementing a dummy debugger interface for the debug server.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#createDebuggerInterfaceNone">createDebuggerInterfaceNone</a></td> | |
| 34 <td>Module function to create a debugger interface instance.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#getRegistryData">getRegistryData</a></td> | |
| 38 <td>Module function to get characterizing data for the debugger interface.</td> | |
| 39 </tr> | |
| 40 </table> | |
| 41 <hr /> | |
| 42 <hr /> | |
| 43 <a NAME="DebuggerInterfaceNone" ID="DebuggerInterfaceNone"></a> | |
| 44 <h2>DebuggerInterfaceNone</h2> | |
| 45 | |
| 46 <p> | |
| 47 Class implementing a dummy debugger interface for the debug server. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 QObject | |
| 51 <h3>Class Attributes</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 | |
| 65 <tr> | |
| 66 <td><a href="#DebuggerInterfaceNone.__init__">DebuggerInterfaceNone</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#DebuggerInterfaceNone.getClientCapabilities">getClientCapabilities</a></td> | |
| 71 <td>Public method to retrieve the debug clients capabilities.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#DebuggerInterfaceNone.getDebuggerIds">getDebuggerIds</a></td> | |
| 75 <td>Public method to return the IDs of the connected debugger backends.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#DebuggerInterfaceNone.isConnected">isConnected</a></td> | |
| 79 <td>Public method to test, if a debug client has connected.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#DebuggerInterfaceNone.newConnection">newConnection</a></td> | |
| 83 <td>Public slot to handle a new connection.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#DebuggerInterfaceNone.remoteBanner">remoteBanner</a></td> | |
| 87 <td>Public slot to get the banner info of the remote client.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#DebuggerInterfaceNone.remoteBreakpoint">remoteBreakpoint</a></td> | |
| 91 <td>Public method to set or clear a breakpoint.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#DebuggerInterfaceNone.remoteBreakpointEnable">remoteBreakpointEnable</a></td> | |
| 95 <td>Public method to enable or disable a breakpoint.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#DebuggerInterfaceNone.remoteBreakpointIgnore">remoteBreakpointIgnore</a></td> | |
| 99 <td>Public method to ignore a breakpoint the next couple of occurrences.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#DebuggerInterfaceNone.remoteCapabilities">remoteCapabilities</a></td> | |
| 103 <td>Public slot to get the debug clients capabilities.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#DebuggerInterfaceNone.remoteClientDisassembly">remoteClientDisassembly</a></td> | |
| 107 <td>Public method to ask the client for the latest traceback disassembly.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#DebuggerInterfaceNone.remoteClientSetFilter">remoteClientSetFilter</a></td> | |
| 111 <td>Public method to set a variables filter list.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#DebuggerInterfaceNone.remoteClientStack">remoteClientStack</a></td> | |
| 115 <td>Public method to request the stack of the main thread.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#DebuggerInterfaceNone.remoteClientVariable">remoteClientVariable</a></td> | |
| 119 <td>Public method to request the variables of the debugged program.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#DebuggerInterfaceNone.remoteClientVariables">remoteClientVariables</a></td> | |
| 123 <td>Public method to request the variables of the debugged program.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#DebuggerInterfaceNone.remoteCompletion">remoteCompletion</a></td> | |
| 127 <td>Public slot to get the a list of possible commandline completions from the remote client.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#DebuggerInterfaceNone.remoteContinue">remoteContinue</a></td> | |
| 131 <td>Public method to continue the debugged program.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#DebuggerInterfaceNone.remoteContinueUntil">remoteContinueUntil</a></td> | |
| 135 <td>Public method to continue the debugged program to the given line or until returning from the current frame.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#DebuggerInterfaceNone.remoteCoverage">remoteCoverage</a></td> | |
| 139 <td>Public method to load a new program to collect coverage data.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#DebuggerInterfaceNone.remoteEnvironment">remoteEnvironment</a></td> | |
| 143 <td>Public method to set the environment for a program to debug, run, ...</td> | |
| 144 </tr> | |
| 145 <tr> | |
| 146 <td><a href="#DebuggerInterfaceNone.remoteLoad">remoteLoad</a></td> | |
| 147 <td>Public method to load a new program to debug.</td> | |
| 148 </tr> | |
| 149 <tr> | |
| 150 <td><a href="#DebuggerInterfaceNone.remoteMoveIP">remoteMoveIP</a></td> | |
| 151 <td>Public method to move the instruction pointer to a different line.</td> | |
| 152 </tr> | |
| 153 <tr> | |
| 154 <td><a href="#DebuggerInterfaceNone.remoteNoDebugList">remoteNoDebugList</a></td> | |
| 155 <td>Public method to set a list of programs not to be debugged.</td> | |
| 156 </tr> | |
| 157 <tr> | |
| 158 <td><a href="#DebuggerInterfaceNone.remoteProfile">remoteProfile</a></td> | |
| 159 <td>Public method to load a new program to collect profiling data.</td> | |
| 160 </tr> | |
| 161 <tr> | |
| 162 <td><a href="#DebuggerInterfaceNone.remoteRawInput">remoteRawInput</a></td> | |
| 163 <td>Public method to send the raw input to the debugged program.</td> | |
| 164 </tr> | |
| 165 <tr> | |
| 166 <td><a href="#DebuggerInterfaceNone.remoteRun">remoteRun</a></td> | |
| 167 <td>Public method to load a new program to run.</td> | |
| 168 </tr> | |
| 169 <tr> | |
| 170 <td><a href="#DebuggerInterfaceNone.remoteSetThread">remoteSetThread</a></td> | |
| 171 <td>Public method to request to set the given thread as current thread.</td> | |
| 172 </tr> | |
| 173 <tr> | |
| 174 <td><a href="#DebuggerInterfaceNone.remoteStatement">remoteStatement</a></td> | |
| 175 <td>Public method to execute a Python statement.</td> | |
| 176 </tr> | |
| 177 <tr> | |
| 178 <td><a href="#DebuggerInterfaceNone.remoteStep">remoteStep</a></td> | |
| 179 <td>Public method to single step the debugged program.</td> | |
| 180 </tr> | |
| 181 <tr> | |
| 182 <td><a href="#DebuggerInterfaceNone.remoteStepOut">remoteStepOut</a></td> | |
| 183 <td>Public method to step out the debugged program.</td> | |
| 184 </tr> | |
| 185 <tr> | |
| 186 <td><a href="#DebuggerInterfaceNone.remoteStepOver">remoteStepOver</a></td> | |
| 187 <td>Public method to step over the debugged program.</td> | |
| 188 </tr> | |
| 189 <tr> | |
| 190 <td><a href="#DebuggerInterfaceNone.remoteStepQuit">remoteStepQuit</a></td> | |
| 191 <td>Public method to stop the debugged program.</td> | |
| 192 </tr> | |
| 193 <tr> | |
| 194 <td><a href="#DebuggerInterfaceNone.remoteThreadList">remoteThreadList</a></td> | |
| 195 <td>Public method to request the list of threads from the client.</td> | |
| 196 </tr> | |
| 197 <tr> | |
| 198 <td><a href="#DebuggerInterfaceNone.remoteWatchpoint">remoteWatchpoint</a></td> | |
| 199 <td>Public method to set or clear a watch expression.</td> | |
| 200 </tr> | |
| 201 <tr> | |
| 202 <td><a href="#DebuggerInterfaceNone.remoteWatchpointEnable">remoteWatchpointEnable</a></td> | |
| 203 <td>Public method to enable or disable a watch expression.</td> | |
| 204 </tr> | |
| 205 <tr> | |
| 206 <td><a href="#DebuggerInterfaceNone.remoteWatchpointIgnore">remoteWatchpointIgnore</a></td> | |
| 207 <td>Public method to ignore a watch expression the next couple of occurrences.</td> | |
| 208 </tr> | |
| 209 <tr> | |
| 210 <td><a href="#DebuggerInterfaceNone.setCallTraceEnabled">setCallTraceEnabled</a></td> | |
| 211 <td>Public method to set the call trace state.</td> | |
| 212 </tr> | |
| 213 <tr> | |
| 214 <td><a href="#DebuggerInterfaceNone.shutdown">shutdown</a></td> | |
| 215 <td>Public method to cleanly shut down.</td> | |
| 216 </tr> | |
| 217 <tr> | |
| 218 <td><a href="#DebuggerInterfaceNone.startRemote">startRemote</a></td> | |
| 219 <td>Public method to start a remote Python interpreter.</td> | |
| 220 </tr> | |
| 221 <tr> | |
| 222 <td><a href="#DebuggerInterfaceNone.startRemoteForProject">startRemoteForProject</a></td> | |
| 223 <td>Public method to start a remote Python interpreter for a project.</td> | |
| 224 </tr> | |
| 225 </table> | |
| 226 <h3>Static Methods</h3> | |
| 227 | |
| 228 <table> | |
| 229 <tr><td>None</td></tr> | |
| 230 </table> | |
| 231 | |
| 232 <a NAME="DebuggerInterfaceNone.__init__" ID="DebuggerInterfaceNone.__init__"></a> | |
| 233 <h4>DebuggerInterfaceNone (Constructor)</h4> | |
| 234 <b>DebuggerInterfaceNone</b>(<i>debugServer, passive</i>) | |
| 235 | |
| 236 <p> | |
| 237 Constructor | |
| 238 </p> | |
| 239 <dl> | |
| 240 | |
| 241 <dt><i>debugServer</i> (DebugServer)</dt> | |
| 242 <dd> | |
| 243 reference to the debug server | |
| 244 </dd> | |
| 245 <dt><i>passive</i> (bool)</dt> | |
| 246 <dd> | |
| 247 flag indicating passive connection mode | |
| 248 </dd> | |
| 249 </dl> | |
| 250 <a NAME="DebuggerInterfaceNone.getClientCapabilities" ID="DebuggerInterfaceNone.getClientCapabilities"></a> | |
| 251 <h4>DebuggerInterfaceNone.getClientCapabilities</h4> | |
| 252 <b>getClientCapabilities</b>(<i></i>) | |
| 253 | |
| 254 <p> | |
| 255 Public method to retrieve the debug clients capabilities. | |
| 256 </p> | |
| 257 <dl> | |
| 258 <dt>Return:</dt> | |
| 259 <dd> | |
| 260 debug client capabilities | |
| 261 </dd> | |
| 262 </dl> | |
| 263 <dl> | |
| 264 <dt>Return Type:</dt> | |
| 265 <dd> | |
| 266 int | |
| 267 </dd> | |
| 268 </dl> | |
| 269 <a NAME="DebuggerInterfaceNone.getDebuggerIds" ID="DebuggerInterfaceNone.getDebuggerIds"></a> | |
| 270 <h4>DebuggerInterfaceNone.getDebuggerIds</h4> | |
| 271 <b>getDebuggerIds</b>(<i></i>) | |
| 272 | |
| 273 <p> | |
| 274 Public method to return the IDs of the connected debugger backends. | |
| 275 </p> | |
| 276 <dl> | |
| 277 <dt>Return:</dt> | |
| 278 <dd> | |
| 279 list of connected debugger backend IDs | |
| 280 </dd> | |
| 281 </dl> | |
| 282 <dl> | |
| 283 <dt>Return Type:</dt> | |
| 284 <dd> | |
| 285 list of str | |
| 286 </dd> | |
| 287 </dl> | |
| 288 <a NAME="DebuggerInterfaceNone.isConnected" ID="DebuggerInterfaceNone.isConnected"></a> | |
| 289 <h4>DebuggerInterfaceNone.isConnected</h4> | |
| 290 <b>isConnected</b>(<i></i>) | |
| 291 | |
| 292 <p> | |
| 293 Public method to test, if a debug client has connected. | |
| 294 </p> | |
| 295 <dl> | |
| 296 <dt>Return:</dt> | |
| 297 <dd> | |
| 298 flag indicating the connection status | |
| 299 </dd> | |
| 300 </dl> | |
| 301 <dl> | |
| 302 <dt>Return Type:</dt> | |
| 303 <dd> | |
| 304 bool | |
| 305 </dd> | |
| 306 </dl> | |
| 307 <a NAME="DebuggerInterfaceNone.newConnection" ID="DebuggerInterfaceNone.newConnection"></a> | |
| 308 <h4>DebuggerInterfaceNone.newConnection</h4> | |
| 309 <b>newConnection</b>(<i>sock</i>) | |
| 310 | |
| 311 <p> | |
| 312 Public slot to handle a new connection. | |
| 313 </p> | |
| 314 <dl> | |
| 315 | |
| 316 <dt><i>sock</i> (QTcpSocket)</dt> | |
| 317 <dd> | |
| 318 reference to the socket object | |
| 319 </dd> | |
| 320 </dl> | |
| 321 <dl> | |
| 322 <dt>Return:</dt> | |
| 323 <dd> | |
| 324 flag indicating success | |
| 325 </dd> | |
| 326 </dl> | |
| 327 <dl> | |
| 328 <dt>Return Type:</dt> | |
| 329 <dd> | |
| 330 bool | |
| 331 </dd> | |
| 332 </dl> | |
| 333 <a NAME="DebuggerInterfaceNone.remoteBanner" ID="DebuggerInterfaceNone.remoteBanner"></a> | |
| 334 <h4>DebuggerInterfaceNone.remoteBanner</h4> | |
| 335 <b>remoteBanner</b>(<i></i>) | |
| 336 | |
| 337 <p> | |
| 338 Public slot to get the banner info of the remote client. | |
| 339 </p> | |
| 340 <a NAME="DebuggerInterfaceNone.remoteBreakpoint" ID="DebuggerInterfaceNone.remoteBreakpoint"></a> | |
| 341 <h4>DebuggerInterfaceNone.remoteBreakpoint</h4> | |
| 342 <b>remoteBreakpoint</b>(<i>debuggerId, fn, line, setBreakpoint, cond=None, temp=False</i>) | |
| 343 | |
| 344 <p> | |
| 345 Public method to set or clear a breakpoint. | |
| 346 </p> | |
| 347 <dl> | |
| 348 | |
| 349 <dt><i>debuggerId</i> (str)</dt> | |
| 350 <dd> | |
| 351 ID of the debugger backend | |
| 352 </dd> | |
| 353 <dt><i>fn</i> (str)</dt> | |
| 354 <dd> | |
| 355 filename the breakpoint belongs to | |
| 356 </dd> | |
| 357 <dt><i>line</i> (int)</dt> | |
| 358 <dd> | |
| 359 linenumber of the breakpoint | |
| 360 </dd> | |
| 361 <dt><i>setBreakpoint</i> (bool)</dt> | |
| 362 <dd> | |
| 363 flag indicating setting or resetting a breakpoint | |
| 364 </dd> | |
| 365 <dt><i>cond</i> (str)</dt> | |
| 366 <dd> | |
| 367 condition of the breakpoint | |
| 368 </dd> | |
| 369 <dt><i>temp</i> (bool)</dt> | |
| 370 <dd> | |
| 371 flag indicating a temporary breakpoint | |
| 372 </dd> | |
| 373 </dl> | |
| 374 <a NAME="DebuggerInterfaceNone.remoteBreakpointEnable" ID="DebuggerInterfaceNone.remoteBreakpointEnable"></a> | |
| 375 <h4>DebuggerInterfaceNone.remoteBreakpointEnable</h4> | |
| 376 <b>remoteBreakpointEnable</b>(<i>debuggerId, fn, line, enable</i>) | |
| 377 | |
| 378 <p> | |
| 379 Public method to enable or disable a breakpoint. | |
| 380 </p> | |
| 381 <dl> | |
| 382 | |
| 383 <dt><i>debuggerId</i> (str)</dt> | |
| 384 <dd> | |
| 385 ID of the debugger backend | |
| 386 </dd> | |
| 387 <dt><i>fn</i> (str)</dt> | |
| 388 <dd> | |
| 389 filename the breakpoint belongs to | |
| 390 </dd> | |
| 391 <dt><i>line</i> (int)</dt> | |
| 392 <dd> | |
| 393 linenumber of the breakpoint | |
| 394 </dd> | |
| 395 <dt><i>enable</i> (bool)</dt> | |
| 396 <dd> | |
| 397 flag indicating enabling or disabling a breakpoint | |
| 398 </dd> | |
| 399 </dl> | |
| 400 <a NAME="DebuggerInterfaceNone.remoteBreakpointIgnore" ID="DebuggerInterfaceNone.remoteBreakpointIgnore"></a> | |
| 401 <h4>DebuggerInterfaceNone.remoteBreakpointIgnore</h4> | |
| 402 <b>remoteBreakpointIgnore</b>(<i>debuggerId, fn, line, count</i>) | |
| 403 | |
| 404 <p> | |
| 405 Public method to ignore a breakpoint the next couple of occurrences. | |
| 406 </p> | |
| 407 <dl> | |
| 408 | |
| 409 <dt><i>debuggerId</i> (str)</dt> | |
| 410 <dd> | |
| 411 ID of the debugger backend | |
| 412 </dd> | |
| 413 <dt><i>fn</i> (str)</dt> | |
| 414 <dd> | |
| 415 filename the breakpoint belongs to | |
| 416 </dd> | |
| 417 <dt><i>line</i> (int)</dt> | |
| 418 <dd> | |
| 419 linenumber of the breakpoint | |
| 420 </dd> | |
| 421 <dt><i>count</i> (int)</dt> | |
| 422 <dd> | |
| 423 number of occurrences to ignore | |
| 424 </dd> | |
| 425 </dl> | |
| 426 <a NAME="DebuggerInterfaceNone.remoteCapabilities" ID="DebuggerInterfaceNone.remoteCapabilities"></a> | |
| 427 <h4>DebuggerInterfaceNone.remoteCapabilities</h4> | |
| 428 <b>remoteCapabilities</b>(<i>debuggerId</i>) | |
| 429 | |
| 430 <p> | |
| 431 Public slot to get the debug clients capabilities. | |
| 432 </p> | |
| 433 <dl> | |
| 434 | |
| 435 <dt><i>debuggerId</i> (str)</dt> | |
| 436 <dd> | |
| 437 ID of the debugger backend | |
| 438 </dd> | |
| 439 </dl> | |
| 440 <a NAME="DebuggerInterfaceNone.remoteClientDisassembly" ID="DebuggerInterfaceNone.remoteClientDisassembly"></a> | |
| 441 <h4>DebuggerInterfaceNone.remoteClientDisassembly</h4> | |
| 442 <b>remoteClientDisassembly</b>(<i>debuggerId</i>) | |
| 443 | |
| 444 <p> | |
| 445 Public method to ask the client for the latest traceback disassembly. | |
| 446 </p> | |
| 447 <dl> | |
| 448 | |
| 449 <dt><i>debuggerId</i> (str)</dt> | |
| 450 <dd> | |
| 451 ID of the debugger backend | |
| 452 </dd> | |
| 453 </dl> | |
| 454 <a NAME="DebuggerInterfaceNone.remoteClientSetFilter" ID="DebuggerInterfaceNone.remoteClientSetFilter"></a> | |
| 455 <h4>DebuggerInterfaceNone.remoteClientSetFilter</h4> | |
| 456 <b>remoteClientSetFilter</b>(<i>debuggerId, scope, filterStr</i>) | |
| 457 | |
| 458 <p> | |
| 459 Public method to set a variables filter list. | |
| 460 </p> | |
| 461 <dl> | |
| 462 | |
| 463 <dt><i>debuggerId</i> (str)</dt> | |
| 464 <dd> | |
| 465 ID of the debugger backend | |
| 466 </dd> | |
| 467 <dt><i>scope</i> (int)</dt> | |
| 468 <dd> | |
| 469 the scope of the variables (0 = local, 1 = global) | |
| 470 </dd> | |
| 471 <dt><i>filterStr</i> (str)</dt> | |
| 472 <dd> | |
| 473 regexp string for variable names to filter out | |
| 474 </dd> | |
| 475 </dl> | |
| 476 <a NAME="DebuggerInterfaceNone.remoteClientStack" ID="DebuggerInterfaceNone.remoteClientStack"></a> | |
| 477 <h4>DebuggerInterfaceNone.remoteClientStack</h4> | |
| 478 <b>remoteClientStack</b>(<i>debuggerId</i>) | |
| 479 | |
| 480 <p> | |
| 481 Public method to request the stack of the main thread. | |
| 482 </p> | |
| 483 <dl> | |
| 484 | |
| 485 <dt><i>debuggerId</i> (str)</dt> | |
| 486 <dd> | |
| 487 ID of the debugger backend | |
| 488 </dd> | |
| 489 </dl> | |
| 490 <a NAME="DebuggerInterfaceNone.remoteClientVariable" ID="DebuggerInterfaceNone.remoteClientVariable"></a> | |
| 491 <h4>DebuggerInterfaceNone.remoteClientVariable</h4> | |
| 492 <b>remoteClientVariable</b>(<i>debuggerId, scope, filterList, var, framenr=0, maxSize=0</i>) | |
| 493 | |
| 494 <p> | |
| 495 Public method to request the variables of the debugged program. | |
| 496 </p> | |
| 497 <dl> | |
| 498 | |
| 499 <dt><i>debuggerId</i> (str)</dt> | |
| 500 <dd> | |
| 501 ID of the debugger backend | |
| 502 </dd> | |
| 503 <dt><i>scope</i> (int)</dt> | |
| 504 <dd> | |
| 505 the scope of the variables (0 = local, 1 = global) | |
| 506 </dd> | |
| 507 <dt><i>filterList</i> (list of str)</dt> | |
| 508 <dd> | |
| 509 list of variable types to filter out | |
| 510 </dd> | |
| 511 <dt><i>var</i> (list of str)</dt> | |
| 512 <dd> | |
| 513 list encoded name of variable to retrieve | |
| 514 </dd> | |
| 515 <dt><i>framenr</i> (int)</dt> | |
| 516 <dd> | |
| 517 framenumber of the variables to retrieve | |
| 518 </dd> | |
| 519 <dt><i>maxSize</i> (int)</dt> | |
| 520 <dd> | |
| 521 maximum size the formatted value of a variable will | |
| 522 be shown. If it is bigger than that, a 'too big' indication will | |
| 523 be given (@@TOO_BIG_TO_SHOW@@). | |
| 524 </dd> | |
| 525 </dl> | |
| 526 <a NAME="DebuggerInterfaceNone.remoteClientVariables" ID="DebuggerInterfaceNone.remoteClientVariables"></a> | |
| 527 <h4>DebuggerInterfaceNone.remoteClientVariables</h4> | |
| 528 <b>remoteClientVariables</b>(<i>debuggerId, scope, filterList, framenr=0, maxSize=0</i>) | |
| 529 | |
| 530 <p> | |
| 531 Public method to request the variables of the debugged program. | |
| 532 </p> | |
| 533 <dl> | |
| 534 | |
| 535 <dt><i>debuggerId</i> (str)</dt> | |
| 536 <dd> | |
| 537 ID of the debugger backend | |
| 538 </dd> | |
| 539 <dt><i>scope</i> (int)</dt> | |
| 540 <dd> | |
| 541 the scope of the variables (0 = local, 1 = global) | |
| 542 </dd> | |
| 543 <dt><i>filterList</i> (list of str)</dt> | |
| 544 <dd> | |
| 545 list of variable types to filter out | |
| 546 </dd> | |
| 547 <dt><i>framenr</i> (int)</dt> | |
| 548 <dd> | |
| 549 framenumber of the variables to retrieve | |
| 550 </dd> | |
| 551 <dt><i>maxSize</i> (int)</dt> | |
| 552 <dd> | |
| 553 maximum size the formatted value of a variable will | |
| 554 be shown. If it is bigger than that, a 'too big' indication will | |
| 555 be given (@@TOO_BIG_TO_SHOW@@). | |
| 556 </dd> | |
| 557 </dl> | |
| 558 <a NAME="DebuggerInterfaceNone.remoteCompletion" ID="DebuggerInterfaceNone.remoteCompletion"></a> | |
| 559 <h4>DebuggerInterfaceNone.remoteCompletion</h4> | |
| 560 <b>remoteCompletion</b>(<i>debuggerId, text</i>) | |
| 561 | |
| 562 <p> | |
| 563 Public slot to get the a list of possible commandline completions | |
| 564 from the remote client. | |
| 565 </p> | |
| 566 <dl> | |
| 567 | |
| 568 <dt><i>debuggerId</i> (str)</dt> | |
| 569 <dd> | |
| 570 ID of the debugger backend | |
| 571 </dd> | |
| 572 <dt><i>text</i> (str)</dt> | |
| 573 <dd> | |
| 574 the text to be completed | |
| 575 </dd> | |
| 576 </dl> | |
| 577 <a NAME="DebuggerInterfaceNone.remoteContinue" ID="DebuggerInterfaceNone.remoteContinue"></a> | |
| 578 <h4>DebuggerInterfaceNone.remoteContinue</h4> | |
| 579 <b>remoteContinue</b>(<i>debuggerId, special=False</i>) | |
| 580 | |
| 581 <p> | |
| 582 Public method to continue the debugged program. | |
| 583 </p> | |
| 584 <dl> | |
| 585 | |
| 586 <dt><i>debuggerId</i> (str)</dt> | |
| 587 <dd> | |
| 588 ID of the debugger backend | |
| 589 </dd> | |
| 590 <dt><i>special</i> (bool)</dt> | |
| 591 <dd> | |
| 592 flag indicating a special continue operation | |
| 593 </dd> | |
| 594 </dl> | |
| 595 <a NAME="DebuggerInterfaceNone.remoteContinueUntil" ID="DebuggerInterfaceNone.remoteContinueUntil"></a> | |
| 596 <h4>DebuggerInterfaceNone.remoteContinueUntil</h4> | |
| 597 <b>remoteContinueUntil</b>(<i>debuggerId, line</i>) | |
| 598 | |
| 599 <p> | |
| 600 Public method to continue the debugged program to the given line | |
| 601 or until returning from the current frame. | |
| 602 </p> | |
| 603 <dl> | |
| 604 | |
| 605 <dt><i>debuggerId</i> (str)</dt> | |
| 606 <dd> | |
| 607 ID of the debugger backend | |
| 608 </dd> | |
| 609 <dt><i>line</i> (int)</dt> | |
| 610 <dd> | |
| 611 the new line, where execution should be continued to | |
| 612 </dd> | |
| 613 </dl> | |
| 614 <a NAME="DebuggerInterfaceNone.remoteCoverage" ID="DebuggerInterfaceNone.remoteCoverage"></a> | |
| 615 <h4>DebuggerInterfaceNone.remoteCoverage</h4> | |
| 616 <b>remoteCoverage</b>(<i>fn, argv, wd, erase=False</i>) | |
| 617 | |
| 618 <p> | |
| 619 Public method to load a new program to collect coverage data. | |
| 620 </p> | |
| 621 <dl> | |
| 622 | |
| 623 <dt><i>fn</i> (str)</dt> | |
| 624 <dd> | |
| 625 the filename to run | |
| 626 </dd> | |
| 627 <dt><i>argv</i> (str)</dt> | |
| 628 <dd> | |
| 629 the commandline arguments to pass to the program | |
| 630 </dd> | |
| 631 <dt><i>wd</i> (str)</dt> | |
| 632 <dd> | |
| 633 the working directory for the program | |
| 634 </dd> | |
| 635 <dt><i>erase</i> (bool)</dt> | |
| 636 <dd> | |
| 637 flag indicating that coverage info should be | |
| 638 cleared first | |
| 639 </dd> | |
| 640 </dl> | |
| 641 <a NAME="DebuggerInterfaceNone.remoteEnvironment" ID="DebuggerInterfaceNone.remoteEnvironment"></a> | |
| 642 <h4>DebuggerInterfaceNone.remoteEnvironment</h4> | |
| 643 <b>remoteEnvironment</b>(<i>env</i>) | |
| 644 | |
| 645 <p> | |
| 646 Public method to set the environment for a program to debug, run, ... | |
| 647 </p> | |
| 648 <dl> | |
| 649 | |
| 650 <dt><i>env</i> (dict)</dt> | |
| 651 <dd> | |
| 652 environment settings | |
| 653 </dd> | |
| 654 </dl> | |
| 655 <a NAME="DebuggerInterfaceNone.remoteLoad" ID="DebuggerInterfaceNone.remoteLoad"></a> | |
| 656 <h4>DebuggerInterfaceNone.remoteLoad</h4> | |
| 657 <b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter=False, autoContinue=True, enableMultiprocess=False</i>) | |
| 658 | |
| 659 <p> | |
| 660 Public method to load a new program to debug. | |
| 661 </p> | |
| 662 <dl> | |
| 663 | |
| 664 <dt><i>fn</i> (str)</dt> | |
| 665 <dd> | |
| 666 the filename to debug | |
| 667 </dd> | |
| 668 <dt><i>argv</i> (str)</dt> | |
| 669 <dd> | |
| 670 the commandline arguments to pass to the program | |
| 671 </dd> | |
| 672 <dt><i>wd</i> (str)</dt> | |
| 673 <dd> | |
| 674 the working directory for the program | |
| 675 </dd> | |
| 676 <dt><i>traceInterpreter</i> (bool)</dt> | |
| 677 <dd> | |
| 678 flag indicating if the interpreter library | |
| 679 should be traced as well | |
| 680 </dd> | |
| 681 <dt><i>autoContinue</i> (bool)</dt> | |
| 682 <dd> | |
| 683 flag indicating, that the debugger should not | |
| 684 stop at the first executable line | |
| 685 </dd> | |
| 686 <dt><i>enableMultiprocess</i> (bool)</dt> | |
| 687 <dd> | |
| 688 flag indicating to perform multiprocess | |
| 689 debugging | |
| 690 </dd> | |
| 691 </dl> | |
| 692 <a NAME="DebuggerInterfaceNone.remoteMoveIP" ID="DebuggerInterfaceNone.remoteMoveIP"></a> | |
| 693 <h4>DebuggerInterfaceNone.remoteMoveIP</h4> | |
| 694 <b>remoteMoveIP</b>(<i>debuggerId, line</i>) | |
| 695 | |
| 696 <p> | |
| 697 Public method to move the instruction pointer to a different line. | |
| 698 </p> | |
| 699 <dl> | |
| 700 | |
| 701 <dt><i>debuggerId</i> (str)</dt> | |
| 702 <dd> | |
| 703 ID of the debugger backend | |
| 704 </dd> | |
| 705 <dt><i>line</i> (int)</dt> | |
| 706 <dd> | |
| 707 the new line, where execution should be continued | |
| 708 </dd> | |
| 709 </dl> | |
| 710 <a NAME="DebuggerInterfaceNone.remoteNoDebugList" ID="DebuggerInterfaceNone.remoteNoDebugList"></a> | |
| 711 <h4>DebuggerInterfaceNone.remoteNoDebugList</h4> | |
| 712 <b>remoteNoDebugList</b>(<i>debuggerId, noDebugList</i>) | |
| 713 | |
| 714 <p> | |
| 715 Public method to set a list of programs not to be debugged. | |
| 716 </p> | |
| 717 <p> | |
| 718 The programs given in the list will not be run under the control | |
| 719 of the multi process debugger. | |
| 720 </p> | |
| 721 <dl> | |
| 722 | |
| 723 <dt><i>debuggerId</i> (str)</dt> | |
| 724 <dd> | |
| 725 ID of the debugger backend | |
| 726 </dd> | |
| 727 <dt><i>noDebugList</i> (list of str)</dt> | |
| 728 <dd> | |
| 729 list of Python programs not to be debugged | |
| 730 </dd> | |
| 731 </dl> | |
| 732 <a NAME="DebuggerInterfaceNone.remoteProfile" ID="DebuggerInterfaceNone.remoteProfile"></a> | |
| 733 <h4>DebuggerInterfaceNone.remoteProfile</h4> | |
| 734 <b>remoteProfile</b>(<i>fn, argv, wd, erase=False</i>) | |
| 735 | |
| 736 <p> | |
| 737 Public method to load a new program to collect profiling data. | |
| 738 </p> | |
| 739 <dl> | |
| 740 | |
| 741 <dt><i>fn</i> (str)</dt> | |
| 742 <dd> | |
| 743 the filename to run | |
| 744 </dd> | |
| 745 <dt><i>argv</i> (str)</dt> | |
| 746 <dd> | |
| 747 the commandline arguments to pass to the program | |
| 748 </dd> | |
| 749 <dt><i>wd</i> (str)</dt> | |
| 750 <dd> | |
| 751 the working directory for the program | |
| 752 </dd> | |
| 753 <dt><i>erase</i> (bool)</dt> | |
| 754 <dd> | |
| 755 flag indicating that timing info should be cleared | |
| 756 first | |
| 757 </dd> | |
| 758 </dl> | |
| 759 <a NAME="DebuggerInterfaceNone.remoteRawInput" ID="DebuggerInterfaceNone.remoteRawInput"></a> | |
| 760 <h4>DebuggerInterfaceNone.remoteRawInput</h4> | |
| 761 <b>remoteRawInput</b>(<i>debuggerId, inputString</i>) | |
| 762 | |
| 763 <p> | |
| 764 Public method to send the raw input to the debugged program. | |
| 765 </p> | |
| 766 <dl> | |
| 767 | |
| 768 <dt><i>debuggerId</i> (str)</dt> | |
| 769 <dd> | |
| 770 ID of the debugger backend | |
| 771 </dd> | |
| 772 <dt><i>inputString</i> (str)</dt> | |
| 773 <dd> | |
| 774 the raw input | |
| 775 </dd> | |
| 776 </dl> | |
| 777 <a NAME="DebuggerInterfaceNone.remoteRun" ID="DebuggerInterfaceNone.remoteRun"></a> | |
| 778 <h4>DebuggerInterfaceNone.remoteRun</h4> | |
| 779 <b>remoteRun</b>(<i>fn, argv, wd</i>) | |
| 780 | |
| 781 <p> | |
| 782 Public method to load a new program to run. | |
| 783 </p> | |
| 784 <dl> | |
| 785 | |
| 786 <dt><i>fn</i> (str)</dt> | |
| 787 <dd> | |
| 788 the filename to run | |
| 789 </dd> | |
| 790 <dt><i>argv</i> (str)</dt> | |
| 791 <dd> | |
| 792 the commandline arguments to pass to the program | |
| 793 </dd> | |
| 794 <dt><i>wd</i> (str)</dt> | |
| 795 <dd> | |
| 796 the working directory for the program | |
| 797 </dd> | |
| 798 </dl> | |
| 799 <a NAME="DebuggerInterfaceNone.remoteSetThread" ID="DebuggerInterfaceNone.remoteSetThread"></a> | |
| 800 <h4>DebuggerInterfaceNone.remoteSetThread</h4> | |
| 801 <b>remoteSetThread</b>(<i>debuggerId, tid</i>) | |
| 802 | |
| 803 <p> | |
| 804 Public method to request to set the given thread as current thread. | |
| 805 </p> | |
| 806 <dl> | |
| 807 | |
| 808 <dt><i>debuggerId</i> (str)</dt> | |
| 809 <dd> | |
| 810 ID of the debugger backend | |
| 811 </dd> | |
| 812 <dt><i>tid</i> (int)</dt> | |
| 813 <dd> | |
| 814 id of the thread | |
| 815 </dd> | |
| 816 </dl> | |
| 817 <a NAME="DebuggerInterfaceNone.remoteStatement" ID="DebuggerInterfaceNone.remoteStatement"></a> | |
| 818 <h4>DebuggerInterfaceNone.remoteStatement</h4> | |
| 819 <b>remoteStatement</b>(<i>debuggerId, stmt</i>) | |
| 820 | |
| 821 <p> | |
| 822 Public method to execute a Python statement. | |
| 823 </p> | |
| 824 <dl> | |
| 825 | |
| 826 <dt><i>debuggerId</i> (str)</dt> | |
| 827 <dd> | |
| 828 ID of the debugger backend | |
| 829 </dd> | |
| 830 <dt><i>stmt</i> (str)</dt> | |
| 831 <dd> | |
| 832 the Python statement to execute. | |
| 833 </dd> | |
| 834 </dl> | |
| 835 <a NAME="DebuggerInterfaceNone.remoteStep" ID="DebuggerInterfaceNone.remoteStep"></a> | |
| 836 <h4>DebuggerInterfaceNone.remoteStep</h4> | |
| 837 <b>remoteStep</b>(<i>debuggerId</i>) | |
| 838 | |
| 839 <p> | |
| 840 Public method to single step the debugged program. | |
| 841 </p> | |
| 842 <dl> | |
| 843 | |
| 844 <dt><i>debuggerId</i> (str)</dt> | |
| 845 <dd> | |
| 846 ID of the debugger backend | |
| 847 </dd> | |
| 848 </dl> | |
| 849 <a NAME="DebuggerInterfaceNone.remoteStepOut" ID="DebuggerInterfaceNone.remoteStepOut"></a> | |
| 850 <h4>DebuggerInterfaceNone.remoteStepOut</h4> | |
| 851 <b>remoteStepOut</b>(<i>debuggerId</i>) | |
| 852 | |
| 853 <p> | |
| 854 Public method to step out the debugged program. | |
| 855 </p> | |
| 856 <dl> | |
| 857 | |
| 858 <dt><i>debuggerId</i> (str)</dt> | |
| 859 <dd> | |
| 860 ID of the debugger backend | |
| 861 </dd> | |
| 862 </dl> | |
| 863 <a NAME="DebuggerInterfaceNone.remoteStepOver" ID="DebuggerInterfaceNone.remoteStepOver"></a> | |
| 864 <h4>DebuggerInterfaceNone.remoteStepOver</h4> | |
| 865 <b>remoteStepOver</b>(<i>debuggerId</i>) | |
| 866 | |
| 867 <p> | |
| 868 Public method to step over the debugged program. | |
| 869 </p> | |
| 870 <dl> | |
| 871 | |
| 872 <dt><i>debuggerId</i> (str)</dt> | |
| 873 <dd> | |
| 874 ID of the debugger backend | |
| 875 </dd> | |
| 876 </dl> | |
| 877 <a NAME="DebuggerInterfaceNone.remoteStepQuit" ID="DebuggerInterfaceNone.remoteStepQuit"></a> | |
| 878 <h4>DebuggerInterfaceNone.remoteStepQuit</h4> | |
| 879 <b>remoteStepQuit</b>(<i>debuggerId</i>) | |
| 880 | |
| 881 <p> | |
| 882 Public method to stop the debugged program. | |
| 883 </p> | |
| 884 <dl> | |
| 885 | |
| 886 <dt><i>debuggerId</i> (str)</dt> | |
| 887 <dd> | |
| 888 ID of the debugger backend | |
| 889 </dd> | |
| 890 </dl> | |
| 891 <a NAME="DebuggerInterfaceNone.remoteThreadList" ID="DebuggerInterfaceNone.remoteThreadList"></a> | |
| 892 <h4>DebuggerInterfaceNone.remoteThreadList</h4> | |
| 893 <b>remoteThreadList</b>(<i>debuggerId</i>) | |
| 894 | |
| 895 <p> | |
| 896 Public method to request the list of threads from the client. | |
| 897 </p> | |
| 898 <dl> | |
| 899 | |
| 900 <dt><i>debuggerId</i> (str)</dt> | |
| 901 <dd> | |
| 902 ID of the debugger backend | |
| 903 </dd> | |
| 904 </dl> | |
| 905 <a NAME="DebuggerInterfaceNone.remoteWatchpoint" ID="DebuggerInterfaceNone.remoteWatchpoint"></a> | |
| 906 <h4>DebuggerInterfaceNone.remoteWatchpoint</h4> | |
| 907 <b>remoteWatchpoint</b>(<i>debuggerId, cond, setWatch, temp=False</i>) | |
| 908 | |
| 909 <p> | |
| 910 Public method to set or clear a watch expression. | |
| 911 </p> | |
| 912 <dl> | |
| 913 | |
| 914 <dt><i>debuggerId</i> (str)</dt> | |
| 915 <dd> | |
| 916 ID of the debugger backend | |
| 917 </dd> | |
| 918 <dt><i>cond</i> (str)</dt> | |
| 919 <dd> | |
| 920 expression of the watch expression | |
| 921 </dd> | |
| 922 <dt><i>setWatch</i> (bool)</dt> | |
| 923 <dd> | |
| 924 flag indicating setting or resetting a watch expression | |
| 925 </dd> | |
| 926 <dt><i>temp</i> (bool)</dt> | |
| 927 <dd> | |
| 928 flag indicating a temporary watch expression | |
| 929 </dd> | |
| 930 </dl> | |
| 931 <a NAME="DebuggerInterfaceNone.remoteWatchpointEnable" ID="DebuggerInterfaceNone.remoteWatchpointEnable"></a> | |
| 932 <h4>DebuggerInterfaceNone.remoteWatchpointEnable</h4> | |
| 933 <b>remoteWatchpointEnable</b>(<i>debuggerId, cond, enable</i>) | |
| 934 | |
| 935 <p> | |
| 936 Public method to enable or disable a watch expression. | |
| 937 </p> | |
| 938 <dl> | |
| 939 | |
| 940 <dt><i>debuggerId</i> (str)</dt> | |
| 941 <dd> | |
| 942 ID of the debugger backend | |
| 943 </dd> | |
| 944 <dt><i>cond</i> (str)</dt> | |
| 945 <dd> | |
| 946 expression of the watch expression | |
| 947 </dd> | |
| 948 <dt><i>enable</i> (bool)</dt> | |
| 949 <dd> | |
| 950 flag indicating enabling or disabling a watch expression | |
| 951 </dd> | |
| 952 </dl> | |
| 953 <a NAME="DebuggerInterfaceNone.remoteWatchpointIgnore" ID="DebuggerInterfaceNone.remoteWatchpointIgnore"></a> | |
| 954 <h4>DebuggerInterfaceNone.remoteWatchpointIgnore</h4> | |
| 955 <b>remoteWatchpointIgnore</b>(<i>debuggerId, cond, count</i>) | |
| 956 | |
| 957 <p> | |
| 958 Public method to ignore a watch expression the next couple of | |
| 959 occurrences. | |
| 960 </p> | |
| 961 <dl> | |
| 962 | |
| 963 <dt><i>debuggerId</i> (str)</dt> | |
| 964 <dd> | |
| 965 ID of the debugger backend | |
| 966 </dd> | |
| 967 <dt><i>cond</i> (str)</dt> | |
| 968 <dd> | |
| 969 expression of the watch expression | |
| 970 </dd> | |
| 971 <dt><i>count</i> (int)</dt> | |
| 972 <dd> | |
| 973 number of occurrences to ignore | |
| 974 </dd> | |
| 975 </dl> | |
| 976 <a NAME="DebuggerInterfaceNone.setCallTraceEnabled" ID="DebuggerInterfaceNone.setCallTraceEnabled"></a> | |
| 977 <h4>DebuggerInterfaceNone.setCallTraceEnabled</h4> | |
| 978 <b>setCallTraceEnabled</b>(<i>debuggerId, on</i>) | |
| 979 | |
| 980 <p> | |
| 981 Public method to set the call trace state. | |
| 982 </p> | |
| 983 <dl> | |
| 984 | |
| 985 <dt><i>debuggerId</i> (str)</dt> | |
| 986 <dd> | |
| 987 ID of the debugger backend | |
| 988 </dd> | |
| 989 <dt><i>on</i> (bool)</dt> | |
| 990 <dd> | |
| 991 flag indicating to enable the call trace function | |
| 992 </dd> | |
| 993 </dl> | |
| 994 <a NAME="DebuggerInterfaceNone.shutdown" ID="DebuggerInterfaceNone.shutdown"></a> | |
| 995 <h4>DebuggerInterfaceNone.shutdown</h4> | |
| 996 <b>shutdown</b>(<i></i>) | |
| 997 | |
| 998 <p> | |
| 999 Public method to cleanly shut down. | |
| 1000 </p> | |
| 1001 <p> | |
| 1002 It closes our socket and shuts down the debug client. | |
| 1003 (Needed on Win OS) | |
| 1004 </p> | |
| 1005 <a NAME="DebuggerInterfaceNone.startRemote" ID="DebuggerInterfaceNone.startRemote"></a> | |
| 1006 <h4>DebuggerInterfaceNone.startRemote</h4> | |
| 1007 <b>startRemote</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None</i>) | |
| 1008 | |
| 1009 <p> | |
| 1010 Public method to start a remote Python interpreter. | |
| 1011 </p> | |
| 1012 <dl> | |
| 1013 | |
| 1014 <dt><i>port</i> (int)</dt> | |
| 1015 <dd> | |
| 1016 port number the debug server is listening on | |
| 1017 </dd> | |
| 1018 <dt><i>runInConsole</i> (bool)</dt> | |
| 1019 <dd> | |
| 1020 flag indicating to start the debugger in a | |
| 1021 console window | |
| 1022 </dd> | |
| 1023 <dt><i>venvName</i> (str)</dt> | |
| 1024 <dd> | |
| 1025 name of the virtual environment to be used | |
| 1026 </dd> | |
| 1027 <dt><i>originalPathString</i> (str)</dt> | |
| 1028 <dd> | |
| 1029 original PATH environment variable | |
| 1030 </dd> | |
| 1031 <dt><i>workingDir</i> (str)</dt> | |
| 1032 <dd> | |
| 1033 directory to start the debugger client in | |
| 1034 </dd> | |
| 1035 <dt><i>configOverride</i> (dict)</dt> | |
| 1036 <dd> | |
| 1037 dictionary containing the global config override | |
| 1038 data | |
| 1039 </dd> | |
| 1040 </dl> | |
| 1041 <dl> | |
| 1042 <dt>Return:</dt> | |
| 1043 <dd> | |
| 1044 client process object, a flag to indicate a network connection | |
| 1045 and the name of the interpreter in case of a local execution | |
| 1046 </dd> | |
| 1047 </dl> | |
| 1048 <dl> | |
| 1049 <dt>Return Type:</dt> | |
| 1050 <dd> | |
| 1051 tuple of (QProcess, bool, str) | |
| 1052 </dd> | |
| 1053 </dl> | |
| 1054 <a NAME="DebuggerInterfaceNone.startRemoteForProject" ID="DebuggerInterfaceNone.startRemoteForProject"></a> | |
| 1055 <h4>DebuggerInterfaceNone.startRemoteForProject</h4> | |
| 1056 <b>startRemoteForProject</b>(<i>port, runInConsole, venvName, originalPathString, workingDir=None, configOverride=None</i>) | |
| 1057 | |
| 1058 <p> | |
| 1059 Public method to start a remote Python interpreter for a project. | |
| 1060 </p> | |
| 1061 <dl> | |
| 1062 | |
| 1063 <dt><i>port</i> (int)</dt> | |
| 1064 <dd> | |
| 1065 port number the debug server is listening on | |
| 1066 </dd> | |
| 1067 <dt><i>runInConsole</i> (bool)</dt> | |
| 1068 <dd> | |
| 1069 flag indicating to start the debugger in a | |
| 1070 console window | |
| 1071 </dd> | |
| 1072 <dt><i>venvName</i> (str)</dt> | |
| 1073 <dd> | |
| 1074 name of the virtual environment to be used | |
| 1075 </dd> | |
| 1076 <dt><i>originalPathString</i> (str)</dt> | |
| 1077 <dd> | |
| 1078 original PATH environment variable | |
| 1079 </dd> | |
| 1080 <dt><i>workingDir</i> (str)</dt> | |
| 1081 <dd> | |
| 1082 directory to start the debugger client in | |
| 1083 </dd> | |
| 1084 <dt><i>configOverride</i> (dict)</dt> | |
| 1085 <dd> | |
| 1086 dictionary containing the global config override | |
| 1087 data | |
| 1088 </dd> | |
| 1089 </dl> | |
| 1090 <dl> | |
| 1091 <dt>Return:</dt> | |
| 1092 <dd> | |
| 1093 client process object, a flag to indicate a network connection | |
| 1094 and the name of the interpreter in case of a local execution | |
| 1095 </dd> | |
| 1096 </dl> | |
| 1097 <dl> | |
| 1098 <dt>Return Type:</dt> | |
| 1099 <dd> | |
| 1100 tuple of (QProcess, bool, str) | |
| 1101 </dd> | |
| 1102 </dl> | |
| 1103 <div align="right"><a href="#top">Up</a></div> | |
| 1104 <hr /> | |
| 1105 <hr /> | |
| 1106 <a NAME="createDebuggerInterfaceNone" ID="createDebuggerInterfaceNone"></a> | |
| 1107 <h2>createDebuggerInterfaceNone</h2> | |
| 1108 <b>createDebuggerInterfaceNone</b>(<i>debugServer, passive</i>) | |
| 1109 | |
| 1110 <p> | |
| 1111 Module function to create a debugger interface instance. | |
| 1112 </p> | |
| 1113 <p> | |
| 1114 | |
| 1115 </p> | |
| 1116 <dl> | |
| 1117 | |
| 1118 <dt><i>debugServer</i> (DebugServer)</dt> | |
| 1119 <dd> | |
| 1120 reference to the debug server | |
| 1121 </dd> | |
| 1122 <dt><i>passive</i> (bool)</dt> | |
| 1123 <dd> | |
| 1124 flag indicating passive connection mode | |
| 1125 </dd> | |
| 1126 </dl> | |
| 1127 <dl> | |
| 1128 <dt>Return:</dt> | |
| 1129 <dd> | |
| 1130 instantiated debugger interface | |
| 1131 </dd> | |
| 1132 </dl> | |
| 1133 <dl> | |
| 1134 <dt>Return Type:</dt> | |
| 1135 <dd> | |
| 1136 DebuggerInterfaceNone | |
| 1137 </dd> | |
| 1138 </dl> | |
| 1139 <div align="right"><a href="#top">Up</a></div> | |
| 1140 <hr /> | |
| 1141 <hr /> | |
| 1142 <a NAME="getRegistryData" ID="getRegistryData"></a> | |
| 1143 <h2>getRegistryData</h2> | |
| 1144 <b>getRegistryData</b>(<i></i>) | |
| 1145 | |
| 1146 <p> | |
| 1147 Module function to get characterizing data for the debugger interface. | |
| 1148 </p> | |
| 1149 <dl> | |
| 1150 <dt>Return:</dt> | |
| 1151 <dd> | |
| 1152 list of tuples containing the client type, the client capabilities, | |
| 1153 the client file type associations and a reference to the creation | |
| 1154 function | |
| 1155 </dd> | |
| 1156 </dl> | |
| 1157 <dl> | |
| 1158 <dt>Return Type:</dt> | |
| 1159 <dd> | |
| 1160 list of tuple of (str, int, list of str, function) | |
| 1161 </dd> | |
| 1162 </dl> | |
| 1163 <div align="right"><a href="#top">Up</a></div> | |
| 1164 <hr /> | |
| 1165 </body></html> |
