Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Debugger.DebugServer.html
eric7/Documentation/Source/eric7.Debugger.DebugServer.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Debugger.DebugServer</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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.Debugger.DebugServer</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the debug server. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>DebuggerInterfaces</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#DebugServer">DebugServer</a></td> | |
| 39 <td>Class implementing the debug server embedded within the IDE.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="DebugServer" ID="DebugServer"></a> | |
| 50 <h2>DebugServer</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing the debug server embedded within the IDE. | |
| 54 </p> | |
| 55 <h3>Signals</h3> | |
| 56 <dl> | |
| 57 | |
| 58 <dt>appendStdout(msg)</dt> | |
| 59 <dd> | |
| 60 emitted when a passive debug connection is | |
| 61 established or lost | |
| 62 </dd> | |
| 63 <dt>callTraceInfo</dt> | |
| 64 <dd> | |
| 65 emitted after the client reported the call trace | |
| 66 data (isCall, fromFile, fromLine, fromFunction, toFile, toLine, | |
| 67 toFunction, debuggerId) | |
| 68 </dd> | |
| 69 <dt>clientBanner(version, platform, venvname)</dt> | |
| 70 <dd> | |
| 71 emitted after | |
| 72 the client banner data was received | |
| 73 </dd> | |
| 74 <dt>clientBreakConditionError(fn, lineno, debuggerId)</dt> | |
| 75 <dd> | |
| 76 emitted after the | |
| 77 client has signaled a syntax error in a breakpoint condition | |
| 78 </dd> | |
| 79 <dt>clientCapabilities(capabilities, cltype, venvname)</dt> | |
| 80 <dd> | |
| 81 emitted after | |
| 82 the clients capabilities were received | |
| 83 </dd> | |
| 84 <dt>clientClearBreak(filename, lineno, debuggerId)</dt> | |
| 85 <dd> | |
| 86 emitted after the | |
| 87 debug client has decided to clear a temporary breakpoint | |
| 88 </dd> | |
| 89 <dt>clientClearWatch(condition, debuggerId)</dt> | |
| 90 <dd> | |
| 91 emitted after the debug | |
| 92 client has decided to clear a temporary watch expression | |
| 93 </dd> | |
| 94 <dt>clientCompletionList(completionList, text)</dt> | |
| 95 <dd> | |
| 96 emitted after the | |
| 97 commandline completion list and the reworked search string was | |
| 98 received from the client | |
| 99 </dd> | |
| 100 <dt>clientDebuggerId(debuggerId)</dt> | |
| 101 <dd> | |
| 102 emitted to indicate a newly connected | |
| 103 debugger backend | |
| 104 </dd> | |
| 105 <dt>clientDisassembly(disassembly, debuggerId)</dt> | |
| 106 <dd> | |
| 107 emitted after the client | |
| 108 has sent a disassembly of the code raising an exception | |
| 109 </dd> | |
| 110 <dt>clientDisconnected(str)</dt> | |
| 111 <dd> | |
| 112 emitted after a debug client has | |
| 113 disconnected (i.e. closed the network socket) | |
| 114 </dd> | |
| 115 <dt>clientException(exceptionType, exceptionMessage, stackTrace,debuggerId, threadName)</dt> | |
| 116 <dd> | |
| 117 emitted after an exception occured on the | |
| 118 client side | |
| 119 </dd> | |
| 120 <dt>clientExit(str, int, str, bool, str)</dt> | |
| 121 <dd> | |
| 122 emitted after the client has | |
| 123 exited giving the program name, the exit status, an exit message, an | |
| 124 indication to be quiet and the ID of the exited client | |
| 125 </dd> | |
| 126 <dt>clientGone(bool)</dt> | |
| 127 <dd> | |
| 128 emitted if the client went away (planned or | |
| 129 unplanned) | |
| 130 </dd> | |
| 131 <dt>clientInterpreterChanged(str)</dt> | |
| 132 <dd> | |
| 133 emitted to signal a change of the | |
| 134 client interpreter | |
| 135 </dd> | |
| 136 <dt>clientLine(filename, lineno, debuggerId, threadName, forStack)</dt> | |
| 137 <dd> | |
| 138 emitted after the debug client has executed a line of code | |
| 139 </dd> | |
| 140 <dt>clientOutput(str)</dt> | |
| 141 <dd> | |
| 142 emitted after the client has sent some output | |
| 143 </dd> | |
| 144 <dt>clientProcessStderr(str)</dt> | |
| 145 <dd> | |
| 146 emitted after the client has sent some | |
| 147 output via stderr | |
| 148 </dd> | |
| 149 <dt>clientProcessStdout(str)</dt> | |
| 150 <dd> | |
| 151 emitted after the client has sent some | |
| 152 output via stdout | |
| 153 </dd> | |
| 154 <dt>clientRawInput(prompt, echo, debuggerId)</dt> | |
| 155 <dd> | |
| 156 emitted after a raw input | |
| 157 request was received | |
| 158 </dd> | |
| 159 <dt>clientRawInputSent(debuggerId)</dt> | |
| 160 <dd> | |
| 161 emitted after the data was sent | |
| 162 to the indicated debug client | |
| 163 </dd> | |
| 164 <dt>clientSignal(message, filename, linenumber, function name,function arguments, debuggerId)</dt> | |
| 165 <dd> | |
| 166 emitted after a signal has been | |
| 167 generated on the client side | |
| 168 </dd> | |
| 169 <dt>clientStack(stack, debuggerId, threadName)</dt> | |
| 170 <dd> | |
| 171 emitted after the | |
| 172 debug client has executed a line of code | |
| 173 </dd> | |
| 174 <dt>clientStatement(continue, debuggerId)</dt> | |
| 175 <dd> | |
| 176 emitted after an interactive | |
| 177 command has been executed. The parameter is False to indicate that the | |
| 178 command is complete and True if it needs more input. | |
| 179 </dd> | |
| 180 <dt>clientSyntaxError(message, filename, linenumber, characternumber,debuggerId, threadName)</dt> | |
| 181 <dd> | |
| 182 emitted after a syntax error has been detected | |
| 183 on the client side | |
| 184 </dd> | |
| 185 <dt>clientThreadList(currentId, threadList, debuggerId)</dt> | |
| 186 <dd> | |
| 187 emitted after | |
| 188 a thread list has been received | |
| 189 </dd> | |
| 190 <dt>clientThreadSet(debuggerId)</dt> | |
| 191 <dd> | |
| 192 emitted after the client has | |
| 193 acknowledged the change of the current thread | |
| 194 </dd> | |
| 195 <dt>clientVariable(scope, variables, debuggerId)</dt> | |
| 196 <dd> | |
| 197 emitted after a dump | |
| 198 for one class variable has been received | |
| 199 </dd> | |
| 200 <dt>clientVariables(scope, variables, debuggerId)</dt> | |
| 201 <dd> | |
| 202 emitted after a | |
| 203 variables dump has been received | |
| 204 </dd> | |
| 205 <dt>clientWatchConditionError(condition, debuggerId)</dt> | |
| 206 <dd> | |
| 207 emitted after the | |
| 208 client has signaled a syntax error in a watch expression | |
| 209 </dd> | |
| 210 <dt>lastClientExited()</dt> | |
| 211 <dd> | |
| 212 emitted to indicate that the last connected | |
| 213 debug client has terminated | |
| 214 </dd> | |
| 215 <dt>mainClientExit()</dt> | |
| 216 <dd> | |
| 217 emitted to indicate that the main client process | |
| 218 has exited | |
| 219 </dd> | |
| 220 <dt>passiveDebugStarted(str, bool)</dt> | |
| 221 <dd> | |
| 222 emitted after the debug client has | |
| 223 connected in passive debug mode | |
| 224 </dd> | |
| 225 <dt>utDiscovered(testCases, exc_type, exc_value)</dt> | |
| 226 <dd> | |
| 227 emitted after the | |
| 228 client has performed a test case discovery action | |
| 229 </dd> | |
| 230 <dt>utFinished()</dt> | |
| 231 <dd> | |
| 232 emitted after the client signalled the end of the | |
| 233 unittest | |
| 234 </dd> | |
| 235 <dt>utPrepared(nrTests, exc_type, exc_value)</dt> | |
| 236 <dd> | |
| 237 emitted after the client | |
| 238 has loaded a unittest suite | |
| 239 </dd> | |
| 240 <dt>utStartTest(testname, testdocu)</dt> | |
| 241 <dd> | |
| 242 emitted after the client has | |
| 243 started a test | |
| 244 </dd> | |
| 245 <dt>utStopTest()</dt> | |
| 246 <dd> | |
| 247 emitted after the client has finished a test | |
| 248 </dd> | |
| 249 <dt>utTestErrored(testname, exc_info, id)</dt> | |
| 250 <dd> | |
| 251 emitted after the client | |
| 252 reported an errored test | |
| 253 </dd> | |
| 254 <dt>utTestFailed(testname, exc_info, id)</dt> | |
| 255 <dd> | |
| 256 emitted after the client | |
| 257 reported a failed test | |
| 258 </dd> | |
| 259 <dt>utTestFailedExpected(testname, exc_info, id)</dt> | |
| 260 <dd> | |
| 261 emitted after the | |
| 262 client reported an expected test failure | |
| 263 </dd> | |
| 264 <dt>utTestSkipped(testname, reason, id)</dt> | |
| 265 <dd> | |
| 266 emitted after the client | |
| 267 reported a skipped test | |
| 268 </dd> | |
| 269 <dt>utTestSucceededUnexpected(testname, id)</dt> | |
| 270 <dd> | |
| 271 emitted after the client | |
| 272 reported an unexpected test success | |
| 273 </dd> | |
| 274 </dl> | |
| 275 <h3>Derived from</h3> | |
| 276 QTcpServer | |
| 277 <h3>Class Attributes</h3> | |
| 278 | |
| 279 <table> | |
| 280 <tr><td>None</td></tr> | |
| 281 </table> | |
| 282 <h3>Class Methods</h3> | |
| 283 | |
| 284 <table> | |
| 285 <tr><td>None</td></tr> | |
| 286 </table> | |
| 287 <h3>Methods</h3> | |
| 288 | |
| 289 <table> | |
| 290 | |
| 291 <tr> | |
| 292 <td><a href="#DebugServer.__init__">DebugServer</a></td> | |
| 293 <td>Constructor</td> | |
| 294 </tr> | |
| 295 <tr> | |
| 296 <td><a href="#DebugServer.__addBreakPoints">__addBreakPoints</a></td> | |
| 297 <td>Private slot to add breakpoints.</td> | |
| 298 </tr> | |
| 299 <tr> | |
| 300 <td><a href="#DebugServer.__addWatchPoints">__addWatchPoints</a></td> | |
| 301 <td>Private slot to set a watch expression.</td> | |
| 302 </tr> | |
| 303 <tr> | |
| 304 <td><a href="#DebugServer.__breakPointDataAboutToBeChanged">__breakPointDataAboutToBeChanged</a></td> | |
| 305 <td>Private slot to handle the dataAboutToBeChanged signal of the breakpoint model.</td> | |
| 306 </tr> | |
| 307 <tr> | |
| 308 <td><a href="#DebugServer.__changeBreakPoints">__changeBreakPoints</a></td> | |
| 309 <td>Private slot to set changed breakpoints.</td> | |
| 310 </tr> | |
| 311 <tr> | |
| 312 <td><a href="#DebugServer.__changeWatchPoints">__changeWatchPoints</a></td> | |
| 313 <td>Private slot to set changed watch expressions.</td> | |
| 314 </tr> | |
| 315 <tr> | |
| 316 <td><a href="#DebugServer.__clientClearBreakPoint">__clientClearBreakPoint</a></td> | |
| 317 <td>Private slot to handle the clientClearBreak signal.</td> | |
| 318 </tr> | |
| 319 <tr> | |
| 320 <td><a href="#DebugServer.__clientClearWatchPoint">__clientClearWatchPoint</a></td> | |
| 321 <td>Private slot to handle the clientClearWatch signal.</td> | |
| 322 </tr> | |
| 323 <tr> | |
| 324 <td><a href="#DebugServer.__clientProcessError">__clientProcessError</a></td> | |
| 325 <td>Private slot to process client output received via stderr.</td> | |
| 326 </tr> | |
| 327 <tr> | |
| 328 <td><a href="#DebugServer.__clientProcessOutput">__clientProcessOutput</a></td> | |
| 329 <td>Private slot to process client output received via stdout.</td> | |
| 330 </tr> | |
| 331 <tr> | |
| 332 <td><a href="#DebugServer.__createDebuggerInterface">__createDebuggerInterface</a></td> | |
| 333 <td>Private slot to create the debugger interface object.</td> | |
| 334 </tr> | |
| 335 <tr> | |
| 336 <td><a href="#DebugServer.__deleteBreakPoints">__deleteBreakPoints</a></td> | |
| 337 <td>Private slot to delete breakpoints.</td> | |
| 338 </tr> | |
| 339 <tr> | |
| 340 <td><a href="#DebugServer.__deleteWatchPoints">__deleteWatchPoints</a></td> | |
| 341 <td>Private slot to delete watch expressions.</td> | |
| 342 </tr> | |
| 343 <tr> | |
| 344 <td><a href="#DebugServer.__findLanguageForExtension">__findLanguageForExtension</a></td> | |
| 345 <td>Private method to get the language associated with a file extension.</td> | |
| 346 </tr> | |
| 347 <tr> | |
| 348 <td><a href="#DebugServer.__getNetworkInterfaceAndIndex">__getNetworkInterfaceAndIndex</a></td> | |
| 349 <td>Private method to determine the network interface and the interface index.</td> | |
| 350 </tr> | |
| 351 <tr> | |
| 352 <td><a href="#DebugServer.__makeWatchCondition">__makeWatchCondition</a></td> | |
| 353 <td>Private method to construct the condition string.</td> | |
| 354 </tr> | |
| 355 <tr> | |
| 356 <td><a href="#DebugServer.__newConnection">__newConnection</a></td> | |
| 357 <td>Private slot to handle a new connection.</td> | |
| 358 </tr> | |
| 359 <tr> | |
| 360 <td><a href="#DebugServer.__passiveShutDown">__passiveShutDown</a></td> | |
| 361 <td>Private method to shut down a passive debug connection.</td> | |
| 362 </tr> | |
| 363 <tr> | |
| 364 <td><a href="#DebugServer.__registerDebuggerInterfaces">__registerDebuggerInterfaces</a></td> | |
| 365 <td>Private method to register the available internal debugger interfaces.</td> | |
| 366 </tr> | |
| 367 <tr> | |
| 368 <td><a href="#DebugServer.__remoteBreakpointEnable">__remoteBreakpointEnable</a></td> | |
| 369 <td>Private method to enable or disable a breakpoint.</td> | |
| 370 </tr> | |
| 371 <tr> | |
| 372 <td><a href="#DebugServer.__remoteBreakpointIgnore">__remoteBreakpointIgnore</a></td> | |
| 373 <td>Private method to ignore a breakpoint the next couple of occurrences.</td> | |
| 374 </tr> | |
| 375 <tr> | |
| 376 <td><a href="#DebugServer.__remoteWatchpoint">__remoteWatchpoint</a></td> | |
| 377 <td>Private method to set or clear a watch expression.</td> | |
| 378 </tr> | |
| 379 <tr> | |
| 380 <td><a href="#DebugServer.__remoteWatchpointEnable">__remoteWatchpointEnable</a></td> | |
| 381 <td>Private method to enable or disable a watch expression.</td> | |
| 382 </tr> | |
| 383 <tr> | |
| 384 <td><a href="#DebugServer.__remoteWatchpointIgnore">__remoteWatchpointIgnore</a></td> | |
| 385 <td>Private method to ignore a watch expression the next couple of occurrences.</td> | |
| 386 </tr> | |
| 387 <tr> | |
| 388 <td><a href="#DebugServer.__restoreBreakpoints">__restoreBreakpoints</a></td> | |
| 389 <td>Private method to restore the breakpoints after a restart.</td> | |
| 390 </tr> | |
| 391 <tr> | |
| 392 <td><a href="#DebugServer.__restoreNoDebugList">__restoreNoDebugList</a></td> | |
| 393 <td>Private method to restore the list of scripts not to be debugged after a restart.</td> | |
| 394 </tr> | |
| 395 <tr> | |
| 396 <td><a href="#DebugServer.__restoreWatchpoints">__restoreWatchpoints</a></td> | |
| 397 <td>Private method to restore the watch expressions after a restart.</td> | |
| 398 </tr> | |
| 399 <tr> | |
| 400 <td><a href="#DebugServer.__setClientType">__setClientType</a></td> | |
| 401 <td>Private method to set the client type.</td> | |
| 402 </tr> | |
| 403 <tr> | |
| 404 <td><a href="#DebugServer.__splitWatchCondition">__splitWatchCondition</a></td> | |
| 405 <td>Private method to split a remote watch expression.</td> | |
| 406 </tr> | |
| 407 <tr> | |
| 408 <td><a href="#DebugServer.__watchPointDataAboutToBeChanged">__watchPointDataAboutToBeChanged</a></td> | |
| 409 <td>Private slot to handle the dataAboutToBeChanged signal of the watch expression model.</td> | |
| 410 </tr> | |
| 411 <tr> | |
| 412 <td><a href="#DebugServer.clientUtDiscovered">clientUtDiscovered</a></td> | |
| 413 <td>Public method to process the client unittest discover info.</td> | |
| 414 </tr> | |
| 415 <tr> | |
| 416 <td><a href="#DebugServer.clientUtFinished">clientUtFinished</a></td> | |
| 417 <td>Public method to process the client unit test finished info.</td> | |
| 418 </tr> | |
| 419 <tr> | |
| 420 <td><a href="#DebugServer.clientUtPrepared">clientUtPrepared</a></td> | |
| 421 <td>Public method to process the client unittest prepared info.</td> | |
| 422 </tr> | |
| 423 <tr> | |
| 424 <td><a href="#DebugServer.clientUtStartTest">clientUtStartTest</a></td> | |
| 425 <td>Public method to process the client start test info.</td> | |
| 426 </tr> | |
| 427 <tr> | |
| 428 <td><a href="#DebugServer.clientUtStopTest">clientUtStopTest</a></td> | |
| 429 <td>Public method to process the client stop test info.</td> | |
| 430 </tr> | |
| 431 <tr> | |
| 432 <td><a href="#DebugServer.clientUtTestErrored">clientUtTestErrored</a></td> | |
| 433 <td>Public method to process the client test errored info.</td> | |
| 434 </tr> | |
| 435 <tr> | |
| 436 <td><a href="#DebugServer.clientUtTestFailed">clientUtTestFailed</a></td> | |
| 437 <td>Public method to process the client test failed info.</td> | |
| 438 </tr> | |
| 439 <tr> | |
| 440 <td><a href="#DebugServer.clientUtTestFailedExpected">clientUtTestFailedExpected</a></td> | |
| 441 <td>Public method to process the client test failed expected info.</td> | |
| 442 </tr> | |
| 443 <tr> | |
| 444 <td><a href="#DebugServer.clientUtTestSkipped">clientUtTestSkipped</a></td> | |
| 445 <td>Public method to process the client test skipped info.</td> | |
| 446 </tr> | |
| 447 <tr> | |
| 448 <td><a href="#DebugServer.clientUtTestSucceededUnexpected">clientUtTestSucceededUnexpected</a></td> | |
| 449 <td>Public method to process the client test succeeded unexpected info.</td> | |
| 450 </tr> | |
| 451 <tr> | |
| 452 <td><a href="#DebugServer.getBreakPointModel">getBreakPointModel</a></td> | |
| 453 <td>Public slot to get a reference to the breakpoint model object.</td> | |
| 454 </tr> | |
| 455 <tr> | |
| 456 <td><a href="#DebugServer.getClientCapabilities">getClientCapabilities</a></td> | |
| 457 <td>Public method to retrieve the debug clients capabilities.</td> | |
| 458 </tr> | |
| 459 <tr> | |
| 460 <td><a href="#DebugServer.getClientInterpreter">getClientInterpreter</a></td> | |
| 461 <td>Public method to get the interpreter of the debug client.</td> | |
| 462 </tr> | |
| 463 <tr> | |
| 464 <td><a href="#DebugServer.getClientType">getClientType</a></td> | |
| 465 <td>Public method to get the currently running debug client type.</td> | |
| 466 </tr> | |
| 467 <tr> | |
| 468 <td><a href="#DebugServer.getDebuggerIds">getDebuggerIds</a></td> | |
| 469 <td>Public method to return the IDs of the connected debugger backends.</td> | |
| 470 </tr> | |
| 471 <tr> | |
| 472 <td><a href="#DebugServer.getExtensions">getExtensions</a></td> | |
| 473 <td>Public slot to get the extensions associated with the given language.</td> | |
| 474 </tr> | |
| 475 <tr> | |
| 476 <td><a href="#DebugServer.getHostAddress">getHostAddress</a></td> | |
| 477 <td>Public method to get the IP address or hostname the debug server is listening.</td> | |
| 478 </tr> | |
| 479 <tr> | |
| 480 <td><a href="#DebugServer.getSupportedLanguages">getSupportedLanguages</a></td> | |
| 481 <td>Public slot to return the supported programming languages.</td> | |
| 482 </tr> | |
| 483 <tr> | |
| 484 <td><a href="#DebugServer.getWatchPointModel">getWatchPointModel</a></td> | |
| 485 <td>Public slot to get a reference to the watch expression model object.</td> | |
| 486 </tr> | |
| 487 <tr> | |
| 488 <td><a href="#DebugServer.initializeClient">initializeClient</a></td> | |
| 489 <td>Public method to initialize a freshly connected debug client.</td> | |
| 490 </tr> | |
| 491 <tr> | |
| 492 <td><a href="#DebugServer.isClientProcessUp">isClientProcessUp</a></td> | |
| 493 <td>Public method to check, if the debug client process is up.</td> | |
| 494 </tr> | |
| 495 <tr> | |
| 496 <td><a href="#DebugServer.isConnected">isConnected</a></td> | |
| 497 <td>Public method to test, if the debug server is connected to a backend.</td> | |
| 498 </tr> | |
| 499 <tr> | |
| 500 <td><a href="#DebugServer.isDebugging">isDebugging</a></td> | |
| 501 <td>Public method to test, if the debug server is debugging.</td> | |
| 502 </tr> | |
| 503 <tr> | |
| 504 <td><a href="#DebugServer.masterClientConnected">masterClientConnected</a></td> | |
| 505 <td>Public method to perform actions after the master client has finally established the connection.</td> | |
| 506 </tr> | |
| 507 <tr> | |
| 508 <td><a href="#DebugServer.passiveStartUp">passiveStartUp</a></td> | |
| 509 <td>Public method to handle a passive debug connection.</td> | |
| 510 </tr> | |
| 511 <tr> | |
| 512 <td><a href="#DebugServer.preferencesChanged">preferencesChanged</a></td> | |
| 513 <td>Public slot to handle the preferencesChanged signal.</td> | |
| 514 </tr> | |
| 515 <tr> | |
| 516 <td><a href="#DebugServer.registerDebuggerInterface">registerDebuggerInterface</a></td> | |
| 517 <td>Public method to register a debugger interface.</td> | |
| 518 </tr> | |
| 519 <tr> | |
| 520 <td><a href="#DebugServer.remoteBanner">remoteBanner</a></td> | |
| 521 <td>Public slot to get the banner info of the remote client.</td> | |
| 522 </tr> | |
| 523 <tr> | |
| 524 <td><a href="#DebugServer.remoteBreakpoint">remoteBreakpoint</a></td> | |
| 525 <td>Public method to set or clear a breakpoint.</td> | |
| 526 </tr> | |
| 527 <tr> | |
| 528 <td><a href="#DebugServer.remoteCapabilities">remoteCapabilities</a></td> | |
| 529 <td>Public slot to get the debug clients capabilities.</td> | |
| 530 </tr> | |
| 531 <tr> | |
| 532 <td><a href="#DebugServer.remoteClientDisassembly">remoteClientDisassembly</a></td> | |
| 533 <td>Public method to ask the client for the latest traceback disassembly.</td> | |
| 534 </tr> | |
| 535 <tr> | |
| 536 <td><a href="#DebugServer.remoteClientSetFilter">remoteClientSetFilter</a></td> | |
| 537 <td>Public method to set a variables filter list.</td> | |
| 538 </tr> | |
| 539 <tr> | |
| 540 <td><a href="#DebugServer.remoteClientStack">remoteClientStack</a></td> | |
| 541 <td>Public method to request the stack of the main thread.</td> | |
| 542 </tr> | |
| 543 <tr> | |
| 544 <td><a href="#DebugServer.remoteClientVariable">remoteClientVariable</a></td> | |
| 545 <td>Public method to request the variables of the debugged program.</td> | |
| 546 </tr> | |
| 547 <tr> | |
| 548 <td><a href="#DebugServer.remoteClientVariables">remoteClientVariables</a></td> | |
| 549 <td>Public method to request the variables of the debugged program.</td> | |
| 550 </tr> | |
| 551 <tr> | |
| 552 <td><a href="#DebugServer.remoteCompletion">remoteCompletion</a></td> | |
| 553 <td>Public slot to get the a list of possible commandline completions from the remote client.</td> | |
| 554 </tr> | |
| 555 <tr> | |
| 556 <td><a href="#DebugServer.remoteContinue">remoteContinue</a></td> | |
| 557 <td>Public method to continue the debugged program.</td> | |
| 558 </tr> | |
| 559 <tr> | |
| 560 <td><a href="#DebugServer.remoteContinueUntil">remoteContinueUntil</a></td> | |
| 561 <td>Public method to continue the debugged program to the given line or until returning from the current frame.</td> | |
| 562 </tr> | |
| 563 <tr> | |
| 564 <td><a href="#DebugServer.remoteCoverage">remoteCoverage</a></td> | |
| 565 <td>Public method to load a new program to collect coverage data.</td> | |
| 566 </tr> | |
| 567 <tr> | |
| 568 <td><a href="#DebugServer.remoteEnvironment">remoteEnvironment</a></td> | |
| 569 <td>Public method to set the environment for a program to debug, run, ...</td> | |
| 570 </tr> | |
| 571 <tr> | |
| 572 <td><a href="#DebugServer.remoteLoad">remoteLoad</a></td> | |
| 573 <td>Public method to load a new program to debug.</td> | |
| 574 </tr> | |
| 575 <tr> | |
| 576 <td><a href="#DebugServer.remoteMoveIP">remoteMoveIP</a></td> | |
| 577 <td>Public method to move the instruction pointer to a different line.</td> | |
| 578 </tr> | |
| 579 <tr> | |
| 580 <td><a href="#DebugServer.remoteProfile">remoteProfile</a></td> | |
| 581 <td>Public method to load a new program to collect profiling data.</td> | |
| 582 </tr> | |
| 583 <tr> | |
| 584 <td><a href="#DebugServer.remoteRawInput">remoteRawInput</a></td> | |
| 585 <td>Public method to send the raw input to the debugged program.</td> | |
| 586 </tr> | |
| 587 <tr> | |
| 588 <td><a href="#DebugServer.remoteRun">remoteRun</a></td> | |
| 589 <td>Public method to load a new program to run.</td> | |
| 590 </tr> | |
| 591 <tr> | |
| 592 <td><a href="#DebugServer.remoteSetThread">remoteSetThread</a></td> | |
| 593 <td>Public method to request to set the given thread as current thread.</td> | |
| 594 </tr> | |
| 595 <tr> | |
| 596 <td><a href="#DebugServer.remoteStatement">remoteStatement</a></td> | |
| 597 <td>Public method to execute a Python statement.</td> | |
| 598 </tr> | |
| 599 <tr> | |
| 600 <td><a href="#DebugServer.remoteStep">remoteStep</a></td> | |
| 601 <td>Public method to single step the debugged program.</td> | |
| 602 </tr> | |
| 603 <tr> | |
| 604 <td><a href="#DebugServer.remoteStepOut">remoteStepOut</a></td> | |
| 605 <td>Public method to step out the debugged program.</td> | |
| 606 </tr> | |
| 607 <tr> | |
| 608 <td><a href="#DebugServer.remoteStepOver">remoteStepOver</a></td> | |
| 609 <td>Public method to step over the debugged program.</td> | |
| 610 </tr> | |
| 611 <tr> | |
| 612 <td><a href="#DebugServer.remoteStepQuit">remoteStepQuit</a></td> | |
| 613 <td>Public method to stop the debugged program.</td> | |
| 614 </tr> | |
| 615 <tr> | |
| 616 <td><a href="#DebugServer.remoteThreadList">remoteThreadList</a></td> | |
| 617 <td>Public method to request the list of threads from the client.</td> | |
| 618 </tr> | |
| 619 <tr> | |
| 620 <td><a href="#DebugServer.remoteUTDiscover">remoteUTDiscover</a></td> | |
| 621 <td>Public method to perform a test case discovery.</td> | |
| 622 </tr> | |
| 623 <tr> | |
| 624 <td><a href="#DebugServer.remoteUTPrepare">remoteUTPrepare</a></td> | |
| 625 <td>Public method to prepare a new unittest run.</td> | |
| 626 </tr> | |
| 627 <tr> | |
| 628 <td><a href="#DebugServer.remoteUTRun">remoteUTRun</a></td> | |
| 629 <td>Public method to start a unittest run.</td> | |
| 630 </tr> | |
| 631 <tr> | |
| 632 <td><a href="#DebugServer.remoteUTStop">remoteUTStop</a></td> | |
| 633 <td>public method to stop a unittest run.</td> | |
| 634 </tr> | |
| 635 <tr> | |
| 636 <td><a href="#DebugServer.setCallTraceEnabled">setCallTraceEnabled</a></td> | |
| 637 <td>Public method to set the call trace state.</td> | |
| 638 </tr> | |
| 639 <tr> | |
| 640 <td><a href="#DebugServer.setDebugging">setDebugging</a></td> | |
| 641 <td>Public method to set the debugging state.</td> | |
| 642 </tr> | |
| 643 <tr> | |
| 644 <td><a href="#DebugServer.shutdownServer">shutdownServer</a></td> | |
| 645 <td>Public method to cleanly shut down.</td> | |
| 646 </tr> | |
| 647 <tr> | |
| 648 <td><a href="#DebugServer.signalClientBanner">signalClientBanner</a></td> | |
| 649 <td>Public method to process the client banner info.</td> | |
| 650 </tr> | |
| 651 <tr> | |
| 652 <td><a href="#DebugServer.signalClientBreakConditionError">signalClientBreakConditionError</a></td> | |
| 653 <td>Public method to process the client breakpoint condition error info.</td> | |
| 654 </tr> | |
| 655 <tr> | |
| 656 <td><a href="#DebugServer.signalClientCallTrace">signalClientCallTrace</a></td> | |
| 657 <td>Public method to process the client call trace data.</td> | |
| 658 </tr> | |
| 659 <tr> | |
| 660 <td><a href="#DebugServer.signalClientCapabilities">signalClientCapabilities</a></td> | |
| 661 <td>Public method to process the client capabilities info.</td> | |
| 662 </tr> | |
| 663 <tr> | |
| 664 <td><a href="#DebugServer.signalClientClearBreak">signalClientClearBreak</a></td> | |
| 665 <td>Public method to process the client clear breakpoint command.</td> | |
| 666 </tr> | |
| 667 <tr> | |
| 668 <td><a href="#DebugServer.signalClientClearWatch">signalClientClearWatch</a></td> | |
| 669 <td>Public slot to handle the clientClearWatch signal.</td> | |
| 670 </tr> | |
| 671 <tr> | |
| 672 <td><a href="#DebugServer.signalClientCompletionList">signalClientCompletionList</a></td> | |
| 673 <td>Public method to process the client auto completion info.</td> | |
| 674 </tr> | |
| 675 <tr> | |
| 676 <td><a href="#DebugServer.signalClientDebuggerId">signalClientDebuggerId</a></td> | |
| 677 <td>Public method to signal the receipt of a new debugger ID.</td> | |
| 678 </tr> | |
| 679 <tr> | |
| 680 <td><a href="#DebugServer.signalClientDisassembly">signalClientDisassembly</a></td> | |
| 681 <td>Public method to process the disassembly info from the client.</td> | |
| 682 </tr> | |
| 683 <tr> | |
| 684 <td><a href="#DebugServer.signalClientDisconnected">signalClientDisconnected</a></td> | |
| 685 <td>Public method to send a signal when a debug client has closed its connection.</td> | |
| 686 </tr> | |
| 687 <tr> | |
| 688 <td><a href="#DebugServer.signalClientException">signalClientException</a></td> | |
| 689 <td>Public method to process the exception info from the client.</td> | |
| 690 </tr> | |
| 691 <tr> | |
| 692 <td><a href="#DebugServer.signalClientExit">signalClientExit</a></td> | |
| 693 <td>Public method to process the client exit status.</td> | |
| 694 </tr> | |
| 695 <tr> | |
| 696 <td><a href="#DebugServer.signalClientLine">signalClientLine</a></td> | |
| 697 <td>Public method to process client position feedback.</td> | |
| 698 </tr> | |
| 699 <tr> | |
| 700 <td><a href="#DebugServer.signalClientOutput">signalClientOutput</a></td> | |
| 701 <td>Public method to process a line of client output.</td> | |
| 702 </tr> | |
| 703 <tr> | |
| 704 <td><a href="#DebugServer.signalClientRawInput">signalClientRawInput</a></td> | |
| 705 <td>Public method to process the client raw input command.</td> | |
| 706 </tr> | |
| 707 <tr> | |
| 708 <td><a href="#DebugServer.signalClientSignal">signalClientSignal</a></td> | |
| 709 <td>Public method to process a signal generated on the client side.</td> | |
| 710 </tr> | |
| 711 <tr> | |
| 712 <td><a href="#DebugServer.signalClientStack">signalClientStack</a></td> | |
| 713 <td>Public method to process a client's stack information.</td> | |
| 714 </tr> | |
| 715 <tr> | |
| 716 <td><a href="#DebugServer.signalClientStatement">signalClientStatement</a></td> | |
| 717 <td>Public method to process the input response from the client.</td> | |
| 718 </tr> | |
| 719 <tr> | |
| 720 <td><a href="#DebugServer.signalClientSyntaxError">signalClientSyntaxError</a></td> | |
| 721 <td>Public method to process a syntax error info from the client.</td> | |
| 722 </tr> | |
| 723 <tr> | |
| 724 <td><a href="#DebugServer.signalClientThreadList">signalClientThreadList</a></td> | |
| 725 <td>Public method to process the client thread list info.</td> | |
| 726 </tr> | |
| 727 <tr> | |
| 728 <td><a href="#DebugServer.signalClientThreadSet">signalClientThreadSet</a></td> | |
| 729 <td>Public method to handle the change of the client thread.</td> | |
| 730 </tr> | |
| 731 <tr> | |
| 732 <td><a href="#DebugServer.signalClientVariable">signalClientVariable</a></td> | |
| 733 <td>Public method to process the client variable info.</td> | |
| 734 </tr> | |
| 735 <tr> | |
| 736 <td><a href="#DebugServer.signalClientVariables">signalClientVariables</a></td> | |
| 737 <td>Public method to process the client variables info.</td> | |
| 738 </tr> | |
| 739 <tr> | |
| 740 <td><a href="#DebugServer.signalClientWatchConditionError">signalClientWatchConditionError</a></td> | |
| 741 <td>Public method to process the client watch expression error info.</td> | |
| 742 </tr> | |
| 743 <tr> | |
| 744 <td><a href="#DebugServer.signalLastClientExited">signalLastClientExited</a></td> | |
| 745 <td>Public method to process the last client exit event.</td> | |
| 746 </tr> | |
| 747 <tr> | |
| 748 <td><a href="#DebugServer.signalMainClientExit">signalMainClientExit</a></td> | |
| 749 <td>Public method to process the main client exiting.</td> | |
| 750 </tr> | |
| 751 <tr> | |
| 752 <td><a href="#DebugServer.startClient">startClient</a></td> | |
| 753 <td>Public method to start a debug client.</td> | |
| 754 </tr> | |
| 755 <tr> | |
| 756 <td><a href="#DebugServer.unregisterDebuggerInterface">unregisterDebuggerInterface</a></td> | |
| 757 <td>Public method to unregister a debugger interface.</td> | |
| 758 </tr> | |
| 759 </table> | |
| 760 <h3>Static Methods</h3> | |
| 761 | |
| 762 <table> | |
| 763 <tr><td>None</td></tr> | |
| 764 </table> | |
| 765 | |
| 766 <a NAME="DebugServer.__init__" ID="DebugServer.__init__"></a> | |
| 767 <h4>DebugServer (Constructor)</h4> | |
| 768 <b>DebugServer</b>(<i>originalPathString, preventPassiveDebugging=False, project=None, parent=None</i>) | |
| 769 | |
| 770 <p> | |
| 771 Constructor | |
| 772 </p> | |
| 773 <dl> | |
| 774 | |
| 775 <dt><i>originalPathString</i> (str)</dt> | |
| 776 <dd> | |
| 777 original PATH environment variable | |
| 778 </dd> | |
| 779 <dt><i>preventPassiveDebugging</i> (bool (optional))</dt> | |
| 780 <dd> | |
| 781 flag overriding the PassiveDbgEnabled | |
| 782 setting (defaults to False) | |
| 783 </dd> | |
| 784 <dt><i>project</i> (Project (optional))</dt> | |
| 785 <dd> | |
| 786 reference to the project object (defaults to None) | |
| 787 </dd> | |
| 788 <dt><i>parent</i> (QObject)</dt> | |
| 789 <dd> | |
| 790 reference to the parent object | |
| 791 </dd> | |
| 792 </dl> | |
| 793 <a NAME="DebugServer.__addBreakPoints" ID="DebugServer.__addBreakPoints"></a> | |
| 794 <h4>DebugServer.__addBreakPoints</h4> | |
| 795 <b>__addBreakPoints</b>(<i>parentIndex, start, end, debuggerId=""</i>) | |
| 796 | |
| 797 <p> | |
| 798 Private slot to add breakpoints. | |
| 799 </p> | |
| 800 <dl> | |
| 801 | |
| 802 <dt><i>parentIndex</i> (QModelIndex)</dt> | |
| 803 <dd> | |
| 804 index of parent item | |
| 805 </dd> | |
| 806 <dt><i>start</i> (int)</dt> | |
| 807 <dd> | |
| 808 start row | |
| 809 </dd> | |
| 810 <dt><i>end</i> (int)</dt> | |
| 811 <dd> | |
| 812 end row | |
| 813 </dd> | |
| 814 <dt><i>debuggerId</i> (str)</dt> | |
| 815 <dd> | |
| 816 ID of the debugger backend to send to. If this is | |
| 817 empty, they will be broadcast to all connected backends. | |
| 818 </dd> | |
| 819 </dl> | |
| 820 <a NAME="DebugServer.__addWatchPoints" ID="DebugServer.__addWatchPoints"></a> | |
| 821 <h4>DebugServer.__addWatchPoints</h4> | |
| 822 <b>__addWatchPoints</b>(<i>parentIndex, start, end, debuggerId=""</i>) | |
| 823 | |
| 824 <p> | |
| 825 Private slot to set a watch expression. | |
| 826 </p> | |
| 827 <dl> | |
| 828 | |
| 829 <dt><i>parentIndex</i> (QModelIndex)</dt> | |
| 830 <dd> | |
| 831 index of parent item | |
| 832 </dd> | |
| 833 <dt><i>start</i> (int)</dt> | |
| 834 <dd> | |
| 835 start row | |
| 836 </dd> | |
| 837 <dt><i>end</i> (int)</dt> | |
| 838 <dd> | |
| 839 end row | |
| 840 </dd> | |
| 841 <dt><i>debuggerId</i> (str)</dt> | |
| 842 <dd> | |
| 843 ID of the debugger backend to send to. If this is | |
| 844 empty, they will be broadcast to all connected backends. | |
| 845 </dd> | |
| 846 </dl> | |
| 847 <a NAME="DebugServer.__breakPointDataAboutToBeChanged" ID="DebugServer.__breakPointDataAboutToBeChanged"></a> | |
| 848 <h4>DebugServer.__breakPointDataAboutToBeChanged</h4> | |
| 849 <b>__breakPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>) | |
| 850 | |
| 851 <p> | |
| 852 Private slot to handle the dataAboutToBeChanged signal of the | |
| 853 breakpoint model. | |
| 854 </p> | |
| 855 <dl> | |
| 856 | |
| 857 <dt><i>startIndex</i> (QModelIndex)</dt> | |
| 858 <dd> | |
| 859 start index of the rows to be changed | |
| 860 </dd> | |
| 861 <dt><i>endIndex</i> (QModelIndex)</dt> | |
| 862 <dd> | |
| 863 end index of the rows to be changed | |
| 864 </dd> | |
| 865 </dl> | |
| 866 <a NAME="DebugServer.__changeBreakPoints" ID="DebugServer.__changeBreakPoints"></a> | |
| 867 <h4>DebugServer.__changeBreakPoints</h4> | |
| 868 <b>__changeBreakPoints</b>(<i>startIndex, endIndex</i>) | |
| 869 | |
| 870 <p> | |
| 871 Private slot to set changed breakpoints. | |
| 872 </p> | |
| 873 <dl> | |
| 874 | |
| 875 <dt><i>startIndex</i> (QModelIndex)</dt> | |
| 876 <dd> | |
| 877 starting index of the change breakpoins | |
| 878 </dd> | |
| 879 <dt><i>endIndex</i> (QModelIndex)</dt> | |
| 880 <dd> | |
| 881 ending index of the change breakpoins | |
| 882 </dd> | |
| 883 </dl> | |
| 884 <a NAME="DebugServer.__changeWatchPoints" ID="DebugServer.__changeWatchPoints"></a> | |
| 885 <h4>DebugServer.__changeWatchPoints</h4> | |
| 886 <b>__changeWatchPoints</b>(<i>startIndex, endIndex</i>) | |
| 887 | |
| 888 <p> | |
| 889 Private slot to set changed watch expressions. | |
| 890 </p> | |
| 891 <dl> | |
| 892 | |
| 893 <dt><i>startIndex</i> (QModelIndex)</dt> | |
| 894 <dd> | |
| 895 start index of the rows to be changed | |
| 896 </dd> | |
| 897 <dt><i>endIndex</i> (QModelIndex)</dt> | |
| 898 <dd> | |
| 899 end index of the rows to be changed | |
| 900 </dd> | |
| 901 </dl> | |
| 902 <a NAME="DebugServer.__clientClearBreakPoint" ID="DebugServer.__clientClearBreakPoint"></a> | |
| 903 <h4>DebugServer.__clientClearBreakPoint</h4> | |
| 904 <b>__clientClearBreakPoint</b>(<i>fn, lineno</i>) | |
| 905 | |
| 906 <p> | |
| 907 Private slot to handle the clientClearBreak signal. | |
| 908 </p> | |
| 909 <dl> | |
| 910 | |
| 911 <dt><i>fn</i> (str)</dt> | |
| 912 <dd> | |
| 913 filename of breakpoint to clear | |
| 914 </dd> | |
| 915 <dt><i>lineno</i> (int)</dt> | |
| 916 <dd> | |
| 917 line number of breakpoint to clear | |
| 918 </dd> | |
| 919 </dl> | |
| 920 <a NAME="DebugServer.__clientClearWatchPoint" ID="DebugServer.__clientClearWatchPoint"></a> | |
| 921 <h4>DebugServer.__clientClearWatchPoint</h4> | |
| 922 <b>__clientClearWatchPoint</b>(<i>condition</i>) | |
| 923 | |
| 924 <p> | |
| 925 Private slot to handle the clientClearWatch signal. | |
| 926 </p> | |
| 927 <dl> | |
| 928 | |
| 929 <dt><i>condition</i> (str)</dt> | |
| 930 <dd> | |
| 931 expression of watch expression to clear | |
| 932 </dd> | |
| 933 </dl> | |
| 934 <a NAME="DebugServer.__clientProcessError" ID="DebugServer.__clientProcessError"></a> | |
| 935 <h4>DebugServer.__clientProcessError</h4> | |
| 936 <b>__clientProcessError</b>(<i></i>) | |
| 937 | |
| 938 <p> | |
| 939 Private slot to process client output received via stderr. | |
| 940 </p> | |
| 941 <a NAME="DebugServer.__clientProcessOutput" ID="DebugServer.__clientProcessOutput"></a> | |
| 942 <h4>DebugServer.__clientProcessOutput</h4> | |
| 943 <b>__clientProcessOutput</b>(<i></i>) | |
| 944 | |
| 945 <p> | |
| 946 Private slot to process client output received via stdout. | |
| 947 </p> | |
| 948 <a NAME="DebugServer.__createDebuggerInterface" ID="DebugServer.__createDebuggerInterface"></a> | |
| 949 <h4>DebugServer.__createDebuggerInterface</h4> | |
| 950 <b>__createDebuggerInterface</b>(<i>clientType=None</i>) | |
| 951 | |
| 952 <p> | |
| 953 Private slot to create the debugger interface object. | |
| 954 </p> | |
| 955 <dl> | |
| 956 | |
| 957 <dt><i>clientType</i> (str)</dt> | |
| 958 <dd> | |
| 959 type of the client interface to be created | |
| 960 </dd> | |
| 961 </dl> | |
| 962 <a NAME="DebugServer.__deleteBreakPoints" ID="DebugServer.__deleteBreakPoints"></a> | |
| 963 <h4>DebugServer.__deleteBreakPoints</h4> | |
| 964 <b>__deleteBreakPoints</b>(<i>parentIndex, start, end</i>) | |
| 965 | |
| 966 <p> | |
| 967 Private slot to delete breakpoints. | |
| 968 </p> | |
| 969 <dl> | |
| 970 | |
| 971 <dt><i>parentIndex</i> (QModelIndex)</dt> | |
| 972 <dd> | |
| 973 index of parent item | |
| 974 </dd> | |
| 975 <dt><i>start</i> (int)</dt> | |
| 976 <dd> | |
| 977 start row | |
| 978 </dd> | |
| 979 <dt><i>end</i> (int)</dt> | |
| 980 <dd> | |
| 981 end row | |
| 982 </dd> | |
| 983 </dl> | |
| 984 <a NAME="DebugServer.__deleteWatchPoints" ID="DebugServer.__deleteWatchPoints"></a> | |
| 985 <h4>DebugServer.__deleteWatchPoints</h4> | |
| 986 <b>__deleteWatchPoints</b>(<i>parentIndex, start, end</i>) | |
| 987 | |
| 988 <p> | |
| 989 Private slot to delete watch expressions. | |
| 990 </p> | |
| 991 <dl> | |
| 992 | |
| 993 <dt><i>parentIndex</i> (QModelIndex)</dt> | |
| 994 <dd> | |
| 995 index of parent item | |
| 996 </dd> | |
| 997 <dt><i>start</i> (int)</dt> | |
| 998 <dd> | |
| 999 start row | |
| 1000 </dd> | |
| 1001 <dt><i>end</i> (int)</dt> | |
| 1002 <dd> | |
| 1003 end row | |
| 1004 </dd> | |
| 1005 </dl> | |
| 1006 <a NAME="DebugServer.__findLanguageForExtension" ID="DebugServer.__findLanguageForExtension"></a> | |
| 1007 <h4>DebugServer.__findLanguageForExtension</h4> | |
| 1008 <b>__findLanguageForExtension</b>(<i>ext</i>) | |
| 1009 | |
| 1010 <p> | |
| 1011 Private method to get the language associated with a file extension. | |
| 1012 </p> | |
| 1013 <dl> | |
| 1014 | |
| 1015 <dt><i>ext</i> (str)</dt> | |
| 1016 <dd> | |
| 1017 file extension | |
| 1018 </dd> | |
| 1019 </dl> | |
| 1020 <dl> | |
| 1021 <dt>Return:</dt> | |
| 1022 <dd> | |
| 1023 associated language | |
| 1024 </dd> | |
| 1025 </dl> | |
| 1026 <dl> | |
| 1027 <dt>Return Type:</dt> | |
| 1028 <dd> | |
| 1029 str | |
| 1030 </dd> | |
| 1031 </dl> | |
| 1032 <a NAME="DebugServer.__getNetworkInterfaceAndIndex" ID="DebugServer.__getNetworkInterfaceAndIndex"></a> | |
| 1033 <h4>DebugServer.__getNetworkInterfaceAndIndex</h4> | |
| 1034 <b>__getNetworkInterfaceAndIndex</b>(<i>address</i>) | |
| 1035 | |
| 1036 <p> | |
| 1037 Private method to determine the network interface and the interface | |
| 1038 index. | |
| 1039 </p> | |
| 1040 <dl> | |
| 1041 | |
| 1042 <dt><i>address</i> (str)</dt> | |
| 1043 <dd> | |
| 1044 address to determine the info for | |
| 1045 </dd> | |
| 1046 </dl> | |
| 1047 <dl> | |
| 1048 <dt>Return:</dt> | |
| 1049 <dd> | |
| 1050 tuple of network interface name and index | |
| 1051 </dd> | |
| 1052 </dl> | |
| 1053 <dl> | |
| 1054 <dt>Return Type:</dt> | |
| 1055 <dd> | |
| 1056 tuple of (str, int) | |
| 1057 </dd> | |
| 1058 </dl> | |
| 1059 <a NAME="DebugServer.__makeWatchCondition" ID="DebugServer.__makeWatchCondition"></a> | |
| 1060 <h4>DebugServer.__makeWatchCondition</h4> | |
| 1061 <b>__makeWatchCondition</b>(<i>cond, special</i>) | |
| 1062 | |
| 1063 <p> | |
| 1064 Private method to construct the condition string. | |
| 1065 </p> | |
| 1066 <dl> | |
| 1067 | |
| 1068 <dt><i>cond</i> (str)</dt> | |
| 1069 <dd> | |
| 1070 condition | |
| 1071 </dd> | |
| 1072 <dt><i>special</i> (str)</dt> | |
| 1073 <dd> | |
| 1074 special condition | |
| 1075 </dd> | |
| 1076 </dl> | |
| 1077 <dl> | |
| 1078 <dt>Return:</dt> | |
| 1079 <dd> | |
| 1080 condition string | |
| 1081 </dd> | |
| 1082 </dl> | |
| 1083 <dl> | |
| 1084 <dt>Return Type:</dt> | |
| 1085 <dd> | |
| 1086 str | |
| 1087 </dd> | |
| 1088 </dl> | |
| 1089 <a NAME="DebugServer.__newConnection" ID="DebugServer.__newConnection"></a> | |
| 1090 <h4>DebugServer.__newConnection</h4> | |
| 1091 <b>__newConnection</b>(<i></i>) | |
| 1092 | |
| 1093 <p> | |
| 1094 Private slot to handle a new connection. | |
| 1095 </p> | |
| 1096 <a NAME="DebugServer.__passiveShutDown" ID="DebugServer.__passiveShutDown"></a> | |
| 1097 <h4>DebugServer.__passiveShutDown</h4> | |
| 1098 <b>__passiveShutDown</b>(<i></i>) | |
| 1099 | |
| 1100 <p> | |
| 1101 Private method to shut down a passive debug connection. | |
| 1102 </p> | |
| 1103 <a NAME="DebugServer.__registerDebuggerInterfaces" ID="DebugServer.__registerDebuggerInterfaces"></a> | |
| 1104 <h4>DebugServer.__registerDebuggerInterfaces</h4> | |
| 1105 <b>__registerDebuggerInterfaces</b>(<i></i>) | |
| 1106 | |
| 1107 <p> | |
| 1108 Private method to register the available internal debugger interfaces. | |
| 1109 </p> | |
| 1110 <a NAME="DebugServer.__remoteBreakpointEnable" ID="DebugServer.__remoteBreakpointEnable"></a> | |
| 1111 <h4>DebugServer.__remoteBreakpointEnable</h4> | |
| 1112 <b>__remoteBreakpointEnable</b>(<i>debuggerId, fn, line, enable</i>) | |
| 1113 | |
| 1114 <p> | |
| 1115 Private method to enable or disable a breakpoint. | |
| 1116 </p> | |
| 1117 <dl> | |
| 1118 | |
| 1119 <dt><i>debuggerId</i> (str)</dt> | |
| 1120 <dd> | |
| 1121 ID of the debugger backend | |
| 1122 </dd> | |
| 1123 <dt><i>fn</i> (str)</dt> | |
| 1124 <dd> | |
| 1125 filename the breakpoint belongs to | |
| 1126 </dd> | |
| 1127 <dt><i>line</i> (int)</dt> | |
| 1128 <dd> | |
| 1129 linenumber of the breakpoint | |
| 1130 </dd> | |
| 1131 <dt><i>enable</i> (bool)</dt> | |
| 1132 <dd> | |
| 1133 flag indicating enabling or disabling a breakpoint | |
| 1134 </dd> | |
| 1135 </dl> | |
| 1136 <a NAME="DebugServer.__remoteBreakpointIgnore" ID="DebugServer.__remoteBreakpointIgnore"></a> | |
| 1137 <h4>DebugServer.__remoteBreakpointIgnore</h4> | |
| 1138 <b>__remoteBreakpointIgnore</b>(<i>debuggerId, fn, line, count</i>) | |
| 1139 | |
| 1140 <p> | |
| 1141 Private method to ignore a breakpoint the next couple of occurrences. | |
| 1142 </p> | |
| 1143 <dl> | |
| 1144 | |
| 1145 <dt><i>debuggerId</i> (str)</dt> | |
| 1146 <dd> | |
| 1147 ID of the debugger backend | |
| 1148 </dd> | |
| 1149 <dt><i>fn</i> (str)</dt> | |
| 1150 <dd> | |
| 1151 filename the breakpoint belongs to | |
| 1152 </dd> | |
| 1153 <dt><i>line</i> (int)</dt> | |
| 1154 <dd> | |
| 1155 linenumber of the breakpoint | |
| 1156 </dd> | |
| 1157 <dt><i>count</i> (int)</dt> | |
| 1158 <dd> | |
| 1159 number of occurrences to ignore | |
| 1160 </dd> | |
| 1161 </dl> | |
| 1162 <a NAME="DebugServer.__remoteWatchpoint" ID="DebugServer.__remoteWatchpoint"></a> | |
| 1163 <h4>DebugServer.__remoteWatchpoint</h4> | |
| 1164 <b>__remoteWatchpoint</b>(<i>debuggerId, cond, setWatch, temp=False</i>) | |
| 1165 | |
| 1166 <p> | |
| 1167 Private method to set or clear a watch expression. | |
| 1168 </p> | |
| 1169 <dl> | |
| 1170 | |
| 1171 <dt><i>debuggerId</i> (str)</dt> | |
| 1172 <dd> | |
| 1173 ID of the debugger backend | |
| 1174 </dd> | |
| 1175 <dt><i>cond</i> (str)</dt> | |
| 1176 <dd> | |
| 1177 expression of the watch expression | |
| 1178 </dd> | |
| 1179 <dt><i>setWatch</i> (bool)</dt> | |
| 1180 <dd> | |
| 1181 flag indicating setting or resetting a watch expression | |
| 1182 </dd> | |
| 1183 <dt><i>temp</i> (bool)</dt> | |
| 1184 <dd> | |
| 1185 flag indicating a temporary watch expression | |
| 1186 </dd> | |
| 1187 </dl> | |
| 1188 <a NAME="DebugServer.__remoteWatchpointEnable" ID="DebugServer.__remoteWatchpointEnable"></a> | |
| 1189 <h4>DebugServer.__remoteWatchpointEnable</h4> | |
| 1190 <b>__remoteWatchpointEnable</b>(<i>debuggerId, cond, enable</i>) | |
| 1191 | |
| 1192 <p> | |
| 1193 Private method to enable or disable a watch expression. | |
| 1194 </p> | |
| 1195 <dl> | |
| 1196 | |
| 1197 <dt><i>debuggerId</i> (str)</dt> | |
| 1198 <dd> | |
| 1199 ID of the debugger backend | |
| 1200 </dd> | |
| 1201 <dt><i>cond</i> (str)</dt> | |
| 1202 <dd> | |
| 1203 expression of the watch expression | |
| 1204 </dd> | |
| 1205 <dt><i>enable</i> (bool)</dt> | |
| 1206 <dd> | |
| 1207 flag indicating enabling or disabling a watch expression | |
| 1208 </dd> | |
| 1209 </dl> | |
| 1210 <a NAME="DebugServer.__remoteWatchpointIgnore" ID="DebugServer.__remoteWatchpointIgnore"></a> | |
| 1211 <h4>DebugServer.__remoteWatchpointIgnore</h4> | |
| 1212 <b>__remoteWatchpointIgnore</b>(<i>debuggerId, cond, count</i>) | |
| 1213 | |
| 1214 <p> | |
| 1215 Private method to ignore a watch expression the next couple of | |
| 1216 occurrences. | |
| 1217 </p> | |
| 1218 <dl> | |
| 1219 | |
| 1220 <dt><i>debuggerId</i> (str)</dt> | |
| 1221 <dd> | |
| 1222 ID of the debugger backend | |
| 1223 </dd> | |
| 1224 <dt><i>cond</i> (str)</dt> | |
| 1225 <dd> | |
| 1226 expression of the watch expression | |
| 1227 </dd> | |
| 1228 <dt><i>count</i> (int)</dt> | |
| 1229 <dd> | |
| 1230 number of occurrences to ignore | |
| 1231 </dd> | |
| 1232 </dl> | |
| 1233 <a NAME="DebugServer.__restoreBreakpoints" ID="DebugServer.__restoreBreakpoints"></a> | |
| 1234 <h4>DebugServer.__restoreBreakpoints</h4> | |
| 1235 <b>__restoreBreakpoints</b>(<i>debuggerId=""</i>) | |
| 1236 | |
| 1237 <p> | |
| 1238 Private method to restore the breakpoints after a restart. | |
| 1239 </p> | |
| 1240 <dl> | |
| 1241 | |
| 1242 <dt><i>debuggerId</i> (str)</dt> | |
| 1243 <dd> | |
| 1244 ID of the debugger backend to send to. If this is | |
| 1245 empty, they will be broadcast to all connected backends. | |
| 1246 </dd> | |
| 1247 </dl> | |
| 1248 <a NAME="DebugServer.__restoreNoDebugList" ID="DebugServer.__restoreNoDebugList"></a> | |
| 1249 <h4>DebugServer.__restoreNoDebugList</h4> | |
| 1250 <b>__restoreNoDebugList</b>(<i>debuggerId=""</i>) | |
| 1251 | |
| 1252 <p> | |
| 1253 Private method to restore the list of scripts not to be debugged after | |
| 1254 a restart. | |
| 1255 </p> | |
| 1256 <dl> | |
| 1257 | |
| 1258 <dt><i>debuggerId</i> (str)</dt> | |
| 1259 <dd> | |
| 1260 ID of the debugger backend to send to. If this is | |
| 1261 empty, they will be broadcast to all connected backends. | |
| 1262 </dd> | |
| 1263 </dl> | |
| 1264 <a NAME="DebugServer.__restoreWatchpoints" ID="DebugServer.__restoreWatchpoints"></a> | |
| 1265 <h4>DebugServer.__restoreWatchpoints</h4> | |
| 1266 <b>__restoreWatchpoints</b>(<i>debuggerId=""</i>) | |
| 1267 | |
| 1268 <p> | |
| 1269 Private method to restore the watch expressions after a restart. | |
| 1270 </p> | |
| 1271 <dl> | |
| 1272 | |
| 1273 <dt><i>debuggerId</i> (str)</dt> | |
| 1274 <dd> | |
| 1275 ID of the debugger backend to send to. If this is | |
| 1276 empty, they will be broadcast to all connected backends. | |
| 1277 </dd> | |
| 1278 </dl> | |
| 1279 <a NAME="DebugServer.__setClientType" ID="DebugServer.__setClientType"></a> | |
| 1280 <h4>DebugServer.__setClientType</h4> | |
| 1281 <b>__setClientType</b>(<i>clType</i>) | |
| 1282 | |
| 1283 <p> | |
| 1284 Private method to set the client type. | |
| 1285 </p> | |
| 1286 <dl> | |
| 1287 | |
| 1288 <dt><i>clType</i> (str)</dt> | |
| 1289 <dd> | |
| 1290 type of client to be started | |
| 1291 </dd> | |
| 1292 </dl> | |
| 1293 <a NAME="DebugServer.__splitWatchCondition" ID="DebugServer.__splitWatchCondition"></a> | |
| 1294 <h4>DebugServer.__splitWatchCondition</h4> | |
| 1295 <b>__splitWatchCondition</b>(<i>cond</i>) | |
| 1296 | |
| 1297 <p> | |
| 1298 Private method to split a remote watch expression. | |
| 1299 </p> | |
| 1300 <dl> | |
| 1301 | |
| 1302 <dt><i>cond</i> (str)</dt> | |
| 1303 <dd> | |
| 1304 remote expression | |
| 1305 </dd> | |
| 1306 </dl> | |
| 1307 <dl> | |
| 1308 <dt>Return:</dt> | |
| 1309 <dd> | |
| 1310 tuple of local expression (string) and special condition | |
| 1311 </dd> | |
| 1312 </dl> | |
| 1313 <dl> | |
| 1314 <dt>Return Type:</dt> | |
| 1315 <dd> | |
| 1316 str | |
| 1317 </dd> | |
| 1318 </dl> | |
| 1319 <a NAME="DebugServer.__watchPointDataAboutToBeChanged" ID="DebugServer.__watchPointDataAboutToBeChanged"></a> | |
| 1320 <h4>DebugServer.__watchPointDataAboutToBeChanged</h4> | |
| 1321 <b>__watchPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>) | |
| 1322 | |
| 1323 <p> | |
| 1324 Private slot to handle the dataAboutToBeChanged signal of the | |
| 1325 watch expression model. | |
| 1326 </p> | |
| 1327 <dl> | |
| 1328 | |
| 1329 <dt><i>startIndex</i> (QModelIndex)</dt> | |
| 1330 <dd> | |
| 1331 start index of the rows to be changed | |
| 1332 </dd> | |
| 1333 <dt><i>endIndex</i> (QModelIndex)</dt> | |
| 1334 <dd> | |
| 1335 end index of the rows to be changed | |
| 1336 </dd> | |
| 1337 </dl> | |
| 1338 <a NAME="DebugServer.clientUtDiscovered" ID="DebugServer.clientUtDiscovered"></a> | |
| 1339 <h4>DebugServer.clientUtDiscovered</h4> | |
| 1340 <b>clientUtDiscovered</b>(<i>testCases, exceptionType, exceptionValue</i>) | |
| 1341 | |
| 1342 <p> | |
| 1343 Public method to process the client unittest discover info. | |
| 1344 </p> | |
| 1345 <dl> | |
| 1346 | |
| 1347 <dt><i>testCases</i> (str)</dt> | |
| 1348 <dd> | |
| 1349 list of detected test cases | |
| 1350 </dd> | |
| 1351 <dt><i>exceptionType</i> (str)</dt> | |
| 1352 <dd> | |
| 1353 exception type | |
| 1354 </dd> | |
| 1355 <dt><i>exceptionValue</i> (str)</dt> | |
| 1356 <dd> | |
| 1357 exception message | |
| 1358 </dd> | |
| 1359 </dl> | |
| 1360 <a NAME="DebugServer.clientUtFinished" ID="DebugServer.clientUtFinished"></a> | |
| 1361 <h4>DebugServer.clientUtFinished</h4> | |
| 1362 <b>clientUtFinished</b>(<i>status</i>) | |
| 1363 | |
| 1364 <p> | |
| 1365 Public method to process the client unit test finished info. | |
| 1366 </p> | |
| 1367 <dl> | |
| 1368 | |
| 1369 <dt><i>status</i> (int)</dt> | |
| 1370 <dd> | |
| 1371 exit status of the unit test | |
| 1372 </dd> | |
| 1373 </dl> | |
| 1374 <a NAME="DebugServer.clientUtPrepared" ID="DebugServer.clientUtPrepared"></a> | |
| 1375 <h4>DebugServer.clientUtPrepared</h4> | |
| 1376 <b>clientUtPrepared</b>(<i>result, exceptionType, exceptionValue</i>) | |
| 1377 | |
| 1378 <p> | |
| 1379 Public method to process the client unittest prepared info. | |
| 1380 </p> | |
| 1381 <dl> | |
| 1382 | |
| 1383 <dt><i>result</i> (int)</dt> | |
| 1384 <dd> | |
| 1385 number of test cases (0 = error) | |
| 1386 </dd> | |
| 1387 <dt><i>exceptionType</i> (str)</dt> | |
| 1388 <dd> | |
| 1389 exception type | |
| 1390 </dd> | |
| 1391 <dt><i>exceptionValue</i> (str)</dt> | |
| 1392 <dd> | |
| 1393 exception message | |
| 1394 </dd> | |
| 1395 </dl> | |
| 1396 <a NAME="DebugServer.clientUtStartTest" ID="DebugServer.clientUtStartTest"></a> | |
| 1397 <h4>DebugServer.clientUtStartTest</h4> | |
| 1398 <b>clientUtStartTest</b>(<i>testname, doc</i>) | |
| 1399 | |
| 1400 <p> | |
| 1401 Public method to process the client start test info. | |
| 1402 </p> | |
| 1403 <dl> | |
| 1404 | |
| 1405 <dt><i>testname</i> (str)</dt> | |
| 1406 <dd> | |
| 1407 name of the test | |
| 1408 </dd> | |
| 1409 <dt><i>doc</i> (str)</dt> | |
| 1410 <dd> | |
| 1411 short description of the test | |
| 1412 </dd> | |
| 1413 </dl> | |
| 1414 <a NAME="DebugServer.clientUtStopTest" ID="DebugServer.clientUtStopTest"></a> | |
| 1415 <h4>DebugServer.clientUtStopTest</h4> | |
| 1416 <b>clientUtStopTest</b>(<i></i>) | |
| 1417 | |
| 1418 <p> | |
| 1419 Public method to process the client stop test info. | |
| 1420 </p> | |
| 1421 <a NAME="DebugServer.clientUtTestErrored" ID="DebugServer.clientUtTestErrored"></a> | |
| 1422 <h4>DebugServer.clientUtTestErrored</h4> | |
| 1423 <b>clientUtTestErrored</b>(<i>testname, traceback, testId</i>) | |
| 1424 | |
| 1425 <p> | |
| 1426 Public method to process the client test errored info. | |
| 1427 </p> | |
| 1428 <dl> | |
| 1429 | |
| 1430 <dt><i>testname</i> (str)</dt> | |
| 1431 <dd> | |
| 1432 name of the test | |
| 1433 </dd> | |
| 1434 <dt><i>traceback</i> (list of str)</dt> | |
| 1435 <dd> | |
| 1436 lines of traceback info | |
| 1437 </dd> | |
| 1438 <dt><i>testId</i> (str)</dt> | |
| 1439 <dd> | |
| 1440 id of the test | |
| 1441 </dd> | |
| 1442 </dl> | |
| 1443 <a NAME="DebugServer.clientUtTestFailed" ID="DebugServer.clientUtTestFailed"></a> | |
| 1444 <h4>DebugServer.clientUtTestFailed</h4> | |
| 1445 <b>clientUtTestFailed</b>(<i>testname, traceback, testId</i>) | |
| 1446 | |
| 1447 <p> | |
| 1448 Public method to process the client test failed info. | |
| 1449 </p> | |
| 1450 <dl> | |
| 1451 | |
| 1452 <dt><i>testname</i> (str)</dt> | |
| 1453 <dd> | |
| 1454 name of the test | |
| 1455 </dd> | |
| 1456 <dt><i>traceback</i> (list of str)</dt> | |
| 1457 <dd> | |
| 1458 lines of traceback info | |
| 1459 </dd> | |
| 1460 <dt><i>testId</i> (str)</dt> | |
| 1461 <dd> | |
| 1462 id of the test | |
| 1463 </dd> | |
| 1464 </dl> | |
| 1465 <a NAME="DebugServer.clientUtTestFailedExpected" ID="DebugServer.clientUtTestFailedExpected"></a> | |
| 1466 <h4>DebugServer.clientUtTestFailedExpected</h4> | |
| 1467 <b>clientUtTestFailedExpected</b>(<i>testname, traceback, testId</i>) | |
| 1468 | |
| 1469 <p> | |
| 1470 Public method to process the client test failed expected info. | |
| 1471 </p> | |
| 1472 <dl> | |
| 1473 | |
| 1474 <dt><i>testname</i> (str)</dt> | |
| 1475 <dd> | |
| 1476 name of the test | |
| 1477 </dd> | |
| 1478 <dt><i>traceback</i> (list of str)</dt> | |
| 1479 <dd> | |
| 1480 lines of traceback info | |
| 1481 </dd> | |
| 1482 <dt><i>testId</i> (str)</dt> | |
| 1483 <dd> | |
| 1484 id of the test | |
| 1485 </dd> | |
| 1486 </dl> | |
| 1487 <a NAME="DebugServer.clientUtTestSkipped" ID="DebugServer.clientUtTestSkipped"></a> | |
| 1488 <h4>DebugServer.clientUtTestSkipped</h4> | |
| 1489 <b>clientUtTestSkipped</b>(<i>testname, reason, testId</i>) | |
| 1490 | |
| 1491 <p> | |
| 1492 Public method to process the client test skipped info. | |
| 1493 </p> | |
| 1494 <dl> | |
| 1495 | |
| 1496 <dt><i>testname</i> (str)</dt> | |
| 1497 <dd> | |
| 1498 name of the test | |
| 1499 </dd> | |
| 1500 <dt><i>reason</i> (str)</dt> | |
| 1501 <dd> | |
| 1502 reason for skipping the test | |
| 1503 </dd> | |
| 1504 <dt><i>testId</i> (str)</dt> | |
| 1505 <dd> | |
| 1506 id of the test | |
| 1507 </dd> | |
| 1508 </dl> | |
| 1509 <a NAME="DebugServer.clientUtTestSucceededUnexpected" ID="DebugServer.clientUtTestSucceededUnexpected"></a> | |
| 1510 <h4>DebugServer.clientUtTestSucceededUnexpected</h4> | |
| 1511 <b>clientUtTestSucceededUnexpected</b>(<i>testname, testId</i>) | |
| 1512 | |
| 1513 <p> | |
| 1514 Public method to process the client test succeeded unexpected info. | |
| 1515 </p> | |
| 1516 <dl> | |
| 1517 | |
| 1518 <dt><i>testname</i> (str)</dt> | |
| 1519 <dd> | |
| 1520 name of the test | |
| 1521 </dd> | |
| 1522 <dt><i>testId</i> (str)</dt> | |
| 1523 <dd> | |
| 1524 id of the test | |
| 1525 </dd> | |
| 1526 </dl> | |
| 1527 <a NAME="DebugServer.getBreakPointModel" ID="DebugServer.getBreakPointModel"></a> | |
| 1528 <h4>DebugServer.getBreakPointModel</h4> | |
| 1529 <b>getBreakPointModel</b>(<i></i>) | |
| 1530 | |
| 1531 <p> | |
| 1532 Public slot to get a reference to the breakpoint model object. | |
| 1533 </p> | |
| 1534 <dl> | |
| 1535 <dt>Return:</dt> | |
| 1536 <dd> | |
| 1537 reference to the breakpoint model object | |
| 1538 </dd> | |
| 1539 </dl> | |
| 1540 <dl> | |
| 1541 <dt>Return Type:</dt> | |
| 1542 <dd> | |
| 1543 BreakPointModel | |
| 1544 </dd> | |
| 1545 </dl> | |
| 1546 <a NAME="DebugServer.getClientCapabilities" ID="DebugServer.getClientCapabilities"></a> | |
| 1547 <h4>DebugServer.getClientCapabilities</h4> | |
| 1548 <b>getClientCapabilities</b>(<i>clientType</i>) | |
| 1549 | |
| 1550 <p> | |
| 1551 Public method to retrieve the debug clients capabilities. | |
| 1552 </p> | |
| 1553 <dl> | |
| 1554 | |
| 1555 <dt><i>clientType</i> (str)</dt> | |
| 1556 <dd> | |
| 1557 debug client type | |
| 1558 </dd> | |
| 1559 </dl> | |
| 1560 <dl> | |
| 1561 <dt>Return:</dt> | |
| 1562 <dd> | |
| 1563 debug client capabilities | |
| 1564 </dd> | |
| 1565 </dl> | |
| 1566 <dl> | |
| 1567 <dt>Return Type:</dt> | |
| 1568 <dd> | |
| 1569 int | |
| 1570 </dd> | |
| 1571 </dl> | |
| 1572 <a NAME="DebugServer.getClientInterpreter" ID="DebugServer.getClientInterpreter"></a> | |
| 1573 <h4>DebugServer.getClientInterpreter</h4> | |
| 1574 <b>getClientInterpreter</b>(<i></i>) | |
| 1575 | |
| 1576 <p> | |
| 1577 Public method to get the interpreter of the debug client. | |
| 1578 </p> | |
| 1579 <dl> | |
| 1580 <dt>Return:</dt> | |
| 1581 <dd> | |
| 1582 interpreter of the debug client | |
| 1583 </dd> | |
| 1584 </dl> | |
| 1585 <dl> | |
| 1586 <dt>Return Type:</dt> | |
| 1587 <dd> | |
| 1588 str | |
| 1589 </dd> | |
| 1590 </dl> | |
| 1591 <a NAME="DebugServer.getClientType" ID="DebugServer.getClientType"></a> | |
| 1592 <h4>DebugServer.getClientType</h4> | |
| 1593 <b>getClientType</b>(<i></i>) | |
| 1594 | |
| 1595 <p> | |
| 1596 Public method to get the currently running debug client type. | |
| 1597 </p> | |
| 1598 <dl> | |
| 1599 <dt>Return:</dt> | |
| 1600 <dd> | |
| 1601 debug client type | |
| 1602 </dd> | |
| 1603 </dl> | |
| 1604 <dl> | |
| 1605 <dt>Return Type:</dt> | |
| 1606 <dd> | |
| 1607 str | |
| 1608 </dd> | |
| 1609 </dl> | |
| 1610 <a NAME="DebugServer.getDebuggerIds" ID="DebugServer.getDebuggerIds"></a> | |
| 1611 <h4>DebugServer.getDebuggerIds</h4> | |
| 1612 <b>getDebuggerIds</b>(<i></i>) | |
| 1613 | |
| 1614 <p> | |
| 1615 Public method to return the IDs of the connected debugger backends. | |
| 1616 </p> | |
| 1617 <dl> | |
| 1618 <dt>Return:</dt> | |
| 1619 <dd> | |
| 1620 list of connected debugger backend IDs | |
| 1621 </dd> | |
| 1622 </dl> | |
| 1623 <dl> | |
| 1624 <dt>Return Type:</dt> | |
| 1625 <dd> | |
| 1626 list of str | |
| 1627 </dd> | |
| 1628 </dl> | |
| 1629 <a NAME="DebugServer.getExtensions" ID="DebugServer.getExtensions"></a> | |
| 1630 <h4>DebugServer.getExtensions</h4> | |
| 1631 <b>getExtensions</b>(<i>language</i>) | |
| 1632 | |
| 1633 <p> | |
| 1634 Public slot to get the extensions associated with the given language. | |
| 1635 </p> | |
| 1636 <dl> | |
| 1637 | |
| 1638 <dt><i>language</i> (str)</dt> | |
| 1639 <dd> | |
| 1640 language to get extensions for | |
| 1641 </dd> | |
| 1642 </dl> | |
| 1643 <dl> | |
| 1644 <dt>Return:</dt> | |
| 1645 <dd> | |
| 1646 tuple of extensions associated with the language | |
| 1647 </dd> | |
| 1648 </dl> | |
| 1649 <dl> | |
| 1650 <dt>Return Type:</dt> | |
| 1651 <dd> | |
| 1652 tuple of str | |
| 1653 </dd> | |
| 1654 </dl> | |
| 1655 <a NAME="DebugServer.getHostAddress" ID="DebugServer.getHostAddress"></a> | |
| 1656 <h4>DebugServer.getHostAddress</h4> | |
| 1657 <b>getHostAddress</b>(<i>localhost</i>) | |
| 1658 | |
| 1659 <p> | |
| 1660 Public method to get the IP address or hostname the debug server is | |
| 1661 listening. | |
| 1662 </p> | |
| 1663 <dl> | |
| 1664 | |
| 1665 <dt><i>localhost</i> (bool)</dt> | |
| 1666 <dd> | |
| 1667 flag indicating to return the address for localhost | |
| 1668 </dd> | |
| 1669 </dl> | |
| 1670 <dl> | |
| 1671 <dt>Return:</dt> | |
| 1672 <dd> | |
| 1673 IP address or hostname | |
| 1674 </dd> | |
| 1675 </dl> | |
| 1676 <dl> | |
| 1677 <dt>Return Type:</dt> | |
| 1678 <dd> | |
| 1679 str | |
| 1680 </dd> | |
| 1681 </dl> | |
| 1682 <a NAME="DebugServer.getSupportedLanguages" ID="DebugServer.getSupportedLanguages"></a> | |
| 1683 <h4>DebugServer.getSupportedLanguages</h4> | |
| 1684 <b>getSupportedLanguages</b>(<i>shellOnly=False</i>) | |
| 1685 | |
| 1686 <p> | |
| 1687 Public slot to return the supported programming languages. | |
| 1688 </p> | |
| 1689 <dl> | |
| 1690 | |
| 1691 <dt><i>shellOnly</i> (bool)</dt> | |
| 1692 <dd> | |
| 1693 flag indicating only languages supporting an | |
| 1694 interactive shell should be returned | |
| 1695 </dd> | |
| 1696 </dl> | |
| 1697 <dl> | |
| 1698 <dt>Return:</dt> | |
| 1699 <dd> | |
| 1700 list of supported languages | |
| 1701 </dd> | |
| 1702 </dl> | |
| 1703 <dl> | |
| 1704 <dt>Return Type:</dt> | |
| 1705 <dd> | |
| 1706 list of str | |
| 1707 </dd> | |
| 1708 </dl> | |
| 1709 <a NAME="DebugServer.getWatchPointModel" ID="DebugServer.getWatchPointModel"></a> | |
| 1710 <h4>DebugServer.getWatchPointModel</h4> | |
| 1711 <b>getWatchPointModel</b>(<i></i>) | |
| 1712 | |
| 1713 <p> | |
| 1714 Public slot to get a reference to the watch expression model object. | |
| 1715 </p> | |
| 1716 <dl> | |
| 1717 <dt>Return:</dt> | |
| 1718 <dd> | |
| 1719 reference to the watch expression model object | |
| 1720 </dd> | |
| 1721 </dl> | |
| 1722 <dl> | |
| 1723 <dt>Return Type:</dt> | |
| 1724 <dd> | |
| 1725 WatchPointModel | |
| 1726 </dd> | |
| 1727 </dl> | |
| 1728 <a NAME="DebugServer.initializeClient" ID="DebugServer.initializeClient"></a> | |
| 1729 <h4>DebugServer.initializeClient</h4> | |
| 1730 <b>initializeClient</b>(<i>debuggerId</i>) | |
| 1731 | |
| 1732 <p> | |
| 1733 Public method to initialize a freshly connected debug client. | |
| 1734 </p> | |
| 1735 <dl> | |
| 1736 | |
| 1737 <dt><i>debuggerId</i> (str)</dt> | |
| 1738 <dd> | |
| 1739 ID of the connected debugger | |
| 1740 </dd> | |
| 1741 </dl> | |
| 1742 <a NAME="DebugServer.isClientProcessUp" ID="DebugServer.isClientProcessUp"></a> | |
| 1743 <h4>DebugServer.isClientProcessUp</h4> | |
| 1744 <b>isClientProcessUp</b>(<i></i>) | |
| 1745 | |
| 1746 <p> | |
| 1747 Public method to check, if the debug client process is up. | |
| 1748 </p> | |
| 1749 <dl> | |
| 1750 <dt>Return:</dt> | |
| 1751 <dd> | |
| 1752 flag indicating a running debug client process | |
| 1753 </dd> | |
| 1754 </dl> | |
| 1755 <dl> | |
| 1756 <dt>Return Type:</dt> | |
| 1757 <dd> | |
| 1758 bool | |
| 1759 </dd> | |
| 1760 </dl> | |
| 1761 <a NAME="DebugServer.isConnected" ID="DebugServer.isConnected"></a> | |
| 1762 <h4>DebugServer.isConnected</h4> | |
| 1763 <b>isConnected</b>(<i></i>) | |
| 1764 | |
| 1765 <p> | |
| 1766 Public method to test, if the debug server is connected to a backend. | |
| 1767 </p> | |
| 1768 <dl> | |
| 1769 <dt>Return:</dt> | |
| 1770 <dd> | |
| 1771 flag indicating a connection | |
| 1772 </dd> | |
| 1773 </dl> | |
| 1774 <dl> | |
| 1775 <dt>Return Type:</dt> | |
| 1776 <dd> | |
| 1777 bool | |
| 1778 </dd> | |
| 1779 </dl> | |
| 1780 <a NAME="DebugServer.isDebugging" ID="DebugServer.isDebugging"></a> | |
| 1781 <h4>DebugServer.isDebugging</h4> | |
| 1782 <b>isDebugging</b>(<i></i>) | |
| 1783 | |
| 1784 <p> | |
| 1785 Public method to test, if the debug server is debugging. | |
| 1786 </p> | |
| 1787 <dl> | |
| 1788 <dt>Return:</dt> | |
| 1789 <dd> | |
| 1790 flag indicating the debugging state | |
| 1791 </dd> | |
| 1792 </dl> | |
| 1793 <dl> | |
| 1794 <dt>Return Type:</dt> | |
| 1795 <dd> | |
| 1796 bool | |
| 1797 </dd> | |
| 1798 </dl> | |
| 1799 <a NAME="DebugServer.masterClientConnected" ID="DebugServer.masterClientConnected"></a> | |
| 1800 <h4>DebugServer.masterClientConnected</h4> | |
| 1801 <b>masterClientConnected</b>(<i></i>) | |
| 1802 | |
| 1803 <p> | |
| 1804 Public method to perform actions after the master client has finally | |
| 1805 established the connection. | |
| 1806 </p> | |
| 1807 <a NAME="DebugServer.passiveStartUp" ID="DebugServer.passiveStartUp"></a> | |
| 1808 <h4>DebugServer.passiveStartUp</h4> | |
| 1809 <b>passiveStartUp</b>(<i>fn, exc, debuggerId</i>) | |
| 1810 | |
| 1811 <p> | |
| 1812 Public method to handle a passive debug connection. | |
| 1813 </p> | |
| 1814 <dl> | |
| 1815 | |
| 1816 <dt><i>fn</i> (str)</dt> | |
| 1817 <dd> | |
| 1818 filename of the debugged script | |
| 1819 </dd> | |
| 1820 <dt><i>exc</i> (bool)</dt> | |
| 1821 <dd> | |
| 1822 flag to enable exception reporting of the IDE | |
| 1823 </dd> | |
| 1824 <dt><i>debuggerId</i> (str)</dt> | |
| 1825 <dd> | |
| 1826 ID of the debugger backend | |
| 1827 </dd> | |
| 1828 </dl> | |
| 1829 <a NAME="DebugServer.preferencesChanged" ID="DebugServer.preferencesChanged"></a> | |
| 1830 <h4>DebugServer.preferencesChanged</h4> | |
| 1831 <b>preferencesChanged</b>(<i></i>) | |
| 1832 | |
| 1833 <p> | |
| 1834 Public slot to handle the preferencesChanged signal. | |
| 1835 </p> | |
| 1836 <a NAME="DebugServer.registerDebuggerInterface" ID="DebugServer.registerDebuggerInterface"></a> | |
| 1837 <h4>DebugServer.registerDebuggerInterface</h4> | |
| 1838 <b>registerDebuggerInterface</b>(<i>interfaceName, getRegistryData, reregister=False</i>) | |
| 1839 | |
| 1840 <p> | |
| 1841 Public method to register a debugger interface. | |
| 1842 </p> | |
| 1843 <dl> | |
| 1844 | |
| 1845 <dt><i>interfaceName</i> (str)</dt> | |
| 1846 <dd> | |
| 1847 name of the debugger interface | |
| 1848 </dd> | |
| 1849 <dt><i>getRegistryData</i> (function)</dt> | |
| 1850 <dd> | |
| 1851 reference to a function to be called | |
| 1852 to get the debugger interface details. This method shall | |
| 1853 return the client language, the client capabilities, the | |
| 1854 list of associated file extensions and a function reference | |
| 1855 to create the debugger interface (see __createDebuggerInterface()) | |
| 1856 </dd> | |
| 1857 <dt><i>reregister</i> (bool)</dt> | |
| 1858 <dd> | |
| 1859 flag indicating to re-register the interface | |
| 1860 </dd> | |
| 1861 </dl> | |
| 1862 <a NAME="DebugServer.remoteBanner" ID="DebugServer.remoteBanner"></a> | |
| 1863 <h4>DebugServer.remoteBanner</h4> | |
| 1864 <b>remoteBanner</b>(<i></i>) | |
| 1865 | |
| 1866 <p> | |
| 1867 Public slot to get the banner info of the remote client. | |
| 1868 </p> | |
| 1869 <a NAME="DebugServer.remoteBreakpoint" ID="DebugServer.remoteBreakpoint"></a> | |
| 1870 <h4>DebugServer.remoteBreakpoint</h4> | |
| 1871 <b>remoteBreakpoint</b>(<i>debuggerId, fn, line, setBreakpoint, cond=None, temp=False</i>) | |
| 1872 | |
| 1873 <p> | |
| 1874 Public method to set or clear a breakpoint. | |
| 1875 </p> | |
| 1876 <dl> | |
| 1877 | |
| 1878 <dt><i>debuggerId</i> (str)</dt> | |
| 1879 <dd> | |
| 1880 ID of the debugger backend | |
| 1881 </dd> | |
| 1882 <dt><i>fn</i> (str)</dt> | |
| 1883 <dd> | |
| 1884 filename the breakpoint belongs to | |
| 1885 </dd> | |
| 1886 <dt><i>line</i> (int)</dt> | |
| 1887 <dd> | |
| 1888 linenumber of the breakpoint | |
| 1889 </dd> | |
| 1890 <dt><i>setBreakpoint</i> (bool)</dt> | |
| 1891 <dd> | |
| 1892 flag indicating setting or resetting a breakpoint | |
| 1893 </dd> | |
| 1894 <dt><i>cond</i> (str)</dt> | |
| 1895 <dd> | |
| 1896 condition of the breakpoint | |
| 1897 </dd> | |
| 1898 <dt><i>temp</i> (bool)</dt> | |
| 1899 <dd> | |
| 1900 flag indicating a temporary breakpoint | |
| 1901 </dd> | |
| 1902 </dl> | |
| 1903 <a NAME="DebugServer.remoteCapabilities" ID="DebugServer.remoteCapabilities"></a> | |
| 1904 <h4>DebugServer.remoteCapabilities</h4> | |
| 1905 <b>remoteCapabilities</b>(<i></i>) | |
| 1906 | |
| 1907 <p> | |
| 1908 Public slot to get the debug clients capabilities. | |
| 1909 </p> | |
| 1910 <a NAME="DebugServer.remoteClientDisassembly" ID="DebugServer.remoteClientDisassembly"></a> | |
| 1911 <h4>DebugServer.remoteClientDisassembly</h4> | |
| 1912 <b>remoteClientDisassembly</b>(<i>debuggerId</i>) | |
| 1913 | |
| 1914 <p> | |
| 1915 Public method to ask the client for the latest traceback disassembly. | |
| 1916 </p> | |
| 1917 <dl> | |
| 1918 | |
| 1919 <dt><i>debuggerId</i> (str)</dt> | |
| 1920 <dd> | |
| 1921 ID of the debugger backend | |
| 1922 </dd> | |
| 1923 </dl> | |
| 1924 <a NAME="DebugServer.remoteClientSetFilter" ID="DebugServer.remoteClientSetFilter"></a> | |
| 1925 <h4>DebugServer.remoteClientSetFilter</h4> | |
| 1926 <b>remoteClientSetFilter</b>(<i>debuggerId, scope, filterStr</i>) | |
| 1927 | |
| 1928 <p> | |
| 1929 Public method to set a variables filter list. | |
| 1930 </p> | |
| 1931 <dl> | |
| 1932 | |
| 1933 <dt><i>debuggerId</i> (str)</dt> | |
| 1934 <dd> | |
| 1935 ID of the debugger backend | |
| 1936 </dd> | |
| 1937 <dt><i>scope</i> (int)</dt> | |
| 1938 <dd> | |
| 1939 the scope of the variables (0 = local, 1 = global) | |
| 1940 </dd> | |
| 1941 <dt><i>filterStr</i> (str)</dt> | |
| 1942 <dd> | |
| 1943 regexp string for variable names to filter out | |
| 1944 </dd> | |
| 1945 </dl> | |
| 1946 <a NAME="DebugServer.remoteClientStack" ID="DebugServer.remoteClientStack"></a> | |
| 1947 <h4>DebugServer.remoteClientStack</h4> | |
| 1948 <b>remoteClientStack</b>(<i>debuggerId</i>) | |
| 1949 | |
| 1950 <p> | |
| 1951 Public method to request the stack of the main thread. | |
| 1952 </p> | |
| 1953 <dl> | |
| 1954 | |
| 1955 <dt><i>debuggerId</i> (str)</dt> | |
| 1956 <dd> | |
| 1957 ID of the debugger backend | |
| 1958 </dd> | |
| 1959 </dl> | |
| 1960 <a NAME="DebugServer.remoteClientVariable" ID="DebugServer.remoteClientVariable"></a> | |
| 1961 <h4>DebugServer.remoteClientVariable</h4> | |
| 1962 <b>remoteClientVariable</b>(<i>debuggerId, scope, filterList, var, framenr=0, maxSize=0</i>) | |
| 1963 | |
| 1964 <p> | |
| 1965 Public method to request the variables of the debugged program. | |
| 1966 </p> | |
| 1967 <dl> | |
| 1968 | |
| 1969 <dt><i>debuggerId</i> (str)</dt> | |
| 1970 <dd> | |
| 1971 ID of the debugger backend | |
| 1972 </dd> | |
| 1973 <dt><i>scope</i> (int)</dt> | |
| 1974 <dd> | |
| 1975 the scope of the variables (0 = local, 1 = global) | |
| 1976 </dd> | |
| 1977 <dt><i>filterList</i> (list of str)</dt> | |
| 1978 <dd> | |
| 1979 list of variable types to filter out | |
| 1980 </dd> | |
| 1981 <dt><i>var</i> (list of str)</dt> | |
| 1982 <dd> | |
| 1983 list encoded name of variable to retrieve | |
| 1984 </dd> | |
| 1985 <dt><i>framenr</i> (int)</dt> | |
| 1986 <dd> | |
| 1987 framenumber of the variables to retrieve | |
| 1988 </dd> | |
| 1989 <dt><i>maxSize</i> (int)</dt> | |
| 1990 <dd> | |
| 1991 maximum size the formatted value of a variable will | |
| 1992 be shown. If it is bigger than that, a 'too big' indication will | |
| 1993 be given (@@TOO_BIG_TO_SHOW@@). | |
| 1994 </dd> | |
| 1995 </dl> | |
| 1996 <a NAME="DebugServer.remoteClientVariables" ID="DebugServer.remoteClientVariables"></a> | |
| 1997 <h4>DebugServer.remoteClientVariables</h4> | |
| 1998 <b>remoteClientVariables</b>(<i>debuggerId, scope, filterList, framenr=0</i>) | |
| 1999 | |
| 2000 <p> | |
| 2001 Public method to request the variables of the debugged program. | |
| 2002 </p> | |
| 2003 <dl> | |
| 2004 | |
| 2005 <dt><i>debuggerId</i> (str)</dt> | |
| 2006 <dd> | |
| 2007 ID of the debugger backend | |
| 2008 </dd> | |
| 2009 <dt><i>scope</i> (int)</dt> | |
| 2010 <dd> | |
| 2011 the scope of the variables (0 = local, 1 = global) | |
| 2012 </dd> | |
| 2013 <dt><i>filterList</i> (list of str)</dt> | |
| 2014 <dd> | |
| 2015 list of variable types to filter out | |
| 2016 </dd> | |
| 2017 <dt><i>framenr</i> (int)</dt> | |
| 2018 <dd> | |
| 2019 framenumber of the variables to retrieve | |
| 2020 </dd> | |
| 2021 </dl> | |
| 2022 <a NAME="DebugServer.remoteCompletion" ID="DebugServer.remoteCompletion"></a> | |
| 2023 <h4>DebugServer.remoteCompletion</h4> | |
| 2024 <b>remoteCompletion</b>(<i>debuggerId, text</i>) | |
| 2025 | |
| 2026 <p> | |
| 2027 Public slot to get the a list of possible commandline completions | |
| 2028 from the remote client. | |
| 2029 </p> | |
| 2030 <dl> | |
| 2031 | |
| 2032 <dt><i>debuggerId</i> (str)</dt> | |
| 2033 <dd> | |
| 2034 ID of the debugger backend | |
| 2035 </dd> | |
| 2036 <dt><i>text</i> (str)</dt> | |
| 2037 <dd> | |
| 2038 the text to be completed | |
| 2039 </dd> | |
| 2040 </dl> | |
| 2041 <a NAME="DebugServer.remoteContinue" ID="DebugServer.remoteContinue"></a> | |
| 2042 <h4>DebugServer.remoteContinue</h4> | |
| 2043 <b>remoteContinue</b>(<i>debuggerId, special=False</i>) | |
| 2044 | |
| 2045 <p> | |
| 2046 Public method to continue the debugged program. | |
| 2047 </p> | |
| 2048 <dl> | |
| 2049 | |
| 2050 <dt><i>debuggerId</i> (str)</dt> | |
| 2051 <dd> | |
| 2052 ID of the debugger backend | |
| 2053 </dd> | |
| 2054 <dt><i>special</i></dt> | |
| 2055 <dd> | |
| 2056 flag indicating a special continue operation | |
| 2057 </dd> | |
| 2058 </dl> | |
| 2059 <a NAME="DebugServer.remoteContinueUntil" ID="DebugServer.remoteContinueUntil"></a> | |
| 2060 <h4>DebugServer.remoteContinueUntil</h4> | |
| 2061 <b>remoteContinueUntil</b>(<i>debuggerId, line</i>) | |
| 2062 | |
| 2063 <p> | |
| 2064 Public method to continue the debugged program to the given line | |
| 2065 or until returning from the current frame. | |
| 2066 </p> | |
| 2067 <dl> | |
| 2068 | |
| 2069 <dt><i>debuggerId</i> (str)</dt> | |
| 2070 <dd> | |
| 2071 ID of the debugger backend | |
| 2072 </dd> | |
| 2073 <dt><i>line</i> (int)</dt> | |
| 2074 <dd> | |
| 2075 the new line, where execution should be continued to | |
| 2076 </dd> | |
| 2077 </dl> | |
| 2078 <a NAME="DebugServer.remoteCoverage" ID="DebugServer.remoteCoverage"></a> | |
| 2079 <h4>DebugServer.remoteCoverage</h4> | |
| 2080 <b>remoteCoverage</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType="", configOverride=None</i>) | |
| 2081 | |
| 2082 <p> | |
| 2083 Public method to load a new program to collect coverage data. | |
| 2084 </p> | |
| 2085 <dl> | |
| 2086 | |
| 2087 <dt><i>venvName</i> (str)</dt> | |
| 2088 <dd> | |
| 2089 name of the virtual environment to be used | |
| 2090 </dd> | |
| 2091 <dt><i>fn</i> (str)</dt> | |
| 2092 <dd> | |
| 2093 the filename to debug | |
| 2094 </dd> | |
| 2095 <dt><i>argv</i> (str)</dt> | |
| 2096 <dd> | |
| 2097 the command line arguments to pass to the program | |
| 2098 </dd> | |
| 2099 <dt><i>wd</i> (str)</dt> | |
| 2100 <dd> | |
| 2101 the working directory for the program | |
| 2102 </dd> | |
| 2103 <dt><i>env</i> (str)</dt> | |
| 2104 <dd> | |
| 2105 environment parameter settings | |
| 2106 </dd> | |
| 2107 <dt><i>autoClearShell</i> (bool)</dt> | |
| 2108 <dd> | |
| 2109 flag indicating, that the interpreter window | |
| 2110 should be cleared | |
| 2111 </dd> | |
| 2112 <dt><i>erase</i> (bool)</dt> | |
| 2113 <dd> | |
| 2114 flag indicating that coverage info should be | |
| 2115 cleared first | |
| 2116 </dd> | |
| 2117 <dt><i>forProject</i> (bool)</dt> | |
| 2118 <dd> | |
| 2119 flag indicating a project related action | |
| 2120 </dd> | |
| 2121 <dt><i>runInConsole</i> (bool)</dt> | |
| 2122 <dd> | |
| 2123 flag indicating to start the debugger in a | |
| 2124 console window | |
| 2125 </dd> | |
| 2126 <dt><i>clientType</i> (str)</dt> | |
| 2127 <dd> | |
| 2128 client type to be used | |
| 2129 </dd> | |
| 2130 <dt><i>configOverride</i> (dict)</dt> | |
| 2131 <dd> | |
| 2132 dictionary containing the global config override | |
| 2133 data | |
| 2134 </dd> | |
| 2135 </dl> | |
| 2136 <a NAME="DebugServer.remoteEnvironment" ID="DebugServer.remoteEnvironment"></a> | |
| 2137 <h4>DebugServer.remoteEnvironment</h4> | |
| 2138 <b>remoteEnvironment</b>(<i>env</i>) | |
| 2139 | |
| 2140 <p> | |
| 2141 Public method to set the environment for a program to debug, run, ... | |
| 2142 </p> | |
| 2143 <dl> | |
| 2144 | |
| 2145 <dt><i>env</i> (str)</dt> | |
| 2146 <dd> | |
| 2147 environment settings | |
| 2148 </dd> | |
| 2149 </dl> | |
| 2150 <a NAME="DebugServer.remoteLoad" ID="DebugServer.remoteLoad"></a> | |
| 2151 <h4>DebugServer.remoteLoad</h4> | |
| 2152 <b>remoteLoad</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, tracePython=False, autoContinue=True, forProject=False, runInConsole=False, clientType="", enableCallTrace=False, enableMultiprocess=False, multiprocessNoDebug="", configOverride=None</i>) | |
| 2153 | |
| 2154 <p> | |
| 2155 Public method to load a new program to debug. | |
| 2156 </p> | |
| 2157 <dl> | |
| 2158 | |
| 2159 <dt><i>venvName</i> (str)</dt> | |
| 2160 <dd> | |
| 2161 name of the virtual environment to be used | |
| 2162 </dd> | |
| 2163 <dt><i>fn</i> (str)</dt> | |
| 2164 <dd> | |
| 2165 the filename to debug | |
| 2166 </dd> | |
| 2167 <dt><i>argv</i> (str)</dt> | |
| 2168 <dd> | |
| 2169 the command line arguments to pass to the program | |
| 2170 </dd> | |
| 2171 <dt><i>wd</i> (str)</dt> | |
| 2172 <dd> | |
| 2173 the working directory for the program | |
| 2174 </dd> | |
| 2175 <dt><i>env</i> (str)</dt> | |
| 2176 <dd> | |
| 2177 environment parameter settings | |
| 2178 </dd> | |
| 2179 <dt><i>autoClearShell</i> (bool)</dt> | |
| 2180 <dd> | |
| 2181 flag indicating, that the interpreter window | |
| 2182 should be cleared | |
| 2183 </dd> | |
| 2184 <dt><i>tracePython</i> (bool)</dt> | |
| 2185 <dd> | |
| 2186 flag indicating if the Python library should be | |
| 2187 traced as well | |
| 2188 </dd> | |
| 2189 <dt><i>autoContinue</i> (bool)</dt> | |
| 2190 <dd> | |
| 2191 flag indicating, that the debugger should not | |
| 2192 stop at the first executable line | |
| 2193 </dd> | |
| 2194 <dt><i>forProject</i> (bool)</dt> | |
| 2195 <dd> | |
| 2196 flag indicating a project related action | |
| 2197 </dd> | |
| 2198 <dt><i>runInConsole</i> (bool)</dt> | |
| 2199 <dd> | |
| 2200 flag indicating to start the debugger in a | |
| 2201 console window | |
| 2202 </dd> | |
| 2203 <dt><i>clientType</i> (str)</dt> | |
| 2204 <dd> | |
| 2205 client type to be used | |
| 2206 </dd> | |
| 2207 <dt><i>enableCallTrace</i> (bool)</dt> | |
| 2208 <dd> | |
| 2209 flag indicating to enable the call trace | |
| 2210 function | |
| 2211 </dd> | |
| 2212 <dt><i>enableMultiprocess</i> (bool)</dt> | |
| 2213 <dd> | |
| 2214 flag indicating to perform multiprocess | |
| 2215 debugging | |
| 2216 </dd> | |
| 2217 <dt><i>multiprocessNoDebug</i> (str)</dt> | |
| 2218 <dd> | |
| 2219 space separated list of programs not to be | |
| 2220 debugged | |
| 2221 </dd> | |
| 2222 <dt><i>configOverride</i> (dict)</dt> | |
| 2223 <dd> | |
| 2224 dictionary containing the global config override | |
| 2225 data | |
| 2226 </dd> | |
| 2227 </dl> | |
| 2228 <a NAME="DebugServer.remoteMoveIP" ID="DebugServer.remoteMoveIP"></a> | |
| 2229 <h4>DebugServer.remoteMoveIP</h4> | |
| 2230 <b>remoteMoveIP</b>(<i>debuggerId, line</i>) | |
| 2231 | |
| 2232 <p> | |
| 2233 Public method to move the instruction pointer to a different line. | |
| 2234 </p> | |
| 2235 <dl> | |
| 2236 | |
| 2237 <dt><i>debuggerId</i> (str)</dt> | |
| 2238 <dd> | |
| 2239 ID of the debugger backend | |
| 2240 </dd> | |
| 2241 <dt><i>line</i> (int)</dt> | |
| 2242 <dd> | |
| 2243 the new line, where execution should be continued | |
| 2244 </dd> | |
| 2245 </dl> | |
| 2246 <a NAME="DebugServer.remoteProfile" ID="DebugServer.remoteProfile"></a> | |
| 2247 <h4>DebugServer.remoteProfile</h4> | |
| 2248 <b>remoteProfile</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType="", configOverride=None</i>) | |
| 2249 | |
| 2250 <p> | |
| 2251 Public method to load a new program to collect profiling data. | |
| 2252 </p> | |
| 2253 <dl> | |
| 2254 | |
| 2255 <dt><i>venvName</i> (str)</dt> | |
| 2256 <dd> | |
| 2257 name of the virtual environment to be used | |
| 2258 </dd> | |
| 2259 <dt><i>fn</i> (str)</dt> | |
| 2260 <dd> | |
| 2261 the filename to debug | |
| 2262 </dd> | |
| 2263 <dt><i>argv</i> (str)</dt> | |
| 2264 <dd> | |
| 2265 the command line arguments to pass to the program | |
| 2266 </dd> | |
| 2267 <dt><i>wd</i> (str)</dt> | |
| 2268 <dd> | |
| 2269 the working directory for the program | |
| 2270 </dd> | |
| 2271 <dt><i>env</i> (str)</dt> | |
| 2272 <dd> | |
| 2273 environment parameter settings | |
| 2274 </dd> | |
| 2275 <dt><i>autoClearShell</i> (bool)</dt> | |
| 2276 <dd> | |
| 2277 flag indicating, that the interpreter window | |
| 2278 should be cleared | |
| 2279 </dd> | |
| 2280 <dt><i>erase</i> (bool)</dt> | |
| 2281 <dd> | |
| 2282 flag indicating that coverage info should be | |
| 2283 cleared first | |
| 2284 </dd> | |
| 2285 <dt><i>forProject</i> (bool)</dt> | |
| 2286 <dd> | |
| 2287 flag indicating a project related action | |
| 2288 </dd> | |
| 2289 <dt><i>runInConsole</i> (bool)</dt> | |
| 2290 <dd> | |
| 2291 flag indicating to start the debugger in a | |
| 2292 console window | |
| 2293 </dd> | |
| 2294 <dt><i>clientType</i> (str)</dt> | |
| 2295 <dd> | |
| 2296 client type to be used | |
| 2297 </dd> | |
| 2298 <dt><i>configOverride</i> (dict)</dt> | |
| 2299 <dd> | |
| 2300 dictionary containing the global config override | |
| 2301 data | |
| 2302 </dd> | |
| 2303 </dl> | |
| 2304 <a NAME="DebugServer.remoteRawInput" ID="DebugServer.remoteRawInput"></a> | |
| 2305 <h4>DebugServer.remoteRawInput</h4> | |
| 2306 <b>remoteRawInput</b>(<i>debuggerId, inputString</i>) | |
| 2307 | |
| 2308 <p> | |
| 2309 Public method to send the raw input to the debugged program. | |
| 2310 </p> | |
| 2311 <dl> | |
| 2312 | |
| 2313 <dt><i>debuggerId</i> (str)</dt> | |
| 2314 <dd> | |
| 2315 ID of the debugger backend | |
| 2316 </dd> | |
| 2317 <dt><i>inputString</i> (str)</dt> | |
| 2318 <dd> | |
| 2319 the raw input | |
| 2320 </dd> | |
| 2321 </dl> | |
| 2322 <a NAME="DebugServer.remoteRun" ID="DebugServer.remoteRun"></a> | |
| 2323 <h4>DebugServer.remoteRun</h4> | |
| 2324 <b>remoteRun</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, forProject=False, runInConsole=False, clientType="", configOverride=None</i>) | |
| 2325 | |
| 2326 <p> | |
| 2327 Public method to load a new program to run. | |
| 2328 </p> | |
| 2329 <dl> | |
| 2330 | |
| 2331 <dt><i>venvName</i> (str)</dt> | |
| 2332 <dd> | |
| 2333 name of the virtual environment to be used | |
| 2334 </dd> | |
| 2335 <dt><i>fn</i> (str)</dt> | |
| 2336 <dd> | |
| 2337 the filename to debug | |
| 2338 </dd> | |
| 2339 <dt><i>argv</i> (str)</dt> | |
| 2340 <dd> | |
| 2341 the command line arguments to pass to the program | |
| 2342 </dd> | |
| 2343 <dt><i>wd</i> (str)</dt> | |
| 2344 <dd> | |
| 2345 the working directory for the program | |
| 2346 </dd> | |
| 2347 <dt><i>env</i> (str)</dt> | |
| 2348 <dd> | |
| 2349 environment parameter settings | |
| 2350 </dd> | |
| 2351 <dt><i>autoClearShell</i> (bool)</dt> | |
| 2352 <dd> | |
| 2353 flag indicating, that the interpreter window | |
| 2354 should be cleared | |
| 2355 </dd> | |
| 2356 <dt><i>forProject</i> (bool)</dt> | |
| 2357 <dd> | |
| 2358 flag indicating a project related action | |
| 2359 </dd> | |
| 2360 <dt><i>runInConsole</i> (bool)</dt> | |
| 2361 <dd> | |
| 2362 flag indicating to start the debugger in a | |
| 2363 console window | |
| 2364 </dd> | |
| 2365 <dt><i>clientType</i> (str)</dt> | |
| 2366 <dd> | |
| 2367 client type to be used | |
| 2368 </dd> | |
| 2369 <dt><i>configOverride</i> (dict)</dt> | |
| 2370 <dd> | |
| 2371 dictionary containing the global config override | |
| 2372 data | |
| 2373 </dd> | |
| 2374 </dl> | |
| 2375 <a NAME="DebugServer.remoteSetThread" ID="DebugServer.remoteSetThread"></a> | |
| 2376 <h4>DebugServer.remoteSetThread</h4> | |
| 2377 <b>remoteSetThread</b>(<i>debuggerId, tid</i>) | |
| 2378 | |
| 2379 <p> | |
| 2380 Public method to request to set the given thread as current thread. | |
| 2381 </p> | |
| 2382 <dl> | |
| 2383 | |
| 2384 <dt><i>debuggerId</i> (str)</dt> | |
| 2385 <dd> | |
| 2386 ID of the debugger backend | |
| 2387 </dd> | |
| 2388 <dt><i>tid</i> (int)</dt> | |
| 2389 <dd> | |
| 2390 id of the thread | |
| 2391 </dd> | |
| 2392 </dl> | |
| 2393 <a NAME="DebugServer.remoteStatement" ID="DebugServer.remoteStatement"></a> | |
| 2394 <h4>DebugServer.remoteStatement</h4> | |
| 2395 <b>remoteStatement</b>(<i>debuggerId, stmt</i>) | |
| 2396 | |
| 2397 <p> | |
| 2398 Public method to execute a Python statement. | |
| 2399 </p> | |
| 2400 <dl> | |
| 2401 | |
| 2402 <dt><i>debuggerId</i> (str)</dt> | |
| 2403 <dd> | |
| 2404 ID of the debugger backend | |
| 2405 </dd> | |
| 2406 <dt><i>stmt</i> (str)</dt> | |
| 2407 <dd> | |
| 2408 the Python statement to execute. | |
| 2409 </dd> | |
| 2410 </dl> | |
| 2411 <a NAME="DebugServer.remoteStep" ID="DebugServer.remoteStep"></a> | |
| 2412 <h4>DebugServer.remoteStep</h4> | |
| 2413 <b>remoteStep</b>(<i>debuggerId</i>) | |
| 2414 | |
| 2415 <p> | |
| 2416 Public method to single step the debugged program. | |
| 2417 </p> | |
| 2418 <dl> | |
| 2419 | |
| 2420 <dt><i>debuggerId</i> (str)</dt> | |
| 2421 <dd> | |
| 2422 ID of the debugger backend | |
| 2423 </dd> | |
| 2424 </dl> | |
| 2425 <a NAME="DebugServer.remoteStepOut" ID="DebugServer.remoteStepOut"></a> | |
| 2426 <h4>DebugServer.remoteStepOut</h4> | |
| 2427 <b>remoteStepOut</b>(<i>debuggerId</i>) | |
| 2428 | |
| 2429 <p> | |
| 2430 Public method to step out the debugged program. | |
| 2431 </p> | |
| 2432 <dl> | |
| 2433 | |
| 2434 <dt><i>debuggerId</i> (str)</dt> | |
| 2435 <dd> | |
| 2436 ID of the debugger backend | |
| 2437 </dd> | |
| 2438 </dl> | |
| 2439 <a NAME="DebugServer.remoteStepOver" ID="DebugServer.remoteStepOver"></a> | |
| 2440 <h4>DebugServer.remoteStepOver</h4> | |
| 2441 <b>remoteStepOver</b>(<i>debuggerId</i>) | |
| 2442 | |
| 2443 <p> | |
| 2444 Public method to step over the debugged program. | |
| 2445 </p> | |
| 2446 <dl> | |
| 2447 | |
| 2448 <dt><i>debuggerId</i> (str)</dt> | |
| 2449 <dd> | |
| 2450 ID of the debugger backend | |
| 2451 </dd> | |
| 2452 </dl> | |
| 2453 <a NAME="DebugServer.remoteStepQuit" ID="DebugServer.remoteStepQuit"></a> | |
| 2454 <h4>DebugServer.remoteStepQuit</h4> | |
| 2455 <b>remoteStepQuit</b>(<i>debuggerId</i>) | |
| 2456 | |
| 2457 <p> | |
| 2458 Public method to stop the debugged program. | |
| 2459 </p> | |
| 2460 <dl> | |
| 2461 | |
| 2462 <dt><i>debuggerId</i> (str)</dt> | |
| 2463 <dd> | |
| 2464 ID of the debugger backend | |
| 2465 </dd> | |
| 2466 </dl> | |
| 2467 <a NAME="DebugServer.remoteThreadList" ID="DebugServer.remoteThreadList"></a> | |
| 2468 <h4>DebugServer.remoteThreadList</h4> | |
| 2469 <b>remoteThreadList</b>(<i>debuggerId</i>) | |
| 2470 | |
| 2471 <p> | |
| 2472 Public method to request the list of threads from the client. | |
| 2473 </p> | |
| 2474 <dl> | |
| 2475 | |
| 2476 <dt><i>debuggerId</i> (str)</dt> | |
| 2477 <dd> | |
| 2478 ID of the debugger backend | |
| 2479 </dd> | |
| 2480 </dl> | |
| 2481 <a NAME="DebugServer.remoteUTDiscover" ID="DebugServer.remoteUTDiscover"></a> | |
| 2482 <h4>DebugServer.remoteUTDiscover</h4> | |
| 2483 <b>remoteUTDiscover</b>(<i>clientType, forProject, venvName, syspath, workdir, discoveryStart</i>) | |
| 2484 | |
| 2485 <p> | |
| 2486 Public method to perform a test case discovery. | |
| 2487 </p> | |
| 2488 <dl> | |
| 2489 | |
| 2490 <dt><i>clientType</i> (str)</dt> | |
| 2491 <dd> | |
| 2492 client type to be used | |
| 2493 </dd> | |
| 2494 <dt><i>forProject</i> (bool)</dt> | |
| 2495 <dd> | |
| 2496 flag indicating a project related action | |
| 2497 </dd> | |
| 2498 <dt><i>venvName</i> (str)</dt> | |
| 2499 <dd> | |
| 2500 name of a virtual environment | |
| 2501 </dd> | |
| 2502 <dt><i>syspath</i> (list of str)</dt> | |
| 2503 <dd> | |
| 2504 list of directories to be added to sys.path on the | |
| 2505 remote side | |
| 2506 </dd> | |
| 2507 <dt><i>workdir</i> (str)</dt> | |
| 2508 <dd> | |
| 2509 path name of the working directory | |
| 2510 </dd> | |
| 2511 <dt><i>discoveryStart</i> (str)</dt> | |
| 2512 <dd> | |
| 2513 directory to start auto-discovery at | |
| 2514 </dd> | |
| 2515 </dl> | |
| 2516 <a NAME="DebugServer.remoteUTPrepare" ID="DebugServer.remoteUTPrepare"></a> | |
| 2517 <h4>DebugServer.remoteUTPrepare</h4> | |
| 2518 <b>remoteUTPrepare</b>(<i>fn, tn, tfn, failed, cov, covname, coverase, clientType="", forProject=False, venvName="", syspath=None, workdir="", discover=False, discoveryStart="", testCases=None, debug=False</i>) | |
| 2519 | |
| 2520 <p> | |
| 2521 Public method to prepare a new unittest run. | |
| 2522 </p> | |
| 2523 <dl> | |
| 2524 | |
| 2525 <dt><i>fn</i> (str)</dt> | |
| 2526 <dd> | |
| 2527 the filename to load | |
| 2528 </dd> | |
| 2529 <dt><i>tn</i> (str)</dt> | |
| 2530 <dd> | |
| 2531 the testname to load | |
| 2532 </dd> | |
| 2533 <dt><i>tfn</i> (str)</dt> | |
| 2534 <dd> | |
| 2535 the test function name to load tests from | |
| 2536 </dd> | |
| 2537 <dt><i>failed</i> (list of str)</dt> | |
| 2538 <dd> | |
| 2539 list of failed test, if only failed test should be run | |
| 2540 </dd> | |
| 2541 <dt><i>cov</i> (bool)</dt> | |
| 2542 <dd> | |
| 2543 flag indicating collection of coverage data is requested | |
| 2544 </dd> | |
| 2545 <dt><i>covname</i> (str)</dt> | |
| 2546 <dd> | |
| 2547 filename to be used to assemble the coverage caches | |
| 2548 filename | |
| 2549 </dd> | |
| 2550 <dt><i>coverase</i> (bool)</dt> | |
| 2551 <dd> | |
| 2552 flag indicating erasure of coverage data is requested | |
| 2553 </dd> | |
| 2554 <dt><i>clientType</i> (str)</dt> | |
| 2555 <dd> | |
| 2556 client type to be used | |
| 2557 </dd> | |
| 2558 <dt><i>forProject</i> (bool)</dt> | |
| 2559 <dd> | |
| 2560 flag indicating a project related action | |
| 2561 </dd> | |
| 2562 <dt><i>venvName</i> (str)</dt> | |
| 2563 <dd> | |
| 2564 name of a virtual environment | |
| 2565 </dd> | |
| 2566 <dt><i>syspath</i> (list of str)</dt> | |
| 2567 <dd> | |
| 2568 list of directories to be added to sys.path on the | |
| 2569 remote side | |
| 2570 </dd> | |
| 2571 <dt><i>workdir</i> (str)</dt> | |
| 2572 <dd> | |
| 2573 path name of the working directory | |
| 2574 </dd> | |
| 2575 <dt><i>discover</i> (bool)</dt> | |
| 2576 <dd> | |
| 2577 flag indicating to discover the tests automatically | |
| 2578 </dd> | |
| 2579 <dt><i>discoveryStart</i> (str)</dt> | |
| 2580 <dd> | |
| 2581 directory to start auto-discovery at | |
| 2582 </dd> | |
| 2583 <dt><i>testCases</i> (list of str)</dt> | |
| 2584 <dd> | |
| 2585 list of test cases to be loaded | |
| 2586 </dd> | |
| 2587 <dt><i>debug</i> (bool)</dt> | |
| 2588 <dd> | |
| 2589 flag indicating to run unittest with debugging | |
| 2590 </dd> | |
| 2591 </dl> | |
| 2592 <a NAME="DebugServer.remoteUTRun" ID="DebugServer.remoteUTRun"></a> | |
| 2593 <h4>DebugServer.remoteUTRun</h4> | |
| 2594 <b>remoteUTRun</b>(<i>debug=False, failfast=False</i>) | |
| 2595 | |
| 2596 <p> | |
| 2597 Public method to start a unittest run. | |
| 2598 </p> | |
| 2599 <dl> | |
| 2600 | |
| 2601 <dt><i>debug</i> (bool)</dt> | |
| 2602 <dd> | |
| 2603 flag indicating to run unittest with debugging | |
| 2604 </dd> | |
| 2605 <dt><i>failfast</i> (bool)</dt> | |
| 2606 <dd> | |
| 2607 flag indicating to stop at the first error | |
| 2608 </dd> | |
| 2609 </dl> | |
| 2610 <a NAME="DebugServer.remoteUTStop" ID="DebugServer.remoteUTStop"></a> | |
| 2611 <h4>DebugServer.remoteUTStop</h4> | |
| 2612 <b>remoteUTStop</b>(<i></i>) | |
| 2613 | |
| 2614 <p> | |
| 2615 public method to stop a unittest run. | |
| 2616 </p> | |
| 2617 <a NAME="DebugServer.setCallTraceEnabled" ID="DebugServer.setCallTraceEnabled"></a> | |
| 2618 <h4>DebugServer.setCallTraceEnabled</h4> | |
| 2619 <b>setCallTraceEnabled</b>(<i>debuggerId, on</i>) | |
| 2620 | |
| 2621 <p> | |
| 2622 Public method to set the call trace state. | |
| 2623 </p> | |
| 2624 <dl> | |
| 2625 | |
| 2626 <dt><i>debuggerId</i> (str)</dt> | |
| 2627 <dd> | |
| 2628 ID of the debugger backend | |
| 2629 </dd> | |
| 2630 <dt><i>on</i> (bool)</dt> | |
| 2631 <dd> | |
| 2632 flag indicating to enable the call trace function | |
| 2633 </dd> | |
| 2634 </dl> | |
| 2635 <a NAME="DebugServer.setDebugging" ID="DebugServer.setDebugging"></a> | |
| 2636 <h4>DebugServer.setDebugging</h4> | |
| 2637 <b>setDebugging</b>(<i>on</i>) | |
| 2638 | |
| 2639 <p> | |
| 2640 Public method to set the debugging state. | |
| 2641 </p> | |
| 2642 <dl> | |
| 2643 | |
| 2644 <dt><i>on</i> (bool)</dt> | |
| 2645 <dd> | |
| 2646 flag indicating the new debugging state | |
| 2647 </dd> | |
| 2648 </dl> | |
| 2649 <a NAME="DebugServer.shutdownServer" ID="DebugServer.shutdownServer"></a> | |
| 2650 <h4>DebugServer.shutdownServer</h4> | |
| 2651 <b>shutdownServer</b>(<i></i>) | |
| 2652 | |
| 2653 <p> | |
| 2654 Public method to cleanly shut down. | |
| 2655 </p> | |
| 2656 <p> | |
| 2657 It closes our socket and shuts down | |
| 2658 the debug client. (Needed on Win OS) | |
| 2659 </p> | |
| 2660 <a NAME="DebugServer.signalClientBanner" ID="DebugServer.signalClientBanner"></a> | |
| 2661 <h4>DebugServer.signalClientBanner</h4> | |
| 2662 <b>signalClientBanner</b>(<i>version, platform, venvName</i>) | |
| 2663 | |
| 2664 <p> | |
| 2665 Public method to process the client banner info. | |
| 2666 </p> | |
| 2667 <dl> | |
| 2668 | |
| 2669 <dt><i>version</i> (str)</dt> | |
| 2670 <dd> | |
| 2671 interpreter version info | |
| 2672 </dd> | |
| 2673 <dt><i>platform</i> (str)</dt> | |
| 2674 <dd> | |
| 2675 hostname of the client | |
| 2676 </dd> | |
| 2677 <dt><i>venvName</i> (str)</dt> | |
| 2678 <dd> | |
| 2679 name of the virtual environment | |
| 2680 </dd> | |
| 2681 </dl> | |
| 2682 <a NAME="DebugServer.signalClientBreakConditionError" ID="DebugServer.signalClientBreakConditionError"></a> | |
| 2683 <h4>DebugServer.signalClientBreakConditionError</h4> | |
| 2684 <b>signalClientBreakConditionError</b>(<i>filename, lineno, debuggerId</i>) | |
| 2685 | |
| 2686 <p> | |
| 2687 Public method to process the client breakpoint condition error info. | |
| 2688 </p> | |
| 2689 <dl> | |
| 2690 | |
| 2691 <dt><i>filename</i> (str)</dt> | |
| 2692 <dd> | |
| 2693 filename of the breakpoint | |
| 2694 </dd> | |
| 2695 <dt><i>lineno</i> (int)</dt> | |
| 2696 <dd> | |
| 2697 line umber of the breakpoint | |
| 2698 </dd> | |
| 2699 <dt><i>debuggerId</i> (str)</dt> | |
| 2700 <dd> | |
| 2701 ID of the debugger backend | |
| 2702 </dd> | |
| 2703 </dl> | |
| 2704 <a NAME="DebugServer.signalClientCallTrace" ID="DebugServer.signalClientCallTrace"></a> | |
| 2705 <h4>DebugServer.signalClientCallTrace</h4> | |
| 2706 <b>signalClientCallTrace</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction, debuggerId</i>) | |
| 2707 | |
| 2708 <p> | |
| 2709 Public method to process the client call trace data. | |
| 2710 </p> | |
| 2711 <dl> | |
| 2712 | |
| 2713 <dt><i>isCall</i> (bool)</dt> | |
| 2714 <dd> | |
| 2715 flag indicating a 'call' | |
| 2716 </dd> | |
| 2717 <dt><i>fromFile</i> (str)</dt> | |
| 2718 <dd> | |
| 2719 name of the originating file | |
| 2720 </dd> | |
| 2721 <dt><i>fromLine</i> (str)</dt> | |
| 2722 <dd> | |
| 2723 line number in the originating file | |
| 2724 </dd> | |
| 2725 <dt><i>fromFunction</i> (str)</dt> | |
| 2726 <dd> | |
| 2727 name of the originating function | |
| 2728 </dd> | |
| 2729 <dt><i>toFile</i> (str)</dt> | |
| 2730 <dd> | |
| 2731 name of the target file | |
| 2732 </dd> | |
| 2733 <dt><i>toLine</i> (str)</dt> | |
| 2734 <dd> | |
| 2735 line number in the target file | |
| 2736 </dd> | |
| 2737 <dt><i>toFunction</i> (str)</dt> | |
| 2738 <dd> | |
| 2739 name of the target function | |
| 2740 </dd> | |
| 2741 <dt><i>debuggerId</i> (str)</dt> | |
| 2742 <dd> | |
| 2743 ID of the debugger backend | |
| 2744 </dd> | |
| 2745 </dl> | |
| 2746 <a NAME="DebugServer.signalClientCapabilities" ID="DebugServer.signalClientCapabilities"></a> | |
| 2747 <h4>DebugServer.signalClientCapabilities</h4> | |
| 2748 <b>signalClientCapabilities</b>(<i>capabilities, clientType, venvName</i>) | |
| 2749 | |
| 2750 <p> | |
| 2751 Public method to process the client capabilities info. | |
| 2752 </p> | |
| 2753 <dl> | |
| 2754 | |
| 2755 <dt><i>capabilities</i> (int)</dt> | |
| 2756 <dd> | |
| 2757 bitmaks with the client capabilities | |
| 2758 </dd> | |
| 2759 <dt><i>clientType</i> (str)</dt> | |
| 2760 <dd> | |
| 2761 type of the debug client | |
| 2762 </dd> | |
| 2763 <dt><i>venvName</i> (str)</dt> | |
| 2764 <dd> | |
| 2765 name of the virtual environment | |
| 2766 </dd> | |
| 2767 </dl> | |
| 2768 <a NAME="DebugServer.signalClientClearBreak" ID="DebugServer.signalClientClearBreak"></a> | |
| 2769 <h4>DebugServer.signalClientClearBreak</h4> | |
| 2770 <b>signalClientClearBreak</b>(<i>filename, lineno, debuggerId</i>) | |
| 2771 | |
| 2772 <p> | |
| 2773 Public method to process the client clear breakpoint command. | |
| 2774 </p> | |
| 2775 <dl> | |
| 2776 | |
| 2777 <dt><i>filename</i> (str)</dt> | |
| 2778 <dd> | |
| 2779 filename of the breakpoint | |
| 2780 </dd> | |
| 2781 <dt><i>lineno</i> (int)</dt> | |
| 2782 <dd> | |
| 2783 line umber of the breakpoint | |
| 2784 </dd> | |
| 2785 <dt><i>debuggerId</i> (str)</dt> | |
| 2786 <dd> | |
| 2787 ID of the debugger backend | |
| 2788 </dd> | |
| 2789 </dl> | |
| 2790 <a NAME="DebugServer.signalClientClearWatch" ID="DebugServer.signalClientClearWatch"></a> | |
| 2791 <h4>DebugServer.signalClientClearWatch</h4> | |
| 2792 <b>signalClientClearWatch</b>(<i>condition, debuggerId</i>) | |
| 2793 | |
| 2794 <p> | |
| 2795 Public slot to handle the clientClearWatch signal. | |
| 2796 </p> | |
| 2797 <dl> | |
| 2798 | |
| 2799 <dt><i>condition</i> (str)</dt> | |
| 2800 <dd> | |
| 2801 expression of watch expression to clear | |
| 2802 </dd> | |
| 2803 <dt><i>debuggerId</i> (str)</dt> | |
| 2804 <dd> | |
| 2805 ID of the debugger backend | |
| 2806 </dd> | |
| 2807 </dl> | |
| 2808 <a NAME="DebugServer.signalClientCompletionList" ID="DebugServer.signalClientCompletionList"></a> | |
| 2809 <h4>DebugServer.signalClientCompletionList</h4> | |
| 2810 <b>signalClientCompletionList</b>(<i>completionList, text, debuggerId</i>) | |
| 2811 | |
| 2812 <p> | |
| 2813 Public method to process the client auto completion info. | |
| 2814 </p> | |
| 2815 <dl> | |
| 2816 | |
| 2817 <dt><i>completionList</i> (list of str)</dt> | |
| 2818 <dd> | |
| 2819 list of possible completions | |
| 2820 </dd> | |
| 2821 <dt><i>text</i> (str)</dt> | |
| 2822 <dd> | |
| 2823 the text to be completed | |
| 2824 </dd> | |
| 2825 <dt><i>debuggerId</i> (str)</dt> | |
| 2826 <dd> | |
| 2827 ID of the debugger backend | |
| 2828 </dd> | |
| 2829 </dl> | |
| 2830 <a NAME="DebugServer.signalClientDebuggerId" ID="DebugServer.signalClientDebuggerId"></a> | |
| 2831 <h4>DebugServer.signalClientDebuggerId</h4> | |
| 2832 <b>signalClientDebuggerId</b>(<i>debuggerId</i>) | |
| 2833 | |
| 2834 <p> | |
| 2835 Public method to signal the receipt of a new debugger ID. | |
| 2836 </p> | |
| 2837 <p> | |
| 2838 This signal indicates, that a new debugger backend has connected. | |
| 2839 </p> | |
| 2840 <dl> | |
| 2841 | |
| 2842 <dt><i>debuggerId</i> (str)</dt> | |
| 2843 <dd> | |
| 2844 ID of the newly connected debugger backend | |
| 2845 </dd> | |
| 2846 </dl> | |
| 2847 <a NAME="DebugServer.signalClientDisassembly" ID="DebugServer.signalClientDisassembly"></a> | |
| 2848 <h4>DebugServer.signalClientDisassembly</h4> | |
| 2849 <b>signalClientDisassembly</b>(<i>disassembly, debuggerId</i>) | |
| 2850 | |
| 2851 <p> | |
| 2852 Public method to process the disassembly info from the client. | |
| 2853 </p> | |
| 2854 <dl> | |
| 2855 | |
| 2856 <dt><i>disassembly</i> (dict)</dt> | |
| 2857 <dd> | |
| 2858 dictionary containing the disassembly information | |
| 2859 </dd> | |
| 2860 <dt><i>debuggerId</i> (str)</dt> | |
| 2861 <dd> | |
| 2862 ID of the debugger backend | |
| 2863 </dd> | |
| 2864 </dl> | |
| 2865 <a NAME="DebugServer.signalClientDisconnected" ID="DebugServer.signalClientDisconnected"></a> | |
| 2866 <h4>DebugServer.signalClientDisconnected</h4> | |
| 2867 <b>signalClientDisconnected</b>(<i>debuggerId</i>) | |
| 2868 | |
| 2869 <p> | |
| 2870 Public method to send a signal when a debug client has closed its | |
| 2871 connection. | |
| 2872 </p> | |
| 2873 <dl> | |
| 2874 | |
| 2875 <dt><i>debuggerId</i> (str)</dt> | |
| 2876 <dd> | |
| 2877 ID of the debugger backend | |
| 2878 </dd> | |
| 2879 </dl> | |
| 2880 <a NAME="DebugServer.signalClientException" ID="DebugServer.signalClientException"></a> | |
| 2881 <h4>DebugServer.signalClientException</h4> | |
| 2882 <b>signalClientException</b>(<i>exceptionType, exceptionMessage, stackTrace, debuggerId, threadName=""</i>) | |
| 2883 | |
| 2884 <p> | |
| 2885 Public method to process the exception info from the client. | |
| 2886 </p> | |
| 2887 <dl> | |
| 2888 | |
| 2889 <dt><i>exceptionType</i> (str)</dt> | |
| 2890 <dd> | |
| 2891 type of exception raised | |
| 2892 </dd> | |
| 2893 <dt><i>exceptionMessage</i> (str)</dt> | |
| 2894 <dd> | |
| 2895 message given by the exception | |
| 2896 </dd> | |
| 2897 <dt><i>stackTrace</i> (list)</dt> | |
| 2898 <dd> | |
| 2899 list of stack entries with the exception position | |
| 2900 first. Each stack entry is a list giving the filename and the | |
| 2901 linenumber. | |
| 2902 </dd> | |
| 2903 <dt><i>debuggerId</i> (str)</dt> | |
| 2904 <dd> | |
| 2905 ID of the debugger backend | |
| 2906 </dd> | |
| 2907 <dt><i>threadName</i> (str)</dt> | |
| 2908 <dd> | |
| 2909 name of the thread signaling the event | |
| 2910 </dd> | |
| 2911 </dl> | |
| 2912 <a NAME="DebugServer.signalClientExit" ID="DebugServer.signalClientExit"></a> | |
| 2913 <h4>DebugServer.signalClientExit</h4> | |
| 2914 <b>signalClientExit</b>(<i>program, status, message, debuggerId</i>) | |
| 2915 | |
| 2916 <p> | |
| 2917 Public method to process the client exit status. | |
| 2918 </p> | |
| 2919 <dl> | |
| 2920 | |
| 2921 <dt><i>program</i> (str)</dt> | |
| 2922 <dd> | |
| 2923 name of the exited program | |
| 2924 </dd> | |
| 2925 <dt><i>status</i> (int)</dt> | |
| 2926 <dd> | |
| 2927 exit code | |
| 2928 </dd> | |
| 2929 <dt><i>message</i> (str)</dt> | |
| 2930 <dd> | |
| 2931 message sent with the exit | |
| 2932 </dd> | |
| 2933 <dt><i>debuggerId</i> (str)</dt> | |
| 2934 <dd> | |
| 2935 ID of the debugger backend | |
| 2936 </dd> | |
| 2937 </dl> | |
| 2938 <a NAME="DebugServer.signalClientLine" ID="DebugServer.signalClientLine"></a> | |
| 2939 <h4>DebugServer.signalClientLine</h4> | |
| 2940 <b>signalClientLine</b>(<i>filename, lineno, debuggerId, forStack=False, threadName=""</i>) | |
| 2941 | |
| 2942 <p> | |
| 2943 Public method to process client position feedback. | |
| 2944 </p> | |
| 2945 <dl> | |
| 2946 | |
| 2947 <dt><i>filename</i> (str)</dt> | |
| 2948 <dd> | |
| 2949 name of the file currently being executed | |
| 2950 </dd> | |
| 2951 <dt><i>lineno</i> (int)</dt> | |
| 2952 <dd> | |
| 2953 line of code currently being executed | |
| 2954 </dd> | |
| 2955 <dt><i>debuggerId</i> (str)</dt> | |
| 2956 <dd> | |
| 2957 ID of the debugger backend | |
| 2958 </dd> | |
| 2959 <dt><i>forStack</i> (bool)</dt> | |
| 2960 <dd> | |
| 2961 flag indicating this is for a stack dump | |
| 2962 </dd> | |
| 2963 <dt><i>threadName</i> (str)</dt> | |
| 2964 <dd> | |
| 2965 name of the thread signaling the event | |
| 2966 </dd> | |
| 2967 </dl> | |
| 2968 <a NAME="DebugServer.signalClientOutput" ID="DebugServer.signalClientOutput"></a> | |
| 2969 <h4>DebugServer.signalClientOutput</h4> | |
| 2970 <b>signalClientOutput</b>(<i>line, debuggerId</i>) | |
| 2971 | |
| 2972 <p> | |
| 2973 Public method to process a line of client output. | |
| 2974 </p> | |
| 2975 <dl> | |
| 2976 | |
| 2977 <dt><i>line</i> (str)</dt> | |
| 2978 <dd> | |
| 2979 client output | |
| 2980 </dd> | |
| 2981 <dt><i>debuggerId</i> (str)</dt> | |
| 2982 <dd> | |
| 2983 ID of the debugger backend | |
| 2984 </dd> | |
| 2985 </dl> | |
| 2986 <a NAME="DebugServer.signalClientRawInput" ID="DebugServer.signalClientRawInput"></a> | |
| 2987 <h4>DebugServer.signalClientRawInput</h4> | |
| 2988 <b>signalClientRawInput</b>(<i>prompt, echo, debuggerId</i>) | |
| 2989 | |
| 2990 <p> | |
| 2991 Public method to process the client raw input command. | |
| 2992 </p> | |
| 2993 <dl> | |
| 2994 | |
| 2995 <dt><i>prompt</i> (str)</dt> | |
| 2996 <dd> | |
| 2997 the input prompt | |
| 2998 </dd> | |
| 2999 <dt><i>echo</i> (bool)</dt> | |
| 3000 <dd> | |
| 3001 flag indicating an echoing of the input | |
| 3002 </dd> | |
| 3003 <dt><i>debuggerId</i> (str)</dt> | |
| 3004 <dd> | |
| 3005 ID of the debugger backend | |
| 3006 </dd> | |
| 3007 </dl> | |
| 3008 <a NAME="DebugServer.signalClientSignal" ID="DebugServer.signalClientSignal"></a> | |
| 3009 <h4>DebugServer.signalClientSignal</h4> | |
| 3010 <b>signalClientSignal</b>(<i>message, filename, lineNo, funcName, funcArgs, debuggerId</i>) | |
| 3011 | |
| 3012 <p> | |
| 3013 Public method to process a signal generated on the client side. | |
| 3014 </p> | |
| 3015 <dl> | |
| 3016 | |
| 3017 <dt><i>message</i> (str)</dt> | |
| 3018 <dd> | |
| 3019 message of the syntax error | |
| 3020 </dd> | |
| 3021 <dt><i>filename</i> (str)</dt> | |
| 3022 <dd> | |
| 3023 translated filename of the syntax error position | |
| 3024 </dd> | |
| 3025 <dt><i>lineNo</i> (int)</dt> | |
| 3026 <dd> | |
| 3027 line number of the syntax error position | |
| 3028 </dd> | |
| 3029 <dt><i>funcName</i> (str)</dt> | |
| 3030 <dd> | |
| 3031 name of the function causing the signal | |
| 3032 </dd> | |
| 3033 <dt><i>funcArgs</i> (str)</dt> | |
| 3034 <dd> | |
| 3035 function arguments | |
| 3036 </dd> | |
| 3037 <dt><i>debuggerId</i> (str)</dt> | |
| 3038 <dd> | |
| 3039 ID of the debugger backend | |
| 3040 </dd> | |
| 3041 </dl> | |
| 3042 <a NAME="DebugServer.signalClientStack" ID="DebugServer.signalClientStack"></a> | |
| 3043 <h4>DebugServer.signalClientStack</h4> | |
| 3044 <b>signalClientStack</b>(<i>stack, debuggerId, threadName=""</i>) | |
| 3045 | |
| 3046 <p> | |
| 3047 Public method to process a client's stack information. | |
| 3048 </p> | |
| 3049 <dl> | |
| 3050 | |
| 3051 <dt><i>stack</i> (list of lists of (string, integer, string))</dt> | |
| 3052 <dd> | |
| 3053 list of stack entries. Each entry is a tuple of three | |
| 3054 values giving the filename, linenumber and method | |
| 3055 </dd> | |
| 3056 <dt><i>debuggerId</i> (str)</dt> | |
| 3057 <dd> | |
| 3058 ID of the debugger backend | |
| 3059 </dd> | |
| 3060 <dt><i>threadName</i> (str)</dt> | |
| 3061 <dd> | |
| 3062 name of the thread signaling the event | |
| 3063 </dd> | |
| 3064 </dl> | |
| 3065 <a NAME="DebugServer.signalClientStatement" ID="DebugServer.signalClientStatement"></a> | |
| 3066 <h4>DebugServer.signalClientStatement</h4> | |
| 3067 <b>signalClientStatement</b>(<i>more, debuggerId</i>) | |
| 3068 | |
| 3069 <p> | |
| 3070 Public method to process the input response from the client. | |
| 3071 </p> | |
| 3072 <dl> | |
| 3073 | |
| 3074 <dt><i>more</i> (bool)</dt> | |
| 3075 <dd> | |
| 3076 flag indicating that more user input is required | |
| 3077 </dd> | |
| 3078 <dt><i>debuggerId</i> (str)</dt> | |
| 3079 <dd> | |
| 3080 ID of the debugger backend | |
| 3081 </dd> | |
| 3082 </dl> | |
| 3083 <a NAME="DebugServer.signalClientSyntaxError" ID="DebugServer.signalClientSyntaxError"></a> | |
| 3084 <h4>DebugServer.signalClientSyntaxError</h4> | |
| 3085 <b>signalClientSyntaxError</b>(<i>message, filename, lineNo, characterNo, debuggerId, threadName=""</i>) | |
| 3086 | |
| 3087 <p> | |
| 3088 Public method to process a syntax error info from the client. | |
| 3089 </p> | |
| 3090 <dl> | |
| 3091 | |
| 3092 <dt><i>message</i> (str)</dt> | |
| 3093 <dd> | |
| 3094 message of the syntax error | |
| 3095 </dd> | |
| 3096 <dt><i>filename</i> (str)</dt> | |
| 3097 <dd> | |
| 3098 translated filename of the syntax error position | |
| 3099 </dd> | |
| 3100 <dt><i>lineNo</i> (int)</dt> | |
| 3101 <dd> | |
| 3102 line number of the syntax error position | |
| 3103 </dd> | |
| 3104 <dt><i>characterNo</i> (int)</dt> | |
| 3105 <dd> | |
| 3106 character number of the syntax error position | |
| 3107 </dd> | |
| 3108 <dt><i>debuggerId</i> (str)</dt> | |
| 3109 <dd> | |
| 3110 ID of the debugger backend | |
| 3111 </dd> | |
| 3112 <dt><i>threadName</i> (str)</dt> | |
| 3113 <dd> | |
| 3114 name of the thread signaling the event | |
| 3115 </dd> | |
| 3116 </dl> | |
| 3117 <a NAME="DebugServer.signalClientThreadList" ID="DebugServer.signalClientThreadList"></a> | |
| 3118 <h4>DebugServer.signalClientThreadList</h4> | |
| 3119 <b>signalClientThreadList</b>(<i>currentId, threadList, debuggerId</i>) | |
| 3120 | |
| 3121 <p> | |
| 3122 Public method to process the client thread list info. | |
| 3123 </p> | |
| 3124 <dl> | |
| 3125 | |
| 3126 <dt><i>currentId</i> (int)</dt> | |
| 3127 <dd> | |
| 3128 id of the current thread | |
| 3129 </dd> | |
| 3130 <dt><i>threadList</i> (list of dict)</dt> | |
| 3131 <dd> | |
| 3132 list of dictionaries containing the thread data | |
| 3133 </dd> | |
| 3134 <dt><i>debuggerId</i> (str)</dt> | |
| 3135 <dd> | |
| 3136 ID of the debugger backend | |
| 3137 </dd> | |
| 3138 </dl> | |
| 3139 <a NAME="DebugServer.signalClientThreadSet" ID="DebugServer.signalClientThreadSet"></a> | |
| 3140 <h4>DebugServer.signalClientThreadSet</h4> | |
| 3141 <b>signalClientThreadSet</b>(<i>debuggerId</i>) | |
| 3142 | |
| 3143 <p> | |
| 3144 Public method to handle the change of the client thread. | |
| 3145 </p> | |
| 3146 <dl> | |
| 3147 | |
| 3148 <dt><i>debuggerId</i> (str)</dt> | |
| 3149 <dd> | |
| 3150 ID of the debugger backend | |
| 3151 </dd> | |
| 3152 </dl> | |
| 3153 <a NAME="DebugServer.signalClientVariable" ID="DebugServer.signalClientVariable"></a> | |
| 3154 <h4>DebugServer.signalClientVariable</h4> | |
| 3155 <b>signalClientVariable</b>(<i>scope, variables, debuggerId</i>) | |
| 3156 | |
| 3157 <p> | |
| 3158 Public method to process the client variable info. | |
| 3159 </p> | |
| 3160 <dl> | |
| 3161 | |
| 3162 <dt><i>scope</i> (int)</dt> | |
| 3163 <dd> | |
| 3164 scope of the variables (-1 = empty global, 1 = global, | |
| 3165 0 = local) | |
| 3166 </dd> | |
| 3167 <dt><i>variables</i> (list)</dt> | |
| 3168 <dd> | |
| 3169 the list of members of a classvariable from the client | |
| 3170 </dd> | |
| 3171 <dt><i>debuggerId</i> (str)</dt> | |
| 3172 <dd> | |
| 3173 ID of the debugger backend | |
| 3174 </dd> | |
| 3175 </dl> | |
| 3176 <a NAME="DebugServer.signalClientVariables" ID="DebugServer.signalClientVariables"></a> | |
| 3177 <h4>DebugServer.signalClientVariables</h4> | |
| 3178 <b>signalClientVariables</b>(<i>scope, variables, debuggerId</i>) | |
| 3179 | |
| 3180 <p> | |
| 3181 Public method to process the client variables info. | |
| 3182 </p> | |
| 3183 <dl> | |
| 3184 | |
| 3185 <dt><i>scope</i> (int)</dt> | |
| 3186 <dd> | |
| 3187 scope of the variables | |
| 3188 (-2 = no frame found, -1 = empty locals, 1 = global, 0 = local) | |
| 3189 </dd> | |
| 3190 <dt><i>variables</i> (list)</dt> | |
| 3191 <dd> | |
| 3192 the list of variables from the client | |
| 3193 </dd> | |
| 3194 <dt><i>debuggerId</i> (str)</dt> | |
| 3195 <dd> | |
| 3196 ID of the debugger backend | |
| 3197 </dd> | |
| 3198 </dl> | |
| 3199 <a NAME="DebugServer.signalClientWatchConditionError" ID="DebugServer.signalClientWatchConditionError"></a> | |
| 3200 <h4>DebugServer.signalClientWatchConditionError</h4> | |
| 3201 <b>signalClientWatchConditionError</b>(<i>condition, debuggerId</i>) | |
| 3202 | |
| 3203 <p> | |
| 3204 Public method to process the client watch expression error info. | |
| 3205 </p> | |
| 3206 <dl> | |
| 3207 | |
| 3208 <dt><i>condition</i> (str)</dt> | |
| 3209 <dd> | |
| 3210 expression of watch expression to clear | |
| 3211 </dd> | |
| 3212 <dt><i>debuggerId</i> (str)</dt> | |
| 3213 <dd> | |
| 3214 ID of the debugger backend | |
| 3215 </dd> | |
| 3216 </dl> | |
| 3217 <a NAME="DebugServer.signalLastClientExited" ID="DebugServer.signalLastClientExited"></a> | |
| 3218 <h4>DebugServer.signalLastClientExited</h4> | |
| 3219 <b>signalLastClientExited</b>(<i></i>) | |
| 3220 | |
| 3221 <p> | |
| 3222 Public method to process the last client exit event. | |
| 3223 </p> | |
| 3224 <a NAME="DebugServer.signalMainClientExit" ID="DebugServer.signalMainClientExit"></a> | |
| 3225 <h4>DebugServer.signalMainClientExit</h4> | |
| 3226 <b>signalMainClientExit</b>(<i></i>) | |
| 3227 | |
| 3228 <p> | |
| 3229 Public method to process the main client exiting. | |
| 3230 </p> | |
| 3231 <a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a> | |
| 3232 <h4>DebugServer.startClient</h4> | |
| 3233 <b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, venvName="", workingDir=None, configOverride=None</i>) | |
| 3234 | |
| 3235 <p> | |
| 3236 Public method to start a debug client. | |
| 3237 </p> | |
| 3238 <dl> | |
| 3239 | |
| 3240 <dt><i>unplanned</i> (bool)</dt> | |
| 3241 <dd> | |
| 3242 flag indicating that the client has died | |
| 3243 </dd> | |
| 3244 <dt><i>clType</i> (str)</dt> | |
| 3245 <dd> | |
| 3246 type of client to be started | |
| 3247 </dd> | |
| 3248 <dt><i>forProject</i> (bool)</dt> | |
| 3249 <dd> | |
| 3250 flag indicating a project related action | |
| 3251 </dd> | |
| 3252 <dt><i>runInConsole</i> (bool)</dt> | |
| 3253 <dd> | |
| 3254 flag indicating to start the debugger in a | |
| 3255 console window | |
| 3256 </dd> | |
| 3257 <dt><i>venvName</i> (str)</dt> | |
| 3258 <dd> | |
| 3259 name of the virtual environment to be used | |
| 3260 </dd> | |
| 3261 <dt><i>workingDir</i> (str)</dt> | |
| 3262 <dd> | |
| 3263 directory to start the debugger client in | |
| 3264 </dd> | |
| 3265 <dt><i>configOverride</i> (dict)</dt> | |
| 3266 <dd> | |
| 3267 dictionary containing the global config override | |
| 3268 data | |
| 3269 </dd> | |
| 3270 </dl> | |
| 3271 <a NAME="DebugServer.unregisterDebuggerInterface" ID="DebugServer.unregisterDebuggerInterface"></a> | |
| 3272 <h4>DebugServer.unregisterDebuggerInterface</h4> | |
| 3273 <b>unregisterDebuggerInterface</b>(<i>interfaceName</i>) | |
| 3274 | |
| 3275 <p> | |
| 3276 Public method to unregister a debugger interface. | |
| 3277 </p> | |
| 3278 <dl> | |
| 3279 | |
| 3280 <dt><i>interfaceName</i> (str)</dt> | |
| 3281 <dd> | |
| 3282 interfaceName of the debugger interface | |
| 3283 </dd> | |
| 3284 </dl> | |
| 3285 <div align="right"><a href="#top">Up</a></div> | |
| 3286 <hr /> | |
| 3287 </body></html> |
