Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvConfigurationDialog.html

eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvConfigurationDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.VirtualEnv.VirtualenvConfigurationDialog</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.VirtualenvConfigurationDialog</h1>
24
25 <p>
26 Module implementing a dialog to enter the parameters for the
27 virtual environment.
28 </p>
29 <h3>Global Attributes</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <h3>Classes</h3>
35
36 <table>
37
38 <tr>
39 <td><a href="#VirtualenvConfigurationDialog">VirtualenvConfigurationDialog</a></td>
40 <td>Class implementing a dialog to enter the parameters for the virtual environment.</td>
41 </tr>
42 </table>
43 <h3>Functions</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr />
49 <hr />
50 <a NAME="VirtualenvConfigurationDialog" ID="VirtualenvConfigurationDialog"></a>
51 <h2>VirtualenvConfigurationDialog</h2>
52
53 <p>
54 Class implementing a dialog to enter the parameters for the
55 virtual environment.
56 </p>
57 <h3>Derived from</h3>
58 QDialog, Ui_VirtualenvConfigurationDialog
59 <h3>Class Attributes</h3>
60
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Class Methods</h3>
65
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70
71 <table>
72
73 <tr>
74 <td><a href="#VirtualenvConfigurationDialog.__init__">VirtualenvConfigurationDialog</a></td>
75 <td>Constructor</td>
76 </tr>
77 <tr>
78 <td><a href="#VirtualenvConfigurationDialog.__generateArguments">__generateArguments</a></td>
79 <td>Private method to generate the process arguments.</td>
80 </tr>
81 <tr>
82 <td><a href="#VirtualenvConfigurationDialog.__generateTargetDir">__generateTargetDir</a></td>
83 <td>Private method to generate a valid target directory path.</td>
84 </tr>
85 <tr>
86 <td><a href="#VirtualenvConfigurationDialog.__setCondaVersion">__setCondaVersion</a></td>
87 <td>Private method to determine the conda version and set the respective label.</td>
88 </tr>
89 <tr>
90 <td><a href="#VirtualenvConfigurationDialog.__setPyvenvVersion">__setPyvenvVersion</a></td>
91 <td>Private method to determine the pyvenv version and set the respective label.</td>
92 </tr>
93 <tr>
94 <td><a href="#VirtualenvConfigurationDialog.__setVirtualenvVersion">__setVirtualenvVersion</a></td>
95 <td>Private method to determine the virtualenv version and set the respective label.</td>
96 </tr>
97 <tr>
98 <td><a href="#VirtualenvConfigurationDialog.__updateOK">__updateOK</a></td>
99 <td>Private method to update the enabled status of the OK button.</td>
100 </tr>
101 <tr>
102 <td><a href="#VirtualenvConfigurationDialog.__updateUi">__updateUi</a></td>
103 <td>Private method to update the UI depending on the selected virtual environment creator (virtualenv or pyvenv).</td>
104 </tr>
105 <tr>
106 <td><a href="#VirtualenvConfigurationDialog.getData">getData</a></td>
107 <td>Public method to retrieve the dialog data.</td>
108 </tr>
109 <tr>
110 <td><a href="#VirtualenvConfigurationDialog.on_condaButton_toggled">on_condaButton_toggled</a></td>
111 <td>Private slot to react to the selection of 'conda'.</td>
112 </tr>
113 <tr>
114 <td><a href="#VirtualenvConfigurationDialog.on_condaCloneButton_clicked">on_condaCloneButton_clicked</a></td>
115 <td>Private slot handling the selection of the clone button.</td>
116 </tr>
117 <tr>
118 <td><a href="#VirtualenvConfigurationDialog.on_condaCloneDirectoryPicker_textChanged">on_condaCloneDirectoryPicker_textChanged</a></td>
119 <td>Private slot handling a change of the cloned from directory.</td>
120 </tr>
121 <tr>
122 <td><a href="#VirtualenvConfigurationDialog.on_condaCloneNameEdit_textChanged">on_condaCloneNameEdit_textChanged</a></td>
123 <td>Private slot handling a change of the conda source environment name.</td>
124 </tr>
125 <tr>
126 <td><a href="#VirtualenvConfigurationDialog.on_condaNameEdit_textChanged">on_condaNameEdit_textChanged</a></td>
127 <td>Private slot handling a change of the conda environment name.</td>
128 </tr>
129 <tr>
130 <td><a href="#VirtualenvConfigurationDialog.on_condaRequirementsButton_clicked">on_condaRequirementsButton_clicked</a></td>
131 <td>Private slot handling the selection of the requirements button.</td>
132 </tr>
133 <tr>
134 <td><a href="#VirtualenvConfigurationDialog.on_condaRequirementsFilePicker_textChanged">on_condaRequirementsFilePicker_textChanged</a></td>
135 <td>Private slot handling a change of the requirements file entry.</td>
136 </tr>
137 <tr>
138 <td><a href="#VirtualenvConfigurationDialog.on_condaSpecialsGroup_clicked">on_condaSpecialsGroup_clicked</a></td>
139 <td>Private slot handling the selection of the specials group.</td>
140 </tr>
141 <tr>
142 <td><a href="#VirtualenvConfigurationDialog.on_condaTargetDirectoryPicker_textChanged">on_condaTargetDirectoryPicker_textChanged</a></td>
143 <td>Private slot handling a change of the conda target directory.</td>
144 </tr>
145 <tr>
146 <td><a href="#VirtualenvConfigurationDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
147 <td>Private slot handling a change of the virtual environment name.</td>
148 </tr>
149 <tr>
150 <td><a href="#VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged">on_pythonExecPicker_textChanged</a></td>
151 <td>Private slot to react to a change of the Python executable.</td>
152 </tr>
153 <tr>
154 <td><a href="#VirtualenvConfigurationDialog.on_pyvenvButton_toggled">on_pyvenvButton_toggled</a></td>
155 <td>Private slot to react to the selection of 'pyvenv'.</td>
156 </tr>
157 <tr>
158 <td><a href="#VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged">on_targetDirectoryPicker_textChanged</a></td>
159 <td>Private slot handling a change of the target directory.</td>
160 </tr>
161 <tr>
162 <td><a href="#VirtualenvConfigurationDialog.on_virtualenvButton_toggled">on_virtualenvButton_toggled</a></td>
163 <td>Private slot to react to the selection of 'virtualenv'.</td>
164 </tr>
165 </table>
166 <h3>Static Methods</h3>
167
168 <table>
169 <tr><td>None</td></tr>
170 </table>
171
172 <a NAME="VirtualenvConfigurationDialog.__init__" ID="VirtualenvConfigurationDialog.__init__"></a>
173 <h4>VirtualenvConfigurationDialog (Constructor)</h4>
174 <b>VirtualenvConfigurationDialog</b>(<i>baseDir="", parent=None</i>)
175
176 <p>
177 Constructor
178 </p>
179 <dl>
180
181 <dt><i>baseDir</i> (str)</dt>
182 <dd>
183 base directory for the virtual environments
184 </dd>
185 <dt><i>parent</i> (QWidget)</dt>
186 <dd>
187 reference to the parent widget
188 </dd>
189 </dl>
190 <a NAME="VirtualenvConfigurationDialog.__generateArguments" ID="VirtualenvConfigurationDialog.__generateArguments"></a>
191 <h4>VirtualenvConfigurationDialog.__generateArguments</h4>
192 <b>__generateArguments</b>(<i></i>)
193
194 <p>
195 Private method to generate the process arguments.
196 </p>
197 <dl>
198 <dt>Return:</dt>
199 <dd>
200 process arguments
201 </dd>
202 </dl>
203 <dl>
204 <dt>Return Type:</dt>
205 <dd>
206 list of str
207 </dd>
208 </dl>
209 <a NAME="VirtualenvConfigurationDialog.__generateTargetDir" ID="VirtualenvConfigurationDialog.__generateTargetDir"></a>
210 <h4>VirtualenvConfigurationDialog.__generateTargetDir</h4>
211 <b>__generateTargetDir</b>(<i></i>)
212
213 <p>
214 Private method to generate a valid target directory path.
215 </p>
216 <dl>
217 <dt>Return:</dt>
218 <dd>
219 target directory path
220 </dd>
221 </dl>
222 <dl>
223 <dt>Return Type:</dt>
224 <dd>
225 str
226 </dd>
227 </dl>
228 <a NAME="VirtualenvConfigurationDialog.__setCondaVersion" ID="VirtualenvConfigurationDialog.__setCondaVersion"></a>
229 <h4>VirtualenvConfigurationDialog.__setCondaVersion</h4>
230 <b>__setCondaVersion</b>(<i></i>)
231
232 <p>
233 Private method to determine the conda version and set the respective
234 label.
235 </p>
236 <a NAME="VirtualenvConfigurationDialog.__setPyvenvVersion" ID="VirtualenvConfigurationDialog.__setPyvenvVersion"></a>
237 <h4>VirtualenvConfigurationDialog.__setPyvenvVersion</h4>
238 <b>__setPyvenvVersion</b>(<i></i>)
239
240 <p>
241 Private method to determine the pyvenv version and set the respective
242 label.
243 </p>
244 <a NAME="VirtualenvConfigurationDialog.__setVirtualenvVersion" ID="VirtualenvConfigurationDialog.__setVirtualenvVersion"></a>
245 <h4>VirtualenvConfigurationDialog.__setVirtualenvVersion</h4>
246 <b>__setVirtualenvVersion</b>(<i></i>)
247
248 <p>
249 Private method to determine the virtualenv version and set the
250 respective label.
251 </p>
252 <a NAME="VirtualenvConfigurationDialog.__updateOK" ID="VirtualenvConfigurationDialog.__updateOK"></a>
253 <h4>VirtualenvConfigurationDialog.__updateOK</h4>
254 <b>__updateOK</b>(<i></i>)
255
256 <p>
257 Private method to update the enabled status of the OK button.
258 </p>
259 <a NAME="VirtualenvConfigurationDialog.__updateUi" ID="VirtualenvConfigurationDialog.__updateUi"></a>
260 <h4>VirtualenvConfigurationDialog.__updateUi</h4>
261 <b>__updateUi</b>(<i></i>)
262
263 <p>
264 Private method to update the UI depending on the selected
265 virtual environment creator (virtualenv or pyvenv).
266 </p>
267 <a NAME="VirtualenvConfigurationDialog.getData" ID="VirtualenvConfigurationDialog.getData"></a>
268 <h4>VirtualenvConfigurationDialog.getData</h4>
269 <b>getData</b>(<i></i>)
270
271 <p>
272 Public method to retrieve the dialog data.
273 </p>
274 <dl>
275 <dt>Return:</dt>
276 <dd>
277 dictionary containing the data for the two environment
278 variants. The keys for both variants are 'arguments' containing the
279 command line arguments, 'logicalName' containing the environment
280 name to be used with the virtual env manager and 'envType'
281 containing the environment type (virtualenv, pyvenv or conda). The
282 virtualenv/pyvenv specific keys are 'openTarget' containg a flag to
283 open the target directory after creation, 'createLog' containing a
284 flag to write a log file, 'createScript' containing a flag to write
285 a script, 'targetDirectory' containing the target directory and
286 'pythonExe' containing the Python interpreter to be used. The
287 conda specific key is 'command' giving the conda command to be
288 executed (always 'create').
289 </dd>
290 </dl>
291 <dl>
292 <dt>Return Type:</dt>
293 <dd>
294 dict
295 </dd>
296 </dl>
297 <a NAME="VirtualenvConfigurationDialog.on_condaButton_toggled" ID="VirtualenvConfigurationDialog.on_condaButton_toggled"></a>
298 <h4>VirtualenvConfigurationDialog.on_condaButton_toggled</h4>
299 <b>on_condaButton_toggled</b>(<i>checked</i>)
300
301 <p>
302 Private slot to react to the selection of 'conda'.
303 </p>
304 <dl>
305
306 <dt><i>checked</i> (bool)</dt>
307 <dd>
308 state of the checkbox
309 </dd>
310 </dl>
311 <a NAME="VirtualenvConfigurationDialog.on_condaCloneButton_clicked" ID="VirtualenvConfigurationDialog.on_condaCloneButton_clicked"></a>
312 <h4>VirtualenvConfigurationDialog.on_condaCloneButton_clicked</h4>
313 <b>on_condaCloneButton_clicked</b>(<i></i>)
314
315 <p>
316 Private slot handling the selection of the clone button.
317 </p>
318 <a NAME="VirtualenvConfigurationDialog.on_condaCloneDirectoryPicker_textChanged" ID="VirtualenvConfigurationDialog.on_condaCloneDirectoryPicker_textChanged"></a>
319 <h4>VirtualenvConfigurationDialog.on_condaCloneDirectoryPicker_textChanged</h4>
320 <b>on_condaCloneDirectoryPicker_textChanged</b>(<i>txt</i>)
321
322 <p>
323 Private slot handling a change of the cloned from directory.
324 </p>
325 <dl>
326
327 <dt><i>txt</i> (str)</dt>
328 <dd>
329 target directory
330 </dd>
331 </dl>
332 <a NAME="VirtualenvConfigurationDialog.on_condaCloneNameEdit_textChanged" ID="VirtualenvConfigurationDialog.on_condaCloneNameEdit_textChanged"></a>
333 <h4>VirtualenvConfigurationDialog.on_condaCloneNameEdit_textChanged</h4>
334 <b>on_condaCloneNameEdit_textChanged</b>(<i>txt</i>)
335
336 <p>
337 Private slot handling a change of the conda source environment name.
338 </p>
339 <dl>
340
341 <dt><i>txt</i> (str)</dt>
342 <dd>
343 name of the environment to be cloned
344 </dd>
345 </dl>
346 <a NAME="VirtualenvConfigurationDialog.on_condaNameEdit_textChanged" ID="VirtualenvConfigurationDialog.on_condaNameEdit_textChanged"></a>
347 <h4>VirtualenvConfigurationDialog.on_condaNameEdit_textChanged</h4>
348 <b>on_condaNameEdit_textChanged</b>(<i>txt</i>)
349
350 <p>
351 Private slot handling a change of the conda environment name.
352 </p>
353 <dl>
354
355 <dt><i>txt</i> (str)</dt>
356 <dd>
357 environment name
358 </dd>
359 </dl>
360 <a NAME="VirtualenvConfigurationDialog.on_condaRequirementsButton_clicked" ID="VirtualenvConfigurationDialog.on_condaRequirementsButton_clicked"></a>
361 <h4>VirtualenvConfigurationDialog.on_condaRequirementsButton_clicked</h4>
362 <b>on_condaRequirementsButton_clicked</b>(<i></i>)
363
364 <p>
365 Private slot handling the selection of the requirements button.
366 </p>
367 <a NAME="VirtualenvConfigurationDialog.on_condaRequirementsFilePicker_textChanged" ID="VirtualenvConfigurationDialog.on_condaRequirementsFilePicker_textChanged"></a>
368 <h4>VirtualenvConfigurationDialog.on_condaRequirementsFilePicker_textChanged</h4>
369 <b>on_condaRequirementsFilePicker_textChanged</b>(<i>txt</i>)
370
371 <p>
372 Private slot handling a change of the requirements file entry.
373 </p>
374 <dl>
375
376 <dt><i>txt</i> (str)</dt>
377 <dd>
378 current text of the requirements file entry
379 </dd>
380 </dl>
381 <a NAME="VirtualenvConfigurationDialog.on_condaSpecialsGroup_clicked" ID="VirtualenvConfigurationDialog.on_condaSpecialsGroup_clicked"></a>
382 <h4>VirtualenvConfigurationDialog.on_condaSpecialsGroup_clicked</h4>
383 <b>on_condaSpecialsGroup_clicked</b>(<i></i>)
384
385 <p>
386 Private slot handling the selection of the specials group.
387 </p>
388 <a NAME="VirtualenvConfigurationDialog.on_condaTargetDirectoryPicker_textChanged" ID="VirtualenvConfigurationDialog.on_condaTargetDirectoryPicker_textChanged"></a>
389 <h4>VirtualenvConfigurationDialog.on_condaTargetDirectoryPicker_textChanged</h4>
390 <b>on_condaTargetDirectoryPicker_textChanged</b>(<i>txt</i>)
391
392 <p>
393 Private slot handling a change of the conda target directory.
394 </p>
395 <dl>
396
397 <dt><i>txt</i> (str)</dt>
398 <dd>
399 target directory
400 </dd>
401 </dl>
402 <a NAME="VirtualenvConfigurationDialog.on_nameEdit_textChanged" ID="VirtualenvConfigurationDialog.on_nameEdit_textChanged"></a>
403 <h4>VirtualenvConfigurationDialog.on_nameEdit_textChanged</h4>
404 <b>on_nameEdit_textChanged</b>(<i>txt</i>)
405
406 <p>
407 Private slot handling a change of the virtual environment name.
408 </p>
409 <dl>
410
411 <dt><i>txt</i> (str)</dt>
412 <dd>
413 name of the virtual environment
414 </dd>
415 </dl>
416 <a NAME="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged" ID="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged"></a>
417 <h4>VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged</h4>
418 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>)
419
420 <p>
421 Private slot to react to a change of the Python executable.
422 </p>
423 <dl>
424
425 <dt><i>txt</i> (str)</dt>
426 <dd>
427 contents of the picker's line edit
428 </dd>
429 </dl>
430 <a NAME="VirtualenvConfigurationDialog.on_pyvenvButton_toggled" ID="VirtualenvConfigurationDialog.on_pyvenvButton_toggled"></a>
431 <h4>VirtualenvConfigurationDialog.on_pyvenvButton_toggled</h4>
432 <b>on_pyvenvButton_toggled</b>(<i>checked</i>)
433
434 <p>
435 Private slot to react to the selection of 'pyvenv'.
436 </p>
437 <dl>
438
439 <dt><i>checked</i> (bool)</dt>
440 <dd>
441 state of the checkbox
442 </dd>
443 </dl>
444 <a NAME="VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged" ID="VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged"></a>
445 <h4>VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged</h4>
446 <b>on_targetDirectoryPicker_textChanged</b>(<i>txt</i>)
447
448 <p>
449 Private slot handling a change of the target directory.
450 </p>
451 <dl>
452
453 <dt><i>txt</i> (str)</dt>
454 <dd>
455 target directory
456 </dd>
457 </dl>
458 <a NAME="VirtualenvConfigurationDialog.on_virtualenvButton_toggled" ID="VirtualenvConfigurationDialog.on_virtualenvButton_toggled"></a>
459 <h4>VirtualenvConfigurationDialog.on_virtualenvButton_toggled</h4>
460 <b>on_virtualenvButton_toggled</b>(<i>checked</i>)
461
462 <p>
463 Private slot to react to the selection of 'virtualenv'.
464 </p>
465 <dl>
466
467 <dt><i>checked</i> (bool)</dt>
468 <dd>
469 state of the checkbox
470 </dd>
471 </dl>
472 <div align="right"><a href="#top">Up</a></div>
473 <hr />
474 </body></html>

Mercurial Repository: eric

eric ide

mercurial