Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvRegistry.html
src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvRegistry.html
- branch
- eric7
- changeset 11231
- c7240fb719c7
equal
deleted
inserted
replaced
| 11230:8a15b05eeee3 | 11231:c7240fb719c7 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.VirtualEnv.VirtualenvRegistry</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.VirtualEnv.VirtualenvRegistry</h1> | |
| 10 <p> | |
| 11 Module implementing the virtual environment types registry and associated data | |
| 12 structures. | |
| 13 </p> | |
| 14 | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 | |
| 20 <h3>Classes</h3> | |
| 21 <table> | |
| 22 <tr> | |
| 23 <td><a href="#VirtualenvType">VirtualenvType</a></td> | |
| 24 <td>Class implementing a container for the metadata of a virtual environment type.</td> | |
| 25 </tr> | |
| 26 <tr> | |
| 27 <td><a href="#VirtualenvTypeRegistry">VirtualenvTypeRegistry</a></td> | |
| 28 <td>Class implementing the virtual environment type registry.</td> | |
| 29 </tr> | |
| 30 </table> | |
| 31 | |
| 32 <h3>Functions</h3> | |
| 33 <table> | |
| 34 <tr><td>None</td></tr> | |
| 35 </table> | |
| 36 | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="VirtualenvType" ID="VirtualenvType"></a> | |
| 40 <h2>VirtualenvType</h2> | |
| 41 <p> | |
| 42 Class implementing a container for the metadata of a virtual environment type. | |
| 43 </p> | |
| 44 | |
| 45 <h3>Derived from</h3> | |
| 46 None | |
| 47 <h3>Class Attributes</h3> | |
| 48 <table> | |
| 49 <tr><td>createFunc</td></tr> | |
| 50 <tr><td>defaultExecPathFunc</td></tr> | |
| 51 <tr><td>deleteFunc</td></tr> | |
| 52 <tr><td>name</td></tr> | |
| 53 <tr><td>visual_name</td></tr> | |
| 54 </table> | |
| 55 | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 | |
| 61 <h3>Methods</h3> | |
| 62 <table> | |
| 63 <tr><td>None</td></tr> | |
| 64 </table> | |
| 65 | |
| 66 <h3>Static Methods</h3> | |
| 67 <table> | |
| 68 <tr><td>None</td></tr> | |
| 69 </table> | |
| 70 | |
| 71 | |
| 72 <div align="right"><a href="#top">Up</a></div> | |
| 73 <hr /> | |
| 74 <hr /> | |
| 75 <a NAME="VirtualenvTypeRegistry" ID="VirtualenvTypeRegistry"></a> | |
| 76 <h2>VirtualenvTypeRegistry</h2> | |
| 77 <p> | |
| 78 Class implementing the virtual environment type registry. | |
| 79 </p> | |
| 80 | |
| 81 <h3>Derived from</h3> | |
| 82 None | |
| 83 <h3>Class Attributes</h3> | |
| 84 <table> | |
| 85 <tr><td>None</td></tr> | |
| 86 </table> | |
| 87 | |
| 88 <h3>Class Methods</h3> | |
| 89 <table> | |
| 90 <tr><td>None</td></tr> | |
| 91 </table> | |
| 92 | |
| 93 <h3>Methods</h3> | |
| 94 <table> | |
| 95 <tr> | |
| 96 <td><a href="#VirtualenvTypeRegistry.__init__">VirtualenvTypeRegistry</a></td> | |
| 97 <td>Constructor</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#VirtualenvTypeRegistry.getCreatableEnvironmentTypes">getCreatableEnvironmentTypes</a></td> | |
| 101 <td>Public method to get a list of all virtual environment types that posses a creation method/function.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#VirtualenvTypeRegistry.getDeletableEnvironmentTypes">getDeletableEnvironmentTypes</a></td> | |
| 105 <td>Public method to get a list of all virtual environment types that posses a deletion method/function.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#VirtualenvTypeRegistry.getEnvironmentType">getEnvironmentType</a></td> | |
| 109 <td>Public method to get a reference to the named virtual environment type.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#VirtualenvTypeRegistry.getEnvironmentTypeNames">getEnvironmentTypeNames</a></td> | |
| 113 <td>Public method to get a list of names of registered virtual environment types.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#VirtualenvTypeRegistry.registerType">registerType</a></td> | |
| 117 <td>Public method to register a new virtual environment type.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#VirtualenvTypeRegistry.unregisterType">unregisterType</a></td> | |
| 121 <td>Public method to unregister the virtual environment type of the given name.</td> | |
| 122 </tr> | |
| 123 </table> | |
| 124 | |
| 125 <h3>Static Methods</h3> | |
| 126 <table> | |
| 127 <tr><td>None</td></tr> | |
| 128 </table> | |
| 129 | |
| 130 | |
| 131 <a NAME="VirtualenvTypeRegistry.__init__" ID="VirtualenvTypeRegistry.__init__"></a> | |
| 132 <h4>VirtualenvTypeRegistry (Constructor)</h4> | |
| 133 <b>VirtualenvTypeRegistry</b>(<i>venvManager</i>) | |
| 134 <p> | |
| 135 Constructor | |
| 136 </p> | |
| 137 | |
| 138 <dl> | |
| 139 | |
| 140 <dt><i>venvManager</i> (VirtualenvManager)</dt> | |
| 141 <dd> | |
| 142 reference to the virtual environment manager object | |
| 143 </dd> | |
| 144 </dl> | |
| 145 <a NAME="VirtualenvTypeRegistry.getCreatableEnvironmentTypes" ID="VirtualenvTypeRegistry.getCreatableEnvironmentTypes"></a> | |
| 146 <h4>VirtualenvTypeRegistry.getCreatableEnvironmentTypes</h4> | |
| 147 <b>getCreatableEnvironmentTypes</b>(<i></i>) | |
| 148 <p> | |
| 149 Public method to get a list of all virtual environment types that posses a | |
| 150 creation method/function. | |
| 151 </p> | |
| 152 | |
| 153 <dl> | |
| 154 <dt>Return:</dt> | |
| 155 <dd> | |
| 156 list of virtual environment types that posses a creation method/function | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <dl> | |
| 160 <dt>Return Type:</dt> | |
| 161 <dd> | |
| 162 functionType | |
| 163 </dd> | |
| 164 </dl> | |
| 165 <a NAME="VirtualenvTypeRegistry.getDeletableEnvironmentTypes" ID="VirtualenvTypeRegistry.getDeletableEnvironmentTypes"></a> | |
| 166 <h4>VirtualenvTypeRegistry.getDeletableEnvironmentTypes</h4> | |
| 167 <b>getDeletableEnvironmentTypes</b>(<i></i>) | |
| 168 <p> | |
| 169 Public method to get a list of all virtual environment types that posses a | |
| 170 deletion method/function. | |
| 171 </p> | |
| 172 | |
| 173 <dl> | |
| 174 <dt>Return:</dt> | |
| 175 <dd> | |
| 176 list of virtual environment types that posses a deletion method/function | |
| 177 </dd> | |
| 178 </dl> | |
| 179 <dl> | |
| 180 <dt>Return Type:</dt> | |
| 181 <dd> | |
| 182 functionType | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <a NAME="VirtualenvTypeRegistry.getEnvironmentType" ID="VirtualenvTypeRegistry.getEnvironmentType"></a> | |
| 186 <h4>VirtualenvTypeRegistry.getEnvironmentType</h4> | |
| 187 <b>getEnvironmentType</b>(<i>name</i>) | |
| 188 <p> | |
| 189 Public method to get a reference to the named virtual environment type. | |
| 190 </p> | |
| 191 | |
| 192 <dl> | |
| 193 | |
| 194 <dt><i>name</i> (str)</dt> | |
| 195 <dd> | |
| 196 name of the virtual environment type | |
| 197 </dd> | |
| 198 </dl> | |
| 199 <dl> | |
| 200 <dt>Return:</dt> | |
| 201 <dd> | |
| 202 reference to the environment type data | |
| 203 </dd> | |
| 204 </dl> | |
| 205 <dl> | |
| 206 <dt>Return Type:</dt> | |
| 207 <dd> | |
| 208 VirtualenvType | |
| 209 </dd> | |
| 210 </dl> | |
| 211 <a NAME="VirtualenvTypeRegistry.getEnvironmentTypeNames" ID="VirtualenvTypeRegistry.getEnvironmentTypeNames"></a> | |
| 212 <h4>VirtualenvTypeRegistry.getEnvironmentTypeNames</h4> | |
| 213 <b>getEnvironmentTypeNames</b>(<i></i>) | |
| 214 <p> | |
| 215 Public method to get a list of names of registered virtual environment types. | |
| 216 </p> | |
| 217 | |
| 218 <dl> | |
| 219 <dt>Return:</dt> | |
| 220 <dd> | |
| 221 list of tuples of virtual environment type names and their visual name | |
| 222 </dd> | |
| 223 </dl> | |
| 224 <dl> | |
| 225 <dt>Return Type:</dt> | |
| 226 <dd> | |
| 227 list of tuple of (str, str) | |
| 228 </dd> | |
| 229 </dl> | |
| 230 <a NAME="VirtualenvTypeRegistry.registerType" ID="VirtualenvTypeRegistry.registerType"></a> | |
| 231 <h4>VirtualenvTypeRegistry.registerType</h4> | |
| 232 <b>registerType</b>(<i>venvType</i>) | |
| 233 <p> | |
| 234 Public method to register a new virtual environment type. | |
| 235 </p> | |
| 236 | |
| 237 <dl> | |
| 238 | |
| 239 <dt><i>venvType</i> (VirtualenvType)</dt> | |
| 240 <dd> | |
| 241 virtual environment data | |
| 242 </dd> | |
| 243 </dl> | |
| 244 <dl> | |
| 245 | |
| 246 <dt>Raises <b>KeyError</b>:</dt> | |
| 247 <dd> | |
| 248 raised to indicate an already registered environment name | |
| 249 </dd> | |
| 250 </dl> | |
| 251 <a NAME="VirtualenvTypeRegistry.unregisterType" ID="VirtualenvTypeRegistry.unregisterType"></a> | |
| 252 <h4>VirtualenvTypeRegistry.unregisterType</h4> | |
| 253 <b>unregisterType</b>(<i>name</i>) | |
| 254 <p> | |
| 255 Public method to unregister the virtual environment type of the given name. | |
| 256 </p> | |
| 257 | |
| 258 <dl> | |
| 259 | |
| 260 <dt><i>name</i> (str)</dt> | |
| 261 <dd> | |
| 262 name of the virtual environment type | |
| 263 </dd> | |
| 264 </dl> | |
| 265 <div align="right"><a href="#top">Up</a></div> | |
| 266 <hr /> | |
| 267 </body></html> |
