Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvExecDialog.html
eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvExecDialog.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 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>configuration, venvManager, parent=None</i>) | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p><dl> | |
| 107 <dt><i>configuration</i> (dict)</dt> | |
| 108 <dd> | |
| 109 dictionary containing the configuration parameters | |
| 110 as returned by the command configuration dialog | |
| 111 </dd><dt><i>venvManager</i> (VirtualenvManager)</dt> | |
| 112 <dd> | |
| 113 reference to the virtual environment manager | |
| 114 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 115 <dd> | |
| 116 reference to the parent widget | |
| 117 </dd> | |
| 118 </dl><a NAME="VirtualenvExecDialog.__finish" ID="VirtualenvExecDialog.__finish"></a> | |
| 119 <h4>VirtualenvExecDialog.__finish</h4> | |
| 120 <b>__finish</b>(<i>exitCode, exitStatus, giveUp=False</i>) | |
| 121 <p> | |
| 122 Private slot called when the process finished. | |
| 123 </p><p> | |
| 124 It is called when the process finished or | |
| 125 the user pressed the button. | |
| 126 </p><dl> | |
| 127 <dt><i>exitCode</i></dt> | |
| 128 <dd> | |
| 129 exit code of the process (integer) | |
| 130 </dd><dt><i>exitStatus</i></dt> | |
| 131 <dd> | |
| 132 exit status of the process (QProcess.ExitStatus) | |
| 133 </dd><dt><i>giveUp=</i></dt> | |
| 134 <dd> | |
| 135 flag indicating to not start another attempt (boolean) | |
| 136 </dd> | |
| 137 </dl><a NAME="VirtualenvExecDialog.__logError" ID="VirtualenvExecDialog.__logError"></a> | |
| 138 <h4>VirtualenvExecDialog.__logError</h4> | |
| 139 <b>__logError</b>(<i>s</i>) | |
| 140 <p> | |
| 141 Private method to log an error. | |
| 142 </p><dl> | |
| 143 <dt><i>s</i></dt> | |
| 144 <dd> | |
| 145 error string to log (string) | |
| 146 </dd> | |
| 147 </dl><a NAME="VirtualenvExecDialog.__logOutput" ID="VirtualenvExecDialog.__logOutput"></a> | |
| 148 <h4>VirtualenvExecDialog.__logOutput</h4> | |
| 149 <b>__logOutput</b>(<i>s</i>) | |
| 150 <p> | |
| 151 Private method to log some output. | |
| 152 </p><dl> | |
| 153 <dt><i>s</i></dt> | |
| 154 <dd> | |
| 155 output string to log (string) | |
| 156 </dd> | |
| 157 </dl><a NAME="VirtualenvExecDialog.__nextAttempt" ID="VirtualenvExecDialog.__nextAttempt"></a> | |
| 158 <h4>VirtualenvExecDialog.__nextAttempt</h4> | |
| 159 <b>__nextAttempt</b>(<i></i>) | |
| 160 <p> | |
| 161 Private method to start another attempt. | |
| 162 </p><a NAME="VirtualenvExecDialog.__readStderr" ID="VirtualenvExecDialog.__readStderr"></a> | |
| 163 <h4>VirtualenvExecDialog.__readStderr</h4> | |
| 164 <b>__readStderr</b>(<i></i>) | |
| 165 <p> | |
| 166 Private slot to handle the readyReadStandardError signal. | |
| 167 </p><p> | |
| 168 It reads the error output of the process and inserts it into the | |
| 169 error pane. | |
| 170 </p><a NAME="VirtualenvExecDialog.__readStdout" ID="VirtualenvExecDialog.__readStdout"></a> | |
| 171 <h4>VirtualenvExecDialog.__readStdout</h4> | |
| 172 <b>__readStdout</b>(<i></i>) | |
| 173 <p> | |
| 174 Private slot to handle the readyReadStandardOutput signal. | |
| 175 </p><p> | |
| 176 It reads the output of the process, formats it and inserts it into | |
| 177 the contents pane. | |
| 178 </p><a NAME="VirtualenvExecDialog.__writeLogFile" ID="VirtualenvExecDialog.__writeLogFile"></a> | |
| 179 <h4>VirtualenvExecDialog.__writeLogFile</h4> | |
| 180 <b>__writeLogFile</b>(<i></i>) | |
| 181 <p> | |
| 182 Private method to write a log file to the virtualenv directory. | |
| 183 </p><a NAME="VirtualenvExecDialog.__writeScriptFile" ID="VirtualenvExecDialog.__writeScriptFile"></a> | |
| 184 <h4>VirtualenvExecDialog.__writeScriptFile</h4> | |
| 185 <b>__writeScriptFile</b>(<i></i>) | |
| 186 <p> | |
| 187 Private method to write a script file to the virtualenv directory. | |
| 188 </p><a NAME="VirtualenvExecDialog.on_buttonBox_clicked" ID="VirtualenvExecDialog.on_buttonBox_clicked"></a> | |
| 189 <h4>VirtualenvExecDialog.on_buttonBox_clicked</h4> | |
| 190 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 191 <p> | |
| 192 Private slot called by a button of the button box clicked. | |
| 193 </p><dl> | |
| 194 <dt><i>button</i></dt> | |
| 195 <dd> | |
| 196 button that was clicked (QAbstractButton) | |
| 197 </dd> | |
| 198 </dl><a NAME="VirtualenvExecDialog.start" ID="VirtualenvExecDialog.start"></a> | |
| 199 <h4>VirtualenvExecDialog.start</h4> | |
| 200 <b>start</b>(<i>arguments</i>) | |
| 201 <p> | |
| 202 Public slot to start the virtualenv command. | |
| 203 </p><dl> | |
| 204 <dt><i>arguments</i></dt> | |
| 205 <dd> | |
| 206 commandline arguments for virtualenv/pyvenv program | |
| 207 (list of strings) | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <div align="right"><a href="#top">Up</a></div> | |
| 211 <hr /> | |
| 212 </body></html> |
