Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html
Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html
- changeset 6339
- d765c3204c71
- child 6343
- 86cea8abd0f7
equal
deleted
inserted
replaced
| 6338:104ee21d765d | 6339:d765c3204c71 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.VirtualEnv.VirtualenvManager</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.VirtualEnv.VirtualenvManager</h1> | |
| 23 <p> | |
| 24 Module implementing a class to manage Python virtual environments. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#VirtualenvManager">VirtualenvManager</a></td> | |
| 34 <td>Class implementing an object to manage Python virtual environments.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="VirtualenvManager" ID="VirtualenvManager"></a> | |
| 43 <h2>VirtualenvManager</h2> | |
| 44 <p> | |
| 45 Class implementing an object to manage Python virtual environments. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QObject | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#VirtualenvManager.__updateSettings">__updateSettings</a></td> | |
| 64 <td>Private slot to save the virtual environments.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#VirtualenvManager.addVirtualEnv">addVirtualEnv</a></td> | |
| 67 <td>Public method to add a virtual environment.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#VirtualenvManager.createVirtualEnv">createVirtualEnv</a></td> | |
| 70 <td>Public slot to create a new virtual environment.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#VirtualenvManager.deleteVirtualEnvs">deleteVirtualEnvs</a></td> | |
| 73 <td>Public method to delete virtual environments from the list and disk.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td> | |
| 76 <td>Public method to a dictionary containing the defined virtual environment entries.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#VirtualenvManager.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td> | |
| 79 <td>Public method to get the interpreter for a virtual environment.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td> | |
| 82 <td>Public method to get a list of defined virtual environments.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td> | |
| 85 <td>Public method to check, if the give logical name is unique.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td> | |
| 88 <td>Public method to delete virtuals environment from the list.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#VirtualenvManager.renameVirtualEnv">renameVirtualEnv</a></td> | |
| 91 <td>Public method to substitute a virtual environment entry with a new name.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#VirtualenvManager.setVirtualEnv">setVirtualEnv</a></td> | |
| 94 <td>Public method to change a virtual environment.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#VirtualenvManager.showVirtualenvManagerDialog">showVirtualenvManagerDialog</a></td> | |
| 97 <td>Public slot to show the virtual environment manager dialog.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#VirtualenvManager.shutdown">shutdown</a></td> | |
| 100 <td>Public method to shutdown the manager.</td> | |
| 101 </tr> | |
| 102 </table> | |
| 103 <h3>Static Methods</h3> | |
| 104 <table> | |
| 105 <tr><td>None</td></tr> | |
| 106 </table> | |
| 107 <a NAME="VirtualenvManager.__init__" ID="VirtualenvManager.__init__"></a> | |
| 108 <h4>VirtualenvManager (Constructor)</h4> | |
| 109 <b>VirtualenvManager</b>(<i>parent=None</i>) | |
| 110 <p> | |
| 111 Constructor | |
| 112 </p><dl> | |
| 113 <dt><i>parent</i> (QWidget)</dt> | |
| 114 <dd> | |
| 115 reference to the parent object | |
| 116 </dd> | |
| 117 </dl><a NAME="VirtualenvManager.__updateSettings" ID="VirtualenvManager.__updateSettings"></a> | |
| 118 <h4>VirtualenvManager.__updateSettings</h4> | |
| 119 <b>__updateSettings</b>(<i></i>) | |
| 120 <p> | |
| 121 Private slot to save the virtual environments. | |
| 122 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> | |
| 123 <h4>VirtualenvManager.addVirtualEnv</h4> | |
| 124 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter=""</i>) | |
| 125 <p> | |
| 126 Public method to add a virtual environment. | |
| 127 </p><dl> | |
| 128 <dt><i>venvName</i> (str)</dt> | |
| 129 <dd> | |
| 130 logical name for the virtual environment | |
| 131 </dd><dt><i>venvDirectory</i> (str)</dt> | |
| 132 <dd> | |
| 133 directory of the virtual environment | |
| 134 </dd><dt><i>venvInterpreter</i></dt> | |
| 135 <dd> | |
| 136 interpreter of the virtual environment | |
| 137 </dd> | |
| 138 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a> | |
| 139 <h4>VirtualenvManager.createVirtualEnv</h4> | |
| 140 <b>createVirtualEnv</b>(<i></i>) | |
| 141 <p> | |
| 142 Public slot to create a new virtual environment. | |
| 143 </p><a NAME="VirtualenvManager.deleteVirtualEnvs" ID="VirtualenvManager.deleteVirtualEnvs"></a> | |
| 144 <h4>VirtualenvManager.deleteVirtualEnvs</h4> | |
| 145 <b>deleteVirtualEnvs</b>(<i>venvNames</i>) | |
| 146 <p> | |
| 147 Public method to delete virtual environments from the list and disk. | |
| 148 </p><dl> | |
| 149 <dt><i>venvNames</i> (list of str)</dt> | |
| 150 <dd> | |
| 151 list of logical names for the virtual environments | |
| 152 </dd> | |
| 153 </dl><a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a> | |
| 154 <h4>VirtualenvManager.getEnvironmentEntries</h4> | |
| 155 <b>getEnvironmentEntries</b>(<i></i>) | |
| 156 <p> | |
| 157 Public method to a dictionary containing the defined virtual | |
| 158 environment entries. | |
| 159 </p><dl> | |
| 160 <dt>Returns:</dt> | |
| 161 <dd> | |
| 162 dictionary containing tuples of the environment path and | |
| 163 the associated interpreter | |
| 164 </dd> | |
| 165 </dl><dl> | |
| 166 <dt>Return Type:</dt> | |
| 167 <dd> | |
| 168 dict of (str, str) | |
| 169 </dd> | |
| 170 </dl><a NAME="VirtualenvManager.getVirtualenvInterpreter" ID="VirtualenvManager.getVirtualenvInterpreter"></a> | |
| 171 <h4>VirtualenvManager.getVirtualenvInterpreter</h4> | |
| 172 <b>getVirtualenvInterpreter</b>(<i>venvName</i>) | |
| 173 <p> | |
| 174 Public method to get the interpreter for a virtual environment. | |
| 175 </p><dl> | |
| 176 <dt><i>venvName</i> (str)</dt> | |
| 177 <dd> | |
| 178 logical name for the virtual environment | |
| 179 </dd> | |
| 180 </dl><dl> | |
| 181 <dt>Returns:</dt> | |
| 182 <dd> | |
| 183 interpreter path | |
| 184 </dd> | |
| 185 </dl><dl> | |
| 186 <dt>Return Type:</dt> | |
| 187 <dd> | |
| 188 str | |
| 189 </dd> | |
| 190 </dl><a NAME="VirtualenvManager.getVirtualenvNames" ID="VirtualenvManager.getVirtualenvNames"></a> | |
| 191 <h4>VirtualenvManager.getVirtualenvNames</h4> | |
| 192 <b>getVirtualenvNames</b>(<i></i>) | |
| 193 <p> | |
| 194 Public method to get a list of defined virtual environments. | |
| 195 </p><dl> | |
| 196 <dt>Returns:</dt> | |
| 197 <dd> | |
| 198 list of defined virtual environments | |
| 199 </dd> | |
| 200 </dl><dl> | |
| 201 <dt>Return Type:</dt> | |
| 202 <dd> | |
| 203 list of str | |
| 204 </dd> | |
| 205 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a> | |
| 206 <h4>VirtualenvManager.isUnique</h4> | |
| 207 <b>isUnique</b>(<i>venvName</i>) | |
| 208 <p> | |
| 209 Public method to check, if the give logical name is unique. | |
| 210 </p><dl> | |
| 211 <dt><i>venvName</i> (str)</dt> | |
| 212 <dd> | |
| 213 logical name for the virtual environment | |
| 214 </dd> | |
| 215 </dl><dl> | |
| 216 <dt>Returns:</dt> | |
| 217 <dd> | |
| 218 flag indicating uniqueness | |
| 219 </dd> | |
| 220 </dl><dl> | |
| 221 <dt>Return Type:</dt> | |
| 222 <dd> | |
| 223 bool | |
| 224 </dd> | |
| 225 </dl><a NAME="VirtualenvManager.removeVirtualEnvs" ID="VirtualenvManager.removeVirtualEnvs"></a> | |
| 226 <h4>VirtualenvManager.removeVirtualEnvs</h4> | |
| 227 <b>removeVirtualEnvs</b>(<i>venvNames</i>) | |
| 228 <p> | |
| 229 Public method to delete virtuals environment from the list. | |
| 230 </p><dl> | |
| 231 <dt><i>venvNames</i> (list of str)</dt> | |
| 232 <dd> | |
| 233 list of logical names for the virtual environments | |
| 234 </dd> | |
| 235 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> | |
| 236 <h4>VirtualenvManager.renameVirtualEnv</h4> | |
| 237 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter</i>) | |
| 238 <p> | |
| 239 Public method to substitute a virtual environment entry with a new | |
| 240 name. | |
| 241 </p><dl> | |
| 242 <dt><i>oldVenvName</i> (str)</dt> | |
| 243 <dd> | |
| 244 old name of the virtual environment | |
| 245 </dd><dt><i>venvName</i> (str)</dt> | |
| 246 <dd> | |
| 247 logical name for the virtual environment | |
| 248 </dd><dt><i>venvDirectory</i> (str)</dt> | |
| 249 <dd> | |
| 250 directory of the virtual environment | |
| 251 </dd><dt><i>venvInterpreter</i></dt> | |
| 252 <dd> | |
| 253 interpreter of the virtual environment | |
| 254 </dd> | |
| 255 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> | |
| 256 <h4>VirtualenvManager.setVirtualEnv</h4> | |
| 257 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter=""</i>) | |
| 258 <p> | |
| 259 Public method to change a virtual environment. | |
| 260 </p><dl> | |
| 261 <dt><i>venvName</i> (str)</dt> | |
| 262 <dd> | |
| 263 logical name of the virtual environment | |
| 264 </dd><dt><i>venvDirectory</i> (str)</dt> | |
| 265 <dd> | |
| 266 directory of the virtual environment | |
| 267 </dd><dt><i>venvInterpreter</i></dt> | |
| 268 <dd> | |
| 269 interpreter of the virtual environment | |
| 270 </dd> | |
| 271 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a> | |
| 272 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4> | |
| 273 <b>showVirtualenvManagerDialog</b>(<i></i>) | |
| 274 <p> | |
| 275 Public slot to show the virtual environment manager dialog. | |
| 276 </p><a NAME="VirtualenvManager.shutdown" ID="VirtualenvManager.shutdown"></a> | |
| 277 <h4>VirtualenvManager.shutdown</h4> | |
| 278 <b>shutdown</b>(<i></i>) | |
| 279 <p> | |
| 280 Public method to shutdown the manager. | |
| 281 </p> | |
| 282 <div align="right"><a href="#top">Up</a></div> | |
| 283 <hr /> | |
| 284 </body></html> |
