Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html
Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html
- branch
- maintenance
- changeset 6826
- c6dda2cbe081
- parent 6807
- 7e5eba19d86d
- child 6903
- 0d4e1033731b
equal
deleted
inserted
replaced
| 6764:d14ddbfbbd36 | 6826:c6dda2cbe081 |
|---|---|
| 41 <hr /><hr /> | 41 <hr /><hr /> |
| 42 <a NAME="VirtualenvManager" ID="VirtualenvManager"></a> | 42 <a NAME="VirtualenvManager" ID="VirtualenvManager"></a> |
| 43 <h2>VirtualenvManager</h2> | 43 <h2>VirtualenvManager</h2> |
| 44 <p> | 44 <p> |
| 45 Class implementing an object to manage Python virtual environments. | 45 Class implementing an object to manage Python virtual environments. |
| 46 </p> | 46 </p><h3>Signals</h3> |
| 47 <dl> | |
| 48 <dt>virtualEnvironmentAdded()</dt> | |
| 49 <dd> | |
| 50 emitted to indicate the addition of | |
| 51 a virtual environment | |
| 52 </dd><dt>virtualEnvironmentChanged(name)</dt> | |
| 53 <dd> | |
| 54 emitted to indicate a change of | |
| 55 a virtual environment | |
| 56 </dd><dt>virtualEnvironmentRemoved()</dt> | |
| 57 <dd> | |
| 58 emitted to indicate the removal and | |
| 59 deletion of a virtual environment | |
| 60 </dd> | |
| 61 </dl> | |
| 47 <h3>Derived from</h3> | 62 <h3>Derived from</h3> |
| 48 QObject | 63 QObject |
| 49 <h3>Class Attributes</h3> | 64 <h3>Class Attributes</h3> |
| 50 <table> | 65 <table> |
| 51 <tr><td>DefaultKey</td></tr> | 66 <tr><td>DefaultKey</td></tr> |
| 102 <td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td> | 117 <td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td> |
| 103 <td>Public method to test, if a given environment is an Anaconda environment.</td> | 118 <td>Public method to test, if a given environment is an Anaconda environment.</td> |
| 104 </tr><tr> | 119 </tr><tr> |
| 105 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td> | 120 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td> |
| 106 <td>Public method to test, if a given environment is a global one.</td> | 121 <td>Public method to test, if a given environment is a global one.</td> |
| 122 </tr><tr> | |
| 123 <td><a href="#VirtualenvManager.isRemoteEnvironment">isRemoteEnvironment</a></td> | |
| 124 <td>Public method to test, if a given environment is a remotely accessed environment.</td> | |
| 107 </tr><tr> | 125 </tr><tr> |
| 108 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td> | 126 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td> |
| 109 <td>Public method to check, if the give logical name is unique.</td> | 127 <td>Public method to check, if the give logical name is unique.</td> |
| 110 </tr><tr> | 128 </tr><tr> |
| 111 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td> | 129 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td> |
| 169 <b>__saveSettings</b>(<i></i>) | 187 <b>__saveSettings</b>(<i></i>) |
| 170 <p> | 188 <p> |
| 171 Private slot to save the virtual environments. | 189 Private slot to save the virtual environments. |
| 172 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> | 190 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> |
| 173 <h4>VirtualenvManager.addVirtualEnv</h4> | 191 <h4>VirtualenvManager.addVirtualEnv</h4> |
| 174 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, execPath=""</i>) | 192 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, isRemote=False, execPath=""</i>) |
| 175 <p> | 193 <p> |
| 176 Public method to add a virtual environment. | 194 Public method to add a virtual environment. |
| 177 </p><dl> | 195 </p><dl> |
| 178 <dt><i>venvName</i> (str)</dt> | 196 <dt><i>venvName</i> (str)</dt> |
| 179 <dd> | 197 <dd> |
| 191 <dd> | 209 <dd> |
| 192 flag indicating a global environment | 210 flag indicating a global environment |
| 193 </dd><dt><i>isConda</i> (bool)</dt> | 211 </dd><dt><i>isConda</i> (bool)</dt> |
| 194 <dd> | 212 <dd> |
| 195 flag indicating an Anaconda virtual environment | 213 flag indicating an Anaconda virtual environment |
| 214 </dd><dt><i>isRemote</i> (bool)</dt> | |
| 215 <dd> | |
| 216 flag indicating a remotely accessed environment | |
| 196 </dd><dt><i>execPath</i> (str)</dt> | 217 </dd><dt><i>execPath</i> (str)</dt> |
| 197 <dd> | 218 <dd> |
| 198 search path string to be prepended to the PATH | 219 search path string to be prepended to the PATH |
| 199 environment variable | 220 environment variable |
| 200 </dd> | 221 </dd> |
| 385 </dl><dl> | 406 </dl><dl> |
| 386 <dt>Return Type:</dt> | 407 <dt>Return Type:</dt> |
| 387 <dd> | 408 <dd> |
| 388 bool | 409 bool |
| 389 </dd> | 410 </dd> |
| 411 </dl><a NAME="VirtualenvManager.isRemoteEnvironment" ID="VirtualenvManager.isRemoteEnvironment"></a> | |
| 412 <h4>VirtualenvManager.isRemoteEnvironment</h4> | |
| 413 <b>isRemoteEnvironment</b>(<i>venvName</i>) | |
| 414 <p> | |
| 415 Public method to test, if a given environment is a remotely accessed | |
| 416 environment. | |
| 417 </p><dl> | |
| 418 <dt><i>venvName</i> (str)</dt> | |
| 419 <dd> | |
| 420 logical name of the virtual environment | |
| 421 </dd> | |
| 422 </dl><dl> | |
| 423 <dt>Returns:</dt> | |
| 424 <dd> | |
| 425 flag indicating a remotely accessed environment | |
| 426 </dd> | |
| 427 </dl><dl> | |
| 428 <dt>Return Type:</dt> | |
| 429 <dd> | |
| 430 bool | |
| 431 </dd> | |
| 390 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a> | 432 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a> |
| 391 <h4>VirtualenvManager.isUnique</h4> | 433 <h4>VirtualenvManager.isUnique</h4> |
| 392 <b>isUnique</b>(<i>venvName</i>) | 434 <b>isUnique</b>(<i>venvName</i>) |
| 393 <p> | 435 <p> |
| 394 Public method to check, if the give logical name is unique. | 436 Public method to check, if the give logical name is unique. |
| 417 <dd> | 459 <dd> |
| 418 list of logical names for the virtual environments | 460 list of logical names for the virtual environments |
| 419 </dd> | 461 </dd> |
| 420 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> | 462 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> |
| 421 <h4>VirtualenvManager.renameVirtualEnv</h4> | 463 <h4>VirtualenvManager.renameVirtualEnv</h4> |
| 422 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, execPath</i>) | 464 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>) |
| 423 <p> | 465 <p> |
| 424 Public method to substitute a virtual environment entry with a new | 466 Public method to substitute a virtual environment entry with a new |
| 425 name. | 467 name. |
| 426 </p><dl> | 468 </p><dl> |
| 427 <dt><i>oldVenvName</i> (str)</dt> | 469 <dt><i>oldVenvName</i> (str)</dt> |
| 443 <dd> | 485 <dd> |
| 444 flag indicating a global environment | 486 flag indicating a global environment |
| 445 </dd><dt><i>isConda</i> (bool)</dt> | 487 </dd><dt><i>isConda</i> (bool)</dt> |
| 446 <dd> | 488 <dd> |
| 447 flag indicating an Anaconda virtual environment | 489 flag indicating an Anaconda virtual environment |
| 490 </dd><dt><i>isRemote</i> (bool)</dt> | |
| 491 <dd> | |
| 492 flag indicating a remotely accessed environment | |
| 448 </dd><dt><i>execPath</i> (str)</dt> | 493 </dd><dt><i>execPath</i> (str)</dt> |
| 449 <dd> | 494 <dd> |
| 450 search path string to be prepended to the PATH | 495 search path string to be prepended to the PATH |
| 451 environment variable | 496 environment variable |
| 452 </dd> | 497 </dd> |
| 453 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> | 498 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> |
| 454 <h4>VirtualenvManager.setVirtualEnv</h4> | 499 <h4>VirtualenvManager.setVirtualEnv</h4> |
| 455 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, execPath</i>) | 500 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>) |
| 456 <p> | 501 <p> |
| 457 Public method to change a virtual environment. | 502 Public method to change a virtual environment. |
| 458 </p><dl> | 503 </p><dl> |
| 459 <dt><i>venvName</i> (str)</dt> | 504 <dt><i>venvName</i> (str)</dt> |
| 460 <dd> | 505 <dd> |
| 472 <dd> | 517 <dd> |
| 473 flag indicating a global environment | 518 flag indicating a global environment |
| 474 </dd><dt><i>isConda</i> (bool)</dt> | 519 </dd><dt><i>isConda</i> (bool)</dt> |
| 475 <dd> | 520 <dd> |
| 476 flag indicating an Anaconda virtual environment | 521 flag indicating an Anaconda virtual environment |
| 522 </dd><dt><i>isRemote</i> (bool)</dt> | |
| 523 <dd> | |
| 524 flag indicating a remotely accessed environment | |
| 477 </dd><dt><i>execPath</i> (str)</dt> | 525 </dd><dt><i>execPath</i> (str)</dt> |
| 478 <dd> | 526 <dd> |
| 479 search path string to be prepended to the PATH | 527 search path string to be prepended to the PATH |
| 480 environment variable | 528 environment variable |
| 481 </dd> | 529 </dd> |
