Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.VirtualEnv.VirtualenvExecDialog.html
Documentation/Source/eric6.VirtualEnv.VirtualenvExecDialog.html
- changeset 6339
- d765c3204c71
- child 6770
- 4782d2b8e1bd
equal
deleted
inserted
replaced
| 6338:104ee21d765d | 6339:d765c3204c71 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.VirtualEnv.VirtualenvExecDialog</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.VirtualEnv.VirtualenvExecDialog</h1> | |
| 23 <p> | |
| 24 Module implementing the virtualenv execution dialog. | |
| 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="#VirtualenvExecDialog">VirtualenvExecDialog</a></td> | |
| 34 <td>Class implementing the virtualenv execution dialog.</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="VirtualenvExecDialog" ID="VirtualenvExecDialog"></a> | |
| 43 <h2>VirtualenvExecDialog</h2> | |
| 44 <p> | |
| 45 Class implementing the virtualenv execution dialog. | |
| 46 </p><p> | |
| 47 This class starts a QProcess and displays a dialog that | |
| 48 shows the output of the virtualenv or pyvenv process. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 QDialog, Ui_VirtualenvExecDialog | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#VirtualenvExecDialog.__init__">VirtualenvExecDialog</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#VirtualenvExecDialog.__finish">__finish</a></td> | |
| 67 <td>Private slot called when the process finished.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#VirtualenvExecDialog.__logError">__logError</a></td> | |
| 70 <td>Private method to log an error.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#VirtualenvExecDialog.__logOutput">__logOutput</a></td> | |
| 73 <td>Private method to log some output.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#VirtualenvExecDialog.__nextAttempt">__nextAttempt</a></td> | |
| 76 <td>Private method to start another attempt.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#VirtualenvExecDialog.__readStderr">__readStderr</a></td> | |
| 79 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#VirtualenvExecDialog.__readStdout">__readStdout</a></td> | |
| 82 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#VirtualenvExecDialog.__writeLogFile">__writeLogFile</a></td> | |
| 85 <td>Private method to write a log file to the virtualenv directory.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#VirtualenvExecDialog.__writeScriptFile">__writeScriptFile</a></td> | |
| 88 <td>Private method to write a script file to the virtualenv directory.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#VirtualenvExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 91 <td>Private slot called by a button of the button box clicked.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#VirtualenvExecDialog.start">start</a></td> | |
| 94 <td>Public slot to start the virtualenv command.</td> | |
| 95 </tr> | |
| 96 </table> | |
| 97 <h3>Static Methods</h3> | |
| 98 <table> | |
| 99 <tr><td>None</td></tr> | |
| 100 </table> | |
| 101 <a NAME="VirtualenvExecDialog.__init__" ID="VirtualenvExecDialog.__init__"></a> | |
| 102 <h4>VirtualenvExecDialog (Constructor)</h4> | |
| 103 <b>VirtualenvExecDialog</b>(<i>pyvenv, targetDir, venvName, openTarget, createLog, createScript, interpreter, venvManager, parent=None</i>) | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p><dl> | |
| 107 <dt><i>pyvenv</i> (bool)</dt> | |
| 108 <dd> | |
| 109 flag indicating the use of 'pyvenv' | |
| 110 </dd><dt><i>targetDir</i> (str)</dt> | |
| 111 <dd> | |
| 112 name of the virtualenv directory | |
| 113 </dd><dt><i>venvName</i> (str)</dt> | |
| 114 <dd> | |
| 115 logical name for the virtual environment | |
| 116 </dd><dt><i>openTarget</i> (bool)</dt> | |
| 117 <dd> | |
| 118 flag indicating to open the virtualenv directory | |
| 119 in a file manager | |
| 120 </dd><dt><i>createLog</i> (bool)</dt> | |
| 121 <dd> | |
| 122 flag indicating to create a log file of the | |
| 123 creation process | |
| 124 </dd><dt><i>createScript</i> (bool)</dt> | |
| 125 <dd> | |
| 126 flag indicating to create a script to recreate | |
| 127 the virtual environment | |
| 128 </dd><dt><i>interpreter</i> (str)</dt> | |
| 129 <dd> | |
| 130 name of the python interpreter to use | |
| 131 </dd><dt><i>venvManager</i> (VirtualenvManager)</dt> | |
| 132 <dd> | |
| 133 reference to the virtual environment manager | |
| 134 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 135 <dd> | |
| 136 reference to the parent widget | |
| 137 </dd> | |
| 138 </dl><a NAME="VirtualenvExecDialog.__finish" ID="VirtualenvExecDialog.__finish"></a> | |
| 139 <h4>VirtualenvExecDialog.__finish</h4> | |
| 140 <b>__finish</b>(<i>exitCode, exitStatus, giveUp=False</i>) | |
| 141 <p> | |
| 142 Private slot called when the process finished. | |
| 143 </p><p> | |
| 144 It is called when the process finished or | |
| 145 the user pressed the button. | |
| 146 </p><dl> | |
| 147 <dt><i>exitCode</i></dt> | |
| 148 <dd> | |
| 149 exit code of the process (integer) | |
| 150 </dd><dt><i>exitStatus</i></dt> | |
| 151 <dd> | |
| 152 exit status of the process (QProcess.ExitStatus) | |
| 153 </dd><dt><i>giveUp=</i></dt> | |
| 154 <dd> | |
| 155 flag indicating to not start another attempt (boolean) | |
| 156 </dd> | |
| 157 </dl><a NAME="VirtualenvExecDialog.__logError" ID="VirtualenvExecDialog.__logError"></a> | |
| 158 <h4>VirtualenvExecDialog.__logError</h4> | |
| 159 <b>__logError</b>(<i>s</i>) | |
| 160 <p> | |
| 161 Private method to log an error. | |
| 162 </p><dl> | |
| 163 <dt><i>s</i></dt> | |
| 164 <dd> | |
| 165 error string to log (string) | |
| 166 </dd> | |
| 167 </dl><a NAME="VirtualenvExecDialog.__logOutput" ID="VirtualenvExecDialog.__logOutput"></a> | |
| 168 <h4>VirtualenvExecDialog.__logOutput</h4> | |
| 169 <b>__logOutput</b>(<i>s</i>) | |
| 170 <p> | |
| 171 Private method to log some output. | |
| 172 </p><dl> | |
| 173 <dt><i>s</i></dt> | |
| 174 <dd> | |
| 175 output sstring to log (string) | |
| 176 </dd> | |
| 177 </dl><a NAME="VirtualenvExecDialog.__nextAttempt" ID="VirtualenvExecDialog.__nextAttempt"></a> | |
| 178 <h4>VirtualenvExecDialog.__nextAttempt</h4> | |
| 179 <b>__nextAttempt</b>(<i></i>) | |
| 180 <p> | |
| 181 Private method to start another attempt. | |
| 182 </p><a NAME="VirtualenvExecDialog.__readStderr" ID="VirtualenvExecDialog.__readStderr"></a> | |
| 183 <h4>VirtualenvExecDialog.__readStderr</h4> | |
| 184 <b>__readStderr</b>(<i></i>) | |
| 185 <p> | |
| 186 Private slot to handle the readyReadStandardError signal. | |
| 187 </p><p> | |
| 188 It reads the error output of the process and inserts it into the | |
| 189 error pane. | |
| 190 </p><a NAME="VirtualenvExecDialog.__readStdout" ID="VirtualenvExecDialog.__readStdout"></a> | |
| 191 <h4>VirtualenvExecDialog.__readStdout</h4> | |
| 192 <b>__readStdout</b>(<i></i>) | |
| 193 <p> | |
| 194 Private slot to handle the readyReadStandardOutput signal. | |
| 195 </p><p> | |
| 196 It reads the output of the process, formats it and inserts it into | |
| 197 the contents pane. | |
| 198 </p><a NAME="VirtualenvExecDialog.__writeLogFile" ID="VirtualenvExecDialog.__writeLogFile"></a> | |
| 199 <h4>VirtualenvExecDialog.__writeLogFile</h4> | |
| 200 <b>__writeLogFile</b>(<i></i>) | |
| 201 <p> | |
| 202 Private method to write a log file to the virtualenv directory. | |
| 203 </p><a NAME="VirtualenvExecDialog.__writeScriptFile" ID="VirtualenvExecDialog.__writeScriptFile"></a> | |
| 204 <h4>VirtualenvExecDialog.__writeScriptFile</h4> | |
| 205 <b>__writeScriptFile</b>(<i></i>) | |
| 206 <p> | |
| 207 Private method to write a script file to the virtualenv directory. | |
| 208 </p><a NAME="VirtualenvExecDialog.on_buttonBox_clicked" ID="VirtualenvExecDialog.on_buttonBox_clicked"></a> | |
| 209 <h4>VirtualenvExecDialog.on_buttonBox_clicked</h4> | |
| 210 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 211 <p> | |
| 212 Private slot called by a button of the button box clicked. | |
| 213 </p><dl> | |
| 214 <dt><i>button</i></dt> | |
| 215 <dd> | |
| 216 button that was clicked (QAbstractButton) | |
| 217 </dd> | |
| 218 </dl><a NAME="VirtualenvExecDialog.start" ID="VirtualenvExecDialog.start"></a> | |
| 219 <h4>VirtualenvExecDialog.start</h4> | |
| 220 <b>start</b>(<i>arguments</i>) | |
| 221 <p> | |
| 222 Public slot to start the virtualenv command. | |
| 223 </p><dl> | |
| 224 <dt><i>arguments</i></dt> | |
| 225 <dd> | |
| 226 commandline arguments for virtualenv/pyvenv program | |
| 227 (list of strings) | |
| 228 </dd> | |
| 229 </dl> | |
| 230 <div align="right"><a href="#top">Up</a></div> | |
| 231 <hr /> | |
| 232 </body></html> |
