Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvUpgradeExecDialog.html
src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvUpgradeExecDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9144
- 135240382a3e
- child 10433
- 328f3ec4b77a
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.VirtualEnv.VirtualenvUpgradeExecDialog</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.VirtualEnv.VirtualenvUpgradeExecDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the virtualenv upgrade execution dialog. | |
| 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="#VirtualenvUpgradeExecDialog">VirtualenvUpgradeExecDialog</a></td> | |
| 25 <td>Class implementing the virtualenv upgrade execution dialog.</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="VirtualenvUpgradeExecDialog" ID="VirtualenvUpgradeExecDialog"></a> | |
| 36 <h2>VirtualenvUpgradeExecDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the virtualenv upgrade execution dialog. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_VirtualenvExecDialog | |
| 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="#VirtualenvUpgradeExecDialog.__init__">VirtualenvUpgradeExecDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#VirtualenvUpgradeExecDialog.__changeVirtualEnvironmentInterpreter">__changeVirtualEnvironmentInterpreter</a></td> | |
| 63 <td>Private method to change the interpreter of the upgraded virtual environment.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#VirtualenvUpgradeExecDialog.__finish">__finish</a></td> | |
| 67 <td>Private slot called when the process finished.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#VirtualenvUpgradeExecDialog.__logError">__logError</a></td> | |
| 71 <td>Private method to log an error.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#VirtualenvUpgradeExecDialog.__logOutput">__logOutput</a></td> | |
| 75 <td>Private method to log some output.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#VirtualenvUpgradeExecDialog.__nextAttempt">__nextAttempt</a></td> | |
| 79 <td>Private method to start another attempt.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#VirtualenvUpgradeExecDialog.__readStderr">__readStderr</a></td> | |
| 83 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#VirtualenvUpgradeExecDialog.__readStdout">__readStdout</a></td> | |
| 87 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#VirtualenvUpgradeExecDialog.__writeLogFile">__writeLogFile</a></td> | |
| 91 <td>Private method to write a log file to the virtualenv directory.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#VirtualenvUpgradeExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 95 <td>Private slot called by a button of the button box clicked.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#VirtualenvUpgradeExecDialog.start">start</a></td> | |
| 99 <td>Public slot to start the virtualenv command.</td> | |
| 100 </tr> | |
| 101 </table> | |
| 102 <h3>Static Methods</h3> | |
| 103 | |
| 104 <table> | |
| 105 <tr><td>None</td></tr> | |
| 106 </table> | |
| 107 | |
| 108 <a NAME="VirtualenvUpgradeExecDialog.__init__" ID="VirtualenvUpgradeExecDialog.__init__"></a> | |
| 109 <h4>VirtualenvUpgradeExecDialog (Constructor)</h4> | |
| 110 <b>VirtualenvUpgradeExecDialog</b>(<i>venvName, interpreter, createLog, venvManager, parent=None</i>) | |
| 111 | |
| 112 <p> | |
| 113 Constructor | |
| 114 </p> | |
| 115 <dl> | |
| 116 | |
| 117 <dt><i>venvName</i> (str)</dt> | |
| 118 <dd> | |
| 119 name of the virtual environment to be upgraded | |
| 120 </dd> | |
| 121 <dt><i>interpreter</i> (str)</dt> | |
| 122 <dd> | |
| 123 interpreter to be used for the upgrade | |
| 124 </dd> | |
| 125 <dt><i>createLog</i> (bool)</dt> | |
| 126 <dd> | |
| 127 flag indicating to create a log file for the upgrade | |
| 128 </dd> | |
| 129 <dt><i>venvManager</i> (VirtualenvManager)</dt> | |
| 130 <dd> | |
| 131 reference to the virtual environment manager | |
| 132 </dd> | |
| 133 <dt><i>parent</i> (QWidget)</dt> | |
| 134 <dd> | |
| 135 reference to the parent widget | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <a NAME="VirtualenvUpgradeExecDialog.__changeVirtualEnvironmentInterpreter" ID="VirtualenvUpgradeExecDialog.__changeVirtualEnvironmentInterpreter"></a> | |
| 139 <h4>VirtualenvUpgradeExecDialog.__changeVirtualEnvironmentInterpreter</h4> | |
| 140 <b>__changeVirtualEnvironmentInterpreter</b>(<i></i>) | |
| 141 | |
| 142 <p> | |
| 143 Private method to change the interpreter of the upgraded virtual | |
| 144 environment. | |
| 145 </p> | |
| 146 <a NAME="VirtualenvUpgradeExecDialog.__finish" ID="VirtualenvUpgradeExecDialog.__finish"></a> | |
| 147 <h4>VirtualenvUpgradeExecDialog.__finish</h4> | |
| 148 <b>__finish</b>(<i>exitCode, exitStatus, giveUp=False</i>) | |
| 149 | |
| 150 <p> | |
| 151 Private slot called when the process finished. | |
| 152 </p> | |
| 153 <p> | |
| 154 It is called when the process finished or | |
| 155 the user pressed the button. | |
| 156 </p> | |
| 157 <dl> | |
| 158 | |
| 159 <dt><i>exitCode</i></dt> | |
| 160 <dd> | |
| 161 exit code of the process (integer) | |
| 162 </dd> | |
| 163 <dt><i>exitStatus</i></dt> | |
| 164 <dd> | |
| 165 exit status of the process (QProcess.ExitStatus) | |
| 166 </dd> | |
| 167 <dt><i>giveUp</i></dt> | |
| 168 <dd> | |
| 169 flag indicating to not start another attempt (boolean) | |
| 170 </dd> | |
| 171 </dl> | |
| 172 <a NAME="VirtualenvUpgradeExecDialog.__logError" ID="VirtualenvUpgradeExecDialog.__logError"></a> | |
| 173 <h4>VirtualenvUpgradeExecDialog.__logError</h4> | |
| 174 <b>__logError</b>(<i>s</i>) | |
| 175 | |
| 176 <p> | |
| 177 Private method to log an error. | |
| 178 </p> | |
| 179 <dl> | |
| 180 | |
| 181 <dt><i>s</i></dt> | |
| 182 <dd> | |
| 183 error string to log (string) | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <a NAME="VirtualenvUpgradeExecDialog.__logOutput" ID="VirtualenvUpgradeExecDialog.__logOutput"></a> | |
| 187 <h4>VirtualenvUpgradeExecDialog.__logOutput</h4> | |
| 188 <b>__logOutput</b>(<i>s</i>) | |
| 189 | |
| 190 <p> | |
| 191 Private method to log some output. | |
| 192 </p> | |
| 193 <dl> | |
| 194 | |
| 195 <dt><i>s</i></dt> | |
| 196 <dd> | |
| 197 output string to log (string) | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <a NAME="VirtualenvUpgradeExecDialog.__nextAttempt" ID="VirtualenvUpgradeExecDialog.__nextAttempt"></a> | |
| 201 <h4>VirtualenvUpgradeExecDialog.__nextAttempt</h4> | |
| 202 <b>__nextAttempt</b>(<i></i>) | |
| 203 | |
| 204 <p> | |
| 205 Private method to start another attempt. | |
| 206 </p> | |
| 207 <a NAME="VirtualenvUpgradeExecDialog.__readStderr" ID="VirtualenvUpgradeExecDialog.__readStderr"></a> | |
| 208 <h4>VirtualenvUpgradeExecDialog.__readStderr</h4> | |
| 209 <b>__readStderr</b>(<i></i>) | |
| 210 | |
| 211 <p> | |
| 212 Private slot to handle the readyReadStandardError signal. | |
| 213 </p> | |
| 214 <p> | |
| 215 It reads the error output of the process and inserts it into the | |
| 216 error pane. | |
| 217 </p> | |
| 218 <a NAME="VirtualenvUpgradeExecDialog.__readStdout" ID="VirtualenvUpgradeExecDialog.__readStdout"></a> | |
| 219 <h4>VirtualenvUpgradeExecDialog.__readStdout</h4> | |
| 220 <b>__readStdout</b>(<i></i>) | |
| 221 | |
| 222 <p> | |
| 223 Private slot to handle the readyReadStandardOutput signal. | |
| 224 </p> | |
| 225 <p> | |
| 226 It reads the output of the process, formats it and inserts it into | |
| 227 the contents pane. | |
| 228 </p> | |
| 229 <a NAME="VirtualenvUpgradeExecDialog.__writeLogFile" ID="VirtualenvUpgradeExecDialog.__writeLogFile"></a> | |
| 230 <h4>VirtualenvUpgradeExecDialog.__writeLogFile</h4> | |
| 231 <b>__writeLogFile</b>(<i></i>) | |
| 232 | |
| 233 <p> | |
| 234 Private method to write a log file to the virtualenv directory. | |
| 235 </p> | |
| 236 <a NAME="VirtualenvUpgradeExecDialog.on_buttonBox_clicked" ID="VirtualenvUpgradeExecDialog.on_buttonBox_clicked"></a> | |
| 237 <h4>VirtualenvUpgradeExecDialog.on_buttonBox_clicked</h4> | |
| 238 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 239 | |
| 240 <p> | |
| 241 Private slot called by a button of the button box clicked. | |
| 242 </p> | |
| 243 <dl> | |
| 244 | |
| 245 <dt><i>button</i></dt> | |
| 246 <dd> | |
| 247 button that was clicked (QAbstractButton) | |
| 248 </dd> | |
| 249 </dl> | |
| 250 <a NAME="VirtualenvUpgradeExecDialog.start" ID="VirtualenvUpgradeExecDialog.start"></a> | |
| 251 <h4>VirtualenvUpgradeExecDialog.start</h4> | |
| 252 <b>start</b>(<i>arguments</i>) | |
| 253 | |
| 254 <p> | |
| 255 Public slot to start the virtualenv command. | |
| 256 </p> | |
| 257 <dl> | |
| 258 | |
| 259 <dt><i>arguments</i></dt> | |
| 260 <dd> | |
| 261 commandline arguments for virtualenv/pyvenv program | |
| 262 (list of strings) | |
| 263 </dd> | |
| 264 </dl> | |
| 265 <div align="right"><a href="#top">Up</a></div> | |
| 266 <hr /> | |
| 267 </body></html> |
