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

changeset 7635
0cdead130a81
parent 7273
391d6b7b1eff
child 7728
a233627a5e25
equal deleted inserted replaced
7634:8c3d033e5044 7635:0cdead130a81
138 <tr> 138 <tr>
139 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td> 139 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td>
140 <td>Public method to get a list of defined virtual environments.</td> 140 <td>Public method to get a list of defined virtual environments.</td>
141 </tr> 141 </tr>
142 <tr> 142 <tr>
143 <td><a href="#VirtualenvManager.getVirtualenvNamesForVariant">getVirtualenvNamesForVariant</a></td>
144 <td>Public method to get a list of virtual environments for a given Python variant.</td>
145 </tr>
146 <tr>
147 <td><a href="#VirtualenvManager.getVirtualenvVariant">getVirtualenvVariant</a></td>
148 <td>Public method to get the variant of a virtual environment.</td>
149 </tr>
150 <tr>
151 <td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td> 143 <td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td>
152 <td>Public method to test, if a given environment is an Anaconda environment.</td> 144 <td>Public method to test, if a given environment is an Anaconda environment.</td>
153 </tr> 145 </tr>
154 <tr> 146 <tr>
155 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td> 147 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td>
245 <p> 237 <p>
246 Private slot to save the virtual environments. 238 Private slot to save the virtual environments.
247 </p> 239 </p>
248 <a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> 240 <a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a>
249 <h4>VirtualenvManager.addVirtualEnv</h4> 241 <h4>VirtualenvManager.addVirtualEnv</h4>
250 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, isRemote=False, execPath=""</i>) 242 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", isGlobal=False, isConda=False, isRemote=False, execPath=""</i>)
251 243
252 <p> 244 <p>
253 Public method to add a virtual environment. 245 Public method to add a virtual environment.
254 </p> 246 </p>
255 <dl> 247 <dl>
263 directory of the virtual environment 255 directory of the virtual environment
264 </dd> 256 </dd>
265 <dt><i>venvInterpreter</i> (str)</dt> 257 <dt><i>venvInterpreter</i> (str)</dt>
266 <dd> 258 <dd>
267 interpreter of the virtual environment 259 interpreter of the virtual environment
268 </dd>
269 <dt><i>venvVariant</i> (int)</dt>
270 <dd>
271 Python variant of the virtual environment
272 </dd> 260 </dd>
273 <dt><i>isGlobal</i> (bool)</dt> 261 <dt><i>isGlobal</i> (bool)</dt>
274 <dd> 262 <dd>
275 flag indicating a global environment 263 flag indicating a global environment
276 </dd> 264 </dd>
458 <dt>Return Type:</dt> 446 <dt>Return Type:</dt>
459 <dd> 447 <dd>
460 list of str 448 list of str
461 </dd> 449 </dd>
462 </dl> 450 </dl>
463 <a NAME="VirtualenvManager.getVirtualenvNamesForVariant" ID="VirtualenvManager.getVirtualenvNamesForVariant"></a>
464 <h4>VirtualenvManager.getVirtualenvNamesForVariant</h4>
465 <b>getVirtualenvNamesForVariant</b>(<i>variant</i>)
466
467 <p>
468 Public method to get a list of virtual environments for a given
469 Python variant.
470 </p>
471 <dl>
472
473 <dt><i>variant</i> (int)</dt>
474 <dd>
475 Python variant (2 or 3)
476 </dd>
477 </dl>
478 <dl>
479 <dt>Returns:</dt>
480 <dd>
481 list of defined virtual environments
482 </dd>
483 </dl>
484 <dl>
485 <dt>Return Type:</dt>
486 <dd>
487 list of str
488 </dd>
489 </dl>
490 <a NAME="VirtualenvManager.getVirtualenvVariant" ID="VirtualenvManager.getVirtualenvVariant"></a>
491 <h4>VirtualenvManager.getVirtualenvVariant</h4>
492 <b>getVirtualenvVariant</b>(<i>venvName</i>)
493
494 <p>
495 Public method to get the variant of a virtual environment.
496 </p>
497 <dl>
498
499 <dt><i>venvName</i> (str)</dt>
500 <dd>
501 logical name for the virtual environment
502 </dd>
503 </dl>
504 <dl>
505 <dt>Returns:</dt>
506 <dd>
507 Python variant of the environment
508 </dd>
509 </dl>
510 <dl>
511 <dt>Return Type:</dt>
512 <dd>
513 str
514 </dd>
515 </dl>
516 <a NAME="VirtualenvManager.isCondaEnvironment" ID="VirtualenvManager.isCondaEnvironment"></a> 451 <a NAME="VirtualenvManager.isCondaEnvironment" ID="VirtualenvManager.isCondaEnvironment"></a>
517 <h4>VirtualenvManager.isCondaEnvironment</h4> 452 <h4>VirtualenvManager.isCondaEnvironment</h4>
518 <b>isCondaEnvironment</b>(<i>venvName</i>) 453 <b>isCondaEnvironment</b>(<i>venvName</i>)
519 454
520 <p> 455 <p>
633 list of logical names for the virtual environments 568 list of logical names for the virtual environments
634 </dd> 569 </dd>
635 </dl> 570 </dl>
636 <a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> 571 <a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
637 <h4>VirtualenvManager.renameVirtualEnv</h4> 572 <h4>VirtualenvManager.renameVirtualEnv</h4>
638 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>) 573 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, isGlobal, isConda, isRemote, execPath</i>)
639 574
640 <p> 575 <p>
641 Public method to substitute a virtual environment entry with a new 576 Public method to substitute a virtual environment entry with a new
642 name. 577 name.
643 </p> 578 </p>
657 </dd> 592 </dd>
658 <dt><i>venvInterpreter</i> (str)</dt> 593 <dt><i>venvInterpreter</i> (str)</dt>
659 <dd> 594 <dd>
660 interpreter of the virtual environment 595 interpreter of the virtual environment
661 </dd> 596 </dd>
662 <dt><i>venvVariant</i> (int)</dt>
663 <dd>
664 Python variant of the virtual environment
665 </dd>
666 <dt><i>isGlobal</i> (bool)</dt> 597 <dt><i>isGlobal</i> (bool)</dt>
667 <dd> 598 <dd>
668 flag indicating a global environment 599 flag indicating a global environment
669 </dd> 600 </dd>
670 <dt><i>isConda</i> (bool)</dt> 601 <dt><i>isConda</i> (bool)</dt>
681 environment variable 612 environment variable
682 </dd> 613 </dd>
683 </dl> 614 </dl>
684 <a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> 615 <a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
685 <h4>VirtualenvManager.setVirtualEnv</h4> 616 <h4>VirtualenvManager.setVirtualEnv</h4>
686 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>) 617 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, isGlobal, isConda, isRemote, execPath</i>)
687 618
688 <p> 619 <p>
689 Public method to change a virtual environment. 620 Public method to change a virtual environment.
690 </p> 621 </p>
691 <dl> 622 <dl>
699 directory of the virtual environment 630 directory of the virtual environment
700 </dd> 631 </dd>
701 <dt><i>venvInterpreter</i> (str)</dt> 632 <dt><i>venvInterpreter</i> (str)</dt>
702 <dd> 633 <dd>
703 interpreter of the virtual environment 634 interpreter of the virtual environment
704 </dd>
705 <dt><i>venvVariant</i> (int)</dt>
706 <dd>
707 Python variant of the virtual environment
708 </dd> 635 </dd>
709 <dt><i>isGlobal</i> (bool)</dt> 636 <dt><i>isGlobal</i> (bool)</dt>
710 <dd> 637 <dd>
711 flag indicating a global environment 638 flag indicating a global environment
712 </dd> 639 </dd>

eric ide

mercurial