Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

changeset 6362
ec32d1d7f525
parent 6349
17b3c75913de
child 6382
4d6e43200bc7
--- a/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html	Fri Jun 22 18:18:23 2018 +0200
+++ b/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html	Sat Jun 23 15:14:48 2018 +0200
@@ -60,6 +60,9 @@
 <td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td>
 <td>Constructor</td>
 </tr><tr>
+<td><a href="#VirtualenvManager.__isEnvironmentDeleteable">__isEnvironmentDeleteable</a></td>
+<td>Private method to check, if a virtual environment can be deleted from disk.</td>
+</tr><tr>
 <td><a href="#VirtualenvManager.__loadSettings">__loadSettings</a></td>
 <td>Private slot to load the virtual environments.</td>
 </tr><tr>
@@ -90,6 +93,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.isGlobalEnvironment">isGlobalEnvironment</a></td>
+<td>Public method to test, if a given environment is a global one.</td>
+</tr><tr>
 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td>
 <td>Public method to check, if the give logical name is unique.</td>
 </tr><tr>
@@ -123,6 +129,27 @@
 <dd>
 reference to the parent object
 </dd>
+</dl><a NAME="VirtualenvManager.__isEnvironmentDeleteable" ID="VirtualenvManager.__isEnvironmentDeleteable"></a>
+<h4>VirtualenvManager.__isEnvironmentDeleteable</h4>
+<b>__isEnvironmentDeleteable</b>(<i>venvName</i>)
+<p>
+        Private method to check, if a virtual environment can be deleted from
+        disk.
+</p><dl>
+<dt><i>venvName</i> (str)</dt>
+<dd>
+name of the virtual environment
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating it can be deleted
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="VirtualenvManager.__loadSettings" ID="VirtualenvManager.__loadSettings"></a>
 <h4>VirtualenvManager.__loadSettings</h4>
 <b>__loadSettings</b>(<i></i>)
@@ -135,7 +162,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</i>)
+<b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False</i>)
 <p>
         Public method to add a virtual environment.
 </p><dl>
@@ -151,6 +178,9 @@
 </dd><dt><i>venvVariant</i> (int)</dt>
 <dd>
 Python variant of the virtual environment
+</dd><dt><i>isGlobal</i> (bool)</dt>
+<dd>
+flag indicating a global environment
 </dd>
 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
 <h4>VirtualenvManager.createVirtualEnv</h4>
@@ -260,6 +290,26 @@
 <dd>
 list of str
 </dd>
+</dl><a NAME="VirtualenvManager.isGlobalEnvironment" ID="VirtualenvManager.isGlobalEnvironment"></a>
+<h4>VirtualenvManager.isGlobalEnvironment</h4>
+<b>isGlobalEnvironment</b>(<i>venvName</i>)
+<p>
+        Public method to test, if a given environment is a global one.
+</p><dl>
+<dt><i>venvName</i> (str)</dt>
+<dd>
+logical name of the virtual environment
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a global environment
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a>
 <h4>VirtualenvManager.isUnique</h4>
 <b>isUnique</b>(<i>venvName</i>)
@@ -292,7 +342,7 @@
 </dd>
 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
 <h4>VirtualenvManager.renameVirtualEnv</h4>
-<b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant</i>)
+<b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal</i>)
 <p>
         Public method to substitute a virtual environment entry with a new
         name.
@@ -312,10 +362,13 @@
 </dd><dt><i>venvVariant</i> (int)</dt>
 <dd>
 Python variant of the virtual environment
+</dd><dt><i>isGlobal</i> (bool)</dt>
+<dd>
+flag indicating a global environment
 </dd>
 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
 <h4>VirtualenvManager.setVirtualEnv</h4>
-<b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant</i>)
+<b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal</i>)
 <p>
         Public method to change a virtual environment.
 </p><dl>
@@ -331,6 +384,9 @@
 </dd><dt><i>venvVariant</i> (int)</dt>
 <dd>
 Python variant of the virtual environment
+</dd><dt><i>isGlobal</i> (bool)</dt>
+<dd>
+flag indicating a global environment
 </dd>
 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a>
 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4>

eric ide

mercurial