Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

changeset 6503
e617c58807e8
parent 6382
4d6e43200bc7
child 6576
ea60ea85067a
diff -r 07070e95be4d -r e617c58807e8 Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html
--- a/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html	Sun Sep 16 13:32:57 2018 +0200
+++ b/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html	Sun Sep 16 13:36:01 2018 +0200
@@ -48,7 +48,7 @@
 QObject
 <h3>Class Attributes</h3>
 <table>
-<tr><td>None</td></tr>
+<tr><td>DefaultKey</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
@@ -78,6 +78,9 @@
 <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>
@@ -197,6 +200,26 @@
 <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>)

eric ide

mercurial