Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6976
66913de629f6
child 7635
0cdead130a81
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.VirtualEnv.VirtualenvManager</h1> 23 <h1>eric6.VirtualEnv.VirtualenvManager</h1>
24
23 <p> 25 <p>
24 Module implementing a class to manage Python virtual environments. 26 Module implementing a class to manage Python virtual environments.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#VirtualenvManager">VirtualenvManager</a></td> 38 <td><a href="#VirtualenvManager">VirtualenvManager</a></td>
34 <td>Class implementing an object to manage Python virtual environments.</td> 39 <td>Class implementing an object to manage Python virtual environments.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="VirtualenvManager" ID="VirtualenvManager"></a> 49 <a NAME="VirtualenvManager" ID="VirtualenvManager"></a>
43 <h2>VirtualenvManager</h2> 50 <h2>VirtualenvManager</h2>
51
44 <p> 52 <p>
45 Class implementing an object to manage Python virtual environments. 53 Class implementing an object to manage Python virtual environments.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>virtualEnvironmentAdded()</dt> 58 <dt>virtualEnvironmentAdded()</dt>
49 <dd> 59 <dd>
50 emitted to indicate the addition of 60 emitted to indicate the addition of
51 a virtual environment 61 a virtual environment
52 </dd><dt>virtualEnvironmentChanged(name)</dt> 62 </dd>
63 <dt>virtualEnvironmentChanged(name)</dt>
53 <dd> 64 <dd>
54 emitted to indicate a change of 65 emitted to indicate a change of
55 a virtual environment 66 a virtual environment
56 </dd><dt>virtualEnvironmentRemoved()</dt> 67 </dd>
68 <dt>virtualEnvironmentRemoved()</dt>
57 <dd> 69 <dd>
58 emitted to indicate the removal and 70 emitted to indicate the removal and
59 deletion of a virtual environment 71 deletion of a virtual environment
60 </dd> 72 </dd>
61 </dl> 73 </dl>
62 <h3>Derived from</h3> 74 <h3>Derived from</h3>
63 QObject 75 QObject
64 <h3>Class Attributes</h3> 76 <h3>Class Attributes</h3>
77
65 <table> 78 <table>
66 <tr><td>DefaultKey</td></tr> 79 <tr><td>DefaultKey</td></tr>
67 </table> 80 </table>
68 <h3>Class Methods</h3> 81 <h3>Class Methods</h3>
82
69 <table> 83 <table>
70 <tr><td>None</td></tr> 84 <tr><td>None</td></tr>
71 </table> 85 </table>
72 <h3>Methods</h3> 86 <h3>Methods</h3>
87
73 <table> 88 <table>
89
74 <tr> 90 <tr>
75 <td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td> 91 <td><a href="#VirtualenvManager.__init__">VirtualenvManager</a></td>
76 <td>Constructor</td> 92 <td>Constructor</td>
77 </tr><tr> 93 </tr>
94 <tr>
78 <td><a href="#VirtualenvManager.__isEnvironmentDeleteable">__isEnvironmentDeleteable</a></td> 95 <td><a href="#VirtualenvManager.__isEnvironmentDeleteable">__isEnvironmentDeleteable</a></td>
79 <td>Private method to check, if a virtual environment can be deleted from disk.</td> 96 <td>Private method to check, if a virtual environment can be deleted from disk.</td>
80 </tr><tr> 97 </tr>
98 <tr>
81 <td><a href="#VirtualenvManager.__loadSettings">__loadSettings</a></td> 99 <td><a href="#VirtualenvManager.__loadSettings">__loadSettings</a></td>
82 <td>Private slot to load the virtual environments.</td> 100 <td>Private slot to load the virtual environments.</td>
83 </tr><tr> 101 </tr>
102 <tr>
84 <td><a href="#VirtualenvManager.__saveSettings">__saveSettings</a></td> 103 <td><a href="#VirtualenvManager.__saveSettings">__saveSettings</a></td>
85 <td>Private slot to save the virtual environments.</td> 104 <td>Private slot to save the virtual environments.</td>
86 </tr><tr> 105 </tr>
106 <tr>
87 <td><a href="#VirtualenvManager.addVirtualEnv">addVirtualEnv</a></td> 107 <td><a href="#VirtualenvManager.addVirtualEnv">addVirtualEnv</a></td>
88 <td>Public method to add a virtual environment.</td> 108 <td>Public method to add a virtual environment.</td>
89 </tr><tr> 109 </tr>
110 <tr>
90 <td><a href="#VirtualenvManager.createVirtualEnv">createVirtualEnv</a></td> 111 <td><a href="#VirtualenvManager.createVirtualEnv">createVirtualEnv</a></td>
91 <td>Public slot to create a new virtual environment.</td> 112 <td>Public slot to create a new virtual environment.</td>
92 </tr><tr> 113 </tr>
114 <tr>
93 <td><a href="#VirtualenvManager.deleteVirtualEnvs">deleteVirtualEnvs</a></td> 115 <td><a href="#VirtualenvManager.deleteVirtualEnvs">deleteVirtualEnvs</a></td>
94 <td>Public method to delete virtual environments from the list and disk.</td> 116 <td>Public method to delete virtual environments from the list and disk.</td>
95 </tr><tr> 117 </tr>
118 <tr>
96 <td><a href="#VirtualenvManager.getDefaultEnvironment">getDefaultEnvironment</a></td> 119 <td><a href="#VirtualenvManager.getDefaultEnvironment">getDefaultEnvironment</a></td>
97 <td>Public method to get the default virtual environment.</td> 120 <td>Public method to get the default virtual environment.</td>
98 </tr><tr> 121 </tr>
122 <tr>
99 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td> 123 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td>
100 <td>Public method to get a dictionary containing the defined virtual environment entries.</td> 124 <td>Public method to get a dictionary containing the defined virtual environment entries.</td>
101 </tr><tr> 125 </tr>
126 <tr>
102 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td> 127 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td>
103 <td>Public method to get the directory of a virtual environment.</td> 128 <td>Public method to get the directory of a virtual environment.</td>
104 </tr><tr> 129 </tr>
130 <tr>
105 <td><a href="#VirtualenvManager.getVirtualenvExecPath">getVirtualenvExecPath</a></td> 131 <td><a href="#VirtualenvManager.getVirtualenvExecPath">getVirtualenvExecPath</a></td>
106 <td>Public method to get the search path prefix of a virtual environment.</td> 132 <td>Public method to get the search path prefix of a virtual environment.</td>
107 </tr><tr> 133 </tr>
134 <tr>
108 <td><a href="#VirtualenvManager.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td> 135 <td><a href="#VirtualenvManager.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td>
109 <td>Public method to get the interpreter for a virtual environment.</td> 136 <td>Public method to get the interpreter for a virtual environment.</td>
110 </tr><tr> 137 </tr>
138 <tr>
111 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td> 139 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td>
112 <td>Public method to get a list of defined virtual environments.</td> 140 <td>Public method to get a list of defined virtual environments.</td>
113 </tr><tr> 141 </tr>
142 <tr>
114 <td><a href="#VirtualenvManager.getVirtualenvNamesForVariant">getVirtualenvNamesForVariant</a></td> 143 <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> 144 <td>Public method to get a list of virtual environments for a given Python variant.</td>
116 </tr><tr> 145 </tr>
146 <tr>
117 <td><a href="#VirtualenvManager.getVirtualenvVariant">getVirtualenvVariant</a></td> 147 <td><a href="#VirtualenvManager.getVirtualenvVariant">getVirtualenvVariant</a></td>
118 <td>Public method to get the variant of a virtual environment.</td> 148 <td>Public method to get the variant of a virtual environment.</td>
119 </tr><tr> 149 </tr>
150 <tr>
120 <td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td> 151 <td><a href="#VirtualenvManager.isCondaEnvironment">isCondaEnvironment</a></td>
121 <td>Public method to test, if a given environment is an Anaconda environment.</td> 152 <td>Public method to test, if a given environment is an Anaconda environment.</td>
122 </tr><tr> 153 </tr>
154 <tr>
123 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td> 155 <td><a href="#VirtualenvManager.isGlobalEnvironment">isGlobalEnvironment</a></td>
124 <td>Public method to test, if a given environment is a global one.</td> 156 <td>Public method to test, if a given environment is a global one.</td>
125 </tr><tr> 157 </tr>
158 <tr>
126 <td><a href="#VirtualenvManager.isRemoteEnvironment">isRemoteEnvironment</a></td> 159 <td><a href="#VirtualenvManager.isRemoteEnvironment">isRemoteEnvironment</a></td>
127 <td>Public method to test, if a given environment is a remotely accessed environment.</td> 160 <td>Public method to test, if a given environment is a remotely accessed environment.</td>
128 </tr><tr> 161 </tr>
162 <tr>
129 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td> 163 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td>
130 <td>Public method to check, if the give logical name is unique.</td> 164 <td>Public method to check, if the give logical name is unique.</td>
131 </tr><tr> 165 </tr>
166 <tr>
132 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td> 167 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td>
133 <td>Public method to delete virtual environment from the list.</td> 168 <td>Public method to delete virtual environment from the list.</td>
134 </tr><tr> 169 </tr>
170 <tr>
135 <td><a href="#VirtualenvManager.renameVirtualEnv">renameVirtualEnv</a></td> 171 <td><a href="#VirtualenvManager.renameVirtualEnv">renameVirtualEnv</a></td>
136 <td>Public method to substitute a virtual environment entry with a new name.</td> 172 <td>Public method to substitute a virtual environment entry with a new name.</td>
137 </tr><tr> 173 </tr>
174 <tr>
138 <td><a href="#VirtualenvManager.setVirtualEnv">setVirtualEnv</a></td> 175 <td><a href="#VirtualenvManager.setVirtualEnv">setVirtualEnv</a></td>
139 <td>Public method to change a virtual environment.</td> 176 <td>Public method to change a virtual environment.</td>
140 </tr><tr> 177 </tr>
178 <tr>
141 <td><a href="#VirtualenvManager.showVirtualenvManagerDialog">showVirtualenvManagerDialog</a></td> 179 <td><a href="#VirtualenvManager.showVirtualenvManagerDialog">showVirtualenvManagerDialog</a></td>
142 <td>Public slot to show the virtual environment manager dialog.</td> 180 <td>Public slot to show the virtual environment manager dialog.</td>
143 </tr><tr> 181 </tr>
182 <tr>
144 <td><a href="#VirtualenvManager.shutdown">shutdown</a></td> 183 <td><a href="#VirtualenvManager.shutdown">shutdown</a></td>
145 <td>Public method to shutdown the manager.</td> 184 <td>Public method to shutdown the manager.</td>
146 </tr> 185 </tr>
147 </table> 186 </table>
148 <h3>Static Methods</h3> 187 <h3>Static Methods</h3>
188
149 <table> 189 <table>
150 <tr><td>None</td></tr> 190 <tr><td>None</td></tr>
151 </table> 191 </table>
192
152 <a NAME="VirtualenvManager.__init__" ID="VirtualenvManager.__init__"></a> 193 <a NAME="VirtualenvManager.__init__" ID="VirtualenvManager.__init__"></a>
153 <h4>VirtualenvManager (Constructor)</h4> 194 <h4>VirtualenvManager (Constructor)</h4>
154 <b>VirtualenvManager</b>(<i>parent=None</i>) 195 <b>VirtualenvManager</b>(<i>parent=None</i>)
196
155 <p> 197 <p>
156 Constructor 198 Constructor
157 </p><dl> 199 </p>
200 <dl>
201
158 <dt><i>parent</i> (QWidget)</dt> 202 <dt><i>parent</i> (QWidget)</dt>
159 <dd> 203 <dd>
160 reference to the parent object 204 reference to the parent object
161 </dd> 205 </dd>
162 </dl><a NAME="VirtualenvManager.__isEnvironmentDeleteable" ID="VirtualenvManager.__isEnvironmentDeleteable"></a> 206 </dl>
207 <a NAME="VirtualenvManager.__isEnvironmentDeleteable" ID="VirtualenvManager.__isEnvironmentDeleteable"></a>
163 <h4>VirtualenvManager.__isEnvironmentDeleteable</h4> 208 <h4>VirtualenvManager.__isEnvironmentDeleteable</h4>
164 <b>__isEnvironmentDeleteable</b>(<i>venvName</i>) 209 <b>__isEnvironmentDeleteable</b>(<i>venvName</i>)
210
165 <p> 211 <p>
166 Private method to check, if a virtual environment can be deleted from 212 Private method to check, if a virtual environment can be deleted from
167 disk. 213 disk.
168 </p><dl> 214 </p>
215 <dl>
216
169 <dt><i>venvName</i> (str)</dt> 217 <dt><i>venvName</i> (str)</dt>
170 <dd> 218 <dd>
171 name of the virtual environment 219 name of the virtual environment
172 </dd> 220 </dd>
173 </dl><dl> 221 </dl>
222 <dl>
174 <dt>Returns:</dt> 223 <dt>Returns:</dt>
175 <dd> 224 <dd>
176 flag indicating it can be deleted 225 flag indicating it can be deleted
177 </dd> 226 </dd>
178 </dl><dl> 227 </dl>
228 <dl>
179 <dt>Return Type:</dt> 229 <dt>Return Type:</dt>
180 <dd> 230 <dd>
181 bool 231 bool
182 </dd> 232 </dd>
183 </dl><a NAME="VirtualenvManager.__loadSettings" ID="VirtualenvManager.__loadSettings"></a> 233 </dl>
234 <a NAME="VirtualenvManager.__loadSettings" ID="VirtualenvManager.__loadSettings"></a>
184 <h4>VirtualenvManager.__loadSettings</h4> 235 <h4>VirtualenvManager.__loadSettings</h4>
185 <b>__loadSettings</b>(<i></i>) 236 <b>__loadSettings</b>(<i></i>)
237
186 <p> 238 <p>
187 Private slot to load the virtual environments. 239 Private slot to load the virtual environments.
188 </p><a NAME="VirtualenvManager.__saveSettings" ID="VirtualenvManager.__saveSettings"></a> 240 </p>
241 <a NAME="VirtualenvManager.__saveSettings" ID="VirtualenvManager.__saveSettings"></a>
189 <h4>VirtualenvManager.__saveSettings</h4> 242 <h4>VirtualenvManager.__saveSettings</h4>
190 <b>__saveSettings</b>(<i></i>) 243 <b>__saveSettings</b>(<i></i>)
244
191 <p> 245 <p>
192 Private slot to save the virtual environments. 246 Private slot to save the virtual environments.
193 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> 247 </p>
248 <a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a>
194 <h4>VirtualenvManager.addVirtualEnv</h4> 249 <h4>VirtualenvManager.addVirtualEnv</h4>
195 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, isRemote=False, execPath=""</i>) 250 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, isRemote=False, execPath=""</i>)
251
196 <p> 252 <p>
197 Public method to add a virtual environment. 253 Public method to add a virtual environment.
198 </p><dl> 254 </p>
255 <dl>
256
199 <dt><i>venvName</i> (str)</dt> 257 <dt><i>venvName</i> (str)</dt>
200 <dd> 258 <dd>
201 logical name for the virtual environment 259 logical name for the virtual environment
202 </dd><dt><i>venvDirectory</i> (str)</dt> 260 </dd>
261 <dt><i>venvDirectory</i> (str)</dt>
203 <dd> 262 <dd>
204 directory of the virtual environment 263 directory of the virtual environment
205 </dd><dt><i>venvInterpreter</i> (str)</dt> 264 </dd>
265 <dt><i>venvInterpreter</i> (str)</dt>
206 <dd> 266 <dd>
207 interpreter of the virtual environment 267 interpreter of the virtual environment
208 </dd><dt><i>venvVariant</i> (int)</dt> 268 </dd>
269 <dt><i>venvVariant</i> (int)</dt>
209 <dd> 270 <dd>
210 Python variant of the virtual environment 271 Python variant of the virtual environment
211 </dd><dt><i>isGlobal</i> (bool)</dt> 272 </dd>
273 <dt><i>isGlobal</i> (bool)</dt>
212 <dd> 274 <dd>
213 flag indicating a global environment 275 flag indicating a global environment
214 </dd><dt><i>isConda</i> (bool)</dt> 276 </dd>
277 <dt><i>isConda</i> (bool)</dt>
215 <dd> 278 <dd>
216 flag indicating an Anaconda virtual environment 279 flag indicating an Anaconda virtual environment
217 </dd><dt><i>isRemote</i> (bool)</dt> 280 </dd>
281 <dt><i>isRemote</i> (bool)</dt>
218 <dd> 282 <dd>
219 flag indicating a remotely accessed environment 283 flag indicating a remotely accessed environment
220 </dd><dt><i>execPath</i> (str)</dt> 284 </dd>
285 <dt><i>execPath</i> (str)</dt>
221 <dd> 286 <dd>
222 search path string to be prepended to the PATH 287 search path string to be prepended to the PATH
223 environment variable 288 environment variable
224 </dd> 289 </dd>
225 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a> 290 </dl>
291 <a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
226 <h4>VirtualenvManager.createVirtualEnv</h4> 292 <h4>VirtualenvManager.createVirtualEnv</h4>
227 <b>createVirtualEnv</b>(<i></i>) 293 <b>createVirtualEnv</b>(<i></i>)
294
228 <p> 295 <p>
229 Public slot to create a new virtual environment. 296 Public slot to create a new virtual environment.
230 </p><a NAME="VirtualenvManager.deleteVirtualEnvs" ID="VirtualenvManager.deleteVirtualEnvs"></a> 297 </p>
298 <a NAME="VirtualenvManager.deleteVirtualEnvs" ID="VirtualenvManager.deleteVirtualEnvs"></a>
231 <h4>VirtualenvManager.deleteVirtualEnvs</h4> 299 <h4>VirtualenvManager.deleteVirtualEnvs</h4>
232 <b>deleteVirtualEnvs</b>(<i>venvNames</i>) 300 <b>deleteVirtualEnvs</b>(<i>venvNames</i>)
301
233 <p> 302 <p>
234 Public method to delete virtual environments from the list and disk. 303 Public method to delete virtual environments from the list and disk.
235 </p><dl> 304 </p>
305 <dl>
306
236 <dt><i>venvNames</i> (list of str)</dt> 307 <dt><i>venvNames</i> (list of str)</dt>
237 <dd> 308 <dd>
238 list of logical names for the virtual environments 309 list of logical names for the virtual environments
239 </dd> 310 </dd>
240 </dl><a NAME="VirtualenvManager.getDefaultEnvironment" ID="VirtualenvManager.getDefaultEnvironment"></a> 311 </dl>
312 <a NAME="VirtualenvManager.getDefaultEnvironment" ID="VirtualenvManager.getDefaultEnvironment"></a>
241 <h4>VirtualenvManager.getDefaultEnvironment</h4> 313 <h4>VirtualenvManager.getDefaultEnvironment</h4>
242 <b>getDefaultEnvironment</b>(<i></i>) 314 <b>getDefaultEnvironment</b>(<i></i>)
315
243 <p> 316 <p>
244 Public method to get the default virtual environment. 317 Public method to get the default virtual environment.
245 </p><p> 318 </p>
319 <p>
246 Default is an environment with the key '<default>' or the first one 320 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 321 having an interpreter matching sys.executable (i.e. the one used to
248 execute eric6 with) 322 execute eric6 with)
249 </p><dl> 323 </p>
324 <dl>
250 <dt>Returns:</dt> 325 <dt>Returns:</dt>
251 <dd> 326 <dd>
252 tuple containing the environment name and a dictionary 327 tuple containing the environment name and a dictionary
253 containing a copy of the default virtual environment 328 containing a copy of the default virtual environment
254 </dd> 329 </dd>
255 </dl><dl> 330 </dl>
331 <dl>
256 <dt>Return Type:</dt> 332 <dt>Return Type:</dt>
257 <dd> 333 <dd>
258 tuple of (str, dict) 334 tuple of (str, dict)
259 </dd> 335 </dd>
260 </dl><a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a> 336 </dl>
337 <a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a>
261 <h4>VirtualenvManager.getEnvironmentEntries</h4> 338 <h4>VirtualenvManager.getEnvironmentEntries</h4>
262 <b>getEnvironmentEntries</b>(<i></i>) 339 <b>getEnvironmentEntries</b>(<i></i>)
340
263 <p> 341 <p>
264 Public method to get a dictionary containing the defined virtual 342 Public method to get a dictionary containing the defined virtual
265 environment entries. 343 environment entries.
266 </p><dl> 344 </p>
345 <dl>
267 <dt>Returns:</dt> 346 <dt>Returns:</dt>
268 <dd> 347 <dd>
269 dictionary containing a copy of the defined virtual 348 dictionary containing a copy of the defined virtual
270 environments 349 environments
271 </dd> 350 </dd>
272 </dl><dl> 351 </dl>
352 <dl>
273 <dt>Return Type:</dt> 353 <dt>Return Type:</dt>
274 <dd> 354 <dd>
275 dict 355 dict
276 </dd> 356 </dd>
277 </dl><a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a> 357 </dl>
358 <a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a>
278 <h4>VirtualenvManager.getVirtualenvDirectory</h4> 359 <h4>VirtualenvManager.getVirtualenvDirectory</h4>
279 <b>getVirtualenvDirectory</b>(<i>venvName</i>) 360 <b>getVirtualenvDirectory</b>(<i>venvName</i>)
361
280 <p> 362 <p>
281 Public method to get the directory of a virtual environment. 363 Public method to get the directory of a virtual environment.
282 </p><dl> 364 </p>
365 <dl>
366
283 <dt><i>venvName</i> (str)</dt> 367 <dt><i>venvName</i> (str)</dt>
284 <dd> 368 <dd>
285 logical name for the virtual environment 369 logical name for the virtual environment
286 </dd> 370 </dd>
287 </dl><dl> 371 </dl>
372 <dl>
288 <dt>Returns:</dt> 373 <dt>Returns:</dt>
289 <dd> 374 <dd>
290 directory path 375 directory path
291 </dd> 376 </dd>
292 </dl><dl> 377 </dl>
378 <dl>
293 <dt>Return Type:</dt> 379 <dt>Return Type:</dt>
294 <dd> 380 <dd>
295 str 381 str
296 </dd> 382 </dd>
297 </dl><a NAME="VirtualenvManager.getVirtualenvExecPath" ID="VirtualenvManager.getVirtualenvExecPath"></a> 383 </dl>
384 <a NAME="VirtualenvManager.getVirtualenvExecPath" ID="VirtualenvManager.getVirtualenvExecPath"></a>
298 <h4>VirtualenvManager.getVirtualenvExecPath</h4> 385 <h4>VirtualenvManager.getVirtualenvExecPath</h4>
299 <b>getVirtualenvExecPath</b>(<i>venvName</i>) 386 <b>getVirtualenvExecPath</b>(<i>venvName</i>)
387
300 <p> 388 <p>
301 Public method to get the search path prefix of a virtual environment. 389 Public method to get the search path prefix of a virtual environment.
302 </p><dl> 390 </p>
391 <dl>
392
303 <dt><i>venvName</i> (str)</dt> 393 <dt><i>venvName</i> (str)</dt>
304 <dd> 394 <dd>
305 logical name for the virtual environment 395 logical name for the virtual environment
306 </dd> 396 </dd>
307 </dl><dl> 397 </dl>
398 <dl>
308 <dt>Returns:</dt> 399 <dt>Returns:</dt>
309 <dd> 400 <dd>
310 search path prefix 401 search path prefix
311 </dd> 402 </dd>
312 </dl><dl> 403 </dl>
404 <dl>
313 <dt>Return Type:</dt> 405 <dt>Return Type:</dt>
314 <dd> 406 <dd>
315 str 407 str
316 </dd> 408 </dd>
317 </dl><a NAME="VirtualenvManager.getVirtualenvInterpreter" ID="VirtualenvManager.getVirtualenvInterpreter"></a> 409 </dl>
410 <a NAME="VirtualenvManager.getVirtualenvInterpreter" ID="VirtualenvManager.getVirtualenvInterpreter"></a>
318 <h4>VirtualenvManager.getVirtualenvInterpreter</h4> 411 <h4>VirtualenvManager.getVirtualenvInterpreter</h4>
319 <b>getVirtualenvInterpreter</b>(<i>venvName</i>) 412 <b>getVirtualenvInterpreter</b>(<i>venvName</i>)
413
320 <p> 414 <p>
321 Public method to get the interpreter for a virtual environment. 415 Public method to get the interpreter for a virtual environment.
322 </p><dl> 416 </p>
417 <dl>
418
323 <dt><i>venvName</i> (str)</dt> 419 <dt><i>venvName</i> (str)</dt>
324 <dd> 420 <dd>
325 logical name for the virtual environment 421 logical name for the virtual environment
326 </dd> 422 </dd>
327 </dl><dl> 423 </dl>
424 <dl>
328 <dt>Returns:</dt> 425 <dt>Returns:</dt>
329 <dd> 426 <dd>
330 interpreter path 427 interpreter path
331 </dd> 428 </dd>
332 </dl><dl> 429 </dl>
430 <dl>
333 <dt>Return Type:</dt> 431 <dt>Return Type:</dt>
334 <dd> 432 <dd>
335 str 433 str
336 </dd> 434 </dd>
337 </dl><a NAME="VirtualenvManager.getVirtualenvNames" ID="VirtualenvManager.getVirtualenvNames"></a> 435 </dl>
436 <a NAME="VirtualenvManager.getVirtualenvNames" ID="VirtualenvManager.getVirtualenvNames"></a>
338 <h4>VirtualenvManager.getVirtualenvNames</h4> 437 <h4>VirtualenvManager.getVirtualenvNames</h4>
339 <b>getVirtualenvNames</b>(<i>noRemote=False</i>) 438 <b>getVirtualenvNames</b>(<i>noRemote=False</i>)
439
340 <p> 440 <p>
341 Public method to get a list of defined virtual environments. 441 Public method to get a list of defined virtual environments.
342 </p><dl> 442 </p>
443 <dl>
444
343 <dt><i>noRemote</i> (bool)</dt> 445 <dt><i>noRemote</i> (bool)</dt>
344 <dd> 446 <dd>
345 flag indicating to exclude environments for remote 447 flag indicating to exclude environments for remote
346 debugging 448 debugging
347 </dd> 449 </dd>
348 </dl><dl> 450 </dl>
451 <dl>
349 <dt>Returns:</dt> 452 <dt>Returns:</dt>
350 <dd> 453 <dd>
351 list of defined virtual environments 454 list of defined virtual environments
352 </dd> 455 </dd>
353 </dl><dl> 456 </dl>
457 <dl>
354 <dt>Return Type:</dt> 458 <dt>Return Type:</dt>
355 <dd> 459 <dd>
356 list of str 460 list of str
357 </dd> 461 </dd>
358 </dl><a NAME="VirtualenvManager.getVirtualenvNamesForVariant" ID="VirtualenvManager.getVirtualenvNamesForVariant"></a> 462 </dl>
463 <a NAME="VirtualenvManager.getVirtualenvNamesForVariant" ID="VirtualenvManager.getVirtualenvNamesForVariant"></a>
359 <h4>VirtualenvManager.getVirtualenvNamesForVariant</h4> 464 <h4>VirtualenvManager.getVirtualenvNamesForVariant</h4>
360 <b>getVirtualenvNamesForVariant</b>(<i>variant</i>) 465 <b>getVirtualenvNamesForVariant</b>(<i>variant</i>)
466
361 <p> 467 <p>
362 Public method to get a list of virtual environments for a given 468 Public method to get a list of virtual environments for a given
363 Python variant. 469 Python variant.
364 </p><dl> 470 </p>
471 <dl>
472
365 <dt><i>variant</i> (int)</dt> 473 <dt><i>variant</i> (int)</dt>
366 <dd> 474 <dd>
367 Python variant (2 or 3) 475 Python variant (2 or 3)
368 </dd> 476 </dd>
369 </dl><dl> 477 </dl>
478 <dl>
370 <dt>Returns:</dt> 479 <dt>Returns:</dt>
371 <dd> 480 <dd>
372 list of defined virtual environments 481 list of defined virtual environments
373 </dd> 482 </dd>
374 </dl><dl> 483 </dl>
484 <dl>
375 <dt>Return Type:</dt> 485 <dt>Return Type:</dt>
376 <dd> 486 <dd>
377 list of str 487 list of str
378 </dd> 488 </dd>
379 </dl><a NAME="VirtualenvManager.getVirtualenvVariant" ID="VirtualenvManager.getVirtualenvVariant"></a> 489 </dl>
490 <a NAME="VirtualenvManager.getVirtualenvVariant" ID="VirtualenvManager.getVirtualenvVariant"></a>
380 <h4>VirtualenvManager.getVirtualenvVariant</h4> 491 <h4>VirtualenvManager.getVirtualenvVariant</h4>
381 <b>getVirtualenvVariant</b>(<i>venvName</i>) 492 <b>getVirtualenvVariant</b>(<i>venvName</i>)
493
382 <p> 494 <p>
383 Public method to get the variant of a virtual environment. 495 Public method to get the variant of a virtual environment.
384 </p><dl> 496 </p>
497 <dl>
498
385 <dt><i>venvName</i> (str)</dt> 499 <dt><i>venvName</i> (str)</dt>
386 <dd> 500 <dd>
387 logical name for the virtual environment 501 logical name for the virtual environment
388 </dd> 502 </dd>
389 </dl><dl> 503 </dl>
504 <dl>
390 <dt>Returns:</dt> 505 <dt>Returns:</dt>
391 <dd> 506 <dd>
392 Python variant of the environment 507 Python variant of the environment
393 </dd> 508 </dd>
394 </dl><dl> 509 </dl>
510 <dl>
395 <dt>Return Type:</dt> 511 <dt>Return Type:</dt>
396 <dd> 512 <dd>
397 str 513 str
398 </dd> 514 </dd>
399 </dl><a NAME="VirtualenvManager.isCondaEnvironment" ID="VirtualenvManager.isCondaEnvironment"></a> 515 </dl>
516 <a NAME="VirtualenvManager.isCondaEnvironment" ID="VirtualenvManager.isCondaEnvironment"></a>
400 <h4>VirtualenvManager.isCondaEnvironment</h4> 517 <h4>VirtualenvManager.isCondaEnvironment</h4>
401 <b>isCondaEnvironment</b>(<i>venvName</i>) 518 <b>isCondaEnvironment</b>(<i>venvName</i>)
519
402 <p> 520 <p>
403 Public method to test, if a given environment is an Anaconda 521 Public method to test, if a given environment is an Anaconda
404 environment. 522 environment.
405 </p><dl> 523 </p>
524 <dl>
525
406 <dt><i>venvName</i> (str)</dt> 526 <dt><i>venvName</i> (str)</dt>
407 <dd> 527 <dd>
408 logical name of the virtual environment 528 logical name of the virtual environment
409 </dd> 529 </dd>
410 </dl><dl> 530 </dl>
531 <dl>
411 <dt>Returns:</dt> 532 <dt>Returns:</dt>
412 <dd> 533 <dd>
413 flag indicating an Anaconda environment 534 flag indicating an Anaconda environment
414 </dd> 535 </dd>
415 </dl><dl> 536 </dl>
537 <dl>
416 <dt>Return Type:</dt> 538 <dt>Return Type:</dt>
417 <dd> 539 <dd>
418 bool 540 bool
419 </dd> 541 </dd>
420 </dl><a NAME="VirtualenvManager.isGlobalEnvironment" ID="VirtualenvManager.isGlobalEnvironment"></a> 542 </dl>
543 <a NAME="VirtualenvManager.isGlobalEnvironment" ID="VirtualenvManager.isGlobalEnvironment"></a>
421 <h4>VirtualenvManager.isGlobalEnvironment</h4> 544 <h4>VirtualenvManager.isGlobalEnvironment</h4>
422 <b>isGlobalEnvironment</b>(<i>venvName</i>) 545 <b>isGlobalEnvironment</b>(<i>venvName</i>)
546
423 <p> 547 <p>
424 Public method to test, if a given environment is a global one. 548 Public method to test, if a given environment is a global one.
425 </p><dl> 549 </p>
550 <dl>
551
426 <dt><i>venvName</i> (str)</dt> 552 <dt><i>venvName</i> (str)</dt>
427 <dd> 553 <dd>
428 logical name of the virtual environment 554 logical name of the virtual environment
429 </dd> 555 </dd>
430 </dl><dl> 556 </dl>
557 <dl>
431 <dt>Returns:</dt> 558 <dt>Returns:</dt>
432 <dd> 559 <dd>
433 flag indicating a global environment 560 flag indicating a global environment
434 </dd> 561 </dd>
435 </dl><dl> 562 </dl>
563 <dl>
436 <dt>Return Type:</dt> 564 <dt>Return Type:</dt>
437 <dd> 565 <dd>
438 bool 566 bool
439 </dd> 567 </dd>
440 </dl><a NAME="VirtualenvManager.isRemoteEnvironment" ID="VirtualenvManager.isRemoteEnvironment"></a> 568 </dl>
569 <a NAME="VirtualenvManager.isRemoteEnvironment" ID="VirtualenvManager.isRemoteEnvironment"></a>
441 <h4>VirtualenvManager.isRemoteEnvironment</h4> 570 <h4>VirtualenvManager.isRemoteEnvironment</h4>
442 <b>isRemoteEnvironment</b>(<i>venvName</i>) 571 <b>isRemoteEnvironment</b>(<i>venvName</i>)
572
443 <p> 573 <p>
444 Public method to test, if a given environment is a remotely accessed 574 Public method to test, if a given environment is a remotely accessed
445 environment. 575 environment.
446 </p><dl> 576 </p>
577 <dl>
578
447 <dt><i>venvName</i> (str)</dt> 579 <dt><i>venvName</i> (str)</dt>
448 <dd> 580 <dd>
449 logical name of the virtual environment 581 logical name of the virtual environment
450 </dd> 582 </dd>
451 </dl><dl> 583 </dl>
584 <dl>
452 <dt>Returns:</dt> 585 <dt>Returns:</dt>
453 <dd> 586 <dd>
454 flag indicating a remotely accessed environment 587 flag indicating a remotely accessed environment
455 </dd> 588 </dd>
456 </dl><dl> 589 </dl>
590 <dl>
457 <dt>Return Type:</dt> 591 <dt>Return Type:</dt>
458 <dd> 592 <dd>
459 bool 593 bool
460 </dd> 594 </dd>
461 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a> 595 </dl>
596 <a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a>
462 <h4>VirtualenvManager.isUnique</h4> 597 <h4>VirtualenvManager.isUnique</h4>
463 <b>isUnique</b>(<i>venvName</i>) 598 <b>isUnique</b>(<i>venvName</i>)
599
464 <p> 600 <p>
465 Public method to check, if the give logical name is unique. 601 Public method to check, if the give logical name is unique.
466 </p><dl> 602 </p>
603 <dl>
604
467 <dt><i>venvName</i> (str)</dt> 605 <dt><i>venvName</i> (str)</dt>
468 <dd> 606 <dd>
469 logical name for the virtual environment 607 logical name for the virtual environment
470 </dd> 608 </dd>
471 </dl><dl> 609 </dl>
610 <dl>
472 <dt>Returns:</dt> 611 <dt>Returns:</dt>
473 <dd> 612 <dd>
474 flag indicating uniqueness 613 flag indicating uniqueness
475 </dd> 614 </dd>
476 </dl><dl> 615 </dl>
616 <dl>
477 <dt>Return Type:</dt> 617 <dt>Return Type:</dt>
478 <dd> 618 <dd>
479 bool 619 bool
480 </dd> 620 </dd>
481 </dl><a NAME="VirtualenvManager.removeVirtualEnvs" ID="VirtualenvManager.removeVirtualEnvs"></a> 621 </dl>
622 <a NAME="VirtualenvManager.removeVirtualEnvs" ID="VirtualenvManager.removeVirtualEnvs"></a>
482 <h4>VirtualenvManager.removeVirtualEnvs</h4> 623 <h4>VirtualenvManager.removeVirtualEnvs</h4>
483 <b>removeVirtualEnvs</b>(<i>venvNames</i>) 624 <b>removeVirtualEnvs</b>(<i>venvNames</i>)
625
484 <p> 626 <p>
485 Public method to delete virtual environment from the list. 627 Public method to delete virtual environment from the list.
486 </p><dl> 628 </p>
629 <dl>
630
487 <dt><i>venvNames</i> (list of str)</dt> 631 <dt><i>venvNames</i> (list of str)</dt>
488 <dd> 632 <dd>
489 list of logical names for the virtual environments 633 list of logical names for the virtual environments
490 </dd> 634 </dd>
491 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> 635 </dl>
636 <a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
492 <h4>VirtualenvManager.renameVirtualEnv</h4> 637 <h4>VirtualenvManager.renameVirtualEnv</h4>
493 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>) 638 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>)
639
494 <p> 640 <p>
495 Public method to substitute a virtual environment entry with a new 641 Public method to substitute a virtual environment entry with a new
496 name. 642 name.
497 </p><dl> 643 </p>
644 <dl>
645
498 <dt><i>oldVenvName</i> (str)</dt> 646 <dt><i>oldVenvName</i> (str)</dt>
499 <dd> 647 <dd>
500 old name of the virtual environment 648 old name of the virtual environment
501 </dd><dt><i>venvName</i> (str)</dt> 649 </dd>
650 <dt><i>venvName</i> (str)</dt>
502 <dd> 651 <dd>
503 logical name for the virtual environment 652 logical name for the virtual environment
504 </dd><dt><i>venvDirectory</i> (str)</dt> 653 </dd>
654 <dt><i>venvDirectory</i> (str)</dt>
505 <dd> 655 <dd>
506 directory of the virtual environment 656 directory of the virtual environment
507 </dd><dt><i>venvInterpreter</i> (str)</dt> 657 </dd>
658 <dt><i>venvInterpreter</i> (str)</dt>
508 <dd> 659 <dd>
509 interpreter of the virtual environment 660 interpreter of the virtual environment
510 </dd><dt><i>venvVariant</i> (int)</dt> 661 </dd>
662 <dt><i>venvVariant</i> (int)</dt>
511 <dd> 663 <dd>
512 Python variant of the virtual environment 664 Python variant of the virtual environment
513 </dd><dt><i>isGlobal</i> (bool)</dt> 665 </dd>
666 <dt><i>isGlobal</i> (bool)</dt>
514 <dd> 667 <dd>
515 flag indicating a global environment 668 flag indicating a global environment
516 </dd><dt><i>isConda</i> (bool)</dt> 669 </dd>
670 <dt><i>isConda</i> (bool)</dt>
517 <dd> 671 <dd>
518 flag indicating an Anaconda virtual environment 672 flag indicating an Anaconda virtual environment
519 </dd><dt><i>isRemote</i> (bool)</dt> 673 </dd>
674 <dt><i>isRemote</i> (bool)</dt>
520 <dd> 675 <dd>
521 flag indicating a remotely accessed environment 676 flag indicating a remotely accessed environment
522 </dd><dt><i>execPath</i> (str)</dt> 677 </dd>
678 <dt><i>execPath</i> (str)</dt>
523 <dd> 679 <dd>
524 search path string to be prepended to the PATH 680 search path string to be prepended to the PATH
525 environment variable 681 environment variable
526 </dd> 682 </dd>
527 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> 683 </dl>
684 <a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
528 <h4>VirtualenvManager.setVirtualEnv</h4> 685 <h4>VirtualenvManager.setVirtualEnv</h4>
529 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>) 686 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant, isGlobal, isConda, isRemote, execPath</i>)
687
530 <p> 688 <p>
531 Public method to change a virtual environment. 689 Public method to change a virtual environment.
532 </p><dl> 690 </p>
691 <dl>
692
533 <dt><i>venvName</i> (str)</dt> 693 <dt><i>venvName</i> (str)</dt>
534 <dd> 694 <dd>
535 logical name of the virtual environment 695 logical name of the virtual environment
536 </dd><dt><i>venvDirectory</i> (str)</dt> 696 </dd>
697 <dt><i>venvDirectory</i> (str)</dt>
537 <dd> 698 <dd>
538 directory of the virtual environment 699 directory of the virtual environment
539 </dd><dt><i>venvInterpreter</i> (str)</dt> 700 </dd>
701 <dt><i>venvInterpreter</i> (str)</dt>
540 <dd> 702 <dd>
541 interpreter of the virtual environment 703 interpreter of the virtual environment
542 </dd><dt><i>venvVariant</i> (int)</dt> 704 </dd>
705 <dt><i>venvVariant</i> (int)</dt>
543 <dd> 706 <dd>
544 Python variant of the virtual environment 707 Python variant of the virtual environment
545 </dd><dt><i>isGlobal</i> (bool)</dt> 708 </dd>
709 <dt><i>isGlobal</i> (bool)</dt>
546 <dd> 710 <dd>
547 flag indicating a global environment 711 flag indicating a global environment
548 </dd><dt><i>isConda</i> (bool)</dt> 712 </dd>
713 <dt><i>isConda</i> (bool)</dt>
549 <dd> 714 <dd>
550 flag indicating an Anaconda virtual environment 715 flag indicating an Anaconda virtual environment
551 </dd><dt><i>isRemote</i> (bool)</dt> 716 </dd>
717 <dt><i>isRemote</i> (bool)</dt>
552 <dd> 718 <dd>
553 flag indicating a remotely accessed environment 719 flag indicating a remotely accessed environment
554 </dd><dt><i>execPath</i> (str)</dt> 720 </dd>
721 <dt><i>execPath</i> (str)</dt>
555 <dd> 722 <dd>
556 search path string to be prepended to the PATH 723 search path string to be prepended to the PATH
557 environment variable 724 environment variable
558 </dd> 725 </dd>
559 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a> 726 </dl>
727 <a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a>
560 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4> 728 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4>
561 <b>showVirtualenvManagerDialog</b>(<i>modal=False</i>) 729 <b>showVirtualenvManagerDialog</b>(<i>modal=False</i>)
730
562 <p> 731 <p>
563 Public slot to show the virtual environment manager dialog. 732 Public slot to show the virtual environment manager dialog.
564 </p><dl> 733 </p>
734 <dl>
735
565 <dt><i>modal</i></dt> 736 <dt><i>modal</i></dt>
566 <dd> 737 <dd>
567 flag indicating that the dialog should be shown in 738 flag indicating that the dialog should be shown in
568 a blocking mode 739 a blocking mode
569 </dd> 740 </dd>
570 </dl><a NAME="VirtualenvManager.shutdown" ID="VirtualenvManager.shutdown"></a> 741 </dl>
742 <a NAME="VirtualenvManager.shutdown" ID="VirtualenvManager.shutdown"></a>
571 <h4>VirtualenvManager.shutdown</h4> 743 <h4>VirtualenvManager.shutdown</h4>
572 <b>shutdown</b>(<i></i>) 744 <b>shutdown</b>(<i></i>)
745
573 <p> 746 <p>
574 Public method to shutdown the manager. 747 Public method to shutdown the manager.
575 </p> 748 </p>
576 <div align="right"><a href="#top">Up</a></div> 749 <div align="right"><a href="#top">Up</a></div>
577 <hr /> 750 <hr />

Mercurial Repository: eric

eric ide

mercurial