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