Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DebugClients.Python3.DebugClientBase.html
Documentation/Source/eric5.DebugClients.Python3.DebugClientBase.html
- changeset 58
- 37f0444c3479
- parent 41
- 572a009369f0
- child 72
- 015c7e35bd84
equal
deleted
inserted
replaced
| 57:81326a94fdca | 58:37f0444c3479 |
|---|---|
| 20 </style> | 20 </style> |
| 21 </head> | 21 </head> |
| 22 <body><a NAME="top" ID="top"></a> | 22 <body><a NAME="top" ID="top"></a> |
| 23 <h1>eric5.DebugClients.Python3.DebugClientBase</h1> | 23 <h1>eric5.DebugClients.Python3.DebugClientBase</h1> |
| 24 <p> | 24 <p> |
| 25 Module implementing a debug client base class. | 25 Module implementing a debug client base class. |
| 26 </p> | 26 </p> |
| 27 <h3>Global Attributes</h3> | 27 <h3>Global Attributes</h3> |
| 28 <table> | 28 <table> |
| 29 <tr><td>DebugClientInstance</td></tr> | 29 <tr><td>DebugClientInstance</td></tr> |
| 30 </table> | 30 </table> |
| 31 <h3>Classes</h3> | 31 <h3>Classes</h3> |
| 32 <table> | 32 <table> |
| 33 <tr> | 33 <tr> |
| 34 <td><a href="#DebugClientBase">DebugClientBase</a></td> | 34 <td><a href="#DebugClientBase">DebugClientBase</a></td> |
| 35 <td>Class implementing the client side of the debugger.</td> | 35 <td>Class implementing the client side of the debugger.</td> |
| 36 </tr> | 36 </tr> |
| 37 </table> | 37 </table> |
| 38 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 <table> | 39 <table> |
| 40 <tr> | 40 <tr> |
| 41 <td><a href="#DebugClientClose">DebugClientClose</a></td> | 41 <td><a href="#DebugClientClose">DebugClientClose</a></td> |
| 42 <td>Replacement for the standard os.close(fd).</td> | 42 <td>Replacement for the standard os.close(fd).</td> |
| 43 </tr><tr> | 43 </tr><tr> |
| 44 <td><a href="#DebugClientFork">DebugClientFork</a></td> | 44 <td><a href="#DebugClientFork">DebugClientFork</a></td> |
| 45 <td>Replacement for the standard os.fork().</td> | 45 <td>Replacement for the standard os.fork().</td> |
| 46 </tr><tr> | 46 </tr><tr> |
| 47 <td><a href="#DebugClientInput">DebugClientInput</a></td> | 47 <td><a href="#DebugClientInput">DebugClientInput</a></td> |
| 48 <td>Replacement for the standard input builtin.</td> | 48 <td>Replacement for the standard input builtin.</td> |
| 49 </tr><tr> | 49 </tr><tr> |
| 50 <td><a href="#DebugClientSetRecursionLimit">DebugClientSetRecursionLimit</a></td> | 50 <td><a href="#DebugClientSetRecursionLimit">DebugClientSetRecursionLimit</a></td> |
| 51 <td>Replacement for the standard sys.setrecursionlimit(limit).</td> | 51 <td>Replacement for the standard sys.setrecursionlimit(limit).</td> |
| 52 </tr> | 52 </tr> |
| 53 </table> | 53 </table> |
| 54 <hr /><hr /> | 54 <hr /><hr /> |
| 55 <a NAME="DebugClientBase" ID="DebugClientBase"></a> | 55 <a NAME="DebugClientBase" ID="DebugClientBase"></a> |
| 56 <h2>DebugClientBase</h2> | 56 <h2>DebugClientBase</h2> |
| 57 <p> | 57 <p> |
| 58 Class implementing the client side of the debugger. | 58 Class implementing the client side of the debugger. |
| 59 </p><p> | 59 </p><p> |
| 60 It provides access to the Python interpeter from a debugger running in another | 60 It provides access to the Python interpeter from a debugger running in another |
| 61 process whether or not the Qt event loop is running. | 61 process whether or not the Qt event loop is running. |
| 62 </p><p> | 62 </p><p> |
| 63 The protocol between the debugger and the client assumes that there will be | 63 The protocol between the debugger and the client assumes that there will be |
| 64 a single source of debugger commands and a single source of Python | 64 a single source of debugger commands and a single source of Python |
| 65 statements. Commands and statement are always exactly one line and may be | 65 statements. Commands and statement are always exactly one line and may be |
| 66 interspersed. | 66 interspersed. |
| 67 </p><p> | 67 </p><p> |
| 68 The protocol is as follows. First the client opens a connection to the | 68 The protocol is as follows. First the client opens a connection to the |
| 69 debugger and then sends a series of one line commands. A command is either | 69 debugger and then sends a series of one line commands. A command is either |
| 70 &gt;Load&lt;, &gt;Step&lt;, &gt;StepInto&lt;, ... or a Python statement. | 70 >Load<, >Step<, >StepInto<, ... or a Python statement. |
| 71 See DebugProtocol.py for a listing of valid protocol tokens. | 71 See DebugProtocol.py for a listing of valid protocol tokens. |
| 72 </p><p> | 72 </p><p> |
| 73 A Python statement consists of the statement to execute, followed (in a | 73 A Python statement consists of the statement to execute, followed (in a |
| 74 separate line) by &gt;OK?&lt;. If the statement was incomplete then the response | 74 separate line) by >OK?<. If the statement was incomplete then the response |
| 75 is &gt;Continue&lt;. If there was an exception then the response is | 75 is >Continue<. If there was an exception then the response is |
| 76 &gt;Exception&lt;. | 76 >Exception<. |
| 77 Otherwise the response is &gt;OK&lt;. The reason for the &gt;OK?&lt; part is to | 77 Otherwise the response is >OK<. The reason for the >OK?< part is to |
| 78 provide a sentinal (ie. the responding &gt;OK&lt;) after any possible output as a | 78 provide a sentinal (ie. the responding >OK<) after any possible output as a |
| 79 result of executing the command. | 79 result of executing the command. |
| 80 </p><p> | 80 </p><p> |
| 81 The client may send any other lines at any other time which should be | 81 The client may send any other lines at any other time which should be |
| 82 interpreted as program output. | 82 interpreted as program output. |
| 83 </p><p> | 83 </p><p> |
| 84 If the debugger closes the session there is no response from the client. | 84 If the debugger closes the session there is no response from the client. |
| 85 The client may close the session at any time as a result of the script | 85 The client may close the session at any time as a result of the script |
| 86 being debugged closing or crashing. | 86 being debugged closing or crashing. |
| 87 </p><p> | 87 </p><p> |
| 88 <b>Note</b>: This class is meant to be subclassed by individual DebugClient classes. | 88 <b>Note</b>: This class is meant to be subclassed by individual DebugClient classes. |
| 89 Do not instantiate it directly. | 89 Do not instantiate it directly. |
| 90 </p> | 90 </p> |
| 91 <h3>Derived from</h3> | 91 <h3>Derived from</h3> |
| 92 object | 92 object |
| 93 <h3>Class Attributes</h3> | 93 <h3>Class Attributes</h3> |
| 94 <table> | 94 <table> |
| 96 </table> | 96 </table> |
| 97 <h3>Methods</h3> | 97 <h3>Methods</h3> |
| 98 <table> | 98 <table> |
| 99 <tr> | 99 <tr> |
| 100 <td><a href="#DebugClientBase.__init__">DebugClientBase</a></td> | 100 <td><a href="#DebugClientBase.__init__">DebugClientBase</a></td> |
| 101 <td>Constructor</td> | 101 <td>Constructor</td> |
| 102 </tr><tr> | 102 </tr><tr> |
| 103 <td><a href="#DebugClientBase.__clientCapabilities">__clientCapabilities</a></td> | 103 <td><a href="#DebugClientBase.__clientCapabilities">__clientCapabilities</a></td> |
| 104 <td>Private method to determine the clients capabilities.</td> | 104 <td>Private method to determine the clients capabilities.</td> |
| 105 </tr><tr> | 105 </tr><tr> |
| 106 <td><a href="#DebugClientBase.__compileFileSource">__compileFileSource</a></td> | 106 <td><a href="#DebugClientBase.__compileFileSource">__compileFileSource</a></td> |
| 107 <td>Private method to compile source code read from a file.</td> | 107 <td>Private method to compile source code read from a file.</td> |
| 108 </tr><tr> | 108 </tr><tr> |
| 109 <td><a href="#DebugClientBase.__completionList">__completionList</a></td> | 109 <td><a href="#DebugClientBase.__completionList">__completionList</a></td> |
| 110 <td>Private slot to handle the request for a commandline completion list.</td> | 110 <td>Private slot to handle the request for a commandline completion list.</td> |
| 111 </tr><tr> | 111 </tr><tr> |
| 112 <td><a href="#DebugClientBase.__dumpThreadList">__dumpThreadList</a></td> | 112 <td><a href="#DebugClientBase.__dumpThreadList">__dumpThreadList</a></td> |
| 113 <td>Public method to send the list of threads.</td> | 113 <td>Public method to send the list of threads.</td> |
| 114 </tr><tr> | 114 </tr><tr> |
| 115 <td><a href="#DebugClientBase.__dumpVariable">__dumpVariable</a></td> | 115 <td><a href="#DebugClientBase.__dumpVariable">__dumpVariable</a></td> |
| 116 <td>Private method to return the variables of a frame to the debug server.</td> | 116 <td>Private method to return the variables of a frame to the debug server.</td> |
| 117 </tr><tr> | 117 </tr><tr> |
| 118 <td><a href="#DebugClientBase.__dumpVariables">__dumpVariables</a></td> | 118 <td><a href="#DebugClientBase.__dumpVariables">__dumpVariables</a></td> |
| 119 <td>Private method to return the variables of a frame to the debug server.</td> | 119 <td>Private method to return the variables of a frame to the debug server.</td> |
| 120 </tr><tr> | 120 </tr><tr> |
| 121 <td><a href="#DebugClientBase.__exceptionRaised">__exceptionRaised</a></td> | 121 <td><a href="#DebugClientBase.__exceptionRaised">__exceptionRaised</a></td> |
| 122 <td>Private method called in the case of an exception</td> | 122 <td>Private method called in the case of an exception</td> |
| 123 </tr><tr> | 123 </tr><tr> |
| 124 <td><a href="#DebugClientBase.__formatQt4Variable">__formatQt4Variable</a></td> | 124 <td><a href="#DebugClientBase.__formatQt4Variable">__formatQt4Variable</a></td> |
| 125 <td>Private method to produce a formatted output of a simple Qt4 type.</td> | 125 <td>Private method to produce a formatted output of a simple Qt4 type.</td> |
| 126 </tr><tr> | 126 </tr><tr> |
| 127 <td><a href="#DebugClientBase.__formatVariablesList">__formatVariablesList</a></td> | 127 <td><a href="#DebugClientBase.__formatVariablesList">__formatVariablesList</a></td> |
| 128 <td>Private method to produce a formated variables list.</td> | 128 <td>Private method to produce a formated variables list.</td> |
| 129 </tr><tr> | 129 </tr><tr> |
| 130 <td><a href="#DebugClientBase.__generateFilterObjects">__generateFilterObjects</a></td> | 130 <td><a href="#DebugClientBase.__generateFilterObjects">__generateFilterObjects</a></td> |
| 131 <td>Private slot to convert a filter string to a list of filter objects.</td> | 131 <td>Private slot to convert a filter string to a list of filter objects.</td> |
| 132 </tr><tr> | 132 </tr><tr> |
| 133 <td><a href="#DebugClientBase.__interact">__interact</a></td> | 133 <td><a href="#DebugClientBase.__interact">__interact</a></td> |
| 134 <td>Private method to Interact with the debugger.</td> | 134 <td>Private method to Interact with the debugger.</td> |
| 135 </tr><tr> | 135 </tr><tr> |
| 136 <td><a href="#DebugClientBase.__resolveHost">__resolveHost</a></td> | 136 <td><a href="#DebugClientBase.__resolveHost">__resolveHost</a></td> |
| 137 <td>Private method to resolve a hostname to an IP address.</td> | 137 <td>Private method to resolve a hostname to an IP address.</td> |
| 138 </tr><tr> | 138 </tr><tr> |
| 139 <td><a href="#DebugClientBase.__setCoding">__setCoding</a></td> | 139 <td><a href="#DebugClientBase.__setCoding">__setCoding</a></td> |
| 140 <td>Private method to set the coding used by a python file.</td> | 140 <td>Private method to set the coding used by a python file.</td> |
| 141 </tr><tr> | 141 </tr><tr> |
| 142 <td><a href="#DebugClientBase.__unhandled_exception">__unhandled_exception</a></td> | 142 <td><a href="#DebugClientBase.__unhandled_exception">__unhandled_exception</a></td> |
| 143 <td>Private method called to report an uncaught exception.</td> | 143 <td>Private method called to report an uncaught exception.</td> |
| 144 </tr><tr> | 144 </tr><tr> |
| 145 <td><a href="#DebugClientBase.absPath">absPath</a></td> | 145 <td><a href="#DebugClientBase.absPath">absPath</a></td> |
| 146 <td>Public method to convert a filename to an absolute name.</td> | 146 <td>Public method to convert a filename to an absolute name.</td> |
| 147 </tr><tr> | 147 </tr><tr> |
| 148 <td><a href="#DebugClientBase.attachThread">attachThread</a></td> | 148 <td><a href="#DebugClientBase.attachThread">attachThread</a></td> |
| 149 <td>Public method to setup a thread for DebugClient to debug.</td> | 149 <td>Public method to setup a thread for DebugClient to debug.</td> |
| 150 </tr><tr> | 150 </tr><tr> |
| 151 <td><a href="#DebugClientBase.close">close</a></td> | 151 <td><a href="#DebugClientBase.close">close</a></td> |
| 152 <td>Private method implementing a close method as a replacement for os.close().</td> | 152 <td>Private method implementing a close method as a replacement for os.close().</td> |
| 153 </tr><tr> | 153 </tr><tr> |
| 154 <td><a href="#DebugClientBase.connectDebugger">connectDebugger</a></td> | 154 <td><a href="#DebugClientBase.connectDebugger">connectDebugger</a></td> |
| 155 <td>Public method to establish a session with the debugger.</td> | 155 <td>Public method to establish a session with the debugger.</td> |
| 156 </tr><tr> | 156 </tr><tr> |
| 157 <td><a href="#DebugClientBase.eventLoop">eventLoop</a></td> | 157 <td><a href="#DebugClientBase.eventLoop">eventLoop</a></td> |
| 158 <td>Public method implementing our event loop.</td> | 158 <td>Public method implementing our event loop.</td> |
| 159 </tr><tr> | 159 </tr><tr> |
| 160 <td><a href="#DebugClientBase.eventPoll">eventPoll</a></td> | 160 <td><a href="#DebugClientBase.eventPoll">eventPoll</a></td> |
| 161 <td>Public method to poll for events like 'set break point'.</td> | 161 <td>Public method to poll for events like 'set break point'.</td> |
| 162 </tr><tr> | 162 </tr><tr> |
| 163 <td><a href="#DebugClientBase.fork">fork</a></td> | 163 <td><a href="#DebugClientBase.fork">fork</a></td> |
| 164 <td>Public method implementing a fork routine deciding which branch to follow.</td> | 164 <td>Public method implementing a fork routine deciding which branch to follow.</td> |
| 165 </tr><tr> | 165 </tr><tr> |
| 166 <td><a href="#DebugClientBase.getCoding">getCoding</a></td> | 166 <td><a href="#DebugClientBase.getCoding">getCoding</a></td> |
| 167 <td>Public method to return the current coding.</td> | 167 <td>Public method to return the current coding.</td> |
| 168 </tr><tr> | 168 </tr><tr> |
| 169 <td><a href="#DebugClientBase.getRunning">getRunning</a></td> | 169 <td><a href="#DebugClientBase.getRunning">getRunning</a></td> |
| 170 <td>Public method to return the main script we are currently running.</td> | 170 <td>Public method to return the main script we are currently running.</td> |
| 171 </tr><tr> | 171 </tr><tr> |
| 172 <td><a href="#DebugClientBase.handleLine">handleLine</a></td> | 172 <td><a href="#DebugClientBase.handleLine">handleLine</a></td> |
| 173 <td>Public method to handle the receipt of a complete line.</td> | 173 <td>Public method to handle the receipt of a complete line.</td> |
| 174 </tr><tr> | 174 </tr><tr> |
| 175 <td><a href="#DebugClientBase.input">input</a></td> | 175 <td><a href="#DebugClientBase.input">input</a></td> |
| 176 <td>Public method to implement input() using the event loop.</td> | 176 <td>Public method to implement input() using the event loop.</td> |
| 177 </tr><tr> | 177 </tr><tr> |
| 178 <td><a href="#DebugClientBase.main">main</a></td> | 178 <td><a href="#DebugClientBase.main">main</a></td> |
| 179 <td>Public method implementing the main method.</td> | 179 <td>Public method implementing the main method.</td> |
| 180 </tr><tr> | 180 </tr><tr> |
| 181 <td><a href="#DebugClientBase.progTerminated">progTerminated</a></td> | 181 <td><a href="#DebugClientBase.progTerminated">progTerminated</a></td> |
| 182 <td>Public method to tell the debugger that the program has terminated.</td> | 182 <td>Public method to tell the debugger that the program has terminated.</td> |
| 183 </tr><tr> | 183 </tr><tr> |
| 184 <td><a href="#DebugClientBase.run_call">run_call</a></td> | 184 <td><a href="#DebugClientBase.run_call">run_call</a></td> |
| 185 <td>Public method used to start the remote debugger and call a function.</td> | 185 <td>Public method used to start the remote debugger and call a function.</td> |
| 186 </tr><tr> | 186 </tr><tr> |
| 187 <td><a href="#DebugClientBase.sessionClose">sessionClose</a></td> | 187 <td><a href="#DebugClientBase.sessionClose">sessionClose</a></td> |
| 188 <td>Public method to close the session with the debugger and optionally terminate.</td> | 188 <td>Public method to close the session with the debugger and optionally terminate.</td> |
| 189 </tr><tr> | 189 </tr><tr> |
| 190 <td><a href="#DebugClientBase.shouldSkip">shouldSkip</a></td> | 190 <td><a href="#DebugClientBase.shouldSkip">shouldSkip</a></td> |
| 191 <td>Public method to check if a file should be skipped.</td> | 191 <td>Public method to check if a file should be skipped.</td> |
| 192 </tr><tr> | 192 </tr><tr> |
| 193 <td><a href="#DebugClientBase.startDebugger">startDebugger</a></td> | 193 <td><a href="#DebugClientBase.startDebugger">startDebugger</a></td> |
| 194 <td>Public method used to start the remote debugger.</td> | 194 <td>Public method used to start the remote debugger.</td> |
| 195 </tr><tr> | 195 </tr><tr> |
| 196 <td><a href="#DebugClientBase.startProgInDebugger">startProgInDebugger</a></td> | 196 <td><a href="#DebugClientBase.startProgInDebugger">startProgInDebugger</a></td> |
| 197 <td>Public method used to start the remote debugger.</td> | 197 <td>Public method used to start the remote debugger.</td> |
| 198 </tr><tr> | 198 </tr><tr> |
| 199 <td><a href="#DebugClientBase.write">write</a></td> | 199 <td><a href="#DebugClientBase.write">write</a></td> |
| 200 <td>Public method to write data to the output stream.</td> | 200 <td>Public method to write data to the output stream.</td> |
| 201 </tr> | 201 </tr> |
| 202 </table> | 202 </table> |
| 203 <a NAME="DebugClientBase.__init__" ID="DebugClientBase.__init__"></a> | 203 <a NAME="DebugClientBase.__init__" ID="DebugClientBase.__init__"></a> |
| 204 <h4>DebugClientBase (Constructor)</h4> | 204 <h4>DebugClientBase (Constructor)</h4> |
| 205 <b>DebugClientBase</b>(<i></i>) | 205 <b>DebugClientBase</b>(<i></i>) |
| 206 <p> | 206 <p> |
| 207 Constructor | 207 Constructor |
| 208 </p><a NAME="DebugClientBase.__clientCapabilities" ID="DebugClientBase.__clientCapabilities"></a> | 208 </p><a NAME="DebugClientBase.__clientCapabilities" ID="DebugClientBase.__clientCapabilities"></a> |
| 209 <h4>DebugClientBase.__clientCapabilities</h4> | 209 <h4>DebugClientBase.__clientCapabilities</h4> |
| 210 <b>__clientCapabilities</b>(<i></i>) | 210 <b>__clientCapabilities</b>(<i></i>) |
| 211 <p> | 211 <p> |
| 212 Private method to determine the clients capabilities. | 212 Private method to determine the clients capabilities. |
| 213 </p><dl> | 213 </p><dl> |
| 214 <dt>Returns:</dt> | 214 <dt>Returns:</dt> |
| 215 <dd> | 215 <dd> |
| 216 client capabilities (integer) | 216 client capabilities (integer) |
| 217 </dd> | 217 </dd> |
| 218 </dl><a NAME="DebugClientBase.__compileFileSource" ID="DebugClientBase.__compileFileSource"></a> | 218 </dl><a NAME="DebugClientBase.__compileFileSource" ID="DebugClientBase.__compileFileSource"></a> |
| 219 <h4>DebugClientBase.__compileFileSource</h4> | 219 <h4>DebugClientBase.__compileFileSource</h4> |
| 220 <b>__compileFileSource</b>(<i>filename, mode = 'exec'</i>) | 220 <b>__compileFileSource</b>(<i>filename, mode = 'exec'</i>) |
| 221 <p> | 221 <p> |
| 222 Private method to compile source code read from a file. | 222 Private method to compile source code read from a file. |
| 223 </p><dl> | 223 </p><dl> |
| 224 <dt><i>filename</i></dt> | 224 <dt><i>filename</i></dt> |
| 225 <dd> | 225 <dd> |
| 226 name of the source file (string) | 226 name of the source file (string) |
| 227 </dd><dt><i>mode</i></dt> | 227 </dd><dt><i>mode</i></dt> |
| 228 <dd> | 228 <dd> |
| 229 kind of code to be generated (string, exec or eval) | 229 kind of code to be generated (string, exec or eval) |
| 230 </dd> | 230 </dd> |
| 231 </dl><dl> | 231 </dl><dl> |
| 232 <dt>Returns:</dt> | 232 <dt>Returns:</dt> |
| 233 <dd> | 233 <dd> |
| 234 compiled code object (None in case of errors) | 234 compiled code object (None in case of errors) |
| 235 </dd> | 235 </dd> |
| 236 </dl><a NAME="DebugClientBase.__completionList" ID="DebugClientBase.__completionList"></a> | 236 </dl><a NAME="DebugClientBase.__completionList" ID="DebugClientBase.__completionList"></a> |
| 237 <h4>DebugClientBase.__completionList</h4> | 237 <h4>DebugClientBase.__completionList</h4> |
| 238 <b>__completionList</b>(<i>text</i>) | 238 <b>__completionList</b>(<i>text</i>) |
| 239 <p> | 239 <p> |
| 240 Private slot to handle the request for a commandline completion list. | 240 Private slot to handle the request for a commandline completion list. |
| 241 </p><dl> | 241 </p><dl> |
| 242 <dt><i>text</i></dt> | 242 <dt><i>text</i></dt> |
| 243 <dd> | 243 <dd> |
| 244 the text to be completed (string) | 244 the text to be completed (string) |
| 245 </dd> | 245 </dd> |
| 246 </dl><a NAME="DebugClientBase.__dumpThreadList" ID="DebugClientBase.__dumpThreadList"></a> | 246 </dl><a NAME="DebugClientBase.__dumpThreadList" ID="DebugClientBase.__dumpThreadList"></a> |
| 247 <h4>DebugClientBase.__dumpThreadList</h4> | 247 <h4>DebugClientBase.__dumpThreadList</h4> |
| 248 <b>__dumpThreadList</b>(<i></i>) | 248 <b>__dumpThreadList</b>(<i></i>) |
| 249 <p> | 249 <p> |
| 250 Public method to send the list of threads. | 250 Public method to send the list of threads. |
| 251 </p><a NAME="DebugClientBase.__dumpVariable" ID="DebugClientBase.__dumpVariable"></a> | 251 </p><a NAME="DebugClientBase.__dumpVariable" ID="DebugClientBase.__dumpVariable"></a> |
| 252 <h4>DebugClientBase.__dumpVariable</h4> | 252 <h4>DebugClientBase.__dumpVariable</h4> |
| 253 <b>__dumpVariable</b>(<i>var, frmnr, scope, filter</i>) | 253 <b>__dumpVariable</b>(<i>var, frmnr, scope, filter</i>) |
| 254 <p> | 254 <p> |
| 255 Private method to return the variables of a frame to the debug server. | 255 Private method to return the variables of a frame to the debug server. |
| 256 </p><dl> | 256 </p><dl> |
| 257 <dt><i>var</i></dt> | 257 <dt><i>var</i></dt> |
| 258 <dd> | 258 <dd> |
| 259 list encoded name of the requested variable (list of strings) | 259 list encoded name of the requested variable (list of strings) |
| 260 </dd><dt><i>frmnr</i></dt> | 260 </dd><dt><i>frmnr</i></dt> |
| 261 <dd> | 261 <dd> |
| 262 distance of frame reported on. 0 is the current frame (int) | 262 distance of frame reported on. 0 is the current frame (int) |
| 263 </dd><dt><i>scope</i></dt> | 263 </dd><dt><i>scope</i></dt> |
| 264 <dd> | 264 <dd> |
| 265 1 to report global variables, 0 for local variables (int) | 265 1 to report global variables, 0 for local variables (int) |
| 266 </dd><dt><i>filter</i></dt> | 266 </dd><dt><i>filter</i></dt> |
| 267 <dd> | 267 <dd> |
| 268 the indices of variable types to be filtered (list of int) | 268 the indices of variable types to be filtered (list of int) |
| 269 </dd> | 269 </dd> |
| 270 </dl><a NAME="DebugClientBase.__dumpVariables" ID="DebugClientBase.__dumpVariables"></a> | 270 </dl><a NAME="DebugClientBase.__dumpVariables" ID="DebugClientBase.__dumpVariables"></a> |
| 271 <h4>DebugClientBase.__dumpVariables</h4> | 271 <h4>DebugClientBase.__dumpVariables</h4> |
| 272 <b>__dumpVariables</b>(<i>frmnr, scope, filter</i>) | 272 <b>__dumpVariables</b>(<i>frmnr, scope, filter</i>) |
| 273 <p> | 273 <p> |
| 274 Private method to return the variables of a frame to the debug server. | 274 Private method to return the variables of a frame to the debug server. |
| 275 </p><dl> | 275 </p><dl> |
| 276 <dt><i>frmnr</i></dt> | 276 <dt><i>frmnr</i></dt> |
| 277 <dd> | 277 <dd> |
| 278 distance of frame reported on. 0 is the current frame (int) | 278 distance of frame reported on. 0 is the current frame (int) |
| 279 </dd><dt><i>scope</i></dt> | 279 </dd><dt><i>scope</i></dt> |
| 280 <dd> | 280 <dd> |
| 281 1 to report global variables, 0 for local variables (int) | 281 1 to report global variables, 0 for local variables (int) |
| 282 </dd><dt><i>filter</i></dt> | 282 </dd><dt><i>filter</i></dt> |
| 283 <dd> | 283 <dd> |
| 284 the indices of variable types to be filtered (list of int) | 284 the indices of variable types to be filtered (list of int) |
| 285 </dd> | 285 </dd> |
| 286 </dl><a NAME="DebugClientBase.__exceptionRaised" ID="DebugClientBase.__exceptionRaised"></a> | 286 </dl><a NAME="DebugClientBase.__exceptionRaised" ID="DebugClientBase.__exceptionRaised"></a> |
| 287 <h4>DebugClientBase.__exceptionRaised</h4> | 287 <h4>DebugClientBase.__exceptionRaised</h4> |
| 288 <b>__exceptionRaised</b>(<i></i>) | 288 <b>__exceptionRaised</b>(<i></i>) |
| 289 <p> | 289 <p> |
| 290 Private method called in the case of an exception | 290 Private method called in the case of an exception |
| 291 </p><p> | 291 </p><p> |
| 292 It ensures that the debug server is informed of the raised exception. | 292 It ensures that the debug server is informed of the raised exception. |
| 293 </p><a NAME="DebugClientBase.__formatQt4Variable" ID="DebugClientBase.__formatQt4Variable"></a> | 293 </p><a NAME="DebugClientBase.__formatQt4Variable" ID="DebugClientBase.__formatQt4Variable"></a> |
| 294 <h4>DebugClientBase.__formatQt4Variable</h4> | 294 <h4>DebugClientBase.__formatQt4Variable</h4> |
| 295 <b>__formatQt4Variable</b>(<i>value, vtype</i>) | 295 <b>__formatQt4Variable</b>(<i>value, vtype</i>) |
| 296 <p> | 296 <p> |
| 297 Private method to produce a formatted output of a simple Qt4 type. | 297 Private method to produce a formatted output of a simple Qt4 type. |
| 298 </p><dl> | 298 </p><dl> |
| 299 <dt><i>value</i></dt> | 299 <dt><i>value</i></dt> |
| 300 <dd> | 300 <dd> |
| 301 variable to be formatted | 301 variable to be formatted |
| 302 </dd><dt><i>vtype</i></dt> | 302 </dd><dt><i>vtype</i></dt> |
| 303 <dd> | 303 <dd> |
| 304 type of the variable to be formatted (string) | 304 type of the variable to be formatted (string) |
| 305 </dd> | 305 </dd> |
| 306 </dl><dl> | 306 </dl><dl> |
| 307 <dt>Returns:</dt> | 307 <dt>Returns:</dt> |
| 308 <dd> | 308 <dd> |
| 309 A tuple consisting of a list of formatted variables. Each | 309 A tuple consisting of a list of formatted variables. Each |
| 310 variable entry is a tuple of three elements, the variable name, | 310 variable entry is a tuple of three elements, the variable name, |
| 311 its type and value. | 311 its type and value. |
| 312 </dd> | 312 </dd> |
| 313 </dl><a NAME="DebugClientBase.__formatVariablesList" ID="DebugClientBase.__formatVariablesList"></a> | 313 </dl><a NAME="DebugClientBase.__formatVariablesList" ID="DebugClientBase.__formatVariablesList"></a> |
| 314 <h4>DebugClientBase.__formatVariablesList</h4> | 314 <h4>DebugClientBase.__formatVariablesList</h4> |
| 315 <b>__formatVariablesList</b>(<i>keylist, dict, scope, filter = [], formatSequences = False</i>) | 315 <b>__formatVariablesList</b>(<i>keylist, dict, scope, filter = [], formatSequences = False</i>) |
| 316 <p> | 316 <p> |
| 317 Private method to produce a formated variables list. | 317 Private method to produce a formated variables list. |
| 318 </p><p> | 318 </p><p> |
| 319 The dictionary passed in to it is scanned. Variables are | 319 The dictionary passed in to it is scanned. Variables are |
| 320 only added to the list, if their type is not contained | 320 only added to the list, if their type is not contained |
| 321 in the filter list and their name doesn't match any of the filter expressions. | 321 in the filter list and their name doesn't match any of the filter expressions. |
| 322 The formated variables list (a list of tuples of 3 values) is returned. | 322 The formated variables list (a list of tuples of 3 values) is returned. |
| 323 </p><dl> | 323 </p><dl> |
| 324 <dt><i>keylist</i></dt> | 324 <dt><i>keylist</i></dt> |
| 325 <dd> | 325 <dd> |
| 326 keys of the dictionary | 326 keys of the dictionary |
| 327 </dd><dt><i>dict</i></dt> | 327 </dd><dt><i>dict</i></dt> |
| 328 <dd> | 328 <dd> |
| 329 the dictionary to be scanned | 329 the dictionary to be scanned |
| 330 </dd><dt><i>scope</i></dt> | 330 </dd><dt><i>scope</i></dt> |
| 331 <dd> | 331 <dd> |
| 332 1 to filter using the globals filter, 0 using the locals | 332 1 to filter using the globals filter, 0 using the locals |
| 333 filter (int). | 333 filter (int). |
| 334 Variables are only added to the list, if their name do not match any of the | 334 Variables are only added to the list, if their name do not match any of the |
| 335 filter expressions. | 335 filter expressions. |
| 336 </dd><dt><i>filter</i></dt> | 336 </dd><dt><i>filter</i></dt> |
| 337 <dd> | 337 <dd> |
| 338 the indices of variable types to be filtered. Variables are | 338 the indices of variable types to be filtered. Variables are |
| 339 only added to the list, if their type is not contained in the filter | 339 only added to the list, if their type is not contained in the filter |
| 340 list. | 340 list. |
| 341 </dd><dt><i>formatSequences</i></dt> | 341 </dd><dt><i>formatSequences</i></dt> |
| 342 <dd> | 342 <dd> |
| 343 flag indicating, that sequence or dictionary variables | 343 flag indicating, that sequence or dictionary variables |
| 344 should be formatted. If it is 0 (or false), just the number of items contained | 344 should be formatted. If it is 0 (or false), just the number of items contained |
| 345 in these variables is returned. (boolean) | 345 in these variables is returned. (boolean) |
| 346 </dd> | 346 </dd> |
| 347 </dl><dl> | 347 </dl><dl> |
| 348 <dt>Returns:</dt> | 348 <dt>Returns:</dt> |
| 349 <dd> | 349 <dd> |
| 350 A tuple consisting of a list of formatted variables. Each variable | 350 A tuple consisting of a list of formatted variables. Each variable |
| 351 entry is a tuple of three elements, the variable name, its type and | 351 entry is a tuple of three elements, the variable name, its type and |
| 352 value. | 352 value. |
| 353 </dd> | 353 </dd> |
| 354 </dl><a NAME="DebugClientBase.__generateFilterObjects" ID="DebugClientBase.__generateFilterObjects"></a> | 354 </dl><a NAME="DebugClientBase.__generateFilterObjects" ID="DebugClientBase.__generateFilterObjects"></a> |
| 355 <h4>DebugClientBase.__generateFilterObjects</h4> | 355 <h4>DebugClientBase.__generateFilterObjects</h4> |
| 356 <b>__generateFilterObjects</b>(<i>scope, filterString</i>) | 356 <b>__generateFilterObjects</b>(<i>scope, filterString</i>) |
| 357 <p> | 357 <p> |
| 358 Private slot to convert a filter string to a list of filter objects. | 358 Private slot to convert a filter string to a list of filter objects. |
| 359 </p><dl> | 359 </p><dl> |
| 360 <dt><i>scope</i></dt> | 360 <dt><i>scope</i></dt> |
| 361 <dd> | 361 <dd> |
| 362 1 to generate filter for global variables, 0 for local | 362 1 to generate filter for global variables, 0 for local |
| 363 variables (int) | 363 variables (int) |
| 364 </dd><dt><i>filterString</i></dt> | 364 </dd><dt><i>filterString</i></dt> |
| 365 <dd> | 365 <dd> |
| 366 string of filter patterns separated by ';' | 366 string of filter patterns separated by ';' |
| 367 </dd> | 367 </dd> |
| 368 </dl><a NAME="DebugClientBase.__interact" ID="DebugClientBase.__interact"></a> | 368 </dl><a NAME="DebugClientBase.__interact" ID="DebugClientBase.__interact"></a> |
| 369 <h4>DebugClientBase.__interact</h4> | 369 <h4>DebugClientBase.__interact</h4> |
| 370 <b>__interact</b>(<i></i>) | 370 <b>__interact</b>(<i></i>) |
| 371 <p> | 371 <p> |
| 372 Private method to Interact with the debugger. | 372 Private method to Interact with the debugger. |
| 373 </p><a NAME="DebugClientBase.__resolveHost" ID="DebugClientBase.__resolveHost"></a> | 373 </p><a NAME="DebugClientBase.__resolveHost" ID="DebugClientBase.__resolveHost"></a> |
| 374 <h4>DebugClientBase.__resolveHost</h4> | 374 <h4>DebugClientBase.__resolveHost</h4> |
| 375 <b>__resolveHost</b>(<i>host</i>) | 375 <b>__resolveHost</b>(<i>host</i>) |
| 376 <p> | 376 <p> |
| 377 Private method to resolve a hostname to an IP address. | 377 Private method to resolve a hostname to an IP address. |
| 378 </p><dl> | 378 </p><dl> |
| 379 <dt><i>host</i></dt> | 379 <dt><i>host</i></dt> |
| 380 <dd> | 380 <dd> |
| 381 hostname of the debug server (string) | 381 hostname of the debug server (string) |
| 382 </dd> | 382 </dd> |
| 383 </dl><dl> | 383 </dl><dl> |
| 384 <dt>Returns:</dt> | 384 <dt>Returns:</dt> |
| 385 <dd> | 385 <dd> |
| 386 IP address (string) | 386 IP address (string) |
| 387 </dd> | 387 </dd> |
| 388 </dl><a NAME="DebugClientBase.__setCoding" ID="DebugClientBase.__setCoding"></a> | 388 </dl><a NAME="DebugClientBase.__setCoding" ID="DebugClientBase.__setCoding"></a> |
| 389 <h4>DebugClientBase.__setCoding</h4> | 389 <h4>DebugClientBase.__setCoding</h4> |
| 390 <b>__setCoding</b>(<i>filename</i>) | 390 <b>__setCoding</b>(<i>filename</i>) |
| 391 <p> | 391 <p> |
| 392 Private method to set the coding used by a python file. | 392 Private method to set the coding used by a python file. |
| 393 </p><dl> | 393 </p><dl> |
| 394 <dt><i>filename</i></dt> | 394 <dt><i>filename</i></dt> |
| 395 <dd> | 395 <dd> |
| 396 name of the file to inspect (string) | 396 name of the file to inspect (string) |
| 397 </dd> | 397 </dd> |
| 398 </dl><a NAME="DebugClientBase.__unhandled_exception" ID="DebugClientBase.__unhandled_exception"></a> | 398 </dl><a NAME="DebugClientBase.__unhandled_exception" ID="DebugClientBase.__unhandled_exception"></a> |
| 399 <h4>DebugClientBase.__unhandled_exception</h4> | 399 <h4>DebugClientBase.__unhandled_exception</h4> |
| 400 <b>__unhandled_exception</b>(<i>exctype, excval, exctb</i>) | 400 <b>__unhandled_exception</b>(<i>exctype, excval, exctb</i>) |
| 401 <p> | 401 <p> |
| 402 Private method called to report an uncaught exception. | 402 Private method called to report an uncaught exception. |
| 403 </p><dl> | 403 </p><dl> |
| 404 <dt><i>exctype</i></dt> | 404 <dt><i>exctype</i></dt> |
| 405 <dd> | 405 <dd> |
| 406 the type of the exception | 406 the type of the exception |
| 407 </dd><dt><i>excval</i></dt> | 407 </dd><dt><i>excval</i></dt> |
| 408 <dd> | 408 <dd> |
| 409 data about the exception | 409 data about the exception |
| 410 </dd><dt><i>exctb</i></dt> | 410 </dd><dt><i>exctb</i></dt> |
| 411 <dd> | 411 <dd> |
| 412 traceback for the exception | 412 traceback for the exception |
| 413 </dd> | 413 </dd> |
| 414 </dl><a NAME="DebugClientBase.absPath" ID="DebugClientBase.absPath"></a> | 414 </dl><a NAME="DebugClientBase.absPath" ID="DebugClientBase.absPath"></a> |
| 415 <h4>DebugClientBase.absPath</h4> | 415 <h4>DebugClientBase.absPath</h4> |
| 416 <b>absPath</b>(<i>fn</i>) | 416 <b>absPath</b>(<i>fn</i>) |
| 417 <p> | 417 <p> |
| 418 Public method to convert a filename to an absolute name. | 418 Public method to convert a filename to an absolute name. |
| 419 </p><p> | 419 </p><p> |
| 420 sys.path is used as a set of possible prefixes. The name stays | 420 sys.path is used as a set of possible prefixes. The name stays |
| 421 relative if a file could not be found. | 421 relative if a file could not be found. |
| 422 </p><dl> | 422 </p><dl> |
| 423 <dt><i>fn</i></dt> | 423 <dt><i>fn</i></dt> |
| 424 <dd> | 424 <dd> |
| 425 filename (string) | 425 filename (string) |
| 426 </dd> | 426 </dd> |
| 427 </dl><dl> | 427 </dl><dl> |
| 428 <dt>Returns:</dt> | 428 <dt>Returns:</dt> |
| 429 <dd> | 429 <dd> |
| 430 the converted filename (string) | 430 the converted filename (string) |
| 431 </dd> | 431 </dd> |
| 432 </dl><a NAME="DebugClientBase.attachThread" ID="DebugClientBase.attachThread"></a> | 432 </dl><a NAME="DebugClientBase.attachThread" ID="DebugClientBase.attachThread"></a> |
| 433 <h4>DebugClientBase.attachThread</h4> | 433 <h4>DebugClientBase.attachThread</h4> |
| 434 <b>attachThread</b>(<i>target = None, args = None, kwargs = None, mainThread = False</i>) | 434 <b>attachThread</b>(<i>target = None, args = None, kwargs = None, mainThread = False</i>) |
| 435 <p> | 435 <p> |
| 436 Public method to setup a thread for DebugClient to debug. | 436 Public method to setup a thread for DebugClient to debug. |
| 437 </p><p> | 437 </p><p> |
| 438 If mainThread is non-zero, then we are attaching to the already | 438 If mainThread is non-zero, then we are attaching to the already |
| 439 started mainthread of the app and the rest of the args are ignored. | 439 started mainthread of the app and the rest of the args are ignored. |
| 440 </p><dl> | 440 </p><dl> |
| 441 <dt><i>target</i></dt> | 441 <dt><i>target</i></dt> |
| 442 <dd> | 442 <dd> |
| 443 the start function of the target thread (i.e. the user code) | 443 the start function of the target thread (i.e. the user code) |
| 444 </dd><dt><i>args</i></dt> | 444 </dd><dt><i>args</i></dt> |
| 445 <dd> | 445 <dd> |
| 446 arguments to pass to target | 446 arguments to pass to target |
| 447 </dd><dt><i>kwargs</i></dt> | 447 </dd><dt><i>kwargs</i></dt> |
| 448 <dd> | 448 <dd> |
| 449 keyword arguments to pass to target | 449 keyword arguments to pass to target |
| 450 </dd><dt><i>mainThread</i></dt> | 450 </dd><dt><i>mainThread</i></dt> |
| 451 <dd> | 451 <dd> |
| 452 True, if we are attaching to the already | 452 True, if we are attaching to the already |
| 453 started mainthread of the app | 453 started mainthread of the app |
| 454 </dd> | 454 </dd> |
| 455 </dl><dl> | 455 </dl><dl> |
| 456 <dt>Returns:</dt> | 456 <dt>Returns:</dt> |
| 457 <dd> | 457 <dd> |
| 458 The identifier of the created thread | 458 The identifier of the created thread |
| 459 </dd> | 459 </dd> |
| 460 </dl><a NAME="DebugClientBase.close" ID="DebugClientBase.close"></a> | 460 </dl><a NAME="DebugClientBase.close" ID="DebugClientBase.close"></a> |
| 461 <h4>DebugClientBase.close</h4> | 461 <h4>DebugClientBase.close</h4> |
| 462 <b>close</b>(<i>fd</i>) | 462 <b>close</b>(<i>fd</i>) |
| 463 <p> | 463 <p> |
| 464 Private method implementing a close method as a replacement for os.close(). | 464 Private method implementing a close method as a replacement for os.close(). |
| 465 </p><p> | 465 </p><p> |
| 466 It prevents the debugger connections from being closed. | 466 It prevents the debugger connections from being closed. |
| 467 </p><dl> | 467 </p><dl> |
| 468 <dt><i>fd</i></dt> | 468 <dt><i>fd</i></dt> |
| 469 <dd> | 469 <dd> |
| 470 file descriptor to be closed (integer) | 470 file descriptor to be closed (integer) |
| 471 </dd> | 471 </dd> |
| 472 </dl><a NAME="DebugClientBase.connectDebugger" ID="DebugClientBase.connectDebugger"></a> | 472 </dl><a NAME="DebugClientBase.connectDebugger" ID="DebugClientBase.connectDebugger"></a> |
| 473 <h4>DebugClientBase.connectDebugger</h4> | 473 <h4>DebugClientBase.connectDebugger</h4> |
| 474 <b>connectDebugger</b>(<i>port, remoteAddress = None, redirect = True</i>) | 474 <b>connectDebugger</b>(<i>port, remoteAddress = None, redirect = True</i>) |
| 475 <p> | 475 <p> |
| 476 Public method to establish a session with the debugger. | 476 Public method to establish a session with the debugger. |
| 477 </p><p> | 477 </p><p> |
| 478 It opens a network connection to the debugger, connects it to stdin, | 478 It opens a network connection to the debugger, connects it to stdin, |
| 479 stdout and stderr and saves these file objects in case the application | 479 stdout and stderr and saves these file objects in case the application |
| 480 being debugged redirects them itself. | 480 being debugged redirects them itself. |
| 481 </p><dl> | 481 </p><dl> |
| 482 <dt><i>port</i></dt> | 482 <dt><i>port</i></dt> |
| 483 <dd> | 483 <dd> |
| 484 the port number to connect to (int) | 484 the port number to connect to (int) |
| 485 </dd><dt><i>remoteAddress</i></dt> | 485 </dd><dt><i>remoteAddress</i></dt> |
| 486 <dd> | 486 <dd> |
| 487 the network address of the debug server host (string) | 487 the network address of the debug server host (string) |
| 488 </dd><dt><i>redirect</i></dt> | 488 </dd><dt><i>redirect</i></dt> |
| 489 <dd> | 489 <dd> |
| 490 flag indicating redirection of stdin, stdout and stderr (boolean) | 490 flag indicating redirection of stdin, stdout and stderr (boolean) |
| 491 </dd> | 491 </dd> |
| 492 </dl><a NAME="DebugClientBase.eventLoop" ID="DebugClientBase.eventLoop"></a> | 492 </dl><a NAME="DebugClientBase.eventLoop" ID="DebugClientBase.eventLoop"></a> |
| 493 <h4>DebugClientBase.eventLoop</h4> | 493 <h4>DebugClientBase.eventLoop</h4> |
| 494 <b>eventLoop</b>(<i>disablePolling = False</i>) | 494 <b>eventLoop</b>(<i>disablePolling = False</i>) |
| 495 <p> | 495 <p> |
| 496 Public method implementing our event loop. | 496 Public method implementing our event loop. |
| 497 </p><dl> | 497 </p><dl> |
| 498 <dt><i>disablePolling</i></dt> | 498 <dt><i>disablePolling</i></dt> |
| 499 <dd> | 499 <dd> |
| 500 flag indicating to enter an event loop with | 500 flag indicating to enter an event loop with |
| 501 polling disabled (boolean) | 501 polling disabled (boolean) |
| 502 </dd> | 502 </dd> |
| 503 </dl><a NAME="DebugClientBase.eventPoll" ID="DebugClientBase.eventPoll"></a> | 503 </dl><a NAME="DebugClientBase.eventPoll" ID="DebugClientBase.eventPoll"></a> |
| 504 <h4>DebugClientBase.eventPoll</h4> | 504 <h4>DebugClientBase.eventPoll</h4> |
| 505 <b>eventPoll</b>(<i></i>) | 505 <b>eventPoll</b>(<i></i>) |
| 506 <p> | 506 <p> |
| 507 Public method to poll for events like 'set break point'. | 507 Public method to poll for events like 'set break point'. |
| 508 </p><a NAME="DebugClientBase.fork" ID="DebugClientBase.fork"></a> | 508 </p><a NAME="DebugClientBase.fork" ID="DebugClientBase.fork"></a> |
| 509 <h4>DebugClientBase.fork</h4> | 509 <h4>DebugClientBase.fork</h4> |
| 510 <b>fork</b>(<i></i>) | 510 <b>fork</b>(<i></i>) |
| 511 <p> | 511 <p> |
| 512 Public method implementing a fork routine deciding which branch to follow. | 512 Public method implementing a fork routine deciding which branch to follow. |
| 513 </p><a NAME="DebugClientBase.getCoding" ID="DebugClientBase.getCoding"></a> | 513 </p><a NAME="DebugClientBase.getCoding" ID="DebugClientBase.getCoding"></a> |
| 514 <h4>DebugClientBase.getCoding</h4> | 514 <h4>DebugClientBase.getCoding</h4> |
| 515 <b>getCoding</b>(<i></i>) | 515 <b>getCoding</b>(<i></i>) |
| 516 <p> | 516 <p> |
| 517 Public method to return the current coding. | 517 Public method to return the current coding. |
| 518 </p><dl> | 518 </p><dl> |
| 519 <dt>Returns:</dt> | 519 <dt>Returns:</dt> |
| 520 <dd> | 520 <dd> |
| 521 codec name (string) | 521 codec name (string) |
| 522 </dd> | 522 </dd> |
| 523 </dl><a NAME="DebugClientBase.getRunning" ID="DebugClientBase.getRunning"></a> | 523 </dl><a NAME="DebugClientBase.getRunning" ID="DebugClientBase.getRunning"></a> |
| 524 <h4>DebugClientBase.getRunning</h4> | 524 <h4>DebugClientBase.getRunning</h4> |
| 525 <b>getRunning</b>(<i></i>) | 525 <b>getRunning</b>(<i></i>) |
| 526 <p> | 526 <p> |
| 527 Public method to return the main script we are currently running. | 527 Public method to return the main script we are currently running. |
| 528 </p><a NAME="DebugClientBase.handleLine" ID="DebugClientBase.handleLine"></a> | 528 </p><a NAME="DebugClientBase.handleLine" ID="DebugClientBase.handleLine"></a> |
| 529 <h4>DebugClientBase.handleLine</h4> | 529 <h4>DebugClientBase.handleLine</h4> |
| 530 <b>handleLine</b>(<i>line</i>) | 530 <b>handleLine</b>(<i>line</i>) |
| 531 <p> | 531 <p> |
| 532 Public method to handle the receipt of a complete line. | 532 Public method to handle the receipt of a complete line. |
| 533 </p><p> | 533 </p><p> |
| 534 It first looks for a valid protocol token at the start of the line. Thereafter | 534 It first looks for a valid protocol token at the start of the line. Thereafter |
| 535 it trys to execute the lines accumulated so far. | 535 it trys to execute the lines accumulated so far. |
| 536 </p><dl> | 536 </p><dl> |
| 537 <dt><i>line</i></dt> | 537 <dt><i>line</i></dt> |
| 538 <dd> | 538 <dd> |
| 539 the received line | 539 the received line |
| 540 </dd> | 540 </dd> |
| 541 </dl><a NAME="DebugClientBase.input" ID="DebugClientBase.input"></a> | 541 </dl><a NAME="DebugClientBase.input" ID="DebugClientBase.input"></a> |
| 542 <h4>DebugClientBase.input</h4> | 542 <h4>DebugClientBase.input</h4> |
| 543 <b>input</b>(<i>prompt</i>) | 543 <b>input</b>(<i>prompt</i>) |
| 544 <p> | 544 <p> |
| 545 Public method to implement input() using the event loop. | 545 Public method to implement input() using the event loop. |
| 546 </p><dl> | 546 </p><dl> |
| 547 <dt><i>prompt</i></dt> | 547 <dt><i>prompt</i></dt> |
| 548 <dd> | 548 <dd> |
| 549 the prompt to be shown (string) | 549 the prompt to be shown (string) |
| 550 </dd> | 550 </dd> |
| 551 </dl><dl> | 551 </dl><dl> |
| 552 <dt>Returns:</dt> | 552 <dt>Returns:</dt> |
| 553 <dd> | 553 <dd> |
| 554 the entered string | 554 the entered string |
| 555 </dd> | 555 </dd> |
| 556 </dl><a NAME="DebugClientBase.main" ID="DebugClientBase.main"></a> | 556 </dl><a NAME="DebugClientBase.main" ID="DebugClientBase.main"></a> |
| 557 <h4>DebugClientBase.main</h4> | 557 <h4>DebugClientBase.main</h4> |
| 558 <b>main</b>(<i></i>) | 558 <b>main</b>(<i></i>) |
| 559 <p> | 559 <p> |
| 560 Public method implementing the main method. | 560 Public method implementing the main method. |
| 561 </p><a NAME="DebugClientBase.progTerminated" ID="DebugClientBase.progTerminated"></a> | 561 </p><a NAME="DebugClientBase.progTerminated" ID="DebugClientBase.progTerminated"></a> |
| 562 <h4>DebugClientBase.progTerminated</h4> | 562 <h4>DebugClientBase.progTerminated</h4> |
| 563 <b>progTerminated</b>(<i>status</i>) | 563 <b>progTerminated</b>(<i>status</i>) |
| 564 <p> | 564 <p> |
| 565 Public method to tell the debugger that the program has terminated. | 565 Public method to tell the debugger that the program has terminated. |
| 566 </p><dl> | 566 </p><dl> |
| 567 <dt><i>status</i></dt> | 567 <dt><i>status</i></dt> |
| 568 <dd> | 568 <dd> |
| 569 the return status | 569 the return status |
| 570 </dd> | 570 </dd> |
| 571 </dl><a NAME="DebugClientBase.run_call" ID="DebugClientBase.run_call"></a> | 571 </dl><a NAME="DebugClientBase.run_call" ID="DebugClientBase.run_call"></a> |
| 572 <h4>DebugClientBase.run_call</h4> | 572 <h4>DebugClientBase.run_call</h4> |
| 573 <b>run_call</b>(<i>scriptname, func, *args</i>) | 573 <b>run_call</b>(<i>scriptname, func, *args</i>) |
| 574 <p> | 574 <p> |
| 575 Public method used to start the remote debugger and call a function. | 575 Public method used to start the remote debugger and call a function. |
| 576 </p><dl> | 576 </p><dl> |
| 577 <dt><i>scriptname</i></dt> | 577 <dt><i>scriptname</i></dt> |
| 578 <dd> | 578 <dd> |
| 579 name of the script to be debugged (string) | 579 name of the script to be debugged (string) |
| 580 </dd><dt><i>func</i></dt> | 580 </dd><dt><i>func</i></dt> |
| 581 <dd> | 581 <dd> |
| 582 function to be called | 582 function to be called |
| 583 </dd><dt><i>*args</i></dt> | 583 </dd><dt><i>*args</i></dt> |
| 584 <dd> | 584 <dd> |
| 585 arguments being passed to func | 585 arguments being passed to func |
| 586 </dd> | 586 </dd> |
| 587 </dl><dl> | 587 </dl><dl> |
| 588 <dt>Returns:</dt> | 588 <dt>Returns:</dt> |
| 589 <dd> | 589 <dd> |
| 590 result of the function call | 590 result of the function call |
| 591 </dd> | 591 </dd> |
| 592 </dl><a NAME="DebugClientBase.sessionClose" ID="DebugClientBase.sessionClose"></a> | 592 </dl><a NAME="DebugClientBase.sessionClose" ID="DebugClientBase.sessionClose"></a> |
| 593 <h4>DebugClientBase.sessionClose</h4> | 593 <h4>DebugClientBase.sessionClose</h4> |
| 594 <b>sessionClose</b>(<i>exit = True</i>) | 594 <b>sessionClose</b>(<i>exit = True</i>) |
| 595 <p> | 595 <p> |
| 596 Public method to close the session with the debugger and optionally terminate. | 596 Public method to close the session with the debugger and optionally terminate. |
| 597 </p><dl> | 597 </p><dl> |
| 598 <dt><i>exit</i></dt> | 598 <dt><i>exit</i></dt> |
| 599 <dd> | 599 <dd> |
| 600 flag indicating to terminate (boolean) | 600 flag indicating to terminate (boolean) |
| 601 </dd> | 601 </dd> |
| 602 </dl><a NAME="DebugClientBase.shouldSkip" ID="DebugClientBase.shouldSkip"></a> | 602 </dl><a NAME="DebugClientBase.shouldSkip" ID="DebugClientBase.shouldSkip"></a> |
| 603 <h4>DebugClientBase.shouldSkip</h4> | 603 <h4>DebugClientBase.shouldSkip</h4> |
| 604 <b>shouldSkip</b>(<i>fn</i>) | 604 <b>shouldSkip</b>(<i>fn</i>) |
| 605 <p> | 605 <p> |
| 606 Public method to check if a file should be skipped. | 606 Public method to check if a file should be skipped. |
| 607 </p><dl> | 607 </p><dl> |
| 608 <dt><i>fn</i></dt> | 608 <dt><i>fn</i></dt> |
| 609 <dd> | 609 <dd> |
| 610 filename to be checked | 610 filename to be checked |
| 611 </dd> | 611 </dd> |
| 612 </dl><dl> | 612 </dl><dl> |
| 613 <dt>Returns:</dt> | 613 <dt>Returns:</dt> |
| 614 <dd> | 614 <dd> |
| 615 non-zero if fn represents a file we are 'skipping', zero otherwise. | 615 non-zero if fn represents a file we are 'skipping', zero otherwise. |
| 616 </dd> | 616 </dd> |
| 617 </dl><a NAME="DebugClientBase.startDebugger" ID="DebugClientBase.startDebugger"></a> | 617 </dl><a NAME="DebugClientBase.startDebugger" ID="DebugClientBase.startDebugger"></a> |
| 618 <h4>DebugClientBase.startDebugger</h4> | 618 <h4>DebugClientBase.startDebugger</h4> |
| 619 <b>startDebugger</b>(<i>filename = None, host = None, port = None, enableTrace = True, exceptions = True, tracePython = False, redirect = True</i>) | 619 <b>startDebugger</b>(<i>filename = None, host = None, port = None, enableTrace = True, exceptions = True, tracePython = False, redirect = True</i>) |
| 620 <p> | 620 <p> |
| 621 Public method used to start the remote debugger. | 621 Public method used to start the remote debugger. |
| 622 </p><dl> | 622 </p><dl> |
| 623 <dt><i>filename</i></dt> | 623 <dt><i>filename</i></dt> |
| 624 <dd> | 624 <dd> |
| 625 the program to be debugged (string) | 625 the program to be debugged (string) |
| 626 </dd><dt><i>host</i></dt> | 626 </dd><dt><i>host</i></dt> |
| 627 <dd> | 627 <dd> |
| 628 hostname of the debug server (string) | 628 hostname of the debug server (string) |
| 629 </dd><dt><i>port</i></dt> | 629 </dd><dt><i>port</i></dt> |
| 630 <dd> | 630 <dd> |
| 631 portnumber of the debug server (int) | 631 portnumber of the debug server (int) |
| 632 </dd><dt><i>enableTrace</i></dt> | 632 </dd><dt><i>enableTrace</i></dt> |
| 633 <dd> | 633 <dd> |
| 634 flag to enable the tracing function (boolean) | 634 flag to enable the tracing function (boolean) |
| 635 </dd><dt><i>exceptions</i></dt> | 635 </dd><dt><i>exceptions</i></dt> |
| 636 <dd> | 636 <dd> |
| 637 flag to enable exception reporting of the IDE (boolean) | 637 flag to enable exception reporting of the IDE (boolean) |
| 638 </dd><dt><i>tracePython</i></dt> | 638 </dd><dt><i>tracePython</i></dt> |
| 639 <dd> | 639 <dd> |
| 640 flag to enable tracing into the Python library (boolean) | 640 flag to enable tracing into the Python library (boolean) |
| 641 </dd><dt><i>redirect</i></dt> | 641 </dd><dt><i>redirect</i></dt> |
| 642 <dd> | 642 <dd> |
| 643 flag indicating redirection of stdin, stdout and stderr (boolean) | 643 flag indicating redirection of stdin, stdout and stderr (boolean) |
| 644 </dd> | 644 </dd> |
| 645 </dl><a NAME="DebugClientBase.startProgInDebugger" ID="DebugClientBase.startProgInDebugger"></a> | 645 </dl><a NAME="DebugClientBase.startProgInDebugger" ID="DebugClientBase.startProgInDebugger"></a> |
| 646 <h4>DebugClientBase.startProgInDebugger</h4> | 646 <h4>DebugClientBase.startProgInDebugger</h4> |
| 647 <b>startProgInDebugger</b>(<i>progargs, wd = '', host = None, port = None, exceptions = True, tracePython = False, redirect = True</i>) | 647 <b>startProgInDebugger</b>(<i>progargs, wd = '', host = None, port = None, exceptions = True, tracePython = False, redirect = True</i>) |
| 648 <p> | 648 <p> |
| 649 Public method used to start the remote debugger. | 649 Public method used to start the remote debugger. |
| 650 </p><dl> | 650 </p><dl> |
| 651 <dt><i>progargs</i></dt> | 651 <dt><i>progargs</i></dt> |
| 652 <dd> | 652 <dd> |
| 653 commandline for the program to be debugged | 653 commandline for the program to be debugged |
| 654 (list of strings) | 654 (list of strings) |
| 655 </dd><dt><i>wd</i></dt> | 655 </dd><dt><i>wd</i></dt> |
| 656 <dd> | 656 <dd> |
| 657 working directory for the program execution (string) | 657 working directory for the program execution (string) |
| 658 </dd><dt><i>host</i></dt> | 658 </dd><dt><i>host</i></dt> |
| 659 <dd> | 659 <dd> |
| 660 hostname of the debug server (string) | 660 hostname of the debug server (string) |
| 661 </dd><dt><i>port</i></dt> | 661 </dd><dt><i>port</i></dt> |
| 662 <dd> | 662 <dd> |
| 663 portnumber of the debug server (int) | 663 portnumber of the debug server (int) |
| 664 </dd><dt><i>exceptions</i></dt> | 664 </dd><dt><i>exceptions</i></dt> |
| 665 <dd> | 665 <dd> |
| 666 flag to enable exception reporting of the IDE (boolean) | 666 flag to enable exception reporting of the IDE (boolean) |
| 667 </dd><dt><i>tracePython</i></dt> | 667 </dd><dt><i>tracePython</i></dt> |
| 668 <dd> | 668 <dd> |
| 669 flag to enable tracing into the Python library (boolean) | 669 flag to enable tracing into the Python library (boolean) |
| 670 </dd><dt><i>redirect</i></dt> | 670 </dd><dt><i>redirect</i></dt> |
| 671 <dd> | 671 <dd> |
| 672 flag indicating redirection of stdin, stdout and stderr (boolean) | 672 flag indicating redirection of stdin, stdout and stderr (boolean) |
| 673 </dd> | 673 </dd> |
| 674 </dl><a NAME="DebugClientBase.write" ID="DebugClientBase.write"></a> | 674 </dl><a NAME="DebugClientBase.write" ID="DebugClientBase.write"></a> |
| 675 <h4>DebugClientBase.write</h4> | 675 <h4>DebugClientBase.write</h4> |
| 676 <b>write</b>(<i>s</i>) | 676 <b>write</b>(<i>s</i>) |
| 677 <p> | 677 <p> |
| 678 Public method to write data to the output stream. | 678 Public method to write data to the output stream. |
| 679 </p><dl> | 679 </p><dl> |
| 680 <dt><i>s</i></dt> | 680 <dt><i>s</i></dt> |
| 681 <dd> | 681 <dd> |
| 682 data to be written (string) | 682 data to be written (string) |
| 683 </dd> | 683 </dd> |
| 684 </dl> | 684 </dl> |
| 685 <div align="right"><a href="#top">Up</a></div> | 685 <div align="right"><a href="#top">Up</a></div> |
| 686 <hr /><hr /> | 686 <hr /><hr /> |
| 687 <a NAME="DebugClientClose" ID="DebugClientClose"></a> | 687 <a NAME="DebugClientClose" ID="DebugClientClose"></a> |
| 688 <h2>DebugClientClose</h2> | 688 <h2>DebugClientClose</h2> |
| 689 <b>DebugClientClose</b>(<i>fd</i>) | 689 <b>DebugClientClose</b>(<i>fd</i>) |
| 690 <p> | 690 <p> |
| 691 Replacement for the standard os.close(fd). | 691 Replacement for the standard os.close(fd). |
| 692 </p><dl> | 692 </p><dl> |
| 693 <dt><i>fd</i></dt> | 693 <dt><i>fd</i></dt> |
| 694 <dd> | 694 <dd> |
| 695 open file descriptor to be closed (integer) | 695 open file descriptor to be closed (integer) |
| 696 </dd> | 696 </dd> |
| 697 </dl> | 697 </dl> |
| 698 <div align="right"><a href="#top">Up</a></div> | 698 <div align="right"><a href="#top">Up</a></div> |
| 699 <hr /><hr /> | 699 <hr /><hr /> |
| 700 <a NAME="DebugClientFork" ID="DebugClientFork"></a> | 700 <a NAME="DebugClientFork" ID="DebugClientFork"></a> |
| 701 <h2>DebugClientFork</h2> | 701 <h2>DebugClientFork</h2> |
| 702 <b>DebugClientFork</b>(<i></i>) | 702 <b>DebugClientFork</b>(<i></i>) |
| 703 <p> | 703 <p> |
| 704 Replacement for the standard os.fork(). | 704 Replacement for the standard os.fork(). |
| 705 </p> | 705 </p> |
| 706 <div align="right"><a href="#top">Up</a></div> | 706 <div align="right"><a href="#top">Up</a></div> |
| 707 <hr /><hr /> | 707 <hr /><hr /> |
| 708 <a NAME="DebugClientInput" ID="DebugClientInput"></a> | 708 <a NAME="DebugClientInput" ID="DebugClientInput"></a> |
| 709 <h2>DebugClientInput</h2> | 709 <h2>DebugClientInput</h2> |
| 710 <b>DebugClientInput</b>(<i>prompt = ""</i>) | 710 <b>DebugClientInput</b>(<i>prompt = ""</i>) |
| 711 <p> | 711 <p> |
| 712 Replacement for the standard input builtin. | 712 Replacement for the standard input builtin. |
| 713 </p><p> | 713 </p><p> |
| 714 This function works with the split debugger. | 714 This function works with the split debugger. |
| 715 </p><dl> | 715 </p><dl> |
| 716 <dt><i>prompt</i></dt> | 716 <dt><i>prompt</i></dt> |
| 717 <dd> | 717 <dd> |
| 718 The prompt to be shown. (string) | 718 The prompt to be shown. (string) |
| 719 </dd> | 719 </dd> |
| 720 </dl> | 720 </dl> |
| 721 <div align="right"><a href="#top">Up</a></div> | 721 <div align="right"><a href="#top">Up</a></div> |
| 722 <hr /><hr /> | 722 <hr /><hr /> |
| 723 <a NAME="DebugClientSetRecursionLimit" ID="DebugClientSetRecursionLimit"></a> | 723 <a NAME="DebugClientSetRecursionLimit" ID="DebugClientSetRecursionLimit"></a> |
| 724 <h2>DebugClientSetRecursionLimit</h2> | 724 <h2>DebugClientSetRecursionLimit</h2> |
| 725 <b>DebugClientSetRecursionLimit</b>(<i>limit</i>) | 725 <b>DebugClientSetRecursionLimit</b>(<i>limit</i>) |
| 726 <p> | 726 <p> |
| 727 Replacement for the standard sys.setrecursionlimit(limit). | 727 Replacement for the standard sys.setrecursionlimit(limit). |
| 728 </p><dl> | 728 </p><dl> |
| 729 <dt><i>limit</i></dt> | 729 <dt><i>limit</i></dt> |
| 730 <dd> | 730 <dd> |
| 731 recursion limit (integer) | 731 recursion limit (integer) |
| 732 </dd> | 732 </dd> |
| 733 </dl> | 733 </dl> |
| 734 <div align="right"><a href="#top">Up</a></div> | 734 <div align="right"><a href="#top">Up</a></div> |
| 735 <hr /> | 735 <hr /> |
| 736 </body></html> | 736 </body></html> |
