Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html
src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html
- branch
- eric7
- changeset 10194
- 2c26b4fe25db
- parent 9507
- 1f39839655ea
- child 10340
- 548b4c7f410e
equal
deleted
inserted
replaced
| 10193:0d7392e49c48 | 10194:2c26b4fe25db |
|---|---|
| 114 <td><a href="#VirtualenvManager.getDefaultEnvironment">getDefaultEnvironment</a></td> | 114 <td><a href="#VirtualenvManager.getDefaultEnvironment">getDefaultEnvironment</a></td> |
| 115 <td>Public method to get the default virtual environment.</td> | 115 <td>Public method to get the default virtual environment.</td> |
| 116 </tr> | 116 </tr> |
| 117 <tr> | 117 <tr> |
| 118 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td> | 118 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td> |
| 119 <td>Public method to get a dictionary containing the defined virtual environment entries.</td> | 119 <td>Public method to get a list of the defined virtual environment entries.</td> |
| 120 </tr> | 120 </tr> |
| 121 <tr> | 121 <tr> |
| 122 <td><a href="#VirtualenvManager.getVirtualEnvironmentsBaseDir">getVirtualEnvironmentsBaseDir</a></td> | 122 <td><a href="#VirtualenvManager.getVirtualEnvironmentsBaseDir">getVirtualEnvironmentsBaseDir</a></td> |
| 123 <td>Public method to set the base directory for the virtual environments.</td> | 123 <td>Public method to set the base directory for the virtual environments.</td> |
| 124 </tr> | 124 </tr> |
| 248 <p> | 248 <p> |
| 249 Private slot to save the virtual environments. | 249 Private slot to save the virtual environments. |
| 250 </p> | 250 </p> |
| 251 <a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> | 251 <a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> |
| 252 <h4>VirtualenvManager.addVirtualEnv</h4> | 252 <h4>VirtualenvManager.addVirtualEnv</h4> |
| 253 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", isGlobal=False, isConda=False, isRemote=False, execPath="", description="", </i>) | 253 <b>addVirtualEnv</b>(<i>metadata</i>) |
| 254 | 254 |
| 255 <p> | 255 <p> |
| 256 Public method to add a virtual environment. | 256 Public method to add a virtual environment. |
| 257 </p> | 257 </p> |
| 258 <dl> | 258 <dl> |
| 259 | 259 |
| 260 <dt><i>venvName</i> (str)</dt> | 260 <dt><i>metadata</i> (VirtualenvMetaData)</dt> |
| 261 <dd> | 261 <dd> |
| 262 logical name for the virtual environment | 262 object containing the metadata of the virtual environment |
| 263 </dd> | |
| 264 <dt><i>venvDirectory</i> (str)</dt> | |
| 265 <dd> | |
| 266 directory of the virtual environment | |
| 267 </dd> | |
| 268 <dt><i>venvInterpreter</i> (str)</dt> | |
| 269 <dd> | |
| 270 interpreter of the virtual environment | |
| 271 </dd> | |
| 272 <dt><i>isGlobal</i> (bool)</dt> | |
| 273 <dd> | |
| 274 flag indicating a global environment | |
| 275 </dd> | |
| 276 <dt><i>isConda</i> (bool)</dt> | |
| 277 <dd> | |
| 278 flag indicating an Anaconda virtual environment | |
| 279 </dd> | |
| 280 <dt><i>isRemote</i> (bool)</dt> | |
| 281 <dd> | |
| 282 flag indicating a remotely accessed environment | |
| 283 </dd> | |
| 284 <dt><i>execPath</i> (str)</dt> | |
| 285 <dd> | |
| 286 search path string to be prepended to the PATH | |
| 287 environment variable | |
| 288 </dd> | |
| 289 <dt><i>description</i> (str)</dt> | |
| 290 <dd> | |
| 291 descriptive text for the environment | |
| 292 </dd> | 263 </dd> |
| 293 </dl> | 264 </dl> |
| 294 <a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a> | 265 <a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a> |
| 295 <h4>VirtualenvManager.createVirtualEnv</h4> | 266 <h4>VirtualenvManager.createVirtualEnv</h4> |
| 296 <b>createVirtualEnv</b>(<i>baseDir=""</i>) | 267 <b>createVirtualEnv</b>(<i>baseDir=""</i>) |
| 334 </dd> | 305 </dd> |
| 335 </dl> | 306 </dl> |
| 336 <dl> | 307 <dl> |
| 337 <dt>Return:</dt> | 308 <dt>Return:</dt> |
| 338 <dd> | 309 <dd> |
| 339 tuple containing the environment name and a dictionary | 310 tuple containing the environment name and a copy of the metadata |
| 340 containing a copy of the default virtual environment | 311 of the virtual environment the interpreter belongs to |
| 341 </dd> | 312 </dd> |
| 342 </dl> | 313 </dl> |
| 343 <dl> | 314 <dl> |
| 344 <dt>Return Type:</dt> | 315 <dt>Return Type:</dt> |
| 345 <dd> | 316 <dd> |
| 346 tuple of (str, dict) | 317 tuple of (str, VirtualenvMetaData) |
| 347 </dd> | 318 </dd> |
| 348 </dl> | 319 </dl> |
| 349 <a NAME="VirtualenvManager.getDefaultEnvironment" ID="VirtualenvManager.getDefaultEnvironment"></a> | 320 <a NAME="VirtualenvManager.getDefaultEnvironment" ID="VirtualenvManager.getDefaultEnvironment"></a> |
| 350 <h4>VirtualenvManager.getDefaultEnvironment</h4> | 321 <h4>VirtualenvManager.getDefaultEnvironment</h4> |
| 351 <b>getDefaultEnvironment</b>(<i></i>) | 322 <b>getDefaultEnvironment</b>(<i></i>) |
| 359 execute eric with) | 330 execute eric with) |
| 360 </p> | 331 </p> |
| 361 <dl> | 332 <dl> |
| 362 <dt>Return:</dt> | 333 <dt>Return:</dt> |
| 363 <dd> | 334 <dd> |
| 364 tuple containing the environment name and a dictionary | 335 tuple containing the environment name and a copy of the metadata |
| 365 containing a copy of the default virtual environment | 336 of the default virtual environment |
| 366 </dd> | 337 </dd> |
| 367 </dl> | 338 </dl> |
| 368 <dl> | 339 <dl> |
| 369 <dt>Return Type:</dt> | 340 <dt>Return Type:</dt> |
| 370 <dd> | 341 <dd> |
| 371 tuple of (str, dict) | 342 tuple of (str, VirtualenvMetaData) |
| 372 </dd> | 343 </dd> |
| 373 </dl> | 344 </dl> |
| 374 <a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a> | 345 <a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a> |
| 375 <h4>VirtualenvManager.getEnvironmentEntries</h4> | 346 <h4>VirtualenvManager.getEnvironmentEntries</h4> |
| 376 <b>getEnvironmentEntries</b>(<i></i>) | 347 <b>getEnvironmentEntries</b>(<i></i>) |
| 377 | 348 |
| 378 <p> | 349 <p> |
| 379 Public method to get a dictionary containing the defined virtual | 350 Public method to get a list of the defined virtual environment entries. |
| 380 environment entries. | 351 </p> |
| 381 </p> | 352 <dl> |
| 382 <dl> | 353 <dt>Return:</dt> |
| 383 <dt>Return:</dt> | 354 <dd> |
| 384 <dd> | 355 list containing a copy of the defined virtual environments |
| 385 dictionary containing a copy of the defined virtual | 356 </dd> |
| 386 environments | 357 </dl> |
| 387 </dd> | 358 <dl> |
| 388 </dl> | 359 <dt>Return Type:</dt> |
| 389 <dl> | 360 <dd> |
| 390 <dt>Return Type:</dt> | 361 list |
| 391 <dd> | |
| 392 dict | |
| 393 </dd> | 362 </dd> |
| 394 </dl> | 363 </dl> |
| 395 <a NAME="VirtualenvManager.getVirtualEnvironmentsBaseDir" ID="VirtualenvManager.getVirtualEnvironmentsBaseDir"></a> | 364 <a NAME="VirtualenvManager.getVirtualEnvironmentsBaseDir" ID="VirtualenvManager.getVirtualEnvironmentsBaseDir"></a> |
| 396 <h4>VirtualenvManager.getVirtualEnvironmentsBaseDir</h4> | 365 <h4>VirtualenvManager.getVirtualEnvironmentsBaseDir</h4> |
| 397 <b>getVirtualEnvironmentsBaseDir</b>(<i></i>) | 366 <b>getVirtualEnvironmentsBaseDir</b>(<i></i>) |
| 647 list of logical names for the virtual environments | 616 list of logical names for the virtual environments |
| 648 </dd> | 617 </dd> |
| 649 </dl> | 618 </dl> |
| 650 <a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> | 619 <a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> |
| 651 <h4>VirtualenvManager.renameVirtualEnv</h4> | 620 <h4>VirtualenvManager.renameVirtualEnv</h4> |
| 652 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, isGlobal, isConda, isRemote, execPath, description, </i>) | 621 <b>renameVirtualEnv</b>(<i>oldVenvName, metadata, </i>) |
| 653 | 622 |
| 654 <p> | 623 <p> |
| 655 Public method to substitute a virtual environment entry with a new | 624 Public method to substitute a virtual environment entry with a new |
| 656 name. | 625 name. |
| 657 </p> | 626 </p> |
| 659 | 628 |
| 660 <dt><i>oldVenvName</i> (str)</dt> | 629 <dt><i>oldVenvName</i> (str)</dt> |
| 661 <dd> | 630 <dd> |
| 662 old name of the virtual environment | 631 old name of the virtual environment |
| 663 </dd> | 632 </dd> |
| 664 <dt><i>venvName</i> (str)</dt> | 633 <dt><i>metadata</i> (VirtualenvMetaData)</dt> |
| 665 <dd> | 634 <dd> |
| 666 logical name for the virtual environment | 635 object containing the metadata of the virtual environment |
| 667 </dd> | |
| 668 <dt><i>venvDirectory</i> (str)</dt> | |
| 669 <dd> | |
| 670 directory of the virtual environment | |
| 671 </dd> | |
| 672 <dt><i>venvInterpreter</i> (str)</dt> | |
| 673 <dd> | |
| 674 interpreter of the virtual environment | |
| 675 </dd> | |
| 676 <dt><i>isGlobal</i> (bool)</dt> | |
| 677 <dd> | |
| 678 flag indicating a global environment | |
| 679 </dd> | |
| 680 <dt><i>isConda</i> (bool)</dt> | |
| 681 <dd> | |
| 682 flag indicating an Anaconda virtual environment | |
| 683 </dd> | |
| 684 <dt><i>isRemote</i> (bool)</dt> | |
| 685 <dd> | |
| 686 flag indicating a remotely accessed environment | |
| 687 </dd> | |
| 688 <dt><i>execPath</i> (str)</dt> | |
| 689 <dd> | |
| 690 search path string to be prepended to the PATH | |
| 691 environment variable | |
| 692 </dd> | |
| 693 <dt><i>description</i> (str)</dt> | |
| 694 <dd> | |
| 695 descriptive text for the environment | |
| 696 </dd> | 636 </dd> |
| 697 </dl> | 637 </dl> |
| 698 <a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> | 638 <a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> |
| 699 <h4>VirtualenvManager.setVirtualEnv</h4> | 639 <h4>VirtualenvManager.setVirtualEnv</h4> |
| 700 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, isGlobal, isConda, isRemote, execPath, description, </i>) | 640 <b>setVirtualEnv</b>(<i>metadata</i>) |
| 701 | 641 |
| 702 <p> | 642 <p> |
| 703 Public method to change a virtual environment. | 643 Public method to change a virtual environment. |
| 704 </p> | 644 </p> |
| 705 <dl> | 645 <dl> |
| 706 | 646 |
| 707 <dt><i>venvName</i> (str)</dt> | 647 <dt><i>metadata</i> (VirtualenvMetaData)</dt> |
| 708 <dd> | 648 <dd> |
| 709 logical name of the virtual environment | 649 object containing the metadata of the virtual environment |
| 710 </dd> | |
| 711 <dt><i>venvDirectory</i> (str)</dt> | |
| 712 <dd> | |
| 713 directory of the virtual environment | |
| 714 </dd> | |
| 715 <dt><i>venvInterpreter</i> (str)</dt> | |
| 716 <dd> | |
| 717 interpreter of the virtual environment | |
| 718 </dd> | |
| 719 <dt><i>isGlobal</i> (bool)</dt> | |
| 720 <dd> | |
| 721 flag indicating a global environment | |
| 722 </dd> | |
| 723 <dt><i>isConda</i> (bool)</dt> | |
| 724 <dd> | |
| 725 flag indicating an Anaconda virtual environment | |
| 726 </dd> | |
| 727 <dt><i>isRemote</i> (bool)</dt> | |
| 728 <dd> | |
| 729 flag indicating a remotely accessed environment | |
| 730 </dd> | |
| 731 <dt><i>execPath</i> (str)</dt> | |
| 732 <dd> | |
| 733 search path string to be prepended to the PATH | |
| 734 environment variable | |
| 735 </dd> | |
| 736 <dt><i>description</i> (str)</dt> | |
| 737 <dd> | |
| 738 descriptive text for the environment | |
| 739 </dd> | 650 </dd> |
| 740 </dl> | 651 </dl> |
| 741 <a NAME="VirtualenvManager.setVirtualEnvInterpreter" ID="VirtualenvManager.setVirtualEnvInterpreter"></a> | 652 <a NAME="VirtualenvManager.setVirtualEnvInterpreter" ID="VirtualenvManager.setVirtualEnvInterpreter"></a> |
| 742 <h4>VirtualenvManager.setVirtualEnvInterpreter</h4> | 653 <h4>VirtualenvManager.setVirtualEnvInterpreter</h4> |
| 743 <b>setVirtualEnvInterpreter</b>(<i>venvName, venvInterpreter</i>) | 654 <b>setVirtualEnvInterpreter</b>(<i>venvName, venvInterpreter</i>) |
