Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

changeset 6942
2602857055c5
parent 6903
0d4e1033731b
child 6976
66913de629f6
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
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><h3>Signals</h3>
47 <dl>
48 <dt>virtualEnvironmentAdded()</dt>
49 <dd>
50 emitted to indicate the addition of
51 a virtual environment
52 </dd><dt>virtualEnvironmentChanged(name)</dt>
53 <dd>
54 emitted to indicate a change of
55 a virtual environment
56 </dd><dt>virtualEnvironmentRemoved()</dt>
57 <dd>
58 emitted to indicate the removal and
59 deletion of a virtual environment
60 </dd>
61 </dl>
62 <h3>Derived from</h3>
63 QObject
64 <h3>Class Attributes</h3>
65 <table>
66 <tr><td>DefaultKey</td></tr>
67 </table>
68 <h3>Class Methods</h3>
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72 <h3>Methods</h3>
73 <table>
74 <tr>
75 <td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td>
76 <td>Constructor</td>
77 </tr><tr>
78 <td><a href="#VirtualenvManager.__isEnvironmentDeleteable">__isEnvironmentDeleteable</a></td>
79 <td>Private method to check, if a virtual environment can be deleted from disk.</td>
80 </tr><tr>
81 <td><a href="#VirtualenvManager.__loadSettings">__loadSettings</a></td>
82 <td>Private slot to load the virtual environments.</td>
83 </tr><tr>
84 <td><a href="#VirtualenvManager.__saveSettings">__saveSettings</a></td>
85 <td>Private slot to save the virtual environments.</td>
86 </tr><tr>
87 <td><a href="#VirtualenvManager.addVirtualEnv">addVirtualEnv</a></td>
88 <td>Public method to add a virtual environment.</td>
89 </tr><tr>
90 <td><a href="#VirtualenvManager.createVirtualEnv">createVirtualEnv</a></td>
91 <td>Public slot to create a new virtual environment.</td>
92 </tr><tr>
93 <td><a href="#VirtualenvManager.deleteVirtualEnvs">deleteVirtualEnvs</a></td>
94 <td>Public method to delete virtual environments from the list and disk.</td>
95 </tr><tr>
96 <td><a href="#VirtualenvManager.getDefaultEnvironment">getDefaultEnvironment</a></td>
97 <td>Public method to get the default virtual environment.</td>
98 </tr><tr>
99 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td>
100 <td>Public method to get a dictionary containing the defined virtual environment entries.</td>
101 </tr><tr>
102 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td>
103 <td>Public method to get the directory of a virtual environment.</td>
104 </tr><tr>
105 <td><a href="#VirtualenvManager.getVirtualenvExecPath">getVirtualenvExecPath</a></td>
106 <td>Public method to get the search path prefix of a virtual environment.</td>
107 </tr><tr>
108 <td><a href="#VirtualenvManager.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td>
109 <td>Public method to get the interpreter for a virtual environment.</td>
110 </tr><tr>
111 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td>
112 <td>Public method to get a list of defined virtual environments.</td>
113 </tr><tr>
114 <td><a href="#VirtualenvManager.getVirtualenvNamesForVariant">getVirtualenvNamesForVariant</a></td>
115 <td>Public method to get a list of virtual environments for a given Python variant.</td>
116 </tr><tr>
117 <td><a href="#VirtualenvManager.getVirtualenvVariant">getVirtualenvVariant</a></td>
118 <td>Public method to get the variant of a virtual environment.</td>
119 </tr><tr>
120 <td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td>
121 <td>Public method to test, if a given environment is an Anaconda environment.</td>
122 </tr><tr>
123 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td>
124 <td>Public method to test, if a given environment is a global one.</td>
125 </tr><tr>
126 <td><a href="#VirtualenvManager.isRemoteEnvironment">isRemoteEnvironment</a></td>
127 <td>Public method to test, if a given environment is a remotely accessed environment.</td>
128 </tr><tr>
129 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td>
130 <td>Public method to check, if the give logical name is unique.</td>
131 </tr><tr>
132 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td>
133 <td>Public method to delete virtual environment from the list.</td>
134 </tr><tr>
135 <td><a href="#VirtualenvManager.renameVirtualEnv">renameVirtualEnv</a></td>
136 <td>Public method to substitute a virtual environment entry with a new name.</td>
137 </tr><tr>
138 <td><a href="#VirtualenvManager.setVirtualEnv">setVirtualEnv</a></td>
139 <td>Public method to change a virtual environment.</td>
140 </tr><tr>
141 <td><a href="#VirtualenvManager.showVirtualenvManagerDialog">showVirtualenvManagerDialog</a></td>
142 <td>Public slot to show the virtual environment manager dialog.</td>
143 </tr><tr>
144 <td><a href="#VirtualenvManager.shutdown">shutdown</a></td>
145 <td>Public method to shutdown the manager.</td>
146 </tr>
147 </table>
148 <h3>Static Methods</h3>
149 <table>
150 <tr><td>None</td></tr>
151 </table>
152 <a NAME="VirtualenvManager.__init__" ID="VirtualenvManager.__init__"></a>
153 <h4>VirtualenvManager (Constructor)</h4>
154 <b>VirtualenvManager</b>(<i>parent=None</i>)
155 <p>
156 Constructor
157 </p><dl>
158 <dt><i>parent</i> (QWidget)</dt>
159 <dd>
160 reference to the parent object
161 </dd>
162 </dl><a NAME="VirtualenvManager.__isEnvironmentDeleteable" ID="VirtualenvManager.__isEnvironmentDeleteable"></a>
163 <h4>VirtualenvManager.__isEnvironmentDeleteable</h4>
164 <b>__isEnvironmentDeleteable</b>(<i>venvName</i>)
165 <p>
166 Private method to check, if a virtual environment can be deleted from
167 disk.
168 </p><dl>
169 <dt><i>venvName</i> (str)</dt>
170 <dd>
171 name of the virtual environment
172 </dd>
173 </dl><dl>
174 <dt>Returns:</dt>
175 <dd>
176 flag indicating it can be deleted
177 </dd>
178 </dl><dl>
179 <dt>Return Type:</dt>
180 <dd>
181 bool
182 </dd>
183 </dl><a NAME="VirtualenvManager.__loadSettings" ID="VirtualenvManager.__loadSettings"></a>
184 <h4>VirtualenvManager.__loadSettings</h4>
185 <b>__loadSettings</b>(<i></i>)
186 <p>
187 Private slot to load the virtual environments.
188 </p><a NAME="VirtualenvManager.__saveSettings" ID="VirtualenvManager.__saveSettings"></a>
189 <h4>VirtualenvManager.__saveSettings</h4>
190 <b>__saveSettings</b>(<i></i>)
191 <p>
192 Private slot to save the virtual environments.
193 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a>
194 <h4>VirtualenvManager.addVirtualEnv</h4>
195 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, isRemote=False, execPath=""</i>)
196 <p>
197 Public method to add a virtual environment.
198 </p><dl>
199 <dt><i>venvName</i> (str)</dt>
200 <dd>
201 logical name for the virtual environment
202 </dd><dt><i>venvDirectory</i> (str)</dt>
203 <dd>
204 directory of the virtual environment
205 </dd><dt><i>venvInterpreter</i> (str)</dt>
206 <dd>
207 interpreter of the virtual environment
208 </dd><dt><i>venvVariant</i> (int)</dt>
209 <dd>
210 Python variant of the virtual environment
211 </dd><dt><i>isGlobal</i> (bool)</dt>
212 <dd>
213 flag indicating a global environment
214 </dd><dt><i>isConda</i> (bool)</dt>
215 <dd>
216 flag indicating an Anaconda virtual environment
217 </dd><dt><i>isRemote</i> (bool)</dt>
218 <dd>
219 flag indicating a remotely accessed environment
220 </dd><dt><i>execPath</i> (str)</dt>
221 <dd>
222 search path string to be prepended to the PATH
223 environment variable
224 </dd>
225 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
226 <h4>VirtualenvManager.createVirtualEnv</h4>
227 <b>createVirtualEnv</b>(<i></i>)
228 <p>
229 Public slot to create a new virtual environment.
230 </p><a NAME="VirtualenvManager.deleteVirtualEnvs" ID="VirtualenvManager.deleteVirtualEnvs"></a>
231 <h4>VirtualenvManager.deleteVirtualEnvs</h4>
232 <b>deleteVirtualEnvs</b>(<i>venvNames</i>)
233 <p>
234 Public method to delete virtual environments from the list and disk.
235 </p><dl>
236 <dt><i>venvNames</i> (list of str)</dt>
237 <dd>
238 list of logical names for the virtual environments
239 </dd>
240 </dl><a NAME="VirtualenvManager.getDefaultEnvironment" ID="VirtualenvManager.getDefaultEnvironment"></a>
241 <h4>VirtualenvManager.getDefaultEnvironment</h4>
242 <b>getDefaultEnvironment</b>(<i></i>)
243 <p>
244 Public method to get the default virtual environment.
245 </p><p>
246 Default is an environment with the key '<default>' or the first one
247 having an interpreter matching sys.executable (i.e. the one used to
248 execute eric6 with)
249 </p><dl>
250 <dt>Returns:</dt>
251 <dd>
252 tuple containing the environment name and a dictionary
253 containing a copy of the default virtual environment
254 </dd>
255 </dl><dl>
256 <dt>Return Type:</dt>
257 <dd>
258 tuple of (str, dict)
259 </dd>
260 </dl><a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a>
261 <h4>VirtualenvManager.getEnvironmentEntries</h4>
262 <b>getEnvironmentEntries</b>(<i></i>)
263 <p>
264 Public method to get a dictionary containing the defined virtual
265 environment entries.
266 </p><dl>
267 <dt>Returns:</dt>
268 <dd>
269 dictionary containing a copy of the defined virtual
270 environments
271 </dd>
272 </dl><dl>
273 <dt>Return Type:</dt>
274 <dd>
275 dict
276 </dd>
277 </dl><a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a>
278 <h4>VirtualenvManager.getVirtualenvDirectory</h4>
279 <b>getVirtualenvDirectory</b>(<i>venvName</i>)
280 <p>
281 Public method to get the directory of a virtual environment.
282 </p><dl>
283 <dt><i>venvName</i> (str)</dt>
284 <dd>
285 logical name for the virtual environment
286 </dd>
287 </dl><dl>
288 <dt>Returns:</dt>
289 <dd>
290 directory path
291 </dd>
292 </dl><dl>
293 <dt>Return Type:</dt>
294 <dd>
295 str
296 </dd>
297 </dl><a NAME="VirtualenvManager.getVirtualenvExecPath" ID="VirtualenvManager.getVirtualenvExecPath"></a>
298 <h4>VirtualenvManager.getVirtualenvExecPath</h4>
299 <b>getVirtualenvExecPath</b>(<i>venvName</i>)
300 <p>
301 Public method to get the search path prefix of a virtual environment.
302 </p><dl>
303 <dt><i>venvName</i> (str)</dt>
304 <dd>
305 logical name for the virtual environment
306 </dd>
307 </dl><dl>
308 <dt>Returns:</dt>
309 <dd>
310 search path prefix
311 </dd>
312 </dl><dl>
313 <dt>Return Type:</dt>
314 <dd>
315 str
316 </dd>
317 </dl><a NAME="VirtualenvManager.getVirtualenvInterpreter" ID="VirtualenvManager.getVirtualenvInterpreter"></a>
318 <h4>VirtualenvManager.getVirtualenvInterpreter</h4>
319 <b>getVirtualenvInterpreter</b>(<i>venvName</i>)
320 <p>
321 Public method to get the interpreter for a virtual environment.
322 </p><dl>
323 <dt><i>venvName</i> (str)</dt>
324 <dd>
325 logical name for the virtual environment
326 </dd>
327 </dl><dl>
328 <dt>Returns:</dt>
329 <dd>
330 interpreter path
331 </dd>
332 </dl><dl>
333 <dt>Return Type:</dt>
334 <dd>
335 str
336 </dd>
337 </dl><a NAME="VirtualenvManager.getVirtualenvNames" ID="VirtualenvManager.getVirtualenvNames"></a>
338 <h4>VirtualenvManager.getVirtualenvNames</h4>
339 <b>getVirtualenvNames</b>(<i></i>)
340 <p>
341 Public method to get a list of defined virtual environments.
342 </p><dl>
343 <dt>Returns:</dt>
344 <dd>
345 list of defined virtual environments
346 </dd>
347 </dl><dl>
348 <dt>Return Type:</dt>
349 <dd>
350 list of str
351 </dd>
352 </dl><a NAME="VirtualenvManager.getVirtualenvNamesForVariant" ID="VirtualenvManager.getVirtualenvNamesForVariant"></a>
353 <h4>VirtualenvManager.getVirtualenvNamesForVariant</h4>
354 <b>getVirtualenvNamesForVariant</b>(<i>variant</i>)
355 <p>
356 Public method to get a list of virtual environments for a given
357 Python variant.
358 </p><dl>
359 <dt><i>variant</i> (int)</dt>
360 <dd>
361 Python variant (2 or 3)
362 </dd>
363 </dl><dl>
364 <dt>Returns:</dt>
365 <dd>
366 list of defined virtual environments
367 </dd>
368 </dl><dl>
369 <dt>Return Type:</dt>
370 <dd>
371 list of str
372 </dd>
373 </dl><a NAME="VirtualenvManager.getVirtualenvVariant" ID="VirtualenvManager.getVirtualenvVariant"></a>
374 <h4>VirtualenvManager.getVirtualenvVariant</h4>
375 <b>getVirtualenvVariant</b>(<i>venvName</i>)
376 <p>
377 Public method to get the variant of a virtual environment.
378 </p><dl>
379 <dt><i>venvName</i> (str)</dt>
380 <dd>
381 logical name for the virtual environment
382 </dd>
383 </dl><dl>
384 <dt>Returns:</dt>
385 <dd>
386 Python variant of the environment
387 </dd>
388 </dl><dl>
389 <dt>Return Type:</dt>
390 <dd>
391 str
392 </dd>
393 </dl><a NAME="VirtualenvManager.isCondaEnvironment" ID="VirtualenvManager.isCondaEnvironment"></a>
394 <h4>VirtualenvManager.isCondaEnvironment</h4>
395 <b>isCondaEnvironment</b>(<i>venvName</i>)
396 <p>
397 Public method to test, if a given environment is an Anaconda
398 environment.
399 </p><dl>
400 <dt><i>venvName</i> (str)</dt>
401 <dd>
402 logical name of the virtual environment
403 </dd>
404 </dl><dl>
405 <dt>Returns:</dt>
406 <dd>
407 flag indicating an Anaconda environment
408 </dd>
409 </dl><dl>
410 <dt>Return Type:</dt>
411 <dd>
412 bool
413 </dd>
414 </dl><a NAME="VirtualenvManager.isGlobalEnvironment" ID="VirtualenvManager.isGlobalEnvironment"></a>
415 <h4>VirtualenvManager.isGlobalEnvironment</h4>
416 <b>isGlobalEnvironment</b>(<i>venvName</i>)
417 <p>
418 Public method to test, if a given environment is a global one.
419 </p><dl>
420 <dt><i>venvName</i> (str)</dt>
421 <dd>
422 logical name of the virtual environment
423 </dd>
424 </dl><dl>
425 <dt>Returns:</dt>
426 <dd>
427 flag indicating a global environment
428 </dd>
429 </dl><dl>
430 <dt>Return Type:</dt>
431 <dd>
432 bool
433 </dd>
434 </dl><a NAME="VirtualenvManager.isRemoteEnvironment" ID="VirtualenvManager.isRemoteEnvironment"></a>
435 <h4>VirtualenvManager.isRemoteEnvironment</h4>
436 <b>isRemoteEnvironment</b>(<i>venvName</i>)
437 <p>
438 Public method to test, if a given environment is a remotely accessed
439 environment.
440 </p><dl>
441 <dt><i>venvName</i> (str)</dt>
442 <dd>
443 logical name of the virtual environment
444 </dd>
445 </dl><dl>
446 <dt>Returns:</dt>
447 <dd>
448 flag indicating a remotely accessed environment
449 </dd>
450 </dl><dl>
451 <dt>Return Type:</dt>
452 <dd>
453 bool
454 </dd>
455 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a>
456 <h4>VirtualenvManager.isUnique</h4>
457 <b>isUnique</b>(<i>venvName</i>)
458 <p>
459 Public method to check, if the give logical name is unique.
460 </p><dl>
461 <dt><i>venvName</i> (str)</dt>
462 <dd>
463 logical name for the virtual environment
464 </dd>
465 </dl><dl>
466 <dt>Returns:</dt>
467 <dd>
468 flag indicating uniqueness
469 </dd>
470 </dl><dl>
471 <dt>Return Type:</dt>
472 <dd>
473 bool
474 </dd>
475 </dl><a NAME="VirtualenvManager.removeVirtualEnvs" ID="VirtualenvManager.removeVirtualEnvs"></a>
476 <h4>VirtualenvManager.removeVirtualEnvs</h4>
477 <b>removeVirtualEnvs</b>(<i>venvNames</i>)
478 <p>
479 Public method to delete virtual environment from the list.
480 </p><dl>
481 <dt><i>venvNames</i> (list of str)</dt>
482 <dd>
483 list of logical names for the virtual environments
484 </dd>
485 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
486 <h4>VirtualenvManager.renameVirtualEnv</h4>
487 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>)
488 <p>
489 Public method to substitute a virtual environment entry with a new
490 name.
491 </p><dl>
492 <dt><i>oldVenvName</i> (str)</dt>
493 <dd>
494 old name of the virtual environment
495 </dd><dt><i>venvName</i> (str)</dt>
496 <dd>
497 logical name for the virtual environment
498 </dd><dt><i>venvDirectory</i> (str)</dt>
499 <dd>
500 directory of the virtual environment
501 </dd><dt><i>venvInterpreter</i> (str)</dt>
502 <dd>
503 interpreter of the virtual environment
504 </dd><dt><i>venvVariant</i> (int)</dt>
505 <dd>
506 Python variant of the virtual environment
507 </dd><dt><i>isGlobal</i> (bool)</dt>
508 <dd>
509 flag indicating a global environment
510 </dd><dt><i>isConda</i> (bool)</dt>
511 <dd>
512 flag indicating an Anaconda virtual environment
513 </dd><dt><i>isRemote</i> (bool)</dt>
514 <dd>
515 flag indicating a remotely accessed environment
516 </dd><dt><i>execPath</i> (str)</dt>
517 <dd>
518 search path string to be prepended to the PATH
519 environment variable
520 </dd>
521 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
522 <h4>VirtualenvManager.setVirtualEnv</h4>
523 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>)
524 <p>
525 Public method to change a virtual environment.
526 </p><dl>
527 <dt><i>venvName</i> (str)</dt>
528 <dd>
529 logical name of the virtual environment
530 </dd><dt><i>venvDirectory</i> (str)</dt>
531 <dd>
532 directory of the virtual environment
533 </dd><dt><i>venvInterpreter</i> (str)</dt>
534 <dd>
535 interpreter of the virtual environment
536 </dd><dt><i>venvVariant</i> (int)</dt>
537 <dd>
538 Python variant of the virtual environment
539 </dd><dt><i>isGlobal</i> (bool)</dt>
540 <dd>
541 flag indicating a global environment
542 </dd><dt><i>isConda</i> (bool)</dt>
543 <dd>
544 flag indicating an Anaconda virtual environment
545 </dd><dt><i>isRemote</i> (bool)</dt>
546 <dd>
547 flag indicating a remotely accessed environment
548 </dd><dt><i>execPath</i> (str)</dt>
549 <dd>
550 search path string to be prepended to the PATH
551 environment variable
552 </dd>
553 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a>
554 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4>
555 <b>showVirtualenvManagerDialog</b>(<i>modal=False</i>)
556 <p>
557 Public slot to show the virtual environment manager dialog.
558 </p><dl>
559 <dt><i>modal</i></dt>
560 <dd>
561 flag indicating that the dialog should be shown in
562 a blocking mode
563 </dd>
564 </dl><a NAME="VirtualenvManager.shutdown" ID="VirtualenvManager.shutdown"></a>
565 <h4>VirtualenvManager.shutdown</h4>
566 <b>shutdown</b>(<i></i>)
567 <p>
568 Public method to shutdown the manager.
569 </p>
570 <div align="right"><a href="#top">Up</a></div>
571 <hr />
572 </body></html>

Mercurial Repository: eric

eric ide

mercurial