Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial