eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvExecDialog.html

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

eric ide

mercurial