Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

changeset 6716
1c9d3b369ea8
parent 6576
ea60ea85067a
child 6807
7e5eba19d86d
equal deleted inserted replaced
6711:a3aec8edaef5 6716:1c9d3b369ea8
103 <td>Public method to test, if a given environment is an Anaconda environment.</td> 103 <td>Public method to test, if a given environment is an Anaconda environment.</td>
104 </tr><tr> 104 </tr><tr>
105 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td> 105 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td>
106 <td>Public method to test, if a given environment is a global one.</td> 106 <td>Public method to test, if a given environment is a global one.</td>
107 </tr><tr> 107 </tr><tr>
108 <td><a href="#VirtualenvManager.isRemoteEnvironment">isRemoteEnvironment</a></td>
109 <td>Public method to test, if a given environment is a remotely accessed environment.</td>
110 </tr><tr>
108 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td> 111 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td>
109 <td>Public method to check, if the give logical name is unique.</td> 112 <td>Public method to check, if the give logical name is unique.</td>
110 </tr><tr> 113 </tr><tr>
111 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td> 114 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td>
112 <td>Public method to delete virtual environment from the list.</td> 115 <td>Public method to delete virtual environment from the list.</td>
169 <b>__saveSettings</b>(<i></i>) 172 <b>__saveSettings</b>(<i></i>)
170 <p> 173 <p>
171 Private slot to save the virtual environments. 174 Private slot to save the virtual environments.
172 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> 175 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a>
173 <h4>VirtualenvManager.addVirtualEnv</h4> 176 <h4>VirtualenvManager.addVirtualEnv</h4>
174 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, execPath=""</i>) 177 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, isRemote=False, execPath=""</i>)
175 <p> 178 <p>
176 Public method to add a virtual environment. 179 Public method to add a virtual environment.
177 </p><dl> 180 </p><dl>
178 <dt><i>venvName</i> (str)</dt> 181 <dt><i>venvName</i> (str)</dt>
179 <dd> 182 <dd>
191 <dd> 194 <dd>
192 flag indicating a global environment 195 flag indicating a global environment
193 </dd><dt><i>isConda</i> (bool)</dt> 196 </dd><dt><i>isConda</i> (bool)</dt>
194 <dd> 197 <dd>
195 flag indicating an Anaconda virtual environment 198 flag indicating an Anaconda virtual environment
199 </dd><dt><i>isRemote</i> (bool)</dt>
200 <dd>
201 flag indicating a remotely accessed environment
196 </dd><dt><i>execPath</i> (str)</dt> 202 </dd><dt><i>execPath</i> (str)</dt>
197 <dd> 203 <dd>
198 search path string to be prepended to the PATH 204 search path string to be prepended to the PATH
199 environment variable 205 environment variable
200 </dd> 206 </dd>
385 </dl><dl> 391 </dl><dl>
386 <dt>Return Type:</dt> 392 <dt>Return Type:</dt>
387 <dd> 393 <dd>
388 bool 394 bool
389 </dd> 395 </dd>
396 </dl><a NAME="VirtualenvManager.isRemoteEnvironment" ID="VirtualenvManager.isRemoteEnvironment"></a>
397 <h4>VirtualenvManager.isRemoteEnvironment</h4>
398 <b>isRemoteEnvironment</b>(<i>venvName</i>)
399 <p>
400 Public method to test, if a given environment is a remotely accessed
401 environment.
402 </p><dl>
403 <dt><i>venvName</i> (str)</dt>
404 <dd>
405 logical name of the virtual environment
406 </dd>
407 </dl><dl>
408 <dt>Returns:</dt>
409 <dd>
410 flag indicating a remotely accessed environment
411 </dd>
412 </dl><dl>
413 <dt>Return Type:</dt>
414 <dd>
415 bool
416 </dd>
390 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a> 417 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a>
391 <h4>VirtualenvManager.isUnique</h4> 418 <h4>VirtualenvManager.isUnique</h4>
392 <b>isUnique</b>(<i>venvName</i>) 419 <b>isUnique</b>(<i>venvName</i>)
393 <p> 420 <p>
394 Public method to check, if the give logical name is unique. 421 Public method to check, if the give logical name is unique.
417 <dd> 444 <dd>
418 list of logical names for the virtual environments 445 list of logical names for the virtual environments
419 </dd> 446 </dd>
420 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> 447 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
421 <h4>VirtualenvManager.renameVirtualEnv</h4> 448 <h4>VirtualenvManager.renameVirtualEnv</h4>
422 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, execPath</i>) 449 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>)
423 <p> 450 <p>
424 Public method to substitute a virtual environment entry with a new 451 Public method to substitute a virtual environment entry with a new
425 name. 452 name.
426 </p><dl> 453 </p><dl>
427 <dt><i>oldVenvName</i> (str)</dt> 454 <dt><i>oldVenvName</i> (str)</dt>
443 <dd> 470 <dd>
444 flag indicating a global environment 471 flag indicating a global environment
445 </dd><dt><i>isConda</i> (bool)</dt> 472 </dd><dt><i>isConda</i> (bool)</dt>
446 <dd> 473 <dd>
447 flag indicating an Anaconda virtual environment 474 flag indicating an Anaconda virtual environment
475 </dd><dt><i>isRemote</i> (bool)</dt>
476 <dd>
477 flag indicating a remotely accessed environment
448 </dd><dt><i>execPath</i> (str)</dt> 478 </dd><dt><i>execPath</i> (str)</dt>
449 <dd> 479 <dd>
450 search path string to be prepended to the PATH 480 search path string to be prepended to the PATH
451 environment variable 481 environment variable
452 </dd> 482 </dd>
453 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> 483 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
454 <h4>VirtualenvManager.setVirtualEnv</h4> 484 <h4>VirtualenvManager.setVirtualEnv</h4>
455 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, execPath</i>) 485 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>)
456 <p> 486 <p>
457 Public method to change a virtual environment. 487 Public method to change a virtual environment.
458 </p><dl> 488 </p><dl>
459 <dt><i>venvName</i> (str)</dt> 489 <dt><i>venvName</i> (str)</dt>
460 <dd> 490 <dd>
472 <dd> 502 <dd>
473 flag indicating a global environment 503 flag indicating a global environment
474 </dd><dt><i>isConda</i> (bool)</dt> 504 </dd><dt><i>isConda</i> (bool)</dt>
475 <dd> 505 <dd>
476 flag indicating an Anaconda virtual environment 506 flag indicating an Anaconda virtual environment
507 </dd><dt><i>isRemote</i> (bool)</dt>
508 <dd>
509 flag indicating a remotely accessed environment
477 </dd><dt><i>execPath</i> (str)</dt> 510 </dd><dt><i>execPath</i> (str)</dt>
478 <dd> 511 <dd>
479 search path string to be prepended to the PATH 512 search path string to be prepended to the PATH
480 environment variable 513 environment variable
481 </dd> 514 </dd>

eric ide

mercurial