--- a/src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.VirtualEnv.VirtualenvManager</h1>
-
<p>
Module implementing a class to manage Python virtual environments.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#VirtualenvManager">VirtualenvManager</a></td>
<td>Class implementing an object to manage Python virtual environments.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="VirtualenvManager" ID="VirtualenvManager"></a>
<h2>VirtualenvManager</h2>
-
<p>
Class implementing an object to manage Python virtual environments.
</p>
+
<h3>Signals</h3>
<dl>
@@ -65,19 +64,18 @@
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
+<table>
+<tr><td>DefaultKey</td></tr>
+<tr><td>SystemKey</td></tr>
+</table>
-<table>
-<tr><td>DefaultKey</td></tr><tr><td>SystemKey</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td>
<td>Constructor</td>
@@ -195,19 +193,20 @@
<td>Public slot to upgrade a virtual environment.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VirtualenvManager.__init__" ID="VirtualenvManager.__init__"></a>
<h4>VirtualenvManager (Constructor)</h4>
<b>VirtualenvManager</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -218,18 +217,18 @@
<a NAME="VirtualenvManager.__cleanEnvironments" ID="VirtualenvManager.__cleanEnvironments"></a>
<h4>VirtualenvManager.__cleanEnvironments</h4>
<b>__cleanEnvironments</b>(<i></i>)
-
<p>
Private method to delete all non-existent local environments.
</p>
+
<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>
@@ -252,24 +251,24 @@
<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>metadata</i>)
-
<p>
Public method to add a virtual environment.
</p>
+
<dl>
<dt><i>metadata</i> (VirtualenvMetaData)</dt>
@@ -280,10 +279,10 @@
<a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
<h4>VirtualenvManager.createVirtualEnv</h4>
<b>createVirtualEnv</b>(<i>baseDir=""</i>)
-
<p>
Public slot to create a new virtual environment.
</p>
+
<dl>
<dt><i>baseDir</i> (str)</dt>
@@ -294,10 +293,10 @@
<a NAME="VirtualenvManager.deleteVirtualEnvs" ID="VirtualenvManager.deleteVirtualEnvs"></a>
<h4>VirtualenvManager.deleteVirtualEnvs</h4>
<b>deleteVirtualEnvs</b>(<i>venvNames</i>)
-
<p>
Public method to delete virtual environments from the list and disk.
</p>
+
<dl>
<dt><i>venvNames</i> (list of str)</dt>
@@ -308,10 +307,10 @@
<a NAME="VirtualenvManager.environmentForInterpreter" ID="VirtualenvManager.environmentForInterpreter"></a>
<h4>VirtualenvManager.environmentForInterpreter</h4>
<b>environmentForInterpreter</b>(<i>interpreter</i>)
-
<p>
Public method to get the environment a given interpreter belongs to.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -335,7 +334,6 @@
<a NAME="VirtualenvManager.getDefaultEnvironment" ID="VirtualenvManager.getDefaultEnvironment"></a>
<h4>VirtualenvManager.getDefaultEnvironment</h4>
<b>getDefaultEnvironment</b>(<i></i>)
-
<p>
Public method to get the default virtual environment.
</p>
@@ -344,6 +342,7 @@
having an interpreter matching sys.executable (i.e. the one used to
execute eric with)
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -360,10 +359,10 @@
<a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a>
<h4>VirtualenvManager.getEnvironmentEntries</h4>
<b>getEnvironmentEntries</b>(<i></i>)
-
<p>
Public method to get a list of the defined virtual environment entries.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -379,10 +378,10 @@
<a NAME="VirtualenvManager.getVirtualEnvironmentsBaseDir" ID="VirtualenvManager.getVirtualEnvironmentsBaseDir"></a>
<h4>VirtualenvManager.getVirtualEnvironmentsBaseDir</h4>
<b>getVirtualEnvironmentsBaseDir</b>(<i></i>)
-
<p>
Public method to set the base directory for the virtual environments.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -398,10 +397,10 @@
<a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a>
<h4>VirtualenvManager.getVirtualenvDirectory</h4>
<b>getVirtualenvDirectory</b>(<i>venvName</i>)
-
<p>
Public method to get the directory of a virtual environment.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -424,10 +423,10 @@
<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>
@@ -450,10 +449,10 @@
<a NAME="VirtualenvManager.getVirtualenvInterpreter" ID="VirtualenvManager.getVirtualenvInterpreter"></a>
<h4>VirtualenvManager.getVirtualenvInterpreter</h4>
<b>getVirtualenvInterpreter</b>(<i>venvName</i>)
-
<p>
Public method to get the interpreter for a virtual environment.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -476,10 +475,10 @@
<a NAME="VirtualenvManager.getVirtualenvNames" ID="VirtualenvManager.getVirtualenvNames"></a>
<h4>VirtualenvManager.getVirtualenvNames</h4>
<b>getVirtualenvNames</b>(<i>noRemote=False, noConda=False</i>)
-
<p>
Public method to get a list of defined virtual environments.
</p>
+
<dl>
<dt><i>noRemote</i> (bool)</dt>
@@ -507,11 +506,11 @@
<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>
@@ -534,10 +533,10 @@
<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>
@@ -560,11 +559,11 @@
<a NAME="VirtualenvManager.isRemoteEnvironment" ID="VirtualenvManager.isRemoteEnvironment"></a>
<h4>VirtualenvManager.isRemoteEnvironment</h4>
<b>isRemoteEnvironment</b>(<i>venvName</i>)
-
<p>
Public method to test, if a given environment is a remotely accessed
environment.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -587,10 +586,10 @@
<a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a>
<h4>VirtualenvManager.isUnique</h4>
<b>isUnique</b>(<i>venvName</i>)
-
<p>
Public method to check, if the give logical name is unique.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -613,17 +612,17 @@
<a NAME="VirtualenvManager.reloadSettings" ID="VirtualenvManager.reloadSettings"></a>
<h4>VirtualenvManager.reloadSettings</h4>
<b>reloadSettings</b>(<i></i>)
-
<p>
Public slot to reload the virtual environments.
</p>
+
<a NAME="VirtualenvManager.removeVirtualEnvs" ID="VirtualenvManager.removeVirtualEnvs"></a>
<h4>VirtualenvManager.removeVirtualEnvs</h4>
<b>removeVirtualEnvs</b>(<i>venvNames</i>)
-
<p>
Public method to delete virtual environment from the list.
</p>
+
<dl>
<dt><i>venvNames</i> (list of str)</dt>
@@ -634,11 +633,11 @@
<a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
<h4>VirtualenvManager.renameVirtualEnv</h4>
<b>renameVirtualEnv</b>(<i>oldVenvName, metadata, </i>)
-
<p>
Public method to substitute a virtual environment entry with a new
name.
</p>
+
<dl>
<dt><i>oldVenvName</i> (str)</dt>
@@ -653,10 +652,10 @@
<a NAME="VirtualenvManager.searchUnregisteredInterpreters" ID="VirtualenvManager.searchUnregisteredInterpreters"></a>
<h4>VirtualenvManager.searchUnregisteredInterpreters</h4>
<b>searchUnregisteredInterpreters</b>(<i></i>)
-
<p>
Public method to search for unregistered Python interpreters.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -672,10 +671,10 @@
<a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
<h4>VirtualenvManager.setVirtualEnv</h4>
<b>setVirtualEnv</b>(<i>metadata</i>)
-
<p>
Public method to change a virtual environment.
</p>
+
<dl>
<dt><i>metadata</i> (VirtualenvMetaData)</dt>
@@ -686,10 +685,10 @@
<a NAME="VirtualenvManager.setVirtualEnvInterpreter" ID="VirtualenvManager.setVirtualEnvInterpreter"></a>
<h4>VirtualenvManager.setVirtualEnvInterpreter</h4>
<b>setVirtualEnvInterpreter</b>(<i>venvName, venvInterpreter</i>)
-
<p>
Public method to change the interpreter for a virtual environment.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -704,10 +703,10 @@
<a NAME="VirtualenvManager.setVirtualEnvironmentsBaseDir" ID="VirtualenvManager.setVirtualEnvironmentsBaseDir"></a>
<h4>VirtualenvManager.setVirtualEnvironmentsBaseDir</h4>
<b>setVirtualEnvironmentsBaseDir</b>(<i>baseDir</i>)
-
<p>
Public method to set the base directory for the virtual environments.
</p>
+
<dl>
<dt><i>baseDir</i> (str)</dt>
@@ -718,10 +717,10 @@
<a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a>
<h4>VirtualenvManager.showVirtualenvManagerDialog</h4>
<b>showVirtualenvManagerDialog</b>(<i>modal=False</i>)
-
<p>
Public slot to show the virtual environment manager dialog.
</p>
+
<dl>
<dt><i>modal</i> (bool)</dt>
@@ -733,10 +732,10 @@
<a NAME="VirtualenvManager.upgradeVirtualEnv" ID="VirtualenvManager.upgradeVirtualEnv"></a>
<h4>VirtualenvManager.upgradeVirtualEnv</h4>
<b>upgradeVirtualEnv</b>(<i>venvName</i>)
-
<p>
Public slot to upgrade a virtual environment.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -746,4 +745,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
