Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html
eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html
- branch
- maintenance
- changeset 8043
- 0acf98cd089a
- parent 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7991:866adc8c315b | 8043:0acf98cd089a |
|---|---|
| 122 <tr> | 122 <tr> |
| 123 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td> | 123 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td> |
| 124 <td>Public method to get a dictionary containing the defined virtual environment entries.</td> | 124 <td>Public method to get a dictionary containing the defined virtual environment entries.</td> |
| 125 </tr> | 125 </tr> |
| 126 <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> | |
| 127 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td> | 131 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td> |
| 128 <td>Public method to get the directory of a virtual environment.</td> | 132 <td>Public method to get the directory of a virtual environment.</td> |
| 129 </tr> | 133 </tr> |
| 130 <tr> | 134 <tr> |
| 131 <td><a href="#VirtualenvManager.getVirtualenvExecPath">getVirtualenvExecPath</a></td> | 135 <td><a href="#VirtualenvManager.getVirtualenvExecPath">getVirtualenvExecPath</a></td> |
| 164 <td>Public method to substitute a virtual environment entry with a new name.</td> | 168 <td>Public method to substitute a virtual environment entry with a new name.</td> |
| 165 </tr> | 169 </tr> |
| 166 <tr> | 170 <tr> |
| 167 <td><a href="#VirtualenvManager.setVirtualEnv">setVirtualEnv</a></td> | 171 <td><a href="#VirtualenvManager.setVirtualEnv">setVirtualEnv</a></td> |
| 168 <td>Public method to change a virtual environment.</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> | |
| 169 </tr> | 177 </tr> |
| 170 <tr> | 178 <tr> |
| 171 <td><a href="#VirtualenvManager.showVirtualenvManagerDialog">showVirtualenvManagerDialog</a></td> | 179 <td><a href="#VirtualenvManager.showVirtualenvManagerDialog">showVirtualenvManagerDialog</a></td> |
| 172 <td>Public slot to show the virtual environment manager dialog.</td> | 180 <td>Public slot to show the virtual environment manager dialog.</td> |
| 173 </tr> | 181 </tr> |
| 210 <dd> | 218 <dd> |
| 211 name of the virtual environment | 219 name of the virtual environment |
| 212 </dd> | 220 </dd> |
| 213 </dl> | 221 </dl> |
| 214 <dl> | 222 <dl> |
| 215 <dt>Returns:</dt> | 223 <dt>Return:</dt> |
| 216 <dd> | 224 <dd> |
| 217 flag indicating it can be deleted | 225 flag indicating it can be deleted |
| 218 </dd> | 226 </dd> |
| 219 </dl> | 227 </dl> |
| 220 <dl> | 228 <dl> |
| 276 environment variable | 284 environment variable |
| 277 </dd> | 285 </dd> |
| 278 </dl> | 286 </dl> |
| 279 <a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a> | 287 <a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a> |
| 280 <h4>VirtualenvManager.createVirtualEnv</h4> | 288 <h4>VirtualenvManager.createVirtualEnv</h4> |
| 281 <b>createVirtualEnv</b>(<i></i>) | 289 <b>createVirtualEnv</b>(<i>baseDir=""</i>) |
| 282 | 290 |
| 283 <p> | 291 <p> |
| 284 Public slot to create a new virtual environment. | 292 Public slot to create a new virtual environment. |
| 285 </p> | 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> | |
| 286 <a NAME="VirtualenvManager.deleteVirtualEnvs" ID="VirtualenvManager.deleteVirtualEnvs"></a> | 301 <a NAME="VirtualenvManager.deleteVirtualEnvs" ID="VirtualenvManager.deleteVirtualEnvs"></a> |
| 287 <h4>VirtualenvManager.deleteVirtualEnvs</h4> | 302 <h4>VirtualenvManager.deleteVirtualEnvs</h4> |
| 288 <b>deleteVirtualEnvs</b>(<i>venvNames</i>) | 303 <b>deleteVirtualEnvs</b>(<i>venvNames</i>) |
| 289 | 304 |
| 290 <p> | 305 <p> |
| 305 Public method to get the default virtual environment. | 320 Public method to get the default virtual environment. |
| 306 </p> | 321 </p> |
| 307 <p> | 322 <p> |
| 308 Default is an environment with the key '<default>' or the first one | 323 Default is an environment with the key '<default>' or the first one |
| 309 having an interpreter matching sys.executable (i.e. the one used to | 324 having an interpreter matching sys.executable (i.e. the one used to |
| 310 execute eric6 with) | 325 execute eric with) |
| 311 </p> | 326 </p> |
| 312 <dl> | 327 <dl> |
| 313 <dt>Returns:</dt> | 328 <dt>Return:</dt> |
| 314 <dd> | 329 <dd> |
| 315 tuple containing the environment name and a dictionary | 330 tuple containing the environment name and a dictionary |
| 316 containing a copy of the default virtual environment | 331 containing a copy of the default virtual environment |
| 317 </dd> | 332 </dd> |
| 318 </dl> | 333 </dl> |
| 329 <p> | 344 <p> |
| 330 Public method to get a dictionary containing the defined virtual | 345 Public method to get a dictionary containing the defined virtual |
| 331 environment entries. | 346 environment entries. |
| 332 </p> | 347 </p> |
| 333 <dl> | 348 <dl> |
| 334 <dt>Returns:</dt> | 349 <dt>Return:</dt> |
| 335 <dd> | 350 <dd> |
| 336 dictionary containing a copy of the defined virtual | 351 dictionary containing a copy of the defined virtual |
| 337 environments | 352 environments |
| 338 </dd> | 353 </dd> |
| 339 </dl> | 354 </dl> |
| 340 <dl> | 355 <dl> |
| 341 <dt>Return Type:</dt> | 356 <dt>Return Type:</dt> |
| 342 <dd> | 357 <dd> |
| 343 dict | 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 | |
| 344 </dd> | 378 </dd> |
| 345 </dl> | 379 </dl> |
| 346 <a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a> | 380 <a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a> |
| 347 <h4>VirtualenvManager.getVirtualenvDirectory</h4> | 381 <h4>VirtualenvManager.getVirtualenvDirectory</h4> |
| 348 <b>getVirtualenvDirectory</b>(<i>venvName</i>) | 382 <b>getVirtualenvDirectory</b>(<i>venvName</i>) |
| 356 <dd> | 390 <dd> |
| 357 logical name for the virtual environment | 391 logical name for the virtual environment |
| 358 </dd> | 392 </dd> |
| 359 </dl> | 393 </dl> |
| 360 <dl> | 394 <dl> |
| 361 <dt>Returns:</dt> | 395 <dt>Return:</dt> |
| 362 <dd> | 396 <dd> |
| 363 directory path | 397 directory path |
| 364 </dd> | 398 </dd> |
| 365 </dl> | 399 </dl> |
| 366 <dl> | 400 <dl> |
| 382 <dd> | 416 <dd> |
| 383 logical name for the virtual environment | 417 logical name for the virtual environment |
| 384 </dd> | 418 </dd> |
| 385 </dl> | 419 </dl> |
| 386 <dl> | 420 <dl> |
| 387 <dt>Returns:</dt> | 421 <dt>Return:</dt> |
| 388 <dd> | 422 <dd> |
| 389 search path prefix | 423 search path prefix |
| 390 </dd> | 424 </dd> |
| 391 </dl> | 425 </dl> |
| 392 <dl> | 426 <dl> |
| 408 <dd> | 442 <dd> |
| 409 logical name for the virtual environment | 443 logical name for the virtual environment |
| 410 </dd> | 444 </dd> |
| 411 </dl> | 445 </dl> |
| 412 <dl> | 446 <dl> |
| 413 <dt>Returns:</dt> | 447 <dt>Return:</dt> |
| 414 <dd> | 448 <dd> |
| 415 interpreter path | 449 interpreter path |
| 416 </dd> | 450 </dd> |
| 417 </dl> | 451 </dl> |
| 418 <dl> | 452 <dl> |
| 439 <dd> | 473 <dd> |
| 440 flag indicating to exclude Conda environments | 474 flag indicating to exclude Conda environments |
| 441 </dd> | 475 </dd> |
| 442 </dl> | 476 </dl> |
| 443 <dl> | 477 <dl> |
| 444 <dt>Returns:</dt> | 478 <dt>Return:</dt> |
| 445 <dd> | 479 <dd> |
| 446 list of defined virtual environments | 480 list of defined virtual environments |
| 447 </dd> | 481 </dd> |
| 448 </dl> | 482 </dl> |
| 449 <dl> | 483 <dl> |
| 466 <dd> | 500 <dd> |
| 467 logical name of the virtual environment | 501 logical name of the virtual environment |
| 468 </dd> | 502 </dd> |
| 469 </dl> | 503 </dl> |
| 470 <dl> | 504 <dl> |
| 471 <dt>Returns:</dt> | 505 <dt>Return:</dt> |
| 472 <dd> | 506 <dd> |
| 473 flag indicating an Anaconda environment | 507 flag indicating an Anaconda environment |
| 474 </dd> | 508 </dd> |
| 475 </dl> | 509 </dl> |
| 476 <dl> | 510 <dl> |
| 492 <dd> | 526 <dd> |
| 493 logical name of the virtual environment | 527 logical name of the virtual environment |
| 494 </dd> | 528 </dd> |
| 495 </dl> | 529 </dl> |
| 496 <dl> | 530 <dl> |
| 497 <dt>Returns:</dt> | 531 <dt>Return:</dt> |
| 498 <dd> | 532 <dd> |
| 499 flag indicating a global environment | 533 flag indicating a global environment |
| 500 </dd> | 534 </dd> |
| 501 </dl> | 535 </dl> |
| 502 <dl> | 536 <dl> |
| 519 <dd> | 553 <dd> |
| 520 logical name of the virtual environment | 554 logical name of the virtual environment |
| 521 </dd> | 555 </dd> |
| 522 </dl> | 556 </dl> |
| 523 <dl> | 557 <dl> |
| 524 <dt>Returns:</dt> | 558 <dt>Return:</dt> |
| 525 <dd> | 559 <dd> |
| 526 flag indicating a remotely accessed environment | 560 flag indicating a remotely accessed environment |
| 527 </dd> | 561 </dd> |
| 528 </dl> | 562 </dl> |
| 529 <dl> | 563 <dl> |
| 545 <dd> | 579 <dd> |
| 546 logical name for the virtual environment | 580 logical name for the virtual environment |
| 547 </dd> | 581 </dd> |
| 548 </dl> | 582 </dl> |
| 549 <dl> | 583 <dl> |
| 550 <dt>Returns:</dt> | 584 <dt>Return:</dt> |
| 551 <dd> | 585 <dd> |
| 552 flag indicating uniqueness | 586 flag indicating uniqueness |
| 553 </dd> | 587 </dd> |
| 554 </dl> | 588 </dl> |
| 555 <dl> | 589 <dl> |
| 653 <dd> | 687 <dd> |
| 654 search path string to be prepended to the PATH | 688 search path string to be prepended to the PATH |
| 655 environment variable | 689 environment variable |
| 656 </dd> | 690 </dd> |
| 657 </dl> | 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> | |
| 658 <a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a> | 706 <a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a> |
| 659 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4> | 707 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4> |
| 660 <b>showVirtualenvManagerDialog</b>(<i>modal=False</i>) | 708 <b>showVirtualenvManagerDialog</b>(<i>modal=False</i>) |
| 661 | 709 |
| 662 <p> | 710 <p> |
