Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html
eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.VirtualEnv.VirtualenvManager</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.VirtualEnv.VirtualenvManager</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a class to manage Python virtual environments. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#VirtualenvManager">VirtualenvManager</a></td> | |
| 39 <td>Class implementing an object to manage Python virtual environments.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="VirtualenvManager" ID="VirtualenvManager"></a> | |
| 50 <h2>VirtualenvManager</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing an object to manage Python virtual environments. | |
| 54 </p> | |
| 55 <h3>Signals</h3> | |
| 56 <dl> | |
| 57 | |
| 58 <dt>virtualEnvironmentAdded()</dt> | |
| 59 <dd> | |
| 60 emitted to indicate the addition of | |
| 61 a virtual environment | |
| 62 </dd> | |
| 63 <dt>virtualEnvironmentChanged(name)</dt> | |
| 64 <dd> | |
| 65 emitted to indicate a change of | |
| 66 a virtual environment | |
| 67 </dd> | |
| 68 <dt>virtualEnvironmentRemoved()</dt> | |
| 69 <dd> | |
| 70 emitted to indicate the removal and | |
| 71 deletion of a virtual environment | |
| 72 </dd> | |
| 73 </dl> | |
| 74 <h3>Derived from</h3> | |
| 75 QObject | |
| 76 <h3>Class Attributes</h3> | |
| 77 | |
| 78 <table> | |
| 79 <tr><td>DefaultKey</td></tr> | |
| 80 </table> | |
| 81 <h3>Class Methods</h3> | |
| 82 | |
| 83 <table> | |
| 84 <tr><td>None</td></tr> | |
| 85 </table> | |
| 86 <h3>Methods</h3> | |
| 87 | |
| 88 <table> | |
| 89 | |
| 90 <tr> | |
| 91 <td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td> | |
| 92 <td>Constructor</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#VirtualenvManager.__isEnvironmentDeleteable">__isEnvironmentDeleteable</a></td> | |
| 96 <td>Private method to check, if a virtual environment can be deleted from disk.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#VirtualenvManager.__loadSettings">__loadSettings</a></td> | |
| 100 <td>Private slot to load the virtual environments.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#VirtualenvManager.__saveSettings">__saveSettings</a></td> | |
| 104 <td>Private slot to save the virtual environments.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#VirtualenvManager.addVirtualEnv">addVirtualEnv</a></td> | |
| 108 <td>Public method to add a virtual environment.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#VirtualenvManager.createVirtualEnv">createVirtualEnv</a></td> | |
| 112 <td>Public slot to create a new virtual environment.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#VirtualenvManager.deleteVirtualEnvs">deleteVirtualEnvs</a></td> | |
| 116 <td>Public method to delete virtual environments from the list and disk.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#VirtualenvManager.getDefaultEnvironment">getDefaultEnvironment</a></td> | |
| 120 <td>Public method to get the default virtual environment.</td> | |
| 121 </tr> | |
| 122 <tr> | |
| 123 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td> | |
| 124 <td>Public method to get a dictionary containing the defined virtual environment entries.</td> | |
| 125 </tr> | |
| 126 <tr> | |
| 127 <td><a href="#VirtualenvManager.getVirtualEnvironmentsBaseDir">getVirtualEnvironmentsBaseDir</a></td> | |
| 128 <td>Public method to set the base directory for the virtual environments.</td> | |
| 129 </tr> | |
| 130 <tr> | |
| 131 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td> | |
| 132 <td>Public method to get the directory of a virtual environment.</td> | |
| 133 </tr> | |
| 134 <tr> | |
| 135 <td><a href="#VirtualenvManager.getVirtualenvExecPath">getVirtualenvExecPath</a></td> | |
| 136 <td>Public method to get the search path prefix of a virtual environment.</td> | |
| 137 </tr> | |
| 138 <tr> | |
| 139 <td><a href="#VirtualenvManager.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td> | |
| 140 <td>Public method to get the interpreter for a virtual environment.</td> | |
| 141 </tr> | |
| 142 <tr> | |
| 143 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td> | |
| 144 <td>Public method to get a list of defined virtual environments.</td> | |
| 145 </tr> | |
| 146 <tr> | |
| 147 <td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td> | |
| 148 <td>Public method to test, if a given environment is an Anaconda environment.</td> | |
| 149 </tr> | |
| 150 <tr> | |
| 151 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td> | |
| 152 <td>Public method to test, if a given environment is a global one.</td> | |
| 153 </tr> | |
| 154 <tr> | |
| 155 <td><a href="#VirtualenvManager.isRemoteEnvironment">isRemoteEnvironment</a></td> | |
| 156 <td>Public method to test, if a given environment is a remotely accessed environment.</td> | |
| 157 </tr> | |
| 158 <tr> | |
| 159 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td> | |
| 160 <td>Public method to check, if the give logical name is unique.</td> | |
| 161 </tr> | |
| 162 <tr> | |
| 163 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td> | |
| 164 <td>Public method to delete virtual environment from the list.</td> | |
| 165 </tr> | |
| 166 <tr> | |
| 167 <td><a href="#VirtualenvManager.renameVirtualEnv">renameVirtualEnv</a></td> | |
| 168 <td>Public method to substitute a virtual environment entry with a new name.</td> | |
| 169 </tr> | |
| 170 <tr> | |
| 171 <td><a href="#VirtualenvManager.setVirtualEnv">setVirtualEnv</a></td> | |
| 172 <td>Public method to change a virtual environment.</td> | |
| 173 </tr> | |
| 174 <tr> | |
| 175 <td><a href="#VirtualenvManager.setVirtualEnvironmentsBaseDir">setVirtualEnvironmentsBaseDir</a></td> | |
| 176 <td>Public method to set the base directory for the virtual environments.</td> | |
| 177 </tr> | |
| 178 <tr> | |
| 179 <td><a href="#VirtualenvManager.showVirtualenvManagerDialog">showVirtualenvManagerDialog</a></td> | |
| 180 <td>Public slot to show the virtual environment manager dialog.</td> | |
| 181 </tr> | |
| 182 <tr> | |
| 183 <td><a href="#VirtualenvManager.shutdown">shutdown</a></td> | |
| 184 <td>Public method to shutdown the manager.</td> | |
| 185 </tr> | |
| 186 </table> | |
| 187 <h3>Static Methods</h3> | |
| 188 | |
| 189 <table> | |
| 190 <tr><td>None</td></tr> | |
| 191 </table> | |
| 192 | |
| 193 <a NAME="VirtualenvManager.__init__" ID="VirtualenvManager.__init__"></a> | |
| 194 <h4>VirtualenvManager (Constructor)</h4> | |
| 195 <b>VirtualenvManager</b>(<i>parent=None</i>) | |
| 196 | |
| 197 <p> | |
| 198 Constructor | |
| 199 </p> | |
| 200 <dl> | |
| 201 | |
| 202 <dt><i>parent</i> (QWidget)</dt> | |
| 203 <dd> | |
| 204 reference to the parent object | |
| 205 </dd> | |
| 206 </dl> | |
| 207 <a NAME="VirtualenvManager.__isEnvironmentDeleteable" ID="VirtualenvManager.__isEnvironmentDeleteable"></a> | |
| 208 <h4>VirtualenvManager.__isEnvironmentDeleteable</h4> | |
| 209 <b>__isEnvironmentDeleteable</b>(<i>venvName</i>) | |
| 210 | |
| 211 <p> | |
| 212 Private method to check, if a virtual environment can be deleted from | |
| 213 disk. | |
| 214 </p> | |
| 215 <dl> | |
| 216 | |
| 217 <dt><i>venvName</i> (str)</dt> | |
| 218 <dd> | |
| 219 name of the virtual environment | |
| 220 </dd> | |
| 221 </dl> | |
| 222 <dl> | |
| 223 <dt>Return:</dt> | |
| 224 <dd> | |
| 225 flag indicating it can be deleted | |
| 226 </dd> | |
| 227 </dl> | |
| 228 <dl> | |
| 229 <dt>Return Type:</dt> | |
| 230 <dd> | |
| 231 bool | |
| 232 </dd> | |
| 233 </dl> | |
| 234 <a NAME="VirtualenvManager.__loadSettings" ID="VirtualenvManager.__loadSettings"></a> | |
| 235 <h4>VirtualenvManager.__loadSettings</h4> | |
| 236 <b>__loadSettings</b>(<i></i>) | |
| 237 | |
| 238 <p> | |
| 239 Private slot to load the virtual environments. | |
| 240 </p> | |
| 241 <a NAME="VirtualenvManager.__saveSettings" ID="VirtualenvManager.__saveSettings"></a> | |
| 242 <h4>VirtualenvManager.__saveSettings</h4> | |
| 243 <b>__saveSettings</b>(<i></i>) | |
| 244 | |
| 245 <p> | |
| 246 Private slot to save the virtual environments. | |
| 247 </p> | |
| 248 <a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> | |
| 249 <h4>VirtualenvManager.addVirtualEnv</h4> | |
| 250 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", isGlobal=False, isConda=False, isRemote=False, execPath=""</i>) | |
| 251 | |
| 252 <p> | |
| 253 Public method to add a virtual environment. | |
| 254 </p> | |
| 255 <dl> | |
| 256 | |
| 257 <dt><i>venvName</i> (str)</dt> | |
| 258 <dd> | |
| 259 logical name for the virtual environment | |
| 260 </dd> | |
| 261 <dt><i>venvDirectory</i> (str)</dt> | |
| 262 <dd> | |
| 263 directory of the virtual environment | |
| 264 </dd> | |
| 265 <dt><i>venvInterpreter</i> (str)</dt> | |
| 266 <dd> | |
| 267 interpreter of the virtual environment | |
| 268 </dd> | |
| 269 <dt><i>isGlobal</i> (bool)</dt> | |
| 270 <dd> | |
| 271 flag indicating a global environment | |
| 272 </dd> | |
| 273 <dt><i>isConda</i> (bool)</dt> | |
| 274 <dd> | |
| 275 flag indicating an Anaconda virtual environment | |
| 276 </dd> | |
| 277 <dt><i>isRemote</i> (bool)</dt> | |
| 278 <dd> | |
| 279 flag indicating a remotely accessed environment | |
| 280 </dd> | |
| 281 <dt><i>execPath</i> (str)</dt> | |
| 282 <dd> | |
| 283 search path string to be prepended to the PATH | |
| 284 environment variable | |
| 285 </dd> | |
| 286 </dl> | |
| 287 <a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a> | |
| 288 <h4>VirtualenvManager.createVirtualEnv</h4> | |
| 289 <b>createVirtualEnv</b>(<i>baseDir=""</i>) | |
| 290 | |
| 291 <p> | |
| 292 Public slot to create a new virtual environment. | |
| 293 </p> | |
| 294 <dl> | |
| 295 | |
| 296 <dt><i>baseDir</i> (str)</dt> | |
| 297 <dd> | |
| 298 base directory for the virtual environments | |
| 299 </dd> | |
| 300 </dl> | |
| 301 <a NAME="VirtualenvManager.deleteVirtualEnvs" ID="VirtualenvManager.deleteVirtualEnvs"></a> | |
| 302 <h4>VirtualenvManager.deleteVirtualEnvs</h4> | |
| 303 <b>deleteVirtualEnvs</b>(<i>venvNames</i>) | |
| 304 | |
| 305 <p> | |
| 306 Public method to delete virtual environments from the list and disk. | |
| 307 </p> | |
| 308 <dl> | |
| 309 | |
| 310 <dt><i>venvNames</i> (list of str)</dt> | |
| 311 <dd> | |
| 312 list of logical names for the virtual environments | |
| 313 </dd> | |
| 314 </dl> | |
| 315 <a NAME="VirtualenvManager.getDefaultEnvironment" ID="VirtualenvManager.getDefaultEnvironment"></a> | |
| 316 <h4>VirtualenvManager.getDefaultEnvironment</h4> | |
| 317 <b>getDefaultEnvironment</b>(<i></i>) | |
| 318 | |
| 319 <p> | |
| 320 Public method to get the default virtual environment. | |
| 321 </p> | |
| 322 <p> | |
| 323 Default is an environment with the key '<default>' or the first one | |
| 324 having an interpreter matching sys.executable (i.e. the one used to | |
| 325 execute eric with) | |
| 326 </p> | |
| 327 <dl> | |
| 328 <dt>Return:</dt> | |
| 329 <dd> | |
| 330 tuple containing the environment name and a dictionary | |
| 331 containing a copy of the default virtual environment | |
| 332 </dd> | |
| 333 </dl> | |
| 334 <dl> | |
| 335 <dt>Return Type:</dt> | |
| 336 <dd> | |
| 337 tuple of (str, dict) | |
| 338 </dd> | |
| 339 </dl> | |
| 340 <a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a> | |
| 341 <h4>VirtualenvManager.getEnvironmentEntries</h4> | |
| 342 <b>getEnvironmentEntries</b>(<i></i>) | |
| 343 | |
| 344 <p> | |
| 345 Public method to get a dictionary containing the defined virtual | |
| 346 environment entries. | |
| 347 </p> | |
| 348 <dl> | |
| 349 <dt>Return:</dt> | |
| 350 <dd> | |
| 351 dictionary containing a copy of the defined virtual | |
| 352 environments | |
| 353 </dd> | |
| 354 </dl> | |
| 355 <dl> | |
| 356 <dt>Return Type:</dt> | |
| 357 <dd> | |
| 358 dict | |
| 359 </dd> | |
| 360 </dl> | |
| 361 <a NAME="VirtualenvManager.getVirtualEnvironmentsBaseDir" ID="VirtualenvManager.getVirtualEnvironmentsBaseDir"></a> | |
| 362 <h4>VirtualenvManager.getVirtualEnvironmentsBaseDir</h4> | |
| 363 <b>getVirtualEnvironmentsBaseDir</b>(<i></i>) | |
| 364 | |
| 365 <p> | |
| 366 Public method to set the base directory for the virtual environments. | |
| 367 </p> | |
| 368 <dl> | |
| 369 <dt>Return:</dt> | |
| 370 <dd> | |
| 371 base directory for the virtual environments | |
| 372 </dd> | |
| 373 </dl> | |
| 374 <dl> | |
| 375 <dt>Return Type:</dt> | |
| 376 <dd> | |
| 377 str | |
| 378 </dd> | |
| 379 </dl> | |
| 380 <a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a> | |
| 381 <h4>VirtualenvManager.getVirtualenvDirectory</h4> | |
| 382 <b>getVirtualenvDirectory</b>(<i>venvName</i>) | |
| 383 | |
| 384 <p> | |
| 385 Public method to get the directory of a virtual environment. | |
| 386 </p> | |
| 387 <dl> | |
| 388 | |
| 389 <dt><i>venvName</i> (str)</dt> | |
| 390 <dd> | |
| 391 logical name for the virtual environment | |
| 392 </dd> | |
| 393 </dl> | |
| 394 <dl> | |
| 395 <dt>Return:</dt> | |
| 396 <dd> | |
| 397 directory path | |
| 398 </dd> | |
| 399 </dl> | |
| 400 <dl> | |
| 401 <dt>Return Type:</dt> | |
| 402 <dd> | |
| 403 str | |
| 404 </dd> | |
| 405 </dl> | |
| 406 <a NAME="VirtualenvManager.getVirtualenvExecPath" ID="VirtualenvManager.getVirtualenvExecPath"></a> | |
| 407 <h4>VirtualenvManager.getVirtualenvExecPath</h4> | |
| 408 <b>getVirtualenvExecPath</b>(<i>venvName</i>) | |
| 409 | |
| 410 <p> | |
| 411 Public method to get the search path prefix of a virtual environment. | |
| 412 </p> | |
| 413 <dl> | |
| 414 | |
| 415 <dt><i>venvName</i> (str)</dt> | |
| 416 <dd> | |
| 417 logical name for the virtual environment | |
| 418 </dd> | |
| 419 </dl> | |
| 420 <dl> | |
| 421 <dt>Return:</dt> | |
| 422 <dd> | |
| 423 search path prefix | |
| 424 </dd> | |
| 425 </dl> | |
| 426 <dl> | |
| 427 <dt>Return Type:</dt> | |
| 428 <dd> | |
| 429 str | |
| 430 </dd> | |
| 431 </dl> | |
| 432 <a NAME="VirtualenvManager.getVirtualenvInterpreter" ID="VirtualenvManager.getVirtualenvInterpreter"></a> | |
| 433 <h4>VirtualenvManager.getVirtualenvInterpreter</h4> | |
| 434 <b>getVirtualenvInterpreter</b>(<i>venvName</i>) | |
| 435 | |
| 436 <p> | |
| 437 Public method to get the interpreter for a virtual environment. | |
| 438 </p> | |
| 439 <dl> | |
| 440 | |
| 441 <dt><i>venvName</i> (str)</dt> | |
| 442 <dd> | |
| 443 logical name for the virtual environment | |
| 444 </dd> | |
| 445 </dl> | |
| 446 <dl> | |
| 447 <dt>Return:</dt> | |
| 448 <dd> | |
| 449 interpreter path | |
| 450 </dd> | |
| 451 </dl> | |
| 452 <dl> | |
| 453 <dt>Return Type:</dt> | |
| 454 <dd> | |
| 455 str | |
| 456 </dd> | |
| 457 </dl> | |
| 458 <a NAME="VirtualenvManager.getVirtualenvNames" ID="VirtualenvManager.getVirtualenvNames"></a> | |
| 459 <h4>VirtualenvManager.getVirtualenvNames</h4> | |
| 460 <b>getVirtualenvNames</b>(<i>noRemote=False, noConda=False</i>) | |
| 461 | |
| 462 <p> | |
| 463 Public method to get a list of defined virtual environments. | |
| 464 </p> | |
| 465 <dl> | |
| 466 | |
| 467 <dt><i>noRemote</i> (bool)</dt> | |
| 468 <dd> | |
| 469 flag indicating to exclude environments for remote | |
| 470 debugging | |
| 471 </dd> | |
| 472 <dt><i>noConda</i> (bool)</dt> | |
| 473 <dd> | |
| 474 flag indicating to exclude Conda environments | |
| 475 </dd> | |
| 476 </dl> | |
| 477 <dl> | |
| 478 <dt>Return:</dt> | |
| 479 <dd> | |
| 480 list of defined virtual environments | |
| 481 </dd> | |
| 482 </dl> | |
| 483 <dl> | |
| 484 <dt>Return Type:</dt> | |
| 485 <dd> | |
| 486 list of str | |
| 487 </dd> | |
| 488 </dl> | |
| 489 <a NAME="VirtualenvManager.isCondaEnvironment" ID="VirtualenvManager.isCondaEnvironment"></a> | |
| 490 <h4>VirtualenvManager.isCondaEnvironment</h4> | |
| 491 <b>isCondaEnvironment</b>(<i>venvName</i>) | |
| 492 | |
| 493 <p> | |
| 494 Public method to test, if a given environment is an Anaconda | |
| 495 environment. | |
| 496 </p> | |
| 497 <dl> | |
| 498 | |
| 499 <dt><i>venvName</i> (str)</dt> | |
| 500 <dd> | |
| 501 logical name of the virtual environment | |
| 502 </dd> | |
| 503 </dl> | |
| 504 <dl> | |
| 505 <dt>Return:</dt> | |
| 506 <dd> | |
| 507 flag indicating an Anaconda environment | |
| 508 </dd> | |
| 509 </dl> | |
| 510 <dl> | |
| 511 <dt>Return Type:</dt> | |
| 512 <dd> | |
| 513 bool | |
| 514 </dd> | |
| 515 </dl> | |
| 516 <a NAME="VirtualenvManager.isGlobalEnvironment" ID="VirtualenvManager.isGlobalEnvironment"></a> | |
| 517 <h4>VirtualenvManager.isGlobalEnvironment</h4> | |
| 518 <b>isGlobalEnvironment</b>(<i>venvName</i>) | |
| 519 | |
| 520 <p> | |
| 521 Public method to test, if a given environment is a global one. | |
| 522 </p> | |
| 523 <dl> | |
| 524 | |
| 525 <dt><i>venvName</i> (str)</dt> | |
| 526 <dd> | |
| 527 logical name of the virtual environment | |
| 528 </dd> | |
| 529 </dl> | |
| 530 <dl> | |
| 531 <dt>Return:</dt> | |
| 532 <dd> | |
| 533 flag indicating a global environment | |
| 534 </dd> | |
| 535 </dl> | |
| 536 <dl> | |
| 537 <dt>Return Type:</dt> | |
| 538 <dd> | |
| 539 bool | |
| 540 </dd> | |
| 541 </dl> | |
| 542 <a NAME="VirtualenvManager.isRemoteEnvironment" ID="VirtualenvManager.isRemoteEnvironment"></a> | |
| 543 <h4>VirtualenvManager.isRemoteEnvironment</h4> | |
| 544 <b>isRemoteEnvironment</b>(<i>venvName</i>) | |
| 545 | |
| 546 <p> | |
| 547 Public method to test, if a given environment is a remotely accessed | |
| 548 environment. | |
| 549 </p> | |
| 550 <dl> | |
| 551 | |
| 552 <dt><i>venvName</i> (str)</dt> | |
| 553 <dd> | |
| 554 logical name of the virtual environment | |
| 555 </dd> | |
| 556 </dl> | |
| 557 <dl> | |
| 558 <dt>Return:</dt> | |
| 559 <dd> | |
| 560 flag indicating a remotely accessed environment | |
| 561 </dd> | |
| 562 </dl> | |
| 563 <dl> | |
| 564 <dt>Return Type:</dt> | |
| 565 <dd> | |
| 566 bool | |
| 567 </dd> | |
| 568 </dl> | |
| 569 <a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a> | |
| 570 <h4>VirtualenvManager.isUnique</h4> | |
| 571 <b>isUnique</b>(<i>venvName</i>) | |
| 572 | |
| 573 <p> | |
| 574 Public method to check, if the give logical name is unique. | |
| 575 </p> | |
| 576 <dl> | |
| 577 | |
| 578 <dt><i>venvName</i> (str)</dt> | |
| 579 <dd> | |
| 580 logical name for the virtual environment | |
| 581 </dd> | |
| 582 </dl> | |
| 583 <dl> | |
| 584 <dt>Return:</dt> | |
| 585 <dd> | |
| 586 flag indicating uniqueness | |
| 587 </dd> | |
| 588 </dl> | |
| 589 <dl> | |
| 590 <dt>Return Type:</dt> | |
| 591 <dd> | |
| 592 bool | |
| 593 </dd> | |
| 594 </dl> | |
| 595 <a NAME="VirtualenvManager.removeVirtualEnvs" ID="VirtualenvManager.removeVirtualEnvs"></a> | |
| 596 <h4>VirtualenvManager.removeVirtualEnvs</h4> | |
| 597 <b>removeVirtualEnvs</b>(<i>venvNames</i>) | |
| 598 | |
| 599 <p> | |
| 600 Public method to delete virtual environment from the list. | |
| 601 </p> | |
| 602 <dl> | |
| 603 | |
| 604 <dt><i>venvNames</i> (list of str)</dt> | |
| 605 <dd> | |
| 606 list of logical names for the virtual environments | |
| 607 </dd> | |
| 608 </dl> | |
| 609 <a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> | |
| 610 <h4>VirtualenvManager.renameVirtualEnv</h4> | |
| 611 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, isGlobal, isConda, isRemote, execPath</i>) | |
| 612 | |
| 613 <p> | |
| 614 Public method to substitute a virtual environment entry with a new | |
| 615 name. | |
| 616 </p> | |
| 617 <dl> | |
| 618 | |
| 619 <dt><i>oldVenvName</i> (str)</dt> | |
| 620 <dd> | |
| 621 old name of the virtual environment | |
| 622 </dd> | |
| 623 <dt><i>venvName</i> (str)</dt> | |
| 624 <dd> | |
| 625 logical name for the virtual environment | |
| 626 </dd> | |
| 627 <dt><i>venvDirectory</i> (str)</dt> | |
| 628 <dd> | |
| 629 directory of the virtual environment | |
| 630 </dd> | |
| 631 <dt><i>venvInterpreter</i> (str)</dt> | |
| 632 <dd> | |
| 633 interpreter of the virtual environment | |
| 634 </dd> | |
| 635 <dt><i>isGlobal</i> (bool)</dt> | |
| 636 <dd> | |
| 637 flag indicating a global environment | |
| 638 </dd> | |
| 639 <dt><i>isConda</i> (bool)</dt> | |
| 640 <dd> | |
| 641 flag indicating an Anaconda virtual environment | |
| 642 </dd> | |
| 643 <dt><i>isRemote</i> (bool)</dt> | |
| 644 <dd> | |
| 645 flag indicating a remotely accessed environment | |
| 646 </dd> | |
| 647 <dt><i>execPath</i> (str)</dt> | |
| 648 <dd> | |
| 649 search path string to be prepended to the PATH | |
| 650 environment variable | |
| 651 </dd> | |
| 652 </dl> | |
| 653 <a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> | |
| 654 <h4>VirtualenvManager.setVirtualEnv</h4> | |
| 655 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, isGlobal, isConda, isRemote, execPath</i>) | |
| 656 | |
| 657 <p> | |
| 658 Public method to change a virtual environment. | |
| 659 </p> | |
| 660 <dl> | |
| 661 | |
| 662 <dt><i>venvName</i> (str)</dt> | |
| 663 <dd> | |
| 664 logical name of the virtual environment | |
| 665 </dd> | |
| 666 <dt><i>venvDirectory</i> (str)</dt> | |
| 667 <dd> | |
| 668 directory of the virtual environment | |
| 669 </dd> | |
| 670 <dt><i>venvInterpreter</i> (str)</dt> | |
| 671 <dd> | |
| 672 interpreter of the virtual environment | |
| 673 </dd> | |
| 674 <dt><i>isGlobal</i> (bool)</dt> | |
| 675 <dd> | |
| 676 flag indicating a global environment | |
| 677 </dd> | |
| 678 <dt><i>isConda</i> (bool)</dt> | |
| 679 <dd> | |
| 680 flag indicating an Anaconda virtual environment | |
| 681 </dd> | |
| 682 <dt><i>isRemote</i> (bool)</dt> | |
| 683 <dd> | |
| 684 flag indicating a remotely accessed environment | |
| 685 </dd> | |
| 686 <dt><i>execPath</i> (str)</dt> | |
| 687 <dd> | |
| 688 search path string to be prepended to the PATH | |
| 689 environment variable | |
| 690 </dd> | |
| 691 </dl> | |
| 692 <a NAME="VirtualenvManager.setVirtualEnvironmentsBaseDir" ID="VirtualenvManager.setVirtualEnvironmentsBaseDir"></a> | |
| 693 <h4>VirtualenvManager.setVirtualEnvironmentsBaseDir</h4> | |
| 694 <b>setVirtualEnvironmentsBaseDir</b>(<i>baseDir</i>) | |
| 695 | |
| 696 <p> | |
| 697 Public method to set the base directory for the virtual environments. | |
| 698 </p> | |
| 699 <dl> | |
| 700 | |
| 701 <dt><i>baseDir</i> (str)</dt> | |
| 702 <dd> | |
| 703 base directory for the virtual environments | |
| 704 </dd> | |
| 705 </dl> | |
| 706 <a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a> | |
| 707 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4> | |
| 708 <b>showVirtualenvManagerDialog</b>(<i>modal=False</i>) | |
| 709 | |
| 710 <p> | |
| 711 Public slot to show the virtual environment manager dialog. | |
| 712 </p> | |
| 713 <dl> | |
| 714 | |
| 715 <dt><i>modal</i></dt> | |
| 716 <dd> | |
| 717 flag indicating that the dialog should be shown in | |
| 718 a blocking mode | |
| 719 </dd> | |
| 720 </dl> | |
| 721 <a NAME="VirtualenvManager.shutdown" ID="VirtualenvManager.shutdown"></a> | |
| 722 <h4>VirtualenvManager.shutdown</h4> | |
| 723 <b>shutdown</b>(<i></i>) | |
| 724 | |
| 725 <p> | |
| 726 Public method to shutdown the manager. | |
| 727 </p> | |
| 728 <div align="right"><a href="#top">Up</a></div> | |
| 729 <hr /> | |
| 730 </body></html> |
