Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DebugClients.Python.QProcessExtension.html
src/eric7/Documentation/Source/eric7.DebugClients.Python.QProcessExtension.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.DebugClients.Python.QProcessExtension</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.DebugClients.Python.QProcessExtension</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a function to patch QProcess to support debugging of the | |
| 13 process. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 | |
| 17 <table> | |
| 18 <tr><td>_debugClient</td></tr> | |
| 19 </table> | |
| 20 <h3>Classes</h3> | |
| 21 | |
| 22 <table> | |
| 23 | |
| 24 <tr> | |
| 25 <td><a href="#QProcessWrapper">QProcessWrapper</a></td> | |
| 26 <td>Wrapper class for *.QProcess.</td> | |
| 27 </tr> | |
| 28 </table> | |
| 29 <h3>Functions</h3> | |
| 30 | |
| 31 <table> | |
| 32 | |
| 33 <tr> | |
| 34 <td><a href="#patchQProcess">patchQProcess</a></td> | |
| 35 <td>Function to patch the QtCore module's QProcess.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <hr /> | |
| 39 <hr /> | |
| 40 <a NAME="QProcessWrapper" ID="QProcessWrapper"></a> | |
| 41 <h2>QProcessWrapper</h2> | |
| 42 | |
| 43 <p> | |
| 44 Wrapper class for *.QProcess. | |
| 45 </p> | |
| 46 <h3>Derived from</h3> | |
| 47 module.QProcess | |
| 48 <h3>Class Attributes</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>_origQProcessStartDetached</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 | |
| 60 <table> | |
| 61 | |
| 62 <tr> | |
| 63 <td><a href="#QProcessWrapper.__init__">QProcessWrapper</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#QProcessWrapper.__startDetached">__startDetached</a></td> | |
| 68 <td>Private method to start the detached process.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#QProcessWrapper.start">start</a></td> | |
| 72 <td>Public method to start the process.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#QProcessWrapper.startDetached">startDetached</a></td> | |
| 76 <td>Public method to start the detached process.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <h3>Static Methods</h3> | |
| 80 | |
| 81 <table> | |
| 82 | |
| 83 <tr> | |
| 84 <td><a href="#QProcessWrapper.startDetachedStatic">startDetachedStatic</a></td> | |
| 85 <td>Static method to start the detached process.</td> | |
| 86 </tr> | |
| 87 </table> | |
| 88 | |
| 89 <a NAME="QProcessWrapper.__init__" ID="QProcessWrapper.__init__"></a> | |
| 90 <h4>QProcessWrapper (Constructor)</h4> | |
| 91 <b>QProcessWrapper</b>(<i>parent=None</i>) | |
| 92 | |
| 93 <p> | |
| 94 Constructor | |
| 95 </p> | |
| 96 <a NAME="QProcessWrapper.__startDetached" ID="QProcessWrapper.__startDetached"></a> | |
| 97 <h4>QProcessWrapper.__startDetached</h4> | |
| 98 <b>__startDetached</b>(<i>*args, **kwargs</i>) | |
| 99 | |
| 100 <p> | |
| 101 Private method to start the detached process. | |
| 102 </p> | |
| 103 <p> | |
| 104 This method patches the arguments such, that a debug client is | |
| 105 started for the Python script. A Python script is assumed, if the | |
| 106 program to be started contains the string 'python'. | |
| 107 </p> | |
| 108 <dl> | |
| 109 | |
| 110 <dt><i>args</i> (list)</dt> | |
| 111 <dd> | |
| 112 arguments of the start call | |
| 113 </dd> | |
| 114 <dt><i>kwargs</i> (dict)</dt> | |
| 115 <dd> | |
| 116 keyword arguments of the start call | |
| 117 </dd> | |
| 118 </dl> | |
| 119 <dl> | |
| 120 <dt>Return:</dt> | |
| 121 <dd> | |
| 122 flag indicating a successful start | |
| 123 </dd> | |
| 124 </dl> | |
| 125 <dl> | |
| 126 <dt>Return Type:</dt> | |
| 127 <dd> | |
| 128 bool | |
| 129 </dd> | |
| 130 </dl> | |
| 131 <a NAME="QProcessWrapper.start" ID="QProcessWrapper.start"></a> | |
| 132 <h4>QProcessWrapper.start</h4> | |
| 133 <b>start</b>(<i>*args, **kwargs</i>) | |
| 134 | |
| 135 <p> | |
| 136 Public method to start the process. | |
| 137 </p> | |
| 138 <p> | |
| 139 This method patches the arguments such, that a debug client is | |
| 140 started for the Python script. A Python script is assumed, if the | |
| 141 program to be started contains the string 'python'. | |
| 142 </p> | |
| 143 <dl> | |
| 144 | |
| 145 <dt><i>args</i> (list)</dt> | |
| 146 <dd> | |
| 147 arguments of the start call | |
| 148 </dd> | |
| 149 <dt><i>kwargs</i> (dict)</dt> | |
| 150 <dd> | |
| 151 keyword arguments of the start call | |
| 152 </dd> | |
| 153 </dl> | |
| 154 <a NAME="QProcessWrapper.startDetached" ID="QProcessWrapper.startDetached"></a> | |
| 155 <h4>QProcessWrapper.startDetached</h4> | |
| 156 <b>startDetached</b>(<i>*args, **kwargs</i>) | |
| 157 | |
| 158 <p> | |
| 159 Public method to start the detached process. | |
| 160 </p> | |
| 161 <p> | |
| 162 This method patches the arguments such, that a debug client is | |
| 163 started for the Python script. A Python script is assumed, if the | |
| 164 program to be started contains the string 'python'. | |
| 165 </p> | |
| 166 <dl> | |
| 167 | |
| 168 <dt><i>args</i> (list)</dt> | |
| 169 <dd> | |
| 170 arguments of the start call | |
| 171 </dd> | |
| 172 <dt><i>kwargs</i> (dict)</dt> | |
| 173 <dd> | |
| 174 keyword arguments of the start call | |
| 175 </dd> | |
| 176 </dl> | |
| 177 <dl> | |
| 178 <dt>Return:</dt> | |
| 179 <dd> | |
| 180 flag indicating a successful start | |
| 181 </dd> | |
| 182 </dl> | |
| 183 <dl> | |
| 184 <dt>Return Type:</dt> | |
| 185 <dd> | |
| 186 bool | |
| 187 </dd> | |
| 188 </dl> | |
| 189 <a NAME="QProcessWrapper.startDetachedStatic" ID="QProcessWrapper.startDetachedStatic"></a> | |
| 190 <h4>QProcessWrapper.startDetachedStatic (static)</h4> | |
| 191 <b>startDetachedStatic</b>(<i>**kwargs</i>) | |
| 192 | |
| 193 <p> | |
| 194 Static method to start the detached process. | |
| 195 </p> | |
| 196 <p> | |
| 197 This method patches the arguments such, that a debug client is | |
| 198 started for the Python script. A Python script is assumed, if the | |
| 199 program to be started contains the string 'python'. | |
| 200 </p> | |
| 201 <dl> | |
| 202 | |
| 203 <dt><i>args</i> (list)</dt> | |
| 204 <dd> | |
| 205 arguments of the start call | |
| 206 </dd> | |
| 207 <dt><i>kwargs</i> (dict)</dt> | |
| 208 <dd> | |
| 209 keyword arguments of the start call | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <dl> | |
| 213 <dt>Return:</dt> | |
| 214 <dd> | |
| 215 flag indicating a successful start | |
| 216 </dd> | |
| 217 </dl> | |
| 218 <dl> | |
| 219 <dt>Return Type:</dt> | |
| 220 <dd> | |
| 221 bool | |
| 222 </dd> | |
| 223 </dl> | |
| 224 <div align="right"><a href="#top">Up</a></div> | |
| 225 <hr /> | |
| 226 <hr /> | |
| 227 <a NAME="patchQProcess" ID="patchQProcess"></a> | |
| 228 <h2>patchQProcess</h2> | |
| 229 <b>patchQProcess</b>(<i>module, debugClient</i>) | |
| 230 | |
| 231 <p> | |
| 232 Function to patch the QtCore module's QProcess. | |
| 233 </p> | |
| 234 <dl> | |
| 235 | |
| 236 <dt><i>module</i> (module)</dt> | |
| 237 <dd> | |
| 238 reference to the imported module to be patched | |
| 239 </dd> | |
| 240 <dt><i>debugClient</i> (DebugClient)</dt> | |
| 241 <dd> | |
| 242 reference to the debug client object | |
| 243 </dd> | |
| 244 </dl> | |
| 245 <div align="right"><a href="#top">Up</a></div> | |
| 246 <hr /> | |
| 247 </body></html> |
