Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.CondaInterface.CondaExecDialog.html
src/eric7/Documentation/Source/eric7.CondaInterface.CondaExecDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.CondaInterface.CondaExecDialog</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.CondaInterface.CondaExecDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to show the output of a conda execution. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#CondaExecDialog">CondaExecDialog</a></td> | |
| 25 <td>Class implementing a dialog to show the output of a conda execution.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="CondaExecDialog" ID="CondaExecDialog"></a> | |
| 36 <h2>CondaExecDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to show the output of a conda execution. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_CondaExecDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#CondaExecDialog.__init__">CondaExecDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#CondaExecDialog.__finish">__finish</a></td> | |
| 63 <td>Private slot called when the process finished.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#CondaExecDialog.__logError">__logError</a></td> | |
| 67 <td>Private method to log an error.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#CondaExecDialog.__logOutput">__logOutput</a></td> | |
| 71 <td>Private method to log some output.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#CondaExecDialog.__readStderr">__readStderr</a></td> | |
| 75 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#CondaExecDialog.__readStdout">__readStdout</a></td> | |
| 79 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#CondaExecDialog.__setProgressValues">__setProgressValues</a></td> | |
| 83 <td>Private method to set the value of the progress bar.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#CondaExecDialog.getResult">getResult</a></td> | |
| 87 <td>Public method to the result of the command execution.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#CondaExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 91 <td>Private slot called by a button of the button box clicked.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#CondaExecDialog.start">start</a></td> | |
| 95 <td>Public slot to start the conda command.</td> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <h3>Static Methods</h3> | |
| 99 | |
| 100 <table> | |
| 101 <tr><td>None</td></tr> | |
| 102 </table> | |
| 103 | |
| 104 <a NAME="CondaExecDialog.__init__" ID="CondaExecDialog.__init__"></a> | |
| 105 <h4>CondaExecDialog (Constructor)</h4> | |
| 106 <b>CondaExecDialog</b>(<i>command, parent=None</i>) | |
| 107 | |
| 108 <p> | |
| 109 Constructor | |
| 110 </p> | |
| 111 <dl> | |
| 112 | |
| 113 <dt><i>command</i> (str)</dt> | |
| 114 <dd> | |
| 115 conda command executed | |
| 116 </dd> | |
| 117 <dt><i>parent</i> (QWidget)</dt> | |
| 118 <dd> | |
| 119 reference to the parent widget | |
| 120 </dd> | |
| 121 </dl> | |
| 122 <a NAME="CondaExecDialog.__finish" ID="CondaExecDialog.__finish"></a> | |
| 123 <h4>CondaExecDialog.__finish</h4> | |
| 124 <b>__finish</b>(<i>exitCode, exitStatus, giveUp=False</i>) | |
| 125 | |
| 126 <p> | |
| 127 Private slot called when the process finished. | |
| 128 </p> | |
| 129 <p> | |
| 130 It is called when the process finished or | |
| 131 the user pressed the button. | |
| 132 </p> | |
| 133 <dl> | |
| 134 | |
| 135 <dt><i>exitCode</i> (int)</dt> | |
| 136 <dd> | |
| 137 exit code of the process | |
| 138 </dd> | |
| 139 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> | |
| 140 <dd> | |
| 141 exit status of the process | |
| 142 </dd> | |
| 143 <dt><i>giveUp</i> (bool)</dt> | |
| 144 <dd> | |
| 145 flag indicating to not start another attempt | |
| 146 </dd> | |
| 147 </dl> | |
| 148 <a NAME="CondaExecDialog.__logError" ID="CondaExecDialog.__logError"></a> | |
| 149 <h4>CondaExecDialog.__logError</h4> | |
| 150 <b>__logError</b>(<i>stderr</i>) | |
| 151 | |
| 152 <p> | |
| 153 Private method to log an error. | |
| 154 </p> | |
| 155 <dl> | |
| 156 | |
| 157 <dt><i>stderr</i> (str)</dt> | |
| 158 <dd> | |
| 159 error string to log | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <a NAME="CondaExecDialog.__logOutput" ID="CondaExecDialog.__logOutput"></a> | |
| 163 <h4>CondaExecDialog.__logOutput</h4> | |
| 164 <b>__logOutput</b>(<i>stdout</i>) | |
| 165 | |
| 166 <p> | |
| 167 Private method to log some output. | |
| 168 </p> | |
| 169 <dl> | |
| 170 | |
| 171 <dt><i>stdout</i> (str)</dt> | |
| 172 <dd> | |
| 173 output string to log | |
| 174 </dd> | |
| 175 </dl> | |
| 176 <a NAME="CondaExecDialog.__readStderr" ID="CondaExecDialog.__readStderr"></a> | |
| 177 <h4>CondaExecDialog.__readStderr</h4> | |
| 178 <b>__readStderr</b>(<i></i>) | |
| 179 | |
| 180 <p> | |
| 181 Private slot to handle the readyReadStandardError signal. | |
| 182 </p> | |
| 183 <p> | |
| 184 It reads the error output of the process and inserts it into the | |
| 185 error pane. | |
| 186 </p> | |
| 187 <a NAME="CondaExecDialog.__readStdout" ID="CondaExecDialog.__readStdout"></a> | |
| 188 <h4>CondaExecDialog.__readStdout</h4> | |
| 189 <b>__readStdout</b>(<i></i>) | |
| 190 | |
| 191 <p> | |
| 192 Private slot to handle the readyReadStandardOutput signal. | |
| 193 </p> | |
| 194 <p> | |
| 195 It reads the output of the process, formats it and inserts it into | |
| 196 the contents pane. | |
| 197 </p> | |
| 198 <a NAME="CondaExecDialog.__setProgressValues" ID="CondaExecDialog.__setProgressValues"></a> | |
| 199 <h4>CondaExecDialog.__setProgressValues</h4> | |
| 200 <b>__setProgressValues</b>(<i>jsonDict, progressType</i>) | |
| 201 | |
| 202 <p> | |
| 203 Private method to set the value of the progress bar. | |
| 204 </p> | |
| 205 <dl> | |
| 206 | |
| 207 <dt><i>jsonDict</i> (dict)</dt> | |
| 208 <dd> | |
| 209 dictionary containing the progress info | |
| 210 </dd> | |
| 211 <dt><i>progressType</i> (str)</dt> | |
| 212 <dd> | |
| 213 action type to check for | |
| 214 </dd> | |
| 215 </dl> | |
| 216 <dl> | |
| 217 <dt>Return:</dt> | |
| 218 <dd> | |
| 219 flag indicating success | |
| 220 </dd> | |
| 221 </dl> | |
| 222 <dl> | |
| 223 <dt>Return Type:</dt> | |
| 224 <dd> | |
| 225 bool | |
| 226 </dd> | |
| 227 </dl> | |
| 228 <a NAME="CondaExecDialog.getResult" ID="CondaExecDialog.getResult"></a> | |
| 229 <h4>CondaExecDialog.getResult</h4> | |
| 230 <b>getResult</b>(<i></i>) | |
| 231 | |
| 232 <p> | |
| 233 Public method to the result of the command execution. | |
| 234 </p> | |
| 235 <dl> | |
| 236 <dt>Return:</dt> | |
| 237 <dd> | |
| 238 tuple containing a flag indicating success and the result data. | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <dl> | |
| 242 <dt>Return Type:</dt> | |
| 243 <dd> | |
| 244 tuple of (bool, dict) | |
| 245 </dd> | |
| 246 </dl> | |
| 247 <a NAME="CondaExecDialog.on_buttonBox_clicked" ID="CondaExecDialog.on_buttonBox_clicked"></a> | |
| 248 <h4>CondaExecDialog.on_buttonBox_clicked</h4> | |
| 249 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 250 | |
| 251 <p> | |
| 252 Private slot called by a button of the button box clicked. | |
| 253 </p> | |
| 254 <dl> | |
| 255 | |
| 256 <dt><i>button</i> (QAbstractButton)</dt> | |
| 257 <dd> | |
| 258 button that was clicked | |
| 259 </dd> | |
| 260 </dl> | |
| 261 <a NAME="CondaExecDialog.start" ID="CondaExecDialog.start"></a> | |
| 262 <h4>CondaExecDialog.start</h4> | |
| 263 <b>start</b>(<i>arguments</i>) | |
| 264 | |
| 265 <p> | |
| 266 Public slot to start the conda command. | |
| 267 </p> | |
| 268 <dl> | |
| 269 | |
| 270 <dt><i>arguments</i> (list of str)</dt> | |
| 271 <dd> | |
| 272 commandline arguments for conda program | |
| 273 </dd> | |
| 274 </dl> | |
| 275 <div align="right"><a href="#top">Up</a></div> | |
| 276 <hr /> | |
| 277 </body></html> |
