Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

changeset 6349
17b3c75913de
parent 6343
86cea8abd0f7
child 6362
ec32d1d7f525
diff -r d6c0b8ab1fc6 -r 17b3c75913de Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html
--- a/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html	Fri Jun 15 18:49:48 2018 +0200
+++ b/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html	Sat Jun 16 13:34:22 2018 +0200
@@ -60,7 +60,10 @@
 <td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td>
 <td>Constructor</td>
 </tr><tr>
-<td><a href="#VirtualenvManager.__updateSettings">__updateSettings</a></td>
+<td><a href="#VirtualenvManager.__loadSettings">__loadSettings</a></td>
+<td>Private slot to load the virtual environments.</td>
+</tr><tr>
+<td><a href="#VirtualenvManager.__saveSettings">__saveSettings</a></td>
 <td>Private slot to save the virtual environments.</td>
 </tr><tr>
 <td><a href="#VirtualenvManager.addVirtualEnv">addVirtualEnv</a></td>
@@ -73,7 +76,7 @@
 <td>Public method to delete virtual environments from the list and disk.</td>
 </tr><tr>
 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td>
-<td>Public method to a dictionary containing the defined virtual environment entries.</td>
+<td>Public method to get a dictionary containing the defined virtual environment entries.</td>
 </tr><tr>
 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td>
 <td>Public method to get the directory of a virtual environment.</td>
@@ -84,6 +87,9 @@
 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td>
 <td>Public method to get a list of defined virtual environments.</td>
 </tr><tr>
+<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.isUnique">isUnique</a></td>
 <td>Public method to check, if the give logical name is unique.</td>
 </tr><tr>
@@ -117,14 +123,19 @@
 <dd>
 reference to the parent object
 </dd>
-</dl><a NAME="VirtualenvManager.__updateSettings" ID="VirtualenvManager.__updateSettings"></a>
-<h4>VirtualenvManager.__updateSettings</h4>
-<b>__updateSettings</b>(<i></i>)
+</dl><a NAME="VirtualenvManager.__loadSettings" ID="VirtualenvManager.__loadSettings"></a>
+<h4>VirtualenvManager.__loadSettings</h4>
+<b>__loadSettings</b>(<i></i>)
+<p>
+        Private slot to load the virtual environments.
+</p><a NAME="VirtualenvManager.__saveSettings" ID="VirtualenvManager.__saveSettings"></a>
+<h4>VirtualenvManager.__saveSettings</h4>
+<b>__saveSettings</b>(<i></i>)
 <p>
         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=""</i>)
+<b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3</i>)
 <p>
         Public method to add a virtual environment.
 </p><dl>
@@ -134,9 +145,12 @@
 </dd><dt><i>venvDirectory</i> (str)</dt>
 <dd>
 directory of the virtual environment
-</dd><dt><i>venvInterpreter</i></dt>
+</dd><dt><i>venvInterpreter</i> (str)</dt>
 <dd>
 interpreter of the virtual environment
+</dd><dt><i>venvVariant</i> (int)</dt>
+<dd>
+Python variant of the virtual environment
 </dd>
 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
 <h4>VirtualenvManager.createVirtualEnv</h4>
@@ -157,18 +171,18 @@
 <h4>VirtualenvManager.getEnvironmentEntries</h4>
 <b>getEnvironmentEntries</b>(<i></i>)
 <p>
-        Public method to a dictionary containing the defined virtual
+        Public method to get a dictionary containing the defined virtual
         environment entries.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-dictionary containing tuples of the environment path and
-            the associated interpreter
+dictionary containing a copy of the defined virtual
+            environments
 </dd>
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-dict of (str, str)
+dict
 </dd>
 </dl><a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a>
 <h4>VirtualenvManager.getVirtualenvDirectory</h4>
@@ -225,6 +239,27 @@
 <dd>
 list of str
 </dd>
+</dl><a NAME="VirtualenvManager.getVirtualenvNamesForVariant" ID="VirtualenvManager.getVirtualenvNamesForVariant"></a>
+<h4>VirtualenvManager.getVirtualenvNamesForVariant</h4>
+<b>getVirtualenvNamesForVariant</b>(<i>variant</i>)
+<p>
+        Public method to get a list of virtual environments for a given
+        Python variant.
+</p><dl>
+<dt><i>variant</i> (int)</dt>
+<dd>
+Python variant (2 or 3)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list of defined virtual environments
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a>
 <h4>VirtualenvManager.isUnique</h4>
 <b>isUnique</b>(<i>venvName</i>)
@@ -257,7 +292,7 @@
 </dd>
 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
 <h4>VirtualenvManager.renameVirtualEnv</h4>
-<b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter</i>)
+<b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant</i>)
 <p>
         Public method to substitute a virtual environment entry with a new
         name.
@@ -271,13 +306,16 @@
 </dd><dt><i>venvDirectory</i> (str)</dt>
 <dd>
 directory of the virtual environment
-</dd><dt><i>venvInterpreter</i></dt>
+</dd><dt><i>venvInterpreter</i> (str)</dt>
 <dd>
 interpreter of the virtual environment
+</dd><dt><i>venvVariant</i> (int)</dt>
+<dd>
+Python variant of the virtual environment
 </dd>
 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
 <h4>VirtualenvManager.setVirtualEnv</h4>
-<b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter=""</i>)
+<b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant</i>)
 <p>
         Public method to change a virtual environment.
 </p><dl>
@@ -287,9 +325,12 @@
 </dd><dt><i>venvDirectory</i> (str)</dt>
 <dd>
 directory of the virtual environment
-</dd><dt><i>venvInterpreter</i></dt>
+</dd><dt><i>venvInterpreter</i> (str)</dt>
 <dd>
 interpreter of the virtual environment
+</dd><dt><i>venvVariant</i> (int)</dt>
+<dd>
+Python variant of the virtual environment
 </dd>
 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a>
 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4>

eric ide

mercurial