Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

changeset 6362
ec32d1d7f525
parent 6349
17b3c75913de
child 6382
4d6e43200bc7
equal deleted inserted replaced
6361:53f6bd7fb238 6362:ec32d1d7f525
58 <table> 58 <table>
59 <tr> 59 <tr>
60 <td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td> 60 <td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td>
61 <td>Constructor</td> 61 <td>Constructor</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#VirtualenvManager.__isEnvironmentDeleteable">__isEnvironmentDeleteable</a></td>
64 <td>Private method to check, if a virtual environment can be deleted from disk.</td>
65 </tr><tr>
63 <td><a href="#VirtualenvManager.__loadSettings">__loadSettings</a></td> 66 <td><a href="#VirtualenvManager.__loadSettings">__loadSettings</a></td>
64 <td>Private slot to load the virtual environments.</td> 67 <td>Private slot to load the virtual environments.</td>
65 </tr><tr> 68 </tr><tr>
66 <td><a href="#VirtualenvManager.__saveSettings">__saveSettings</a></td> 69 <td><a href="#VirtualenvManager.__saveSettings">__saveSettings</a></td>
67 <td>Private slot to save the virtual environments.</td> 70 <td>Private slot to save the virtual environments.</td>
87 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td> 90 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td>
88 <td>Public method to get a list of defined virtual environments.</td> 91 <td>Public method to get a list of defined virtual environments.</td>
89 </tr><tr> 92 </tr><tr>
90 <td><a href="#VirtualenvManager.getVirtualenvNamesForVariant">getVirtualenvNamesForVariant</a></td> 93 <td><a href="#VirtualenvManager.getVirtualenvNamesForVariant">getVirtualenvNamesForVariant</a></td>
91 <td>Public method to get a list of virtual environments for a given Python variant.</td> 94 <td>Public method to get a list of virtual environments for a given Python variant.</td>
95 </tr><tr>
96 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td>
97 <td>Public method to test, if a given environment is a global one.</td>
92 </tr><tr> 98 </tr><tr>
93 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td> 99 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td>
94 <td>Public method to check, if the give logical name is unique.</td> 100 <td>Public method to check, if the give logical name is unique.</td>
95 </tr><tr> 101 </tr><tr>
96 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td> 102 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td>
120 Constructor 126 Constructor
121 </p><dl> 127 </p><dl>
122 <dt><i>parent</i> (QWidget)</dt> 128 <dt><i>parent</i> (QWidget)</dt>
123 <dd> 129 <dd>
124 reference to the parent object 130 reference to the parent object
131 </dd>
132 </dl><a NAME="VirtualenvManager.__isEnvironmentDeleteable" ID="VirtualenvManager.__isEnvironmentDeleteable"></a>
133 <h4>VirtualenvManager.__isEnvironmentDeleteable</h4>
134 <b>__isEnvironmentDeleteable</b>(<i>venvName</i>)
135 <p>
136 Private method to check, if a virtual environment can be deleted from
137 disk.
138 </p><dl>
139 <dt><i>venvName</i> (str)</dt>
140 <dd>
141 name of the virtual environment
142 </dd>
143 </dl><dl>
144 <dt>Returns:</dt>
145 <dd>
146 flag indicating it can be deleted
147 </dd>
148 </dl><dl>
149 <dt>Return Type:</dt>
150 <dd>
151 bool
125 </dd> 152 </dd>
126 </dl><a NAME="VirtualenvManager.__loadSettings" ID="VirtualenvManager.__loadSettings"></a> 153 </dl><a NAME="VirtualenvManager.__loadSettings" ID="VirtualenvManager.__loadSettings"></a>
127 <h4>VirtualenvManager.__loadSettings</h4> 154 <h4>VirtualenvManager.__loadSettings</h4>
128 <b>__loadSettings</b>(<i></i>) 155 <b>__loadSettings</b>(<i></i>)
129 <p> 156 <p>
133 <b>__saveSettings</b>(<i></i>) 160 <b>__saveSettings</b>(<i></i>)
134 <p> 161 <p>
135 Private slot to save the virtual environments. 162 Private slot to save the virtual environments.
136 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> 163 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a>
137 <h4>VirtualenvManager.addVirtualEnv</h4> 164 <h4>VirtualenvManager.addVirtualEnv</h4>
138 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3</i>) 165 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False</i>)
139 <p> 166 <p>
140 Public method to add a virtual environment. 167 Public method to add a virtual environment.
141 </p><dl> 168 </p><dl>
142 <dt><i>venvName</i> (str)</dt> 169 <dt><i>venvName</i> (str)</dt>
143 <dd> 170 <dd>
149 <dd> 176 <dd>
150 interpreter of the virtual environment 177 interpreter of the virtual environment
151 </dd><dt><i>venvVariant</i> (int)</dt> 178 </dd><dt><i>venvVariant</i> (int)</dt>
152 <dd> 179 <dd>
153 Python variant of the virtual environment 180 Python variant of the virtual environment
181 </dd><dt><i>isGlobal</i> (bool)</dt>
182 <dd>
183 flag indicating a global environment
154 </dd> 184 </dd>
155 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a> 185 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
156 <h4>VirtualenvManager.createVirtualEnv</h4> 186 <h4>VirtualenvManager.createVirtualEnv</h4>
157 <b>createVirtualEnv</b>(<i></i>) 187 <b>createVirtualEnv</b>(<i></i>)
158 <p> 188 <p>
258 </dl><dl> 288 </dl><dl>
259 <dt>Return Type:</dt> 289 <dt>Return Type:</dt>
260 <dd> 290 <dd>
261 list of str 291 list of str
262 </dd> 292 </dd>
293 </dl><a NAME="VirtualenvManager.isGlobalEnvironment" ID="VirtualenvManager.isGlobalEnvironment"></a>
294 <h4>VirtualenvManager.isGlobalEnvironment</h4>
295 <b>isGlobalEnvironment</b>(<i>venvName</i>)
296 <p>
297 Public method to test, if a given environment is a global one.
298 </p><dl>
299 <dt><i>venvName</i> (str)</dt>
300 <dd>
301 logical name of the virtual environment
302 </dd>
303 </dl><dl>
304 <dt>Returns:</dt>
305 <dd>
306 flag indicating a global environment
307 </dd>
308 </dl><dl>
309 <dt>Return Type:</dt>
310 <dd>
311 bool
312 </dd>
263 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a> 313 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a>
264 <h4>VirtualenvManager.isUnique</h4> 314 <h4>VirtualenvManager.isUnique</h4>
265 <b>isUnique</b>(<i>venvName</i>) 315 <b>isUnique</b>(<i>venvName</i>)
266 <p> 316 <p>
267 Public method to check, if the give logical name is unique. 317 Public method to check, if the give logical name is unique.
290 <dd> 340 <dd>
291 list of logical names for the virtual environments 341 list of logical names for the virtual environments
292 </dd> 342 </dd>
293 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> 343 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
294 <h4>VirtualenvManager.renameVirtualEnv</h4> 344 <h4>VirtualenvManager.renameVirtualEnv</h4>
295 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant</i>) 345 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal</i>)
296 <p> 346 <p>
297 Public method to substitute a virtual environment entry with a new 347 Public method to substitute a virtual environment entry with a new
298 name. 348 name.
299 </p><dl> 349 </p><dl>
300 <dt><i>oldVenvName</i> (str)</dt> 350 <dt><i>oldVenvName</i> (str)</dt>
310 <dd> 360 <dd>
311 interpreter of the virtual environment 361 interpreter of the virtual environment
312 </dd><dt><i>venvVariant</i> (int)</dt> 362 </dd><dt><i>venvVariant</i> (int)</dt>
313 <dd> 363 <dd>
314 Python variant of the virtual environment 364 Python variant of the virtual environment
365 </dd><dt><i>isGlobal</i> (bool)</dt>
366 <dd>
367 flag indicating a global environment
315 </dd> 368 </dd>
316 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> 369 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
317 <h4>VirtualenvManager.setVirtualEnv</h4> 370 <h4>VirtualenvManager.setVirtualEnv</h4>
318 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant</i>) 371 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal</i>)
319 <p> 372 <p>
320 Public method to change a virtual environment. 373 Public method to change a virtual environment.
321 </p><dl> 374 </p><dl>
322 <dt><i>venvName</i> (str)</dt> 375 <dt><i>venvName</i> (str)</dt>
323 <dd> 376 <dd>
329 <dd> 382 <dd>
330 interpreter of the virtual environment 383 interpreter of the virtual environment
331 </dd><dt><i>venvVariant</i> (int)</dt> 384 </dd><dt><i>venvVariant</i> (int)</dt>
332 <dd> 385 <dd>
333 Python variant of the virtual environment 386 Python variant of the virtual environment
387 </dd><dt><i>isGlobal</i> (bool)</dt>
388 <dd>
389 flag indicating a global environment
334 </dd> 390 </dd>
335 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a> 391 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a>
336 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4> 392 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4>
337 <b>showVirtualenvManagerDialog</b>(<i></i>) 393 <b>showVirtualenvManagerDialog</b>(<i></i>)
338 <p> 394 <p>

eric ide

mercurial