Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

changeset 6576
ea60ea85067a
parent 6503
e617c58807e8
child 6716
1c9d3b369ea8
--- a/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html	Sat Nov 03 14:16:43 2018 +0100
+++ b/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html	Sat Nov 03 14:19:21 2018 +0100
@@ -87,6 +87,9 @@
 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td>
 <td>Public method to get the directory of a virtual environment.</td>
 </tr><tr>
+<td><a href="#VirtualenvManager.getVirtualenvExecPath">getVirtualenvExecPath</a></td>
+<td>Public method to get the search path prefix of a virtual environment.</td>
+</tr><tr>
 <td><a href="#VirtualenvManager.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td>
 <td>Public method to get the interpreter for a virtual environment.</td>
 </tr><tr>
@@ -96,6 +99,9 @@
 <td><a href="#VirtualenvManager.getVirtualenvNamesForVariant">getVirtualenvNamesForVariant</a></td>
 <td>Public method to get a list of virtual environments for a given Python variant.</td>
 </tr><tr>
+<td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td>
+<td>Public method to test, if a given environment is an Anaconda environment.</td>
+</tr><tr>
 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td>
 <td>Public method to test, if a given environment is a global one.</td>
 </tr><tr>
@@ -165,7 +171,7 @@
         Private slot to save the virtual environments.
 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a>
 <h4>VirtualenvManager.addVirtualEnv</h4>
-<b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False</i>)
+<b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, execPath=""</i>)
 <p>
         Public method to add a virtual environment.
 </p><dl>
@@ -184,6 +190,13 @@
 </dd><dt><i>isGlobal</i> (bool)</dt>
 <dd>
 flag indicating a global environment
+</dd><dt><i>isConda</i> (bool)</dt>
+<dd>
+flag indicating an Anaconda virtual environment
+</dd><dt><i>execPath</i> (str)</dt>
+<dd>
+search path string to be prepended to the PATH
+            environment variable
 </dd>
 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
 <h4>VirtualenvManager.createVirtualEnv</h4>
@@ -257,6 +270,26 @@
 <dd>
 str
 </dd>
+</dl><a NAME="VirtualenvManager.getVirtualenvExecPath" ID="VirtualenvManager.getVirtualenvExecPath"></a>
+<h4>VirtualenvManager.getVirtualenvExecPath</h4>
+<b>getVirtualenvExecPath</b>(<i>venvName</i>)
+<p>
+        Public method to get the search path prefix of a virtual environment.
+</p><dl>
+<dt><i>venvName</i> (str)</dt>
+<dd>
+logical name for the virtual environment
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+search path prefix
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
 </dl><a NAME="VirtualenvManager.getVirtualenvInterpreter" ID="VirtualenvManager.getVirtualenvInterpreter"></a>
 <h4>VirtualenvManager.getVirtualenvInterpreter</h4>
 <b>getVirtualenvInterpreter</b>(<i>venvName</i>)
@@ -313,6 +346,27 @@
 <dd>
 list of str
 </dd>
+</dl><a NAME="VirtualenvManager.isCondaEnvironment" ID="VirtualenvManager.isCondaEnvironment"></a>
+<h4>VirtualenvManager.isCondaEnvironment</h4>
+<b>isCondaEnvironment</b>(<i>venvName</i>)
+<p>
+        Public method to test, if a given environment is an Anaconda
+        environment.
+</p><dl>
+<dt><i>venvName</i> (str)</dt>
+<dd>
+logical name of the virtual environment
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating an Anaconda environment
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="VirtualenvManager.isGlobalEnvironment" ID="VirtualenvManager.isGlobalEnvironment"></a>
 <h4>VirtualenvManager.isGlobalEnvironment</h4>
 <b>isGlobalEnvironment</b>(<i>venvName</i>)
@@ -365,7 +419,7 @@
 </dd>
 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
 <h4>VirtualenvManager.renameVirtualEnv</h4>
-<b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal</i>)
+<b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, execPath</i>)
 <p>
         Public method to substitute a virtual environment entry with a new
         name.
@@ -388,10 +442,17 @@
 </dd><dt><i>isGlobal</i> (bool)</dt>
 <dd>
 flag indicating a global environment
+</dd><dt><i>isConda</i> (bool)</dt>
+<dd>
+flag indicating an Anaconda virtual environment
+</dd><dt><i>execPath</i> (str)</dt>
+<dd>
+search path string to be prepended to the PATH
+            environment variable
 </dd>
 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
 <h4>VirtualenvManager.setVirtualEnv</h4>
-<b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal</i>)
+<b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, execPath</i>)
 <p>
         Public method to change a virtual environment.
 </p><dl>
@@ -410,6 +471,13 @@
 </dd><dt><i>isGlobal</i> (bool)</dt>
 <dd>
 flag indicating a global environment
+</dd><dt><i>isConda</i> (bool)</dt>
+<dd>
+flag indicating an Anaconda virtual environment
+</dd><dt><i>execPath</i> (str)</dt>
+<dd>
+search path string to be prepended to the PATH
+            environment variable
 </dd>
 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a>
 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4>

eric ide

mercurial