Mercurial Repositories > eric / file diff

diff: Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

changeset 6339
d765c3204c71
child 6343
86cea8abd0f7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html	Sun Jun 10 17:05:15 2018 +0200
@@ -0,0 +1,284 @@
+<!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>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</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.__updateSettings">__updateSettings</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.getEnvironmentEntries">getEnvironmentEntries</a></td>
+<td>Public method to a dictionary containing the defined virtual environment entries.</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.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 virtuals 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.__updateSettings" ID="VirtualenvManager.__updateSettings"></a>
+<h4>VirtualenvManager.__updateSettings</h4>
+<b>__updateSettings</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>)
+<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></dt>
+<dd>
+interpreter of the virtual environment
+</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.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a>
+<h4>VirtualenvManager.getEnvironmentEntries</h4>
+<b>getEnvironmentEntries</b>(<i></i>)
+<p>
+        Public method to 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
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict of (str, 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.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 virtuals 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</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></dt>
+<dd>
+interpreter 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>)
+<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></dt>
+<dd>
+interpreter of the virtual environment
+</dd>
+</dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a>
+<h4>VirtualenvManager.showVirtualenvManagerDialog</h4>
+<b>showVirtualenvManagerDialog</b>(<i></i>)
+<p>
+        Public slot to show the virtual environment manager dialog.
+</p><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

Mercurial Repository: eric

eric ide

mercurial