src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvExecDialog.html

branch
eric7
changeset 10479
856476537696
parent 10433
328f3ec4b77a
child 10692
9becf9ca115c
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.VirtualEnv.VirtualenvExecDialog</h1> 9 <h1>eric7.VirtualEnv.VirtualenvExecDialog</h1>
10
11 <p> 10 <p>
12 Module implementing the virtualenv execution dialog. 11 Module implementing the virtualenv execution dialog.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#VirtualenvExecDialog">VirtualenvExecDialog</a></td> 22 <td><a href="#VirtualenvExecDialog">VirtualenvExecDialog</a></td>
25 <td>Class implementing the virtualenv execution dialog.</td> 23 <td>Class implementing the virtualenv execution dialog.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="VirtualenvExecDialog" ID="VirtualenvExecDialog"></a> 34 <a NAME="VirtualenvExecDialog" ID="VirtualenvExecDialog"></a>
36 <h2>VirtualenvExecDialog</h2> 35 <h2>VirtualenvExecDialog</h2>
37
38 <p> 36 <p>
39 Class implementing the virtualenv execution dialog. 37 Class implementing the virtualenv execution dialog.
40 </p> 38 </p>
41 <p> 39 <p>
42 This class starts a QProcess and displays a dialog that 40 This class starts a QProcess and displays a dialog that
43 shows the output of the virtualenv or pyvenv process. 41 shows the output of the virtualenv or pyvenv process.
44 </p> 42 </p>
43
45 <h3>Derived from</h3> 44 <h3>Derived from</h3>
46 QDialog, Ui_VirtualenvExecDialog 45 QDialog, Ui_VirtualenvExecDialog
47 <h3>Class Attributes</h3> 46 <h3>Class Attributes</h3>
48 47 <table>
49 <table> 48 <tr><td>None</td></tr>
50 <tr><td>None</td></tr> 49 </table>
51 </table> 50
52 <h3>Class Methods</h3> 51 <h3>Class Methods</h3>
53 52 <table>
54 <table> 53 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 54 </table>
56 </table> 55
57 <h3>Methods</h3> 56 <h3>Methods</h3>
58 57 <table>
59 <table>
60
61 <tr> 58 <tr>
62 <td><a href="#VirtualenvExecDialog.__init__">VirtualenvExecDialog</a></td> 59 <td><a href="#VirtualenvExecDialog.__init__">VirtualenvExecDialog</a></td>
63 <td>Constructor</td> 60 <td>Constructor</td>
64 </tr> 61 </tr>
65 <tr> 62 <tr>
101 <tr> 98 <tr>
102 <td><a href="#VirtualenvExecDialog.start">start</a></td> 99 <td><a href="#VirtualenvExecDialog.start">start</a></td>
103 <td>Public slot to start the virtualenv command.</td> 100 <td>Public slot to start the virtualenv command.</td>
104 </tr> 101 </tr>
105 </table> 102 </table>
103
106 <h3>Static Methods</h3> 104 <h3>Static Methods</h3>
107 105 <table>
108 <table> 106 <tr><td>None</td></tr>
109 <tr><td>None</td></tr> 107 </table>
110 </table> 108
111 109
112 <a NAME="VirtualenvExecDialog.__init__" ID="VirtualenvExecDialog.__init__"></a> 110 <a NAME="VirtualenvExecDialog.__init__" ID="VirtualenvExecDialog.__init__"></a>
113 <h4>VirtualenvExecDialog (Constructor)</h4> 111 <h4>VirtualenvExecDialog (Constructor)</h4>
114 <b>VirtualenvExecDialog</b>(<i>configuration, venvManager, parent=None</i>) 112 <b>VirtualenvExecDialog</b>(<i>configuration, venvManager, parent=None</i>)
115
116 <p> 113 <p>
117 Constructor 114 Constructor
118 </p> 115 </p>
116
119 <dl> 117 <dl>
120 118
121 <dt><i>configuration</i> (dict)</dt> 119 <dt><i>configuration</i> (dict)</dt>
122 <dd> 120 <dd>
123 dictionary containing the configuration parameters 121 dictionary containing the configuration parameters
133 </dd> 131 </dd>
134 </dl> 132 </dl>
135 <a NAME="VirtualenvExecDialog.__finish" ID="VirtualenvExecDialog.__finish"></a> 133 <a NAME="VirtualenvExecDialog.__finish" ID="VirtualenvExecDialog.__finish"></a>
136 <h4>VirtualenvExecDialog.__finish</h4> 134 <h4>VirtualenvExecDialog.__finish</h4>
137 <b>__finish</b>(<i>exitCode, exitStatus, giveUp=False</i>) 135 <b>__finish</b>(<i>exitCode, exitStatus, giveUp=False</i>)
138
139 <p> 136 <p>
140 Private slot called when the process finished. 137 Private slot called when the process finished.
141 </p> 138 </p>
142 <p> 139 <p>
143 It is called when the process finished or the user pressed the button. 140 It is called when the process finished or the user pressed the button.
144 </p> 141 </p>
142
145 <dl> 143 <dl>
146 144
147 <dt><i>exitCode</i> (int)</dt> 145 <dt><i>exitCode</i> (int)</dt>
148 <dd> 146 <dd>
149 exit code of the process 147 exit code of the process
158 </dd> 156 </dd>
159 </dl> 157 </dl>
160 <a NAME="VirtualenvExecDialog.__logError" ID="VirtualenvExecDialog.__logError"></a> 158 <a NAME="VirtualenvExecDialog.__logError" ID="VirtualenvExecDialog.__logError"></a>
161 <h4>VirtualenvExecDialog.__logError</h4> 159 <h4>VirtualenvExecDialog.__logError</h4>
162 <b>__logError</b>(<i>s</i>) 160 <b>__logError</b>(<i>s</i>)
163
164 <p> 161 <p>
165 Private method to log an error. 162 Private method to log an error.
166 </p> 163 </p>
164
167 <dl> 165 <dl>
168 166
169 <dt><i>s</i> (str)</dt> 167 <dt><i>s</i> (str)</dt>
170 <dd> 168 <dd>
171 error string to log 169 error string to log
172 </dd> 170 </dd>
173 </dl> 171 </dl>
174 <a NAME="VirtualenvExecDialog.__logOutput" ID="VirtualenvExecDialog.__logOutput"></a> 172 <a NAME="VirtualenvExecDialog.__logOutput" ID="VirtualenvExecDialog.__logOutput"></a>
175 <h4>VirtualenvExecDialog.__logOutput</h4> 173 <h4>VirtualenvExecDialog.__logOutput</h4>
176 <b>__logOutput</b>(<i>s</i>) 174 <b>__logOutput</b>(<i>s</i>)
177
178 <p> 175 <p>
179 Private method to log some output. 176 Private method to log some output.
180 </p> 177 </p>
178
181 <dl> 179 <dl>
182 180
183 <dt><i>s</i> (str)</dt> 181 <dt><i>s</i> (str)</dt>
184 <dd> 182 <dd>
185 output string to log 183 output string to log
186 </dd> 184 </dd>
187 </dl> 185 </dl>
188 <a NAME="VirtualenvExecDialog.__nextAttempt" ID="VirtualenvExecDialog.__nextAttempt"></a> 186 <a NAME="VirtualenvExecDialog.__nextAttempt" ID="VirtualenvExecDialog.__nextAttempt"></a>
189 <h4>VirtualenvExecDialog.__nextAttempt</h4> 187 <h4>VirtualenvExecDialog.__nextAttempt</h4>
190 <b>__nextAttempt</b>(<i></i>) 188 <b>__nextAttempt</b>(<i></i>)
191
192 <p> 189 <p>
193 Private method to start another attempt. 190 Private method to start another attempt.
194 </p> 191 </p>
192
195 <a NAME="VirtualenvExecDialog.__readStderr" ID="VirtualenvExecDialog.__readStderr"></a> 193 <a NAME="VirtualenvExecDialog.__readStderr" ID="VirtualenvExecDialog.__readStderr"></a>
196 <h4>VirtualenvExecDialog.__readStderr</h4> 194 <h4>VirtualenvExecDialog.__readStderr</h4>
197 <b>__readStderr</b>(<i></i>) 195 <b>__readStderr</b>(<i></i>)
198
199 <p> 196 <p>
200 Private slot to handle the readyReadStandardError signal. 197 Private slot to handle the readyReadStandardError signal.
201 </p> 198 </p>
202 <p> 199 <p>
203 It reads the error output of the process and inserts it into the 200 It reads the error output of the process and inserts it into the
204 error pane. 201 error pane.
205 </p> 202 </p>
203
206 <a NAME="VirtualenvExecDialog.__readStdout" ID="VirtualenvExecDialog.__readStdout"></a> 204 <a NAME="VirtualenvExecDialog.__readStdout" ID="VirtualenvExecDialog.__readStdout"></a>
207 <h4>VirtualenvExecDialog.__readStdout</h4> 205 <h4>VirtualenvExecDialog.__readStdout</h4>
208 <b>__readStdout</b>(<i></i>) 206 <b>__readStdout</b>(<i></i>)
209
210 <p> 207 <p>
211 Private slot to handle the readyReadStandardOutput signal. 208 Private slot to handle the readyReadStandardOutput signal.
212 </p> 209 </p>
213 <p> 210 <p>
214 It reads the output of the process, formats it and inserts it into 211 It reads the output of the process, formats it and inserts it into
215 the contents pane. 212 the contents pane.
216 </p> 213 </p>
214
217 <a NAME="VirtualenvExecDialog.__writeLogFile" ID="VirtualenvExecDialog.__writeLogFile"></a> 215 <a NAME="VirtualenvExecDialog.__writeLogFile" ID="VirtualenvExecDialog.__writeLogFile"></a>
218 <h4>VirtualenvExecDialog.__writeLogFile</h4> 216 <h4>VirtualenvExecDialog.__writeLogFile</h4>
219 <b>__writeLogFile</b>(<i></i>) 217 <b>__writeLogFile</b>(<i></i>)
220
221 <p> 218 <p>
222 Private method to write a log file to the virtualenv directory. 219 Private method to write a log file to the virtualenv directory.
223 </p> 220 </p>
221
224 <a NAME="VirtualenvExecDialog.__writeScriptFile" ID="VirtualenvExecDialog.__writeScriptFile"></a> 222 <a NAME="VirtualenvExecDialog.__writeScriptFile" ID="VirtualenvExecDialog.__writeScriptFile"></a>
225 <h4>VirtualenvExecDialog.__writeScriptFile</h4> 223 <h4>VirtualenvExecDialog.__writeScriptFile</h4>
226 <b>__writeScriptFile</b>(<i></i>) 224 <b>__writeScriptFile</b>(<i></i>)
227
228 <p> 225 <p>
229 Private method to write a script file to the virtualenv directory. 226 Private method to write a script file to the virtualenv directory.
230 </p> 227 </p>
228
231 <a NAME="VirtualenvExecDialog.on_buttonBox_clicked" ID="VirtualenvExecDialog.on_buttonBox_clicked"></a> 229 <a NAME="VirtualenvExecDialog.on_buttonBox_clicked" ID="VirtualenvExecDialog.on_buttonBox_clicked"></a>
232 <h4>VirtualenvExecDialog.on_buttonBox_clicked</h4> 230 <h4>VirtualenvExecDialog.on_buttonBox_clicked</h4>
233 <b>on_buttonBox_clicked</b>(<i>button</i>) 231 <b>on_buttonBox_clicked</b>(<i>button</i>)
234
235 <p> 232 <p>
236 Private slot called by a button of the button box clicked. 233 Private slot called by a button of the button box clicked.
237 </p> 234 </p>
235
238 <dl> 236 <dl>
239 237
240 <dt><i>button</i> (QAbstractButton)</dt> 238 <dt><i>button</i> (QAbstractButton)</dt>
241 <dd> 239 <dd>
242 button that was clicked 240 button that was clicked
243 </dd> 241 </dd>
244 </dl> 242 </dl>
245 <a NAME="VirtualenvExecDialog.start" ID="VirtualenvExecDialog.start"></a> 243 <a NAME="VirtualenvExecDialog.start" ID="VirtualenvExecDialog.start"></a>
246 <h4>VirtualenvExecDialog.start</h4> 244 <h4>VirtualenvExecDialog.start</h4>
247 <b>start</b>(<i>arguments</i>) 245 <b>start</b>(<i>arguments</i>)
248
249 <p> 246 <p>
250 Public slot to start the virtualenv command. 247 Public slot to start the virtualenv command.
251 </p> 248 </p>
249
252 <dl> 250 <dl>
253 251
254 <dt><i>arguments</i> (list of str)</dt> 252 <dt><i>arguments</i> (list of str)</dt>
255 <dd> 253 <dd>
256 commandline arguments for virtualenv/pyvenv program 254 commandline arguments for virtualenv/pyvenv program

eric ide

mercurial