|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.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> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.VirtualEnv.VirtualenvExecDialog</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing the virtualenv execution dialog. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#VirtualenvExecDialog">VirtualenvExecDialog</a></td> |
|
39 <td>Class implementing the virtualenv execution dialog.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
|
49 <a NAME="VirtualenvExecDialog" ID="VirtualenvExecDialog"></a> |
|
50 <h2>VirtualenvExecDialog</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing the virtualenv execution dialog. |
|
54 </p> |
|
55 <p> |
|
56 This class starts a QProcess and displays a dialog that |
|
57 shows the output of the virtualenv or pyvenv process. |
|
58 </p> |
|
59 <h3>Derived from</h3> |
|
60 QDialog, Ui_VirtualenvExecDialog |
|
61 <h3>Class Attributes</h3> |
|
62 |
|
63 <table> |
|
64 <tr><td>None</td></tr> |
|
65 </table> |
|
66 <h3>Class Methods</h3> |
|
67 |
|
68 <table> |
|
69 <tr><td>None</td></tr> |
|
70 </table> |
|
71 <h3>Methods</h3> |
|
72 |
|
73 <table> |
|
74 |
|
75 <tr> |
|
76 <td><a href="#VirtualenvExecDialog.__init__">VirtualenvExecDialog</a></td> |
|
77 <td>Constructor</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#VirtualenvExecDialog.__finish">__finish</a></td> |
|
81 <td>Private slot called when the process finished.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#VirtualenvExecDialog.__logError">__logError</a></td> |
|
85 <td>Private method to log an error.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#VirtualenvExecDialog.__logOutput">__logOutput</a></td> |
|
89 <td>Private method to log some output.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#VirtualenvExecDialog.__nextAttempt">__nextAttempt</a></td> |
|
93 <td>Private method to start another attempt.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#VirtualenvExecDialog.__readStderr">__readStderr</a></td> |
|
97 <td>Private slot to handle the readyReadStandardError signal.</td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td><a href="#VirtualenvExecDialog.__readStdout">__readStdout</a></td> |
|
101 <td>Private slot to handle the readyReadStandardOutput signal.</td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td><a href="#VirtualenvExecDialog.__writeLogFile">__writeLogFile</a></td> |
|
105 <td>Private method to write a log file to the virtualenv directory.</td> |
|
106 </tr> |
|
107 <tr> |
|
108 <td><a href="#VirtualenvExecDialog.__writeScriptFile">__writeScriptFile</a></td> |
|
109 <td>Private method to write a script file to the virtualenv directory.</td> |
|
110 </tr> |
|
111 <tr> |
|
112 <td><a href="#VirtualenvExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
113 <td>Private slot called by a button of the button box clicked.</td> |
|
114 </tr> |
|
115 <tr> |
|
116 <td><a href="#VirtualenvExecDialog.start">start</a></td> |
|
117 <td>Public slot to start the virtualenv command.</td> |
|
118 </tr> |
|
119 </table> |
|
120 <h3>Static Methods</h3> |
|
121 |
|
122 <table> |
|
123 <tr><td>None</td></tr> |
|
124 </table> |
|
125 |
|
126 <a NAME="VirtualenvExecDialog.__init__" ID="VirtualenvExecDialog.__init__"></a> |
|
127 <h4>VirtualenvExecDialog (Constructor)</h4> |
|
128 <b>VirtualenvExecDialog</b>(<i>configuration, venvManager, parent=None</i>) |
|
129 |
|
130 <p> |
|
131 Constructor |
|
132 </p> |
|
133 <dl> |
|
134 |
|
135 <dt><i>configuration</i> (dict)</dt> |
|
136 <dd> |
|
137 dictionary containing the configuration parameters |
|
138 as returned by the command configuration dialog |
|
139 </dd> |
|
140 <dt><i>venvManager</i> (VirtualenvManager)</dt> |
|
141 <dd> |
|
142 reference to the virtual environment manager |
|
143 </dd> |
|
144 <dt><i>parent</i> (QWidget)</dt> |
|
145 <dd> |
|
146 reference to the parent widget |
|
147 </dd> |
|
148 </dl> |
|
149 <a NAME="VirtualenvExecDialog.__finish" ID="VirtualenvExecDialog.__finish"></a> |
|
150 <h4>VirtualenvExecDialog.__finish</h4> |
|
151 <b>__finish</b>(<i>exitCode, exitStatus, giveUp=False</i>) |
|
152 |
|
153 <p> |
|
154 Private slot called when the process finished. |
|
155 </p> |
|
156 <p> |
|
157 It is called when the process finished or |
|
158 the user pressed the button. |
|
159 </p> |
|
160 <dl> |
|
161 |
|
162 <dt><i>exitCode</i></dt> |
|
163 <dd> |
|
164 exit code of the process (integer) |
|
165 </dd> |
|
166 <dt><i>exitStatus</i></dt> |
|
167 <dd> |
|
168 exit status of the process (QProcess.ExitStatus) |
|
169 </dd> |
|
170 <dt><i>giveUp</i></dt> |
|
171 <dd> |
|
172 flag indicating to not start another attempt (boolean) |
|
173 </dd> |
|
174 </dl> |
|
175 <a NAME="VirtualenvExecDialog.__logError" ID="VirtualenvExecDialog.__logError"></a> |
|
176 <h4>VirtualenvExecDialog.__logError</h4> |
|
177 <b>__logError</b>(<i>s</i>) |
|
178 |
|
179 <p> |
|
180 Private method to log an error. |
|
181 </p> |
|
182 <dl> |
|
183 |
|
184 <dt><i>s</i></dt> |
|
185 <dd> |
|
186 error string to log (string) |
|
187 </dd> |
|
188 </dl> |
|
189 <a NAME="VirtualenvExecDialog.__logOutput" ID="VirtualenvExecDialog.__logOutput"></a> |
|
190 <h4>VirtualenvExecDialog.__logOutput</h4> |
|
191 <b>__logOutput</b>(<i>s</i>) |
|
192 |
|
193 <p> |
|
194 Private method to log some output. |
|
195 </p> |
|
196 <dl> |
|
197 |
|
198 <dt><i>s</i></dt> |
|
199 <dd> |
|
200 output string to log (string) |
|
201 </dd> |
|
202 </dl> |
|
203 <a NAME="VirtualenvExecDialog.__nextAttempt" ID="VirtualenvExecDialog.__nextAttempt"></a> |
|
204 <h4>VirtualenvExecDialog.__nextAttempt</h4> |
|
205 <b>__nextAttempt</b>(<i></i>) |
|
206 |
|
207 <p> |
|
208 Private method to start another attempt. |
|
209 </p> |
|
210 <a NAME="VirtualenvExecDialog.__readStderr" ID="VirtualenvExecDialog.__readStderr"></a> |
|
211 <h4>VirtualenvExecDialog.__readStderr</h4> |
|
212 <b>__readStderr</b>(<i></i>) |
|
213 |
|
214 <p> |
|
215 Private slot to handle the readyReadStandardError signal. |
|
216 </p> |
|
217 <p> |
|
218 It reads the error output of the process and inserts it into the |
|
219 error pane. |
|
220 </p> |
|
221 <a NAME="VirtualenvExecDialog.__readStdout" ID="VirtualenvExecDialog.__readStdout"></a> |
|
222 <h4>VirtualenvExecDialog.__readStdout</h4> |
|
223 <b>__readStdout</b>(<i></i>) |
|
224 |
|
225 <p> |
|
226 Private slot to handle the readyReadStandardOutput signal. |
|
227 </p> |
|
228 <p> |
|
229 It reads the output of the process, formats it and inserts it into |
|
230 the contents pane. |
|
231 </p> |
|
232 <a NAME="VirtualenvExecDialog.__writeLogFile" ID="VirtualenvExecDialog.__writeLogFile"></a> |
|
233 <h4>VirtualenvExecDialog.__writeLogFile</h4> |
|
234 <b>__writeLogFile</b>(<i></i>) |
|
235 |
|
236 <p> |
|
237 Private method to write a log file to the virtualenv directory. |
|
238 </p> |
|
239 <a NAME="VirtualenvExecDialog.__writeScriptFile" ID="VirtualenvExecDialog.__writeScriptFile"></a> |
|
240 <h4>VirtualenvExecDialog.__writeScriptFile</h4> |
|
241 <b>__writeScriptFile</b>(<i></i>) |
|
242 |
|
243 <p> |
|
244 Private method to write a script file to the virtualenv directory. |
|
245 </p> |
|
246 <a NAME="VirtualenvExecDialog.on_buttonBox_clicked" ID="VirtualenvExecDialog.on_buttonBox_clicked"></a> |
|
247 <h4>VirtualenvExecDialog.on_buttonBox_clicked</h4> |
|
248 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
249 |
|
250 <p> |
|
251 Private slot called by a button of the button box clicked. |
|
252 </p> |
|
253 <dl> |
|
254 |
|
255 <dt><i>button</i></dt> |
|
256 <dd> |
|
257 button that was clicked (QAbstractButton) |
|
258 </dd> |
|
259 </dl> |
|
260 <a NAME="VirtualenvExecDialog.start" ID="VirtualenvExecDialog.start"></a> |
|
261 <h4>VirtualenvExecDialog.start</h4> |
|
262 <b>start</b>(<i>arguments</i>) |
|
263 |
|
264 <p> |
|
265 Public slot to start the virtualenv command. |
|
266 </p> |
|
267 <dl> |
|
268 |
|
269 <dt><i>arguments</i></dt> |
|
270 <dd> |
|
271 commandline arguments for virtualenv/pyvenv program |
|
272 (list of strings) |
|
273 </dd> |
|
274 </dl> |
|
275 <div align="right"><a href="#top">Up</a></div> |
|
276 <hr /> |
|
277 </body></html> |