Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html

changeset 6349
17b3c75913de
parent 6343
86cea8abd0f7
child 6362
ec32d1d7f525
equal deleted inserted replaced
6348:d6c0b8ab1fc6 6349:17b3c75913de
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.__updateSettings">__updateSettings</a></td> 63 <td><a href="#VirtualenvManager.__loadSettings">__loadSettings</a></td>
64 <td>Private slot to load the virtual environments.</td>
65 </tr><tr>
66 <td><a href="#VirtualenvManager.__saveSettings">__saveSettings</a></td>
64 <td>Private slot to save the virtual environments.</td> 67 <td>Private slot to save the virtual environments.</td>
65 </tr><tr> 68 </tr><tr>
66 <td><a href="#VirtualenvManager.addVirtualEnv">addVirtualEnv</a></td> 69 <td><a href="#VirtualenvManager.addVirtualEnv">addVirtualEnv</a></td>
67 <td>Public method to add a virtual environment.</td> 70 <td>Public method to add a virtual environment.</td>
68 </tr><tr> 71 </tr><tr>
71 </tr><tr> 74 </tr><tr>
72 <td><a href="#VirtualenvManager.deleteVirtualEnvs">deleteVirtualEnvs</a></td> 75 <td><a href="#VirtualenvManager.deleteVirtualEnvs">deleteVirtualEnvs</a></td>
73 <td>Public method to delete virtual environments from the list and disk.</td> 76 <td>Public method to delete virtual environments from the list and disk.</td>
74 </tr><tr> 77 </tr><tr>
75 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td> 78 <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td>
76 <td>Public method to a dictionary containing the defined virtual environment entries.</td> 79 <td>Public method to get a dictionary containing the defined virtual environment entries.</td>
77 </tr><tr> 80 </tr><tr>
78 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td> 81 <td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td>
79 <td>Public method to get the directory of a virtual environment.</td> 82 <td>Public method to get the directory of a virtual environment.</td>
80 </tr><tr> 83 </tr><tr>
81 <td><a href="#VirtualenvManager.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td> 84 <td><a href="#VirtualenvManager.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td>
82 <td>Public method to get the interpreter for a virtual environment.</td> 85 <td>Public method to get the interpreter for a virtual environment.</td>
83 </tr><tr> 86 </tr><tr>
84 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td> 87 <td><a href="#VirtualenvManager.getVirtualenvNames">getVirtualenvNames</a></td>
85 <td>Public method to get a list of defined virtual environments.</td> 88 <td>Public method to get a list of defined virtual environments.</td>
89 </tr><tr>
90 <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>
86 </tr><tr> 92 </tr><tr>
87 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td> 93 <td><a href="#VirtualenvManager.isUnique">isUnique</a></td>
88 <td>Public method to check, if the give logical name is unique.</td> 94 <td>Public method to check, if the give logical name is unique.</td>
89 </tr><tr> 95 </tr><tr>
90 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td> 96 <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td>
115 </p><dl> 121 </p><dl>
116 <dt><i>parent</i> (QWidget)</dt> 122 <dt><i>parent</i> (QWidget)</dt>
117 <dd> 123 <dd>
118 reference to the parent object 124 reference to the parent object
119 </dd> 125 </dd>
120 </dl><a NAME="VirtualenvManager.__updateSettings" ID="VirtualenvManager.__updateSettings"></a> 126 </dl><a NAME="VirtualenvManager.__loadSettings" ID="VirtualenvManager.__loadSettings"></a>
121 <h4>VirtualenvManager.__updateSettings</h4> 127 <h4>VirtualenvManager.__loadSettings</h4>
122 <b>__updateSettings</b>(<i></i>) 128 <b>__loadSettings</b>(<i></i>)
129 <p>
130 Private slot to load the virtual environments.
131 </p><a NAME="VirtualenvManager.__saveSettings" ID="VirtualenvManager.__saveSettings"></a>
132 <h4>VirtualenvManager.__saveSettings</h4>
133 <b>__saveSettings</b>(<i></i>)
123 <p> 134 <p>
124 Private slot to save the virtual environments. 135 Private slot to save the virtual environments.
125 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a> 136 </p><a NAME="VirtualenvManager.addVirtualEnv" ID="VirtualenvManager.addVirtualEnv"></a>
126 <h4>VirtualenvManager.addVirtualEnv</h4> 137 <h4>VirtualenvManager.addVirtualEnv</h4>
127 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter=""</i>) 138 <b>addVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter="", venvVariant=3</i>)
128 <p> 139 <p>
129 Public method to add a virtual environment. 140 Public method to add a virtual environment.
130 </p><dl> 141 </p><dl>
131 <dt><i>venvName</i> (str)</dt> 142 <dt><i>venvName</i> (str)</dt>
132 <dd> 143 <dd>
133 logical name for the virtual environment 144 logical name for the virtual environment
134 </dd><dt><i>venvDirectory</i> (str)</dt> 145 </dd><dt><i>venvDirectory</i> (str)</dt>
135 <dd> 146 <dd>
136 directory of the virtual environment 147 directory of the virtual environment
137 </dd><dt><i>venvInterpreter</i></dt> 148 </dd><dt><i>venvInterpreter</i> (str)</dt>
138 <dd> 149 <dd>
139 interpreter of the virtual environment 150 interpreter of the virtual environment
151 </dd><dt><i>venvVariant</i> (int)</dt>
152 <dd>
153 Python variant of the virtual environment
140 </dd> 154 </dd>
141 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a> 155 </dl><a NAME="VirtualenvManager.createVirtualEnv" ID="VirtualenvManager.createVirtualEnv"></a>
142 <h4>VirtualenvManager.createVirtualEnv</h4> 156 <h4>VirtualenvManager.createVirtualEnv</h4>
143 <b>createVirtualEnv</b>(<i></i>) 157 <b>createVirtualEnv</b>(<i></i>)
144 <p> 158 <p>
155 </dd> 169 </dd>
156 </dl><a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a> 170 </dl><a NAME="VirtualenvManager.getEnvironmentEntries" ID="VirtualenvManager.getEnvironmentEntries"></a>
157 <h4>VirtualenvManager.getEnvironmentEntries</h4> 171 <h4>VirtualenvManager.getEnvironmentEntries</h4>
158 <b>getEnvironmentEntries</b>(<i></i>) 172 <b>getEnvironmentEntries</b>(<i></i>)
159 <p> 173 <p>
160 Public method to a dictionary containing the defined virtual 174 Public method to get a dictionary containing the defined virtual
161 environment entries. 175 environment entries.
162 </p><dl> 176 </p><dl>
163 <dt>Returns:</dt> 177 <dt>Returns:</dt>
164 <dd> 178 <dd>
165 dictionary containing tuples of the environment path and 179 dictionary containing a copy of the defined virtual
166 the associated interpreter 180 environments
167 </dd> 181 </dd>
168 </dl><dl> 182 </dl><dl>
169 <dt>Return Type:</dt> 183 <dt>Return Type:</dt>
170 <dd> 184 <dd>
171 dict of (str, str) 185 dict
172 </dd> 186 </dd>
173 </dl><a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a> 187 </dl><a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a>
174 <h4>VirtualenvManager.getVirtualenvDirectory</h4> 188 <h4>VirtualenvManager.getVirtualenvDirectory</h4>
175 <b>getVirtualenvDirectory</b>(<i>venvName</i>) 189 <b>getVirtualenvDirectory</b>(<i>venvName</i>)
176 <p> 190 <p>
223 </dl><dl> 237 </dl><dl>
224 <dt>Return Type:</dt> 238 <dt>Return Type:</dt>
225 <dd> 239 <dd>
226 list of str 240 list of str
227 </dd> 241 </dd>
242 </dl><a NAME="VirtualenvManager.getVirtualenvNamesForVariant" ID="VirtualenvManager.getVirtualenvNamesForVariant"></a>
243 <h4>VirtualenvManager.getVirtualenvNamesForVariant</h4>
244 <b>getVirtualenvNamesForVariant</b>(<i>variant</i>)
245 <p>
246 Public method to get a list of virtual environments for a given
247 Python variant.
248 </p><dl>
249 <dt><i>variant</i> (int)</dt>
250 <dd>
251 Python variant (2 or 3)
252 </dd>
253 </dl><dl>
254 <dt>Returns:</dt>
255 <dd>
256 list of defined virtual environments
257 </dd>
258 </dl><dl>
259 <dt>Return Type:</dt>
260 <dd>
261 list of str
262 </dd>
228 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a> 263 </dl><a NAME="VirtualenvManager.isUnique" ID="VirtualenvManager.isUnique"></a>
229 <h4>VirtualenvManager.isUnique</h4> 264 <h4>VirtualenvManager.isUnique</h4>
230 <b>isUnique</b>(<i>venvName</i>) 265 <b>isUnique</b>(<i>venvName</i>)
231 <p> 266 <p>
232 Public method to check, if the give logical name is unique. 267 Public method to check, if the give logical name is unique.
255 <dd> 290 <dd>
256 list of logical names for the virtual environments 291 list of logical names for the virtual environments
257 </dd> 292 </dd>
258 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a> 293 </dl><a NAME="VirtualenvManager.renameVirtualEnv" ID="VirtualenvManager.renameVirtualEnv"></a>
259 <h4>VirtualenvManager.renameVirtualEnv</h4> 294 <h4>VirtualenvManager.renameVirtualEnv</h4>
260 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter</i>) 295 <b>renameVirtualEnv</b>(<i>oldVenvName, venvName, venvDirectory, venvInterpreter, venvVariant</i>)
261 <p> 296 <p>
262 Public method to substitute a virtual environment entry with a new 297 Public method to substitute a virtual environment entry with a new
263 name. 298 name.
264 </p><dl> 299 </p><dl>
265 <dt><i>oldVenvName</i> (str)</dt> 300 <dt><i>oldVenvName</i> (str)</dt>
269 <dd> 304 <dd>
270 logical name for the virtual environment 305 logical name for the virtual environment
271 </dd><dt><i>venvDirectory</i> (str)</dt> 306 </dd><dt><i>venvDirectory</i> (str)</dt>
272 <dd> 307 <dd>
273 directory of the virtual environment 308 directory of the virtual environment
274 </dd><dt><i>venvInterpreter</i></dt> 309 </dd><dt><i>venvInterpreter</i> (str)</dt>
275 <dd> 310 <dd>
276 interpreter of the virtual environment 311 interpreter of the virtual environment
312 </dd><dt><i>venvVariant</i> (int)</dt>
313 <dd>
314 Python variant of the virtual environment
277 </dd> 315 </dd>
278 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a> 316 </dl><a NAME="VirtualenvManager.setVirtualEnv" ID="VirtualenvManager.setVirtualEnv"></a>
279 <h4>VirtualenvManager.setVirtualEnv</h4> 317 <h4>VirtualenvManager.setVirtualEnv</h4>
280 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter=""</i>) 318 <b>setVirtualEnv</b>(<i>venvName, venvDirectory, venvInterpreter, venvVariant</i>)
281 <p> 319 <p>
282 Public method to change a virtual environment. 320 Public method to change a virtual environment.
283 </p><dl> 321 </p><dl>
284 <dt><i>venvName</i> (str)</dt> 322 <dt><i>venvName</i> (str)</dt>
285 <dd> 323 <dd>
286 logical name of the virtual environment 324 logical name of the virtual environment
287 </dd><dt><i>venvDirectory</i> (str)</dt> 325 </dd><dt><i>venvDirectory</i> (str)</dt>
288 <dd> 326 <dd>
289 directory of the virtual environment 327 directory of the virtual environment
290 </dd><dt><i>venvInterpreter</i></dt> 328 </dd><dt><i>venvInterpreter</i> (str)</dt>
291 <dd> 329 <dd>
292 interpreter of the virtual environment 330 interpreter of the virtual environment
331 </dd><dt><i>venvVariant</i> (int)</dt>
332 <dd>
333 Python variant of the virtual environment
293 </dd> 334 </dd>
294 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a> 335 </dl><a NAME="VirtualenvManager.showVirtualenvManagerDialog" ID="VirtualenvManager.showVirtualenvManagerDialog"></a>
295 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4> 336 <h4>VirtualenvManager.showVirtualenvManagerDialog</h4>
296 <b>showVirtualenvManagerDialog</b>(<i></i>) 337 <b>showVirtualenvManagerDialog</b>(<i></i>)
297 <p> 338 <p>

Mercurial Repository: eric

eric ide

mercurial