Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html	Tue Sep 05 14:17:29 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html	Wed Sep 06 10:28:50 2023 +0200
@@ -116,7 +116,7 @@
 </tr>
 <tr>
 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td>
-<td>Public method to get a dictionary containing the defined virtual environment entries.</td>
+<td>Public method to get a list of the defined virtual environment entries.</td>
 </tr>
 <tr>
 <td><a href="#VirtualenvManager.getVirtualEnvironmentsBaseDir">getVirtualEnvironmentsBaseDir</a></td>
@@ -250,45 +250,16 @@
 </p>
 <a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a>
 <h4>VirtualenvManager.addVirtualEnv</h4>
-<b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", isGlobal=False, isConda=False, isRemote=False, execPath="", description="", </i>)
+<b>addVirtualEnv</b>(<i>metadata</i>)
 
 <p>
         Public method to add a virtual environment.
 </p>
 <dl>
 
-<dt><i>venvName</i> (str)</dt>
-<dd>
-logical name for the virtual environment
-</dd>
-<dt><i>venvDirectory</i> (str)</dt>
-<dd>
-directory of the virtual environment
-</dd>
-<dt><i>venvInterpreter</i> (str)</dt>
-<dd>
-interpreter of the virtual environment
-</dd>
-<dt><i>isGlobal</i> (bool)</dt>
+<dt><i>metadata</i> (VirtualenvMetaData)</dt>
 <dd>
-flag indicating a global environment
-</dd>
-<dt><i>isConda</i> (bool)</dt>
-<dd>
-flag indicating an Anaconda virtual environment
-</dd>
-<dt><i>isRemote</i> (bool)</dt>
-<dd>
-flag indicating a remotely accessed environment
-</dd>
-<dt><i>execPath</i> (str)</dt>
-<dd>
-search path string to be prepended to the PATH
-            environment variable
-</dd>
-<dt><i>description</i> (str)</dt>
-<dd>
-descriptive text for the environment
+object containing the metadata of the virtual environment
 </dd>
 </dl>
 <a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
@@ -336,14 +307,14 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple containing the environment name and a dictionary
-            containing a copy of the default virtual environment
+tuple containing the environment name and a copy of the metadata
+            of the virtual environment the interpreter belongs to
 </dd>
 </dl>
 <dl>
 <dt>Return Type:</dt>
 <dd>
-tuple of (str, dict)
+tuple of (str, VirtualenvMetaData)
 </dd>
 </dl>
 <a NAME="VirtualenvManager.getDefaultEnvironment" ID="VirtualenvManager.getDefaultEnvironment"></a>
@@ -361,14 +332,14 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple containing the environment name and a dictionary
-            containing a copy of the default virtual environment
+tuple containing the environment name and a copy of the metadata
+            of the default virtual environment
 </dd>
 </dl>
 <dl>
 <dt>Return Type:</dt>
 <dd>
-tuple of (str, dict)
+tuple of (str, VirtualenvMetaData)
 </dd>
 </dl>
 <a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a>
@@ -376,20 +347,18 @@
 <b>getEnvironmentEntries</b>(<i></i>)
 
 <p>
-        Public method to get a dictionary containing the defined virtual
-        environment entries.
+        Public method to get a list of the defined virtual environment entries.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
-dictionary containing a copy of the defined virtual
-            environments
+list containing a copy of the defined virtual environments
 </dd>
 </dl>
 <dl>
 <dt>Return Type:</dt>
 <dd>
-dict
+list
 </dd>
 </dl>
 <a NAME="VirtualenvManager.getVirtualEnvironmentsBaseDir" ID="VirtualenvManager.getVirtualEnvironmentsBaseDir"></a>
@@ -649,7 +618,7 @@
 </dl>
 <a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
 <h4>VirtualenvManager.renameVirtualEnv</h4>
-<b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, isGlobal, isConda, isRemote, execPath, description, </i>)
+<b>renameVirtualEnv</b>(<i>oldVenvName, metadata, </i>)
 
 <p>
         Public method to substitute a virtual environment entry with a new
@@ -661,81 +630,23 @@
 <dd>
 old name of the virtual environment
 </dd>
-<dt><i>venvName</i> (str)</dt>
-<dd>
-logical name for the virtual environment
-</dd>
-<dt><i>venvDirectory</i> (str)</dt>
-<dd>
-directory of the virtual environment
-</dd>
-<dt><i>venvInterpreter</i> (str)</dt>
-<dd>
-interpreter of the virtual environment
-</dd>
-<dt><i>isGlobal</i> (bool)</dt>
+<dt><i>metadata</i> (VirtualenvMetaData)</dt>
 <dd>
-flag indicating a global environment
-</dd>
-<dt><i>isConda</i> (bool)</dt>
-<dd>
-flag indicating an Anaconda virtual environment
-</dd>
-<dt><i>isRemote</i> (bool)</dt>
-<dd>
-flag indicating a remotely accessed environment
-</dd>
-<dt><i>execPath</i> (str)</dt>
-<dd>
-search path string to be prepended to the PATH
-            environment variable
-</dd>
-<dt><i>description</i> (str)</dt>
-<dd>
-descriptive text for the environment
+object containing the metadata 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, isGlobal, isConda, isRemote, execPath, description, </i>)
+<b>setVirtualEnv</b>(<i>metadata</i>)
 
 <p>
         Public method to change a virtual environment.
 </p>
 <dl>
 
-<dt><i>venvName</i> (str)</dt>
-<dd>
-logical name of the virtual environment
-</dd>
-<dt><i>venvDirectory</i> (str)</dt>
-<dd>
-directory of the virtual environment
-</dd>
-<dt><i>venvInterpreter</i> (str)</dt>
-<dd>
-interpreter of the virtual environment
-</dd>
-<dt><i>isGlobal</i> (bool)</dt>
+<dt><i>metadata</i> (VirtualenvMetaData)</dt>
 <dd>
-flag indicating a global environment
-</dd>
-<dt><i>isConda</i> (bool)</dt>
-<dd>
-flag indicating an Anaconda virtual environment
-</dd>
-<dt><i>isRemote</i> (bool)</dt>
-<dd>
-flag indicating a remotely accessed environment
-</dd>
-<dt><i>execPath</i> (str)</dt>
-<dd>
-search path string to be prepended to the PATH
-            environment variable
-</dd>
-<dt><i>description</i> (str)</dt>
-<dd>
-descriptive text for the environment
+object containing the metadata of the virtual environment
 </dd>
 </dl>
 <a NAME="VirtualenvManager.setVirtualEnvInterpreter" ID="VirtualenvManager.setVirtualEnvInterpreter"></a>