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