Documentation/Source/eric6.VirtualEnv.VirtualenvConfigurationDialog.html

changeset 6770
4782d2b8e1bd
parent 6339
d765c3204c71
equal deleted inserted replaced
6769:a2a9ef2da98a 6770:4782d2b8e1bd
66 <td>Private method to generate the process arguments.</td> 66 <td>Private method to generate the process arguments.</td>
67 </tr><tr> 67 </tr><tr>
68 <td><a href="#VirtualenvConfigurationDialog.__generateTargetDir">__generateTargetDir</a></td> 68 <td><a href="#VirtualenvConfigurationDialog.__generateTargetDir">__generateTargetDir</a></td>
69 <td>Private method to generate a valid target directory path.</td> 69 <td>Private method to generate a valid target directory path.</td>
70 </tr><tr> 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>
71 <td><a href="#VirtualenvConfigurationDialog.__setPyvenvVersion">__setPyvenvVersion</a></td> 74 <td><a href="#VirtualenvConfigurationDialog.__setPyvenvVersion">__setPyvenvVersion</a></td>
72 <td>Private method to determine the pyvenv version and set the respective label.</td> 75 <td>Private method to determine the pyvenv version and set the respective label.</td>
73 </tr><tr> 76 </tr><tr>
74 <td><a href="#VirtualenvConfigurationDialog.__setVirtualenvVersion">__setVirtualenvVersion</a></td> 77 <td><a href="#VirtualenvConfigurationDialog.__setVirtualenvVersion">__setVirtualenvVersion</a></td>
75 <td>Private method to determine the virtualenv version and set the respective label.</td> 78 <td>Private method to determine the virtualenv version and set the respective label.</td>
80 <td><a href="#VirtualenvConfigurationDialog.__updateUi">__updateUi</a></td> 83 <td><a href="#VirtualenvConfigurationDialog.__updateUi">__updateUi</a></td>
81 <td>Private method to update the UI depending on the selected virtual environment creator (virtualenv or pyvenv).</td> 84 <td>Private method to update the UI depending on the selected virtual environment creator (virtualenv or pyvenv).</td>
82 </tr><tr> 85 </tr><tr>
83 <td><a href="#VirtualenvConfigurationDialog.getData">getData</a></td> 86 <td><a href="#VirtualenvConfigurationDialog.getData">getData</a></td>
84 <td>Public method to retrieve the dialog data.</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>
85 </tr><tr> 115 </tr><tr>
86 <td><a href="#VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged">on_pythonExecPicker_textChanged</a></td> 116 <td><a href="#VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged">on_pythonExecPicker_textChanged</a></td>
87 <td>Private slot to react to a change of the Python executable.</td> 117 <td>Private slot to react to a change of the Python executable.</td>
88 </tr><tr> 118 </tr><tr>
89 <td><a href="#VirtualenvConfigurationDialog.on_pyvenvButton_toggled">on_pyvenvButton_toggled</a></td> 119 <td><a href="#VirtualenvConfigurationDialog.on_pyvenvButton_toggled">on_pyvenvButton_toggled</a></td>
138 </dl><dl> 168 </dl><dl>
139 <dt>Return Type:</dt> 169 <dt>Return Type:</dt>
140 <dd> 170 <dd>
141 str 171 str
142 </dd> 172 </dd>
143 </dl><a NAME="VirtualenvConfigurationDialog.__setPyvenvVersion" ID="VirtualenvConfigurationDialog.__setPyvenvVersion"></a> 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>
144 <h4>VirtualenvConfigurationDialog.__setPyvenvVersion</h4> 180 <h4>VirtualenvConfigurationDialog.__setPyvenvVersion</h4>
145 <b>__setPyvenvVersion</b>(<i></i>) 181 <b>__setPyvenvVersion</b>(<i></i>)
146 <p> 182 <p>
147 Private method to determine the pyvenv version and set the respective 183 Private method to determine the pyvenv version and set the respective
148 label. 184 label.
169 <p> 205 <p>
170 Public method to retrieve the dialog data. 206 Public method to retrieve the dialog data.
171 </p><dl> 207 </p><dl>
172 <dt>Returns:</dt> 208 <dt>Returns:</dt>
173 <dd> 209 <dd>
174 tuple containing a flag indicating the pyvenv selection, the 210 dictionary containing the data for the two environment
175 process arguments, a name for the virtual environment, a flag 211 variants. The keys for both variants are 'arguments' containing the
176 indicating to open the target directory after creation, a flag 212 command line arguments, 'logicalName' containing the environment
177 indicating to write a log file, a flag indicating to write a 213 name to be used with the virtual env manager and 'envType'
178 script, the name of the target directory and the name of the 214 containing the environment type (virtualenv, pyvenv or conda). The
179 Python interpreter to use 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').
180 </dd> 222 </dd>
181 </dl><dl> 223 </dl><dl>
182 <dt>Return Type:</dt> 224 <dt>Return Type:</dt>
183 <dd> 225 <dd>
184 tuple of (bool, list of str, str, bool, bool, bool, str, str) 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
185 </dd> 302 </dd>
186 </dl><a NAME="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged" ID="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged"></a> 303 </dl><a NAME="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged" ID="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged"></a>
187 <h4>VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged</h4> 304 <h4>VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged</h4>
188 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>) 305 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>)
189 <p> 306 <p>

eric ide

mercurial