src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html

branch
eric7
changeset 10784
521fd465b048
parent 10742
7aa41173b44b
child 11231
c7240fb719c7
diff -r ccf28bec1227 -r 521fd465b048 src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html
--- a/src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html	Fri Jun 14 11:18:10 2024 +0200
+++ b/src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManager.html	Fri Jun 14 11:23:45 2024 +0200
@@ -82,7 +82,7 @@
 </tr>
 <tr>
 <td><a href="#VirtualenvManager.__cleanEnvironments">__cleanEnvironments</a></td>
-<td>Private method to delete all non-existent local environments.</td>
+<td>Private method to delete all non-existent local or eric-ide server environments.</td>
 </tr>
 <tr>
 <td><a href="#VirtualenvManager.__isEnvironmentDeleteable">__isEnvironmentDeleteable</a></td>
@@ -121,6 +121,10 @@
 <td>Public method to get a list of the defined virtual environment entries.</td>
 </tr>
 <tr>
+<td><a href="#VirtualenvManager.getEricServerEnvironmentNames">getEricServerEnvironmentNames</a></td>
+<td>Public method to get a list of defined eric-ide server environments.</td>
+</tr>
+<tr>
 <td><a href="#VirtualenvManager.getVirtualEnvironmentsBaseDir">getVirtualEnvironmentsBaseDir</a></td>
 <td>Public method to set the base directory for the virtual environments.</td>
 </tr>
@@ -145,6 +149,10 @@
 <td>Public method to test, if a given environment is an Anaconda environment.</td>
 </tr>
 <tr>
+<td><a href="#VirtualenvManager.isEricServerEnvironment">isEricServerEnvironment</a></td>
+<td>Public method to test, if a given environment is an environment accessed through an eric-ide server.</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>
@@ -218,7 +226,7 @@
 <h4>VirtualenvManager.__cleanEnvironments</h4>
 <b>__cleanEnvironments</b>(<i></i>)
 <p>
-        Private method to delete all non-existent local environments.
+        Private method to delete all non-existent local or eric-ide server environments.
 </p>
 
 <a NAME="VirtualenvManager.__isEnvironmentDeleteable" ID="VirtualenvManager.__isEnvironmentDeleteable"></a>
@@ -375,6 +383,32 @@
 list
 </dd>
 </dl>
+<a NAME="VirtualenvManager.getEricServerEnvironmentNames" ID="VirtualenvManager.getEricServerEnvironmentNames"></a>
+<h4>VirtualenvManager.getEricServerEnvironmentNames</h4>
+<b>getEricServerEnvironmentNames</b>(<i>host=""</i>)
+<p>
+        Public method to get a list of defined eric-ide server environments.
+</p>
+
+<dl>
+
+<dt><i>host</i> (str (optional))</dt>
+<dd>
+host name to get environment names for (defaults to "")
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of defined eric-ide server environments
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
 <a NAME="VirtualenvManager.getVirtualEnvironmentsBaseDir" ID="VirtualenvManager.getVirtualEnvironmentsBaseDir"></a>
 <h4>VirtualenvManager.getVirtualEnvironmentsBaseDir</h4>
 <b>getVirtualEnvironmentsBaseDir</b>(<i></i>)
@@ -474,7 +508,7 @@
 </dl>
 <a NAME="VirtualenvManager.getVirtualenvNames" ID="VirtualenvManager.getVirtualenvNames"></a>
 <h4>VirtualenvManager.getVirtualenvNames</h4>
-<b>getVirtualenvNames</b>(<i>noRemote=False, noConda=False, noGlobals=False</i>)
+<b>getVirtualenvNames</b>(<i>noRemote=False, noConda=False, noGlobals=False, noServer=False</i>)
 <p>
         Public method to get a list of defined virtual environments.
 </p>
@@ -495,6 +529,11 @@
 flag indicating to exclude global environments
             (defaults to False)
 </dd>
+<dt><i>noServer</i> (bool (optional))</dt>
+<dd>
+flag indicating to exclude eric-ide server environments
+            (defaults to False)
+</dd>
 </dl>
 <dl>
 <dt>Return:</dt>
@@ -535,6 +574,38 @@
 bool
 </dd>
 </dl>
+<a NAME="VirtualenvManager.isEricServerEnvironment" ID="VirtualenvManager.isEricServerEnvironment"></a>
+<h4>VirtualenvManager.isEricServerEnvironment</h4>
+<b>isEricServerEnvironment</b>(<i>venvName, host=""</i>)
+<p>
+        Public method to test, if a given environment is an environment accessed
+        through an eric-ide server.
+</p>
+
+<dl>
+
+<dt><i>venvName</i> (str)</dt>
+<dd>
+logical name of the virtual environment
+</dd>
+<dt><i>host</i> (str (optional))</dt>
+<dd>
+name of the host to check for or empty string to just check for
+            an eric-ide server environment (defaults to "")
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating an eric-ide server 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>)

eric ide

mercurial