Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

changeset 6576
ea60ea85067a
parent 6503
e617c58807e8
child 6716
1c9d3b369ea8
equal deleted inserted replaced
6575:40a11619ee77 6576:ea60ea85067a
85 <td>Public method to get a dictionary containing the defined virtual environment entries.</td> 85 <td>Public method to get a dictionary containing the defined virtual environment entries.</td>
86 </tr><tr> 86 </tr><tr>
87 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td> 87 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td>
88 <td>Public method to get the directory of a virtual environment.</td> 88 <td>Public method to get the directory of a virtual environment.</td>
89 </tr><tr> 89 </tr><tr>
90 <td><a href="#VirtualenvManager.getVirtualenvExecPath">getVirtualenvExecPath</a></td>
91 <td>Public method to get the search path prefix of a virtual environment.</td>
92 </tr><tr>
90 <td><a href="#VirtualenvManager.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td> 93 <td><a href="#VirtualenvManager.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td>
91 <td>Public method to get the interpreter for a virtual environment.</td> 94 <td>Public method to get the interpreter for a virtual environment.</td>
92 </tr><tr> 95 </tr><tr>
93 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td> 96 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td>
94 <td>Public method to get a list of defined virtual environments.</td> 97 <td>Public method to get a list of defined virtual environments.</td>
95 </tr><tr> 98 </tr><tr>
96 <td><a href="#VirtualenvManager.getVirtualenvNamesForVariant">getVirtualenvNamesForVariant</a></td> 99 <td><a href="#VirtualenvManager.getVirtualenvNamesForVariant">getVirtualenvNamesForVariant</a></td>
97 <td>Public method to get a list of virtual environments for a given Python variant.</td> 100 <td>Public method to get a list of virtual environments for a given Python variant.</td>
101 </tr><tr>
102 <td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td>
103 <td>Public method to test, if a given environment is an Anaconda environment.</td>
98 </tr><tr> 104 </tr><tr>
99 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td> 105 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td>
100 <td>Public method to test, if a given environment is a global one.</td> 106 <td>Public method to test, if a given environment is a global one.</td>
101 </tr><tr> 107 </tr><tr>
102 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td> 108 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td>
163 <b>__saveSettings</b>(<i></i>) 169 <b>__saveSettings</b>(<i></i>)
164 <p> 170 <p>
165 Private slot to save the virtual environments. 171 Private slot to save the virtual environments.
166 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> 172 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a>
167 <h4>VirtualenvManager.addVirtualEnv</h4> 173 <h4>VirtualenvManager.addVirtualEnv</h4>
168 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False</i>) 174 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, execPath=""</i>)
169 <p> 175 <p>
170 Public method to add a virtual environment. 176 Public method to add a virtual environment.
171 </p><dl> 177 </p><dl>
172 <dt><i>venvName</i> (str)</dt> 178 <dt><i>venvName</i> (str)</dt>
173 <dd> 179 <dd>
182 <dd> 188 <dd>
183 Python variant of the virtual environment 189 Python variant of the virtual environment
184 </dd><dt><i>isGlobal</i> (bool)</dt> 190 </dd><dt><i>isGlobal</i> (bool)</dt>
185 <dd> 191 <dd>
186 flag indicating a global environment 192 flag indicating a global environment
193 </dd><dt><i>isConda</i> (bool)</dt>
194 <dd>
195 flag indicating an Anaconda virtual environment
196 </dd><dt><i>execPath</i> (str)</dt>
197 <dd>
198 search path string to be prepended to the PATH
199 environment variable
187 </dd> 200 </dd>
188 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a> 201 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
189 <h4>VirtualenvManager.createVirtualEnv</h4> 202 <h4>VirtualenvManager.createVirtualEnv</h4>
190 <b>createVirtualEnv</b>(<i></i>) 203 <b>createVirtualEnv</b>(<i></i>)
191 <p> 204 <p>
255 </dl><dl> 268 </dl><dl>
256 <dt>Return Type:</dt> 269 <dt>Return Type:</dt>
257 <dd> 270 <dd>
258 str 271 str
259 </dd> 272 </dd>
273 </dl><a NAME="VirtualenvManager.getVirtualenvExecPath" ID="VirtualenvManager.getVirtualenvExecPath"></a>
274 <h4>VirtualenvManager.getVirtualenvExecPath</h4>
275 <b>getVirtualenvExecPath</b>(<i>venvName</i>)
276 <p>
277 Public method to get the search path prefix of a virtual environment.
278 </p><dl>
279 <dt><i>venvName</i> (str)</dt>
280 <dd>
281 logical name for the virtual environment
282 </dd>
283 </dl><dl>
284 <dt>Returns:</dt>
285 <dd>
286 search path prefix
287 </dd>
288 </dl><dl>
289 <dt>Return Type:</dt>
290 <dd>
291 str
292 </dd>
260 </dl><a NAME="VirtualenvManager.getVirtualenvInterpreter" ID="VirtualenvManager.getVirtualenvInterpreter"></a> 293 </dl><a NAME="VirtualenvManager.getVirtualenvInterpreter" ID="VirtualenvManager.getVirtualenvInterpreter"></a>
261 <h4>VirtualenvManager.getVirtualenvInterpreter</h4> 294 <h4>VirtualenvManager.getVirtualenvInterpreter</h4>
262 <b>getVirtualenvInterpreter</b>(<i>venvName</i>) 295 <b>getVirtualenvInterpreter</b>(<i>venvName</i>)
263 <p> 296 <p>
264 Public method to get the interpreter for a virtual environment. 297 Public method to get the interpreter for a virtual environment.
311 </dl><dl> 344 </dl><dl>
312 <dt>Return Type:</dt> 345 <dt>Return Type:</dt>
313 <dd> 346 <dd>
314 list of str 347 list of str
315 </dd> 348 </dd>
349 </dl><a NAME="VirtualenvManager.isCondaEnvironment" ID="VirtualenvManager.isCondaEnvironment"></a>
350 <h4>VirtualenvManager.isCondaEnvironment</h4>
351 <b>isCondaEnvironment</b>(<i>venvName</i>)
352 <p>
353 Public method to test, if a given environment is an Anaconda
354 environment.
355 </p><dl>
356 <dt><i>venvName</i> (str)</dt>
357 <dd>
358 logical name of the virtual environment
359 </dd>
360 </dl><dl>
361 <dt>Returns:</dt>
362 <dd>
363 flag indicating an Anaconda environment
364 </dd>
365 </dl><dl>
366 <dt>Return Type:</dt>
367 <dd>
368 bool
369 </dd>
316 </dl><a NAME="VirtualenvManager.isGlobalEnvironment" ID="VirtualenvManager.isGlobalEnvironment"></a> 370 </dl><a NAME="VirtualenvManager.isGlobalEnvironment" ID="VirtualenvManager.isGlobalEnvironment"></a>
317 <h4>VirtualenvManager.isGlobalEnvironment</h4> 371 <h4>VirtualenvManager.isGlobalEnvironment</h4>
318 <b>isGlobalEnvironment</b>(<i>venvName</i>) 372 <b>isGlobalEnvironment</b>(<i>venvName</i>)
319 <p> 373 <p>
320 Public method to test, if a given environment is a global one. 374 Public method to test, if a given environment is a global one.
363 <dd> 417 <dd>
364 list of logical names for the virtual environments 418 list of logical names for the virtual environments
365 </dd> 419 </dd>
366 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> 420 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
367 <h4>VirtualenvManager.renameVirtualEnv</h4> 421 <h4>VirtualenvManager.renameVirtualEnv</h4>
368 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal</i>) 422 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, execPath</i>)
369 <p> 423 <p>
370 Public method to substitute a virtual environment entry with a new 424 Public method to substitute a virtual environment entry with a new
371 name. 425 name.
372 </p><dl> 426 </p><dl>
373 <dt><i>oldVenvName</i> (str)</dt> 427 <dt><i>oldVenvName</i> (str)</dt>
386 <dd> 440 <dd>
387 Python variant of the virtual environment 441 Python variant of the virtual environment
388 </dd><dt><i>isGlobal</i> (bool)</dt> 442 </dd><dt><i>isGlobal</i> (bool)</dt>
389 <dd> 443 <dd>
390 flag indicating a global environment 444 flag indicating a global environment
445 </dd><dt><i>isConda</i> (bool)</dt>
446 <dd>
447 flag indicating an Anaconda virtual environment
448 </dd><dt><i>execPath</i> (str)</dt>
449 <dd>
450 search path string to be prepended to the PATH
451 environment variable
391 </dd> 452 </dd>
392 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> 453 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
393 <h4>VirtualenvManager.setVirtualEnv</h4> 454 <h4>VirtualenvManager.setVirtualEnv</h4>
394 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal</i>) 455 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, execPath</i>)
395 <p> 456 <p>
396 Public method to change a virtual environment. 457 Public method to change a virtual environment.
397 </p><dl> 458 </p><dl>
398 <dt><i>venvName</i> (str)</dt> 459 <dt><i>venvName</i> (str)</dt>
399 <dd> 460 <dd>
408 <dd> 469 <dd>
409 Python variant of the virtual environment 470 Python variant of the virtual environment
410 </dd><dt><i>isGlobal</i> (bool)</dt> 471 </dd><dt><i>isGlobal</i> (bool)</dt>
411 <dd> 472 <dd>
412 flag indicating a global environment 473 flag indicating a global environment
474 </dd><dt><i>isConda</i> (bool)</dt>
475 <dd>
476 flag indicating an Anaconda virtual environment
477 </dd><dt><i>execPath</i> (str)</dt>
478 <dd>
479 search path string to be prepended to the PATH
480 environment variable
413 </dd> 481 </dd>
414 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a> 482 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a>
415 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4> 483 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4>
416 <b>showVirtualenvManagerDialog</b>(<i>modal=False</i>) 484 <b>showVirtualenvManagerDialog</b>(<i>modal=False</i>)
417 <p> 485 <p>

Mercurial Repository: eric

eric ide

mercurial