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