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 10784
- 521fd465b048
- parent 10742
- 7aa41173b44b
- child 11231
- c7240fb719c7
equal
deleted
inserted
replaced
| 10783:ccf28bec1227 | 10784:521fd465b048 |
|---|---|
| 80 <td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td> | 80 <td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td> |
| 81 <td>Constructor</td> | 81 <td>Constructor</td> |
| 82 </tr> | 82 </tr> |
| 83 <tr> | 83 <tr> |
| 84 <td><a href="#VirtualenvManager.__cleanEnvironments">__cleanEnvironments</a></td> | 84 <td><a href="#VirtualenvManager.__cleanEnvironments">__cleanEnvironments</a></td> |
| 85 <td>Private method to delete all non-existent local environments.</td> | 85 <td>Private method to delete all non-existent local or eric-ide server environments.</td> |
| 86 </tr> | 86 </tr> |
| 87 <tr> | 87 <tr> |
| 88 <td><a href="#VirtualenvManager.__isEnvironmentDeleteable">__isEnvironmentDeleteable</a></td> | 88 <td><a href="#VirtualenvManager.__isEnvironmentDeleteable">__isEnvironmentDeleteable</a></td> |
| 89 <td>Private method to check, if a virtual environment can be deleted from disk.</td> | 89 <td>Private method to check, if a virtual environment can be deleted from disk.</td> |
| 90 </tr> | 90 </tr> |
| 119 <tr> | 119 <tr> |
| 120 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td> | 120 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td> |
| 121 <td>Public method to get a list of the defined virtual environment entries.</td> | 121 <td>Public method to get a list of the defined virtual environment entries.</td> |
| 122 </tr> | 122 </tr> |
| 123 <tr> | 123 <tr> |
| 124 <td><a href="#VirtualenvManager.getEricServerEnvironmentNames">getEricServerEnvironmentNames</a></td> | |
| 125 <td>Public method to get a list of defined eric-ide server environments.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 124 <td><a href="#VirtualenvManager.getVirtualEnvironmentsBaseDir">getVirtualEnvironmentsBaseDir</a></td> | 128 <td><a href="#VirtualenvManager.getVirtualEnvironmentsBaseDir">getVirtualEnvironmentsBaseDir</a></td> |
| 125 <td>Public method to set the base directory for the virtual environments.</td> | 129 <td>Public method to set the base directory for the virtual environments.</td> |
| 126 </tr> | 130 </tr> |
| 127 <tr> | 131 <tr> |
| 128 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td> | 132 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td> |
| 141 <td>Public method to get a list of defined virtual environments.</td> | 145 <td>Public method to get a list of defined virtual environments.</td> |
| 142 </tr> | 146 </tr> |
| 143 <tr> | 147 <tr> |
| 144 <td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td> | 148 <td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td> |
| 145 <td>Public method to test, if a given environment is an Anaconda environment.</td> | 149 <td>Public method to test, if a given environment is an Anaconda environment.</td> |
| 150 </tr> | |
| 151 <tr> | |
| 152 <td><a href="#VirtualenvManager.isEricServerEnvironment">isEricServerEnvironment</a></td> | |
| 153 <td>Public method to test, if a given environment is an environment accessed through an eric-ide server.</td> | |
| 146 </tr> | 154 </tr> |
| 147 <tr> | 155 <tr> |
| 148 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td> | 156 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td> |
| 149 <td>Public method to test, if a given environment is a global one.</td> | 157 <td>Public method to test, if a given environment is a global one.</td> |
| 150 </tr> | 158 </tr> |
| 216 </dl> | 224 </dl> |
| 217 <a NAME="VirtualenvManager.__cleanEnvironments" ID="VirtualenvManager.__cleanEnvironments"></a> | 225 <a NAME="VirtualenvManager.__cleanEnvironments" ID="VirtualenvManager.__cleanEnvironments"></a> |
| 218 <h4>VirtualenvManager.__cleanEnvironments</h4> | 226 <h4>VirtualenvManager.__cleanEnvironments</h4> |
| 219 <b>__cleanEnvironments</b>(<i></i>) | 227 <b>__cleanEnvironments</b>(<i></i>) |
| 220 <p> | 228 <p> |
| 221 Private method to delete all non-existent local environments. | 229 Private method to delete all non-existent local or eric-ide server environments. |
| 222 </p> | 230 </p> |
| 223 | 231 |
| 224 <a NAME="VirtualenvManager.__isEnvironmentDeleteable" ID="VirtualenvManager.__isEnvironmentDeleteable"></a> | 232 <a NAME="VirtualenvManager.__isEnvironmentDeleteable" ID="VirtualenvManager.__isEnvironmentDeleteable"></a> |
| 225 <h4>VirtualenvManager.__isEnvironmentDeleteable</h4> | 233 <h4>VirtualenvManager.__isEnvironmentDeleteable</h4> |
| 226 <b>__isEnvironmentDeleteable</b>(<i>venvName</i>) | 234 <b>__isEnvironmentDeleteable</b>(<i>venvName</i>) |
| 373 <dt>Return Type:</dt> | 381 <dt>Return Type:</dt> |
| 374 <dd> | 382 <dd> |
| 375 list | 383 list |
| 376 </dd> | 384 </dd> |
| 377 </dl> | 385 </dl> |
| 386 <a NAME="VirtualenvManager.getEricServerEnvironmentNames" ID="VirtualenvManager.getEricServerEnvironmentNames"></a> | |
| 387 <h4>VirtualenvManager.getEricServerEnvironmentNames</h4> | |
| 388 <b>getEricServerEnvironmentNames</b>(<i>host=""</i>) | |
| 389 <p> | |
| 390 Public method to get a list of defined eric-ide server environments. | |
| 391 </p> | |
| 392 | |
| 393 <dl> | |
| 394 | |
| 395 <dt><i>host</i> (str (optional))</dt> | |
| 396 <dd> | |
| 397 host name to get environment names for (defaults to "") | |
| 398 </dd> | |
| 399 </dl> | |
| 400 <dl> | |
| 401 <dt>Return:</dt> | |
| 402 <dd> | |
| 403 list of defined eric-ide server environments | |
| 404 </dd> | |
| 405 </dl> | |
| 406 <dl> | |
| 407 <dt>Return Type:</dt> | |
| 408 <dd> | |
| 409 list of str | |
| 410 </dd> | |
| 411 </dl> | |
| 378 <a NAME="VirtualenvManager.getVirtualEnvironmentsBaseDir" ID="VirtualenvManager.getVirtualEnvironmentsBaseDir"></a> | 412 <a NAME="VirtualenvManager.getVirtualEnvironmentsBaseDir" ID="VirtualenvManager.getVirtualEnvironmentsBaseDir"></a> |
| 379 <h4>VirtualenvManager.getVirtualEnvironmentsBaseDir</h4> | 413 <h4>VirtualenvManager.getVirtualEnvironmentsBaseDir</h4> |
| 380 <b>getVirtualEnvironmentsBaseDir</b>(<i></i>) | 414 <b>getVirtualEnvironmentsBaseDir</b>(<i></i>) |
| 381 <p> | 415 <p> |
| 382 Public method to set the base directory for the virtual environments. | 416 Public method to set the base directory for the virtual environments. |
| 472 str | 506 str |
| 473 </dd> | 507 </dd> |
| 474 </dl> | 508 </dl> |
| 475 <a NAME="VirtualenvManager.getVirtualenvNames" ID="VirtualenvManager.getVirtualenvNames"></a> | 509 <a NAME="VirtualenvManager.getVirtualenvNames" ID="VirtualenvManager.getVirtualenvNames"></a> |
| 476 <h4>VirtualenvManager.getVirtualenvNames</h4> | 510 <h4>VirtualenvManager.getVirtualenvNames</h4> |
| 477 <b>getVirtualenvNames</b>(<i>noRemote=False, noConda=False, noGlobals=False</i>) | 511 <b>getVirtualenvNames</b>(<i>noRemote=False, noConda=False, noGlobals=False, noServer=False</i>) |
| 478 <p> | 512 <p> |
| 479 Public method to get a list of defined virtual environments. | 513 Public method to get a list of defined virtual environments. |
| 480 </p> | 514 </p> |
| 481 | 515 |
| 482 <dl> | 516 <dl> |
| 491 flag indicating to exclude Conda environments (defaults to False) | 525 flag indicating to exclude Conda environments (defaults to False) |
| 492 </dd> | 526 </dd> |
| 493 <dt><i>noGlobals</i> (bool (optional))</dt> | 527 <dt><i>noGlobals</i> (bool (optional))</dt> |
| 494 <dd> | 528 <dd> |
| 495 flag indicating to exclude global environments | 529 flag indicating to exclude global environments |
| 530 (defaults to False) | |
| 531 </dd> | |
| 532 <dt><i>noServer</i> (bool (optional))</dt> | |
| 533 <dd> | |
| 534 flag indicating to exclude eric-ide server environments | |
| 496 (defaults to False) | 535 (defaults to False) |
| 497 </dd> | 536 </dd> |
| 498 </dl> | 537 </dl> |
| 499 <dl> | 538 <dl> |
| 500 <dt>Return:</dt> | 539 <dt>Return:</dt> |
| 533 <dt>Return Type:</dt> | 572 <dt>Return Type:</dt> |
| 534 <dd> | 573 <dd> |
| 535 bool | 574 bool |
| 536 </dd> | 575 </dd> |
| 537 </dl> | 576 </dl> |
| 577 <a NAME="VirtualenvManager.isEricServerEnvironment" ID="VirtualenvManager.isEricServerEnvironment"></a> | |
| 578 <h4>VirtualenvManager.isEricServerEnvironment</h4> | |
| 579 <b>isEricServerEnvironment</b>(<i>venvName, host=""</i>) | |
| 580 <p> | |
| 581 Public method to test, if a given environment is an environment accessed | |
| 582 through an eric-ide server. | |
| 583 </p> | |
| 584 | |
| 585 <dl> | |
| 586 | |
| 587 <dt><i>venvName</i> (str)</dt> | |
| 588 <dd> | |
| 589 logical name of the virtual environment | |
| 590 </dd> | |
| 591 <dt><i>host</i> (str (optional))</dt> | |
| 592 <dd> | |
| 593 name of the host to check for or empty string to just check for | |
| 594 an eric-ide server environment (defaults to "") | |
| 595 </dd> | |
| 596 </dl> | |
| 597 <dl> | |
| 598 <dt>Return:</dt> | |
| 599 <dd> | |
| 600 flag indicating an eric-ide server environment | |
| 601 </dd> | |
| 602 </dl> | |
| 603 <dl> | |
| 604 <dt>Return Type:</dt> | |
| 605 <dd> | |
| 606 bool | |
| 607 </dd> | |
| 608 </dl> | |
| 538 <a NAME="VirtualenvManager.isGlobalEnvironment" ID="VirtualenvManager.isGlobalEnvironment"></a> | 609 <a NAME="VirtualenvManager.isGlobalEnvironment" ID="VirtualenvManager.isGlobalEnvironment"></a> |
| 539 <h4>VirtualenvManager.isGlobalEnvironment</h4> | 610 <h4>VirtualenvManager.isGlobalEnvironment</h4> |
| 540 <b>isGlobalEnvironment</b>(<i>venvName</i>) | 611 <b>isGlobalEnvironment</b>(<i>venvName</i>) |
| 541 <p> | 612 <p> |
| 542 Public method to test, if a given environment is a global one. | 613 Public method to test, if a given environment is a global one. |
