Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvConfigurationDialog.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.VirtualEnv.VirtualenvConfigurationDialog</h1>
23 <p>
24 Module implementing a dialog to enter the parameters for the
25 virtual environment.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#VirtualenvConfigurationDialog">VirtualenvConfigurationDialog</a></td>
35 <td>Class implementing a dialog to enter the parameters for the virtual environment.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="VirtualenvConfigurationDialog" ID="VirtualenvConfigurationDialog"></a>
44 <h2>VirtualenvConfigurationDialog</h2>
45 <p>
46 Class implementing a dialog to enter the parameters for the
47 virtual environment.
48 </p>
49 <h3>Derived from</h3>
50 QDialog, Ui_VirtualenvConfigurationDialog
51 <h3>Class Attributes</h3>
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <h3>Class Methods</h3>
56 <table>
57 <tr><td>None</td></tr>
58 </table>
59 <h3>Methods</h3>
60 <table>
61 <tr>
62 <td><a href="#VirtualenvConfigurationDialog.__init__">VirtualenvConfigurationDialog</a></td>
63 <td>Constructor</td>
64 </tr><tr>
65 <td><a href="#VirtualenvConfigurationDialog.__generateArguments">__generateArguments</a></td>
66 <td>Private method to generate the process arguments.</td>
67 </tr><tr>
68 <td><a href="#VirtualenvConfigurationDialog.__generateTargetDir">__generateTargetDir</a></td>
69 <td>Private method to generate a valid target directory path.</td>
70 </tr><tr>
71 <td><a href="#VirtualenvConfigurationDialog.__setCondaVersion">__setCondaVersion</a></td>
72 <td>Private method to determine the conda version and set the respective label.</td>
73 </tr><tr>
74 <td><a href="#VirtualenvConfigurationDialog.__setPyvenvVersion">__setPyvenvVersion</a></td>
75 <td>Private method to determine the pyvenv version and set the respective label.</td>
76 </tr><tr>
77 <td><a href="#VirtualenvConfigurationDialog.__setVirtualenvVersion">__setVirtualenvVersion</a></td>
78 <td>Private method to determine the virtualenv version and set the respective label.</td>
79 </tr><tr>
80 <td><a href="#VirtualenvConfigurationDialog.__updateOK">__updateOK</a></td>
81 <td>Private method to update the enabled status of the OK button.</td>
82 </tr><tr>
83 <td><a href="#VirtualenvConfigurationDialog.__updateUi">__updateUi</a></td>
84 <td>Private method to update the UI depending on the selected virtual environment creator (virtualenv or pyvenv).</td>
85 </tr><tr>
86 <td><a href="#VirtualenvConfigurationDialog.getData">getData</a></td>
87 <td>Public method to retrieve the dialog data.</td>
88 </tr><tr>
89 <td><a href="#VirtualenvConfigurationDialog.on_condaButton_toggled">on_condaButton_toggled</a></td>
90 <td>Private slot to react to the selection of 'conda'.</td>
91 </tr><tr>
92 <td><a href="#VirtualenvConfigurationDialog.on_condaCloneButton_clicked">on_condaCloneButton_clicked</a></td>
93 <td>Private slot handling the selection of the clone button.</td>
94 </tr><tr>
95 <td><a href="#VirtualenvConfigurationDialog.on_condaCloneDirectoryPicker_textChanged">on_condaCloneDirectoryPicker_textChanged</a></td>
96 <td>Private slot handling a change of the cloned from directory.</td>
97 </tr><tr>
98 <td><a href="#VirtualenvConfigurationDialog.on_condaCloneNameEdit_textChanged">on_condaCloneNameEdit_textChanged</a></td>
99 <td>Private slot handling a change of the conda source environment name.</td>
100 </tr><tr>
101 <td><a href="#VirtualenvConfigurationDialog.on_condaNameEdit_textChanged">on_condaNameEdit_textChanged</a></td>
102 <td>Private slot handling a change of the conda environment name.</td>
103 </tr><tr>
104 <td><a href="#VirtualenvConfigurationDialog.on_condaRequirementsButton_clicked">on_condaRequirementsButton_clicked</a></td>
105 <td>Private slot handling the selection of the requirements button.</td>
106 </tr><tr>
107 <td><a href="#VirtualenvConfigurationDialog.on_condaRequirementsFilePicker_textChanged">on_condaRequirementsFilePicker_textChanged</a></td>
108 <td>Private slot handling a change of the requirements file entry.</td>
109 </tr><tr>
110 <td><a href="#VirtualenvConfigurationDialog.on_condaSpecialsGroup_clicked">on_condaSpecialsGroup_clicked</a></td>
111 <td>Private slot handling the selection of the specials group.</td>
112 </tr><tr>
113 <td><a href="#VirtualenvConfigurationDialog.on_condaTargetDirectoryPicker_textChanged">on_condaTargetDirectoryPicker_textChanged</a></td>
114 <td>Private slot handling a change of the conda target directory.</td>
115 </tr><tr>
116 <td><a href="#VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged">on_pythonExecPicker_textChanged</a></td>
117 <td>Private slot to react to a change of the Python executable.</td>
118 </tr><tr>
119 <td><a href="#VirtualenvConfigurationDialog.on_pyvenvButton_toggled">on_pyvenvButton_toggled</a></td>
120 <td>Private slot to react to the selection of 'pyvenv'.</td>
121 </tr><tr>
122 <td><a href="#VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged">on_targetDirectoryPicker_textChanged</a></td>
123 <td>Private slot handling a change of the target directory.</td>
124 </tr><tr>
125 <td><a href="#VirtualenvConfigurationDialog.on_virtualenvButton_toggled">on_virtualenvButton_toggled</a></td>
126 <td>Private slot to react to the selection of 'virtualenv'.</td>
127 </tr>
128 </table>
129 <h3>Static Methods</h3>
130 <table>
131 <tr><td>None</td></tr>
132 </table>
133 <a NAME="VirtualenvConfigurationDialog.__init__" ID="VirtualenvConfigurationDialog.__init__"></a>
134 <h4>VirtualenvConfigurationDialog (Constructor)</h4>
135 <b>VirtualenvConfigurationDialog</b>(<i>parent=None</i>)
136 <p>
137 Constructor
138 </p><dl>
139 <dt><i>parent</i> (QWidget)</dt>
140 <dd>
141 reference to the parent widget
142 </dd>
143 </dl><a NAME="VirtualenvConfigurationDialog.__generateArguments" ID="VirtualenvConfigurationDialog.__generateArguments"></a>
144 <h4>VirtualenvConfigurationDialog.__generateArguments</h4>
145 <b>__generateArguments</b>(<i></i>)
146 <p>
147 Private method to generate the process arguments.
148 </p><dl>
149 <dt>Returns:</dt>
150 <dd>
151 process arguments
152 </dd>
153 </dl><dl>
154 <dt>Return Type:</dt>
155 <dd>
156 list of str
157 </dd>
158 </dl><a NAME="VirtualenvConfigurationDialog.__generateTargetDir" ID="VirtualenvConfigurationDialog.__generateTargetDir"></a>
159 <h4>VirtualenvConfigurationDialog.__generateTargetDir</h4>
160 <b>__generateTargetDir</b>(<i></i>)
161 <p>
162 Private method to generate a valid target directory path.
163 </p><dl>
164 <dt>Returns:</dt>
165 <dd>
166 target directory path
167 </dd>
168 </dl><dl>
169 <dt>Return Type:</dt>
170 <dd>
171 str
172 </dd>
173 </dl><a NAME="VirtualenvConfigurationDialog.__setCondaVersion" ID="VirtualenvConfigurationDialog.__setCondaVersion"></a>
174 <h4>VirtualenvConfigurationDialog.__setCondaVersion</h4>
175 <b>__setCondaVersion</b>(<i></i>)
176 <p>
177 Private method to determine the conda version and set the respective
178 label.
179 </p><a NAME="VirtualenvConfigurationDialog.__setPyvenvVersion" ID="VirtualenvConfigurationDialog.__setPyvenvVersion"></a>
180 <h4>VirtualenvConfigurationDialog.__setPyvenvVersion</h4>
181 <b>__setPyvenvVersion</b>(<i></i>)
182 <p>
183 Private method to determine the pyvenv version and set the respective
184 label.
185 </p><a NAME="VirtualenvConfigurationDialog.__setVirtualenvVersion" ID="VirtualenvConfigurationDialog.__setVirtualenvVersion"></a>
186 <h4>VirtualenvConfigurationDialog.__setVirtualenvVersion</h4>
187 <b>__setVirtualenvVersion</b>(<i></i>)
188 <p>
189 Private method to determine the virtualenv version and set the
190 respective label.
191 </p><a NAME="VirtualenvConfigurationDialog.__updateOK" ID="VirtualenvConfigurationDialog.__updateOK"></a>
192 <h4>VirtualenvConfigurationDialog.__updateOK</h4>
193 <b>__updateOK</b>(<i></i>)
194 <p>
195 Private method to update the enabled status of the OK button.
196 </p><a NAME="VirtualenvConfigurationDialog.__updateUi" ID="VirtualenvConfigurationDialog.__updateUi"></a>
197 <h4>VirtualenvConfigurationDialog.__updateUi</h4>
198 <b>__updateUi</b>(<i></i>)
199 <p>
200 Private method to update the UI depending on the selected
201 virtual environment creator (virtualenv or pyvenv).
202 </p><a NAME="VirtualenvConfigurationDialog.getData" ID="VirtualenvConfigurationDialog.getData"></a>
203 <h4>VirtualenvConfigurationDialog.getData</h4>
204 <b>getData</b>(<i></i>)
205 <p>
206 Public method to retrieve the dialog data.
207 </p><dl>
208 <dt>Returns:</dt>
209 <dd>
210 dictionary containing the data for the two environment
211 variants. The keys for both variants are 'arguments' containing the
212 command line arguments, 'logicalName' containing the environment
213 name to be used with the virtual env manager and 'envType'
214 containing the environment type (virtualenv, pyvenv or conda). The
215 virtualenv/pyvenv specific keys are 'openTarget' containg a flag to
216 open the target directory after creation, 'createLog' containing a
217 flag to write a log file, 'createScript' containing a flag to write
218 a script, 'targetDirectory' containing the target directory and
219 'pythonExe' containing the Python interpreter to be used. The
220 conda specific key is 'command' giving the conda command to be
221 executed (always 'create').
222 </dd>
223 </dl><dl>
224 <dt>Return Type:</dt>
225 <dd>
226 dict
227 </dd>
228 </dl><a NAME="VirtualenvConfigurationDialog.on_condaButton_toggled" ID="VirtualenvConfigurationDialog.on_condaButton_toggled"></a>
229 <h4>VirtualenvConfigurationDialog.on_condaButton_toggled</h4>
230 <b>on_condaButton_toggled</b>(<i>checked</i>)
231 <p>
232 Private slot to react to the selection of 'conda'.
233 </p><dl>
234 <dt><i>checked</i> (bool)</dt>
235 <dd>
236 state of the checkbox
237 </dd>
238 </dl><a NAME="VirtualenvConfigurationDialog.on_condaCloneButton_clicked" ID="VirtualenvConfigurationDialog.on_condaCloneButton_clicked"></a>
239 <h4>VirtualenvConfigurationDialog.on_condaCloneButton_clicked</h4>
240 <b>on_condaCloneButton_clicked</b>(<i></i>)
241 <p>
242 Private slot handling the selection of the clone button.
243 </p><a NAME="VirtualenvConfigurationDialog.on_condaCloneDirectoryPicker_textChanged" ID="VirtualenvConfigurationDialog.on_condaCloneDirectoryPicker_textChanged"></a>
244 <h4>VirtualenvConfigurationDialog.on_condaCloneDirectoryPicker_textChanged</h4>
245 <b>on_condaCloneDirectoryPicker_textChanged</b>(<i>txt</i>)
246 <p>
247 Private slot handling a change of the cloned from directory.
248 </p><dl>
249 <dt><i>txt</i> (str)</dt>
250 <dd>
251 target directory
252 </dd>
253 </dl><a NAME="VirtualenvConfigurationDialog.on_condaCloneNameEdit_textChanged" ID="VirtualenvConfigurationDialog.on_condaCloneNameEdit_textChanged"></a>
254 <h4>VirtualenvConfigurationDialog.on_condaCloneNameEdit_textChanged</h4>
255 <b>on_condaCloneNameEdit_textChanged</b>(<i>txt</i>)
256 <p>
257 Private slot handling a change of the conda source environment name.
258 </p><dl>
259 <dt><i>txt</i> (str)</dt>
260 <dd>
261 name of the environment to be cloned
262 </dd>
263 </dl><a NAME="VirtualenvConfigurationDialog.on_condaNameEdit_textChanged" ID="VirtualenvConfigurationDialog.on_condaNameEdit_textChanged"></a>
264 <h4>VirtualenvConfigurationDialog.on_condaNameEdit_textChanged</h4>
265 <b>on_condaNameEdit_textChanged</b>(<i>txt</i>)
266 <p>
267 Private slot handling a change of the conda environment name.
268 </p><dl>
269 <dt><i>txt</i> (str)</dt>
270 <dd>
271 environment name
272 </dd>
273 </dl><a NAME="VirtualenvConfigurationDialog.on_condaRequirementsButton_clicked" ID="VirtualenvConfigurationDialog.on_condaRequirementsButton_clicked"></a>
274 <h4>VirtualenvConfigurationDialog.on_condaRequirementsButton_clicked</h4>
275 <b>on_condaRequirementsButton_clicked</b>(<i></i>)
276 <p>
277 Private slot handling the selection of the requirements button.
278 </p><a NAME="VirtualenvConfigurationDialog.on_condaRequirementsFilePicker_textChanged" ID="VirtualenvConfigurationDialog.on_condaRequirementsFilePicker_textChanged"></a>
279 <h4>VirtualenvConfigurationDialog.on_condaRequirementsFilePicker_textChanged</h4>
280 <b>on_condaRequirementsFilePicker_textChanged</b>(<i>txt</i>)
281 <p>
282 Private slot handling a change of the requirements file entry.
283 </p><dl>
284 <dt><i>txt</i> (str)</dt>
285 <dd>
286 current text of the requirements file entry
287 </dd>
288 </dl><a NAME="VirtualenvConfigurationDialog.on_condaSpecialsGroup_clicked" ID="VirtualenvConfigurationDialog.on_condaSpecialsGroup_clicked"></a>
289 <h4>VirtualenvConfigurationDialog.on_condaSpecialsGroup_clicked</h4>
290 <b>on_condaSpecialsGroup_clicked</b>(<i></i>)
291 <p>
292 Private slot handling the selection of the specials group.
293 </p><a NAME="VirtualenvConfigurationDialog.on_condaTargetDirectoryPicker_textChanged" ID="VirtualenvConfigurationDialog.on_condaTargetDirectoryPicker_textChanged"></a>
294 <h4>VirtualenvConfigurationDialog.on_condaTargetDirectoryPicker_textChanged</h4>
295 <b>on_condaTargetDirectoryPicker_textChanged</b>(<i>txt</i>)
296 <p>
297 Private slot handling a change of the conda target directory.
298 </p><dl>
299 <dt><i>txt</i> (str)</dt>
300 <dd>
301 target directory
302 </dd>
303 </dl><a NAME="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged" ID="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged"></a>
304 <h4>VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged</h4>
305 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>)
306 <p>
307 Private slot to react to a change of the Python executable.
308 </p><dl>
309 <dt><i>txt</i> (str)</dt>
310 <dd>
311 contents of the picker's line edit
312 </dd>
313 </dl><a NAME="VirtualenvConfigurationDialog.on_pyvenvButton_toggled" ID="VirtualenvConfigurationDialog.on_pyvenvButton_toggled"></a>
314 <h4>VirtualenvConfigurationDialog.on_pyvenvButton_toggled</h4>
315 <b>on_pyvenvButton_toggled</b>(<i>checked</i>)
316 <p>
317 Private slot to react to the selection of 'pyvenv'.
318 </p><dl>
319 <dt><i>checked</i> (bool)</dt>
320 <dd>
321 state of the checkbox
322 </dd>
323 </dl><a NAME="VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged" ID="VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged"></a>
324 <h4>VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged</h4>
325 <b>on_targetDirectoryPicker_textChanged</b>(<i>txt</i>)
326 <p>
327 Private slot handling a change of the target directory.
328 </p><dl>
329 <dt><i>txt</i> (str)</dt>
330 <dd>
331 target directory
332 </dd>
333 </dl><a NAME="VirtualenvConfigurationDialog.on_virtualenvButton_toggled" ID="VirtualenvConfigurationDialog.on_virtualenvButton_toggled"></a>
334 <h4>VirtualenvConfigurationDialog.on_virtualenvButton_toggled</h4>
335 <b>on_virtualenvButton_toggled</b>(<i>checked</i>)
336 <p>
337 Private slot to react to the selection of 'virtualenv'.
338 </p><dl>
339 <dt><i>checked</i> (bool)</dt>
340 <dd>
341 state of the checkbox
342 </dd>
343 </dl>
344 <div align="right"><a href="#top">Up</a></div>
345 <hr />
346 </body></html>

Mercurial Repository: eric

eric ide

mercurial