Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Debugger.DebuggerInterfacePython.html

eric6/Documentation/Source/eric6.Debugger.DebuggerInterfacePython.html

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

Mercurial Repository: eric

eric ide

mercurial