--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html Sun Apr 14 15:09:21 2019 +0200
@@ -0,0 +1,572 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.VirtualEnv.VirtualenvManager</title>
+<meta charset="UTF-8">
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric6.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>
+<dt>virtualEnvironmentAdded()</dt>
+<dd>
+emitted to indicate the addition of
+ a virtual environment
+</dd><dt>virtualEnvironmentChanged(name)</dt>
+<dd>
+emitted to indicate a change of
+ a virtual environment
+</dd><dt>virtualEnvironmentRemoved()</dt>
+<dd>
+emitted to indicate the removal and
+ deletion of a virtual environment
+</dd>
+</dl>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>DefaultKey</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>
+</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>
+<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>
+<td>Public method to add a virtual environment.</td>
+</tr><tr>
+<td><a href="#VirtualenvManager.createVirtualEnv">createVirtualEnv</a></td>
+<td>Public slot to create a new virtual environment.</td>
+</tr><tr>
+<td><a href="#VirtualenvManager.deleteVirtualEnvs">deleteVirtualEnvs</a></td>
+<td>Public method to delete virtual environments from the list and disk.</td>
+</tr><tr>
+<td><a href="#VirtualenvManager.getDefaultEnvironment">getDefaultEnvironment</a></td>
+<td>Public method to get the default virtual environment.</td>
+</tr><tr>
+<td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></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>
+</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>
+<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.getVirtualenvVariant">getVirtualenvVariant</a></td>
+<td>Public method to get the variant of a virtual environment.</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>
+<td><a href="#VirtualenvManager.isRemoteEnvironment">isRemoteEnvironment</a></td>
+<td>Public method to test, if a given environment is a remotely accessed environment.</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>
+<td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td>
+<td>Public method to delete virtual environment from the list.</td>
+</tr><tr>
+<td><a href="#VirtualenvManager.renameVirtualEnv">renameVirtualEnv</a></td>
+<td>Public method to substitute a virtual environment entry with a new name.</td>
+</tr><tr>
+<td><a href="#VirtualenvManager.setVirtualEnv">setVirtualEnv</a></td>
+<td>Public method to change a virtual environment.</td>
+</tr><tr>
+<td><a href="#VirtualenvManager.showVirtualenvManagerDialog">showVirtualenvManagerDialog</a></td>
+<td>Public slot to show the virtual environment manager dialog.</td>
+</tr><tr>
+<td><a href="#VirtualenvManager.shutdown">shutdown</a></td>
+<td>Public method to shutdown the manager.</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>
+<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>)
+<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="", venvVariant=3, isGlobal=False, isConda=False, isRemote=False, execPath=""</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>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><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>
+</dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
+<h4>VirtualenvManager.createVirtualEnv</h4>
+<b>createVirtualEnv</b>(<i></i>)
+<p>
+ Public slot to create a new virtual environment.
+</p><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>
+<dd>
+list of logical names for the virtual environments
+</dd>
+</dl><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><p>
+ Default is an environment with the key '<default>' or the first one
+ having an interpreter matching sys.executable (i.e. the one used to
+ execute eric6 with)
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing the environment name and a dictionary
+ containing a copy of the default virtual environment
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, dict)
+</dd>
+</dl><a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a>
+<h4>VirtualenvManager.getEnvironmentEntries</h4>
+<b>getEnvironmentEntries</b>(<i></i>)
+<p>
+ Public method to get a dictionary containing the defined virtual
+ environment entries.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+dictionary containing a copy of the defined virtual
+ environments
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl><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>
+<dd>
+logical name for the virtual environment
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+directory path
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<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>)
+<p>
+ Public method to get the interpreter for 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>
+interpreter path
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl><a NAME="VirtualenvManager.getVirtualenvNames" ID="VirtualenvManager.getVirtualenvNames"></a>
+<h4>VirtualenvManager.getVirtualenvNames</h4>
+<b>getVirtualenvNames</b>(<i></i>)
+<p>
+ Public method to get a list of defined virtual environments.
+</p><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.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.getVirtualenvVariant" ID="VirtualenvManager.getVirtualenvVariant"></a>
+<h4>VirtualenvManager.getVirtualenvVariant</h4>
+<b>getVirtualenvVariant</b>(<i>venvName</i>)
+<p>
+ Public method to get the variant 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>
+Python variant of the environment
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+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>)
+<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.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>
+<dd>
+logical name of the virtual environment
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a remotely accessed 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>)
+<p>
+ Public method to check, if the give logical name is unique.
+</p><dl>
+<dt><i>venvName</i> (str)</dt>
+<dd>
+logical name for the virtual environment
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating uniqueness
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><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>
+<dd>
+list of logical names for the virtual environments
+</dd>
+</dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
+<h4>VirtualenvManager.renameVirtualEnv</h4>
+<b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>)
+<p>
+ Public method to substitute a virtual environment entry with a new
+ name.
+</p><dl>
+<dt><i>oldVenvName</i> (str)</dt>
+<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>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><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>
+</dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
+<h4>VirtualenvManager.setVirtualEnv</h4>
+<b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</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>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><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>
+</dl><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></dt>
+<dd>
+flag indicating that the dialog should be shown in
+ a blocking mode
+</dd>
+</dl><a NAME="VirtualenvManager.shutdown" ID="VirtualenvManager.shutdown"></a>
+<h4>VirtualenvManager.shutdown</h4>
+<b>shutdown</b>(<i></i>)
+<p>
+ Public method to shutdown the manager.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
