Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Debugger.DebuggerInterfaceNone.html

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

Mercurial Repository: eric

eric ide

mercurial