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

branch
eric7
changeset 11231
c7240fb719c7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvRegistry.html	Wed Apr 23 18:03:14 2025 +0200
@@ -0,0 +1,267 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.VirtualEnv.VirtualenvRegistry</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.VirtualEnv.VirtualenvRegistry</h1>
+<p>
+Module implementing the virtual environment types registry and associated data
+structures.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#VirtualenvType">VirtualenvType</a></td>
+<td>Class implementing a container for the metadata of a virtual environment type.</td>
+</tr>
+<tr>
+<td><a href="#VirtualenvTypeRegistry">VirtualenvTypeRegistry</a></td>
+<td>Class implementing the virtual environment type registry.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="VirtualenvType" ID="VirtualenvType"></a>
+<h2>VirtualenvType</h2>
+<p>
+    Class implementing a container for the metadata of a virtual environment type.
+</p>
+
+<h3>Derived from</h3>
+None
+<h3>Class Attributes</h3>
+<table>
+<tr><td>createFunc</td></tr>
+<tr><td>defaultExecPathFunc</td></tr>
+<tr><td>deleteFunc</td></tr>
+<tr><td>name</td></tr>
+<tr><td>visual_name</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="VirtualenvTypeRegistry" ID="VirtualenvTypeRegistry"></a>
+<h2>VirtualenvTypeRegistry</h2>
+<p>
+    Class implementing the virtual environment type registry.
+</p>
+
+<h3>Derived from</h3>
+None
+<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="#VirtualenvTypeRegistry.__init__">VirtualenvTypeRegistry</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#VirtualenvTypeRegistry.getCreatableEnvironmentTypes">getCreatableEnvironmentTypes</a></td>
+<td>Public method to get a list of all virtual environment types that posses a creation method/function.</td>
+</tr>
+<tr>
+<td><a href="#VirtualenvTypeRegistry.getDeletableEnvironmentTypes">getDeletableEnvironmentTypes</a></td>
+<td>Public method to get a list of all virtual environment types that posses a deletion method/function.</td>
+</tr>
+<tr>
+<td><a href="#VirtualenvTypeRegistry.getEnvironmentType">getEnvironmentType</a></td>
+<td>Public method to get a reference to the named virtual environment type.</td>
+</tr>
+<tr>
+<td><a href="#VirtualenvTypeRegistry.getEnvironmentTypeNames">getEnvironmentTypeNames</a></td>
+<td>Public method to get a list of names of registered virtual environment types.</td>
+</tr>
+<tr>
+<td><a href="#VirtualenvTypeRegistry.registerType">registerType</a></td>
+<td>Public method to register a new virtual environment type.</td>
+</tr>
+<tr>
+<td><a href="#VirtualenvTypeRegistry.unregisterType">unregisterType</a></td>
+<td>Public method to unregister the virtual environment type of the given name.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="VirtualenvTypeRegistry.__init__" ID="VirtualenvTypeRegistry.__init__"></a>
+<h4>VirtualenvTypeRegistry (Constructor)</h4>
+<b>VirtualenvTypeRegistry</b>(<i>venvManager</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>venvManager</i> (VirtualenvManager)</dt>
+<dd>
+reference to the virtual environment manager object
+</dd>
+</dl>
+<a NAME="VirtualenvTypeRegistry.getCreatableEnvironmentTypes" ID="VirtualenvTypeRegistry.getCreatableEnvironmentTypes"></a>
+<h4>VirtualenvTypeRegistry.getCreatableEnvironmentTypes</h4>
+<b>getCreatableEnvironmentTypes</b>(<i></i>)
+<p>
+        Public method to get a list of all virtual environment types that posses a
+        creation method/function.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of virtual environment types that posses a creation method/function
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+functionType
+</dd>
+</dl>
+<a NAME="VirtualenvTypeRegistry.getDeletableEnvironmentTypes" ID="VirtualenvTypeRegistry.getDeletableEnvironmentTypes"></a>
+<h4>VirtualenvTypeRegistry.getDeletableEnvironmentTypes</h4>
+<b>getDeletableEnvironmentTypes</b>(<i></i>)
+<p>
+        Public method to get a list of all virtual environment types that posses a
+        deletion method/function.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of virtual environment types that posses a deletion method/function
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+functionType
+</dd>
+</dl>
+<a NAME="VirtualenvTypeRegistry.getEnvironmentType" ID="VirtualenvTypeRegistry.getEnvironmentType"></a>
+<h4>VirtualenvTypeRegistry.getEnvironmentType</h4>
+<b>getEnvironmentType</b>(<i>name</i>)
+<p>
+        Public method to get a reference to the named virtual environment type.
+</p>
+
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the virtual environment type
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the environment type data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+VirtualenvType
+</dd>
+</dl>
+<a NAME="VirtualenvTypeRegistry.getEnvironmentTypeNames" ID="VirtualenvTypeRegistry.getEnvironmentTypeNames"></a>
+<h4>VirtualenvTypeRegistry.getEnvironmentTypeNames</h4>
+<b>getEnvironmentTypeNames</b>(<i></i>)
+<p>
+        Public method to get a list of names of registered virtual environment types.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of tuples of virtual environment type names and their visual name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of tuple of (str, str)
+</dd>
+</dl>
+<a NAME="VirtualenvTypeRegistry.registerType" ID="VirtualenvTypeRegistry.registerType"></a>
+<h4>VirtualenvTypeRegistry.registerType</h4>
+<b>registerType</b>(<i>venvType</i>)
+<p>
+        Public method to register a new virtual environment type.
+</p>
+
+<dl>
+
+<dt><i>venvType</i> (VirtualenvType)</dt>
+<dd>
+virtual environment data
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>KeyError</b>:</dt>
+<dd>
+raised to indicate an already registered environment name
+</dd>
+</dl>
+<a NAME="VirtualenvTypeRegistry.unregisterType" ID="VirtualenvTypeRegistry.unregisterType"></a>
+<h4>VirtualenvTypeRegistry.unregisterType</h4>
+<b>unregisterType</b>(<i>name</i>)
+<p>
+        Public method to unregister the virtual environment type of the given name.
+</p>
+
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the virtual environment type
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial