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