Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.PipInterface.Pip.html

eric6/Documentation/Source/eric6.PipInterface.Pip.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6976
66913de629f6
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.PipInterface.Pip</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.PipInterface.Pip</h1>
23 <p>
24 Package implementing the pip GUI logic.
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="#Pip">Pip</a></td>
34 <td>Class implementing the pip GUI logic.</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="Pip" ID="Pip"></a>
43 <h2>Pip</h2>
44 <p>
45 Class implementing the pip GUI logic.
46 </p>
47 <h3>Derived from</h3>
48 QObject
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>DefaultIndexUrlPip</td></tr><tr><td>DefaultIndexUrlXml</td></tr><tr><td>DefaultPyPiUrl</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="#Pip.__init__">Pip</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#Pip.__checkUpgradePyQt">__checkUpgradePyQt</a></td>
64 <td>Private method to check, if an upgrade of PyQt packages is attempted.</td>
65 </tr><tr>
66 <td><a href="#Pip.getIndexUrl">getIndexUrl</a></td>
67 <td>Public method to get the index URL for PyPI.</td>
68 </tr><tr>
69 <td><a href="#Pip.getIndexUrlXml">getIndexUrlXml</a></td>
70 <td>Public method to get the index URL for XML RPC calls.</td>
71 </tr><tr>
72 <td><a href="#Pip.getInstalledPackages">getInstalledPackages</a></td>
73 <td>Public method to get the list of installed packages.</td>
74 </tr><tr>
75 <td><a href="#Pip.getOutdatedPackages">getOutdatedPackages</a></td>
76 <td>Public method to get the list of outdated packages.</td>
77 </tr><tr>
78 <td><a href="#Pip.getPackageDetails">getPackageDetails</a></td>
79 <td>Public method to get package details using the PyPI JSON interface.</td>
80 </tr><tr>
81 <td><a href="#Pip.getProjectEnvironmentString">getProjectEnvironmentString</a></td>
82 <td>Public method to get the string for the project environment.</td>
83 </tr><tr>
84 <td><a href="#Pip.getUserConfig">getUserConfig</a></td>
85 <td>Public method to get the name of the user configuration file.</td>
86 </tr><tr>
87 <td><a href="#Pip.getVirtualenvConfig">getVirtualenvConfig</a></td>
88 <td>Public method to get the name of the virtualenv configuration file.</td>
89 </tr><tr>
90 <td><a href="#Pip.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td>
91 <td>Public method to get the interpreter for a virtual environment.</td>
92 </tr><tr>
93 <td><a href="#Pip.getVirtualenvNames">getVirtualenvNames</a></td>
94 <td>Public method to get a sorted list of virtual environment names.</td>
95 </tr><tr>
96 <td><a href="#Pip.installPackages">installPackages</a></td>
97 <td>Public method to install the given list of packages.</td>
98 </tr><tr>
99 <td><a href="#Pip.installPip">installPip</a></td>
100 <td>Public method to install pip.</td>
101 </tr><tr>
102 <td><a href="#Pip.installRequirements">installRequirements</a></td>
103 <td>Public method to install packages as given in a requirements file.</td>
104 </tr><tr>
105 <td><a href="#Pip.repairPip">repairPip</a></td>
106 <td>Public method to repair the pip installation.</td>
107 </tr><tr>
108 <td><a href="#Pip.runProcess">runProcess</a></td>
109 <td>Public method to execute the current pip with the given arguments.</td>
110 </tr><tr>
111 <td><a href="#Pip.uninstallPackages">uninstallPackages</a></td>
112 <td>Public method to uninstall the given list of packages.</td>
113 </tr><tr>
114 <td><a href="#Pip.uninstallRequirements">uninstallRequirements</a></td>
115 <td>Public method to uninstall packages as given in a requirements file.</td>
116 </tr><tr>
117 <td><a href="#Pip.upgradePackages">upgradePackages</a></td>
118 <td>Public method to upgrade the given list of packages.</td>
119 </tr>
120 </table>
121 <h3>Static Methods</h3>
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125 <a NAME="Pip.__init__" ID="Pip.__init__"></a>
126 <h4>Pip (Constructor)</h4>
127 <b>Pip</b>(<i>parent=None</i>)
128 <p>
129 Constructor
130 </p><dl>
131 <dt><i>parent</i> (QObject)</dt>
132 <dd>
133 parent
134 </dd>
135 </dl><a NAME="Pip.__checkUpgradePyQt" ID="Pip.__checkUpgradePyQt"></a>
136 <h4>Pip.__checkUpgradePyQt</h4>
137 <b>__checkUpgradePyQt</b>(<i>packages</i>)
138 <p>
139 Private method to check, if an upgrade of PyQt packages is attempted.
140 </p><dl>
141 <dt><i>packages</i> (list of str)</dt>
142 <dd>
143 list of packages to upgrade
144 </dd>
145 </dl><dl>
146 <dt>Returns:</dt>
147 <dd>
148 flag indicating to abort the upgrade attempt
149 </dd>
150 </dl><dl>
151 <dt>Return Type:</dt>
152 <dd>
153 bool
154 </dd>
155 </dl><a NAME="Pip.getIndexUrl" ID="Pip.getIndexUrl"></a>
156 <h4>Pip.getIndexUrl</h4>
157 <b>getIndexUrl</b>(<i></i>)
158 <p>
159 Public method to get the index URL for PyPI.
160 </p><dl>
161 <dt>Returns:</dt>
162 <dd>
163 index URL for PyPI
164 </dd>
165 </dl><dl>
166 <dt>Return Type:</dt>
167 <dd>
168 str
169 </dd>
170 </dl><a NAME="Pip.getIndexUrlXml" ID="Pip.getIndexUrlXml"></a>
171 <h4>Pip.getIndexUrlXml</h4>
172 <b>getIndexUrlXml</b>(<i></i>)
173 <p>
174 Public method to get the index URL for XML RPC calls.
175 </p><dl>
176 <dt>Returns:</dt>
177 <dd>
178 index URL for XML RPC calls
179 </dd>
180 </dl><dl>
181 <dt>Return Type:</dt>
182 <dd>
183 str
184 </dd>
185 </dl><a NAME="Pip.getInstalledPackages" ID="Pip.getInstalledPackages"></a>
186 <h4>Pip.getInstalledPackages</h4>
187 <b>getInstalledPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False</i>)
188 <p>
189 Public method to get the list of installed packages.
190 </p><dl>
191 <dt><i>envName</i> (str)</dt>
192 <dd>
193 name of the environment to get the packages for
194 </dd><dt><i>localPackages</i> (bool)</dt>
195 <dd>
196 flag indicating to get local packages only
197 </dd><dt><i>notRequired</i> (bool)</dt>
198 <dd>
199 flag indicating to list packages that are not
200 dependencies of installed packages as well
201 </dd><dt><i>usersite</i> (bool)</dt>
202 <dd>
203 flag indicating to only list packages installed
204 in user-site
205 </dd>
206 </dl><dl>
207 <dt>Returns:</dt>
208 <dd>
209 list of tuples containing the package name and version
210 </dd>
211 </dl><dl>
212 <dt>Return Type:</dt>
213 <dd>
214 list of tuple of (str, str)
215 </dd>
216 </dl><a NAME="Pip.getOutdatedPackages" ID="Pip.getOutdatedPackages"></a>
217 <h4>Pip.getOutdatedPackages</h4>
218 <b>getOutdatedPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False</i>)
219 <p>
220 Public method to get the list of outdated packages.
221 </p><dl>
222 <dt><i>envName</i> (str)</dt>
223 <dd>
224 name of the environment to get the packages for
225 </dd><dt><i>localPackages</i> (bool)</dt>
226 <dd>
227 flag indicating to get local packages only
228 </dd><dt><i>notRequired</i> (bool)</dt>
229 <dd>
230 flag indicating to list packages that are not
231 dependencies of installed packages as well
232 </dd><dt><i>usersite</i> (bool)</dt>
233 <dd>
234 flag indicating to only list packages installed
235 in user-site
236 </dd>
237 </dl><dl>
238 <dt>Returns:</dt>
239 <dd>
240 list of tuples containing the package name, installed version
241 and available version
242 </dd>
243 </dl><dl>
244 <dt>Return Type:</dt>
245 <dd>
246 list of tuple of (str, str, str)
247 </dd>
248 </dl><a NAME="Pip.getPackageDetails" ID="Pip.getPackageDetails"></a>
249 <h4>Pip.getPackageDetails</h4>
250 <b>getPackageDetails</b>(<i>name, version</i>)
251 <p>
252 Public method to get package details using the PyPI JSON interface.
253 </p><dl>
254 <dt><i>name</i> (str)</dt>
255 <dd>
256 package name
257 </dd><dt><i>version</i> (str)</dt>
258 <dd>
259 package version
260 </dd>
261 </dl><dl>
262 <dt>Returns:</dt>
263 <dd>
264 dictionary containing PyPI package data
265 </dd>
266 </dl><dl>
267 <dt>Return Type:</dt>
268 <dd>
269 dict
270 </dd>
271 </dl><a NAME="Pip.getProjectEnvironmentString" ID="Pip.getProjectEnvironmentString"></a>
272 <h4>Pip.getProjectEnvironmentString</h4>
273 <b>getProjectEnvironmentString</b>(<i></i>)
274 <p>
275 Public method to get the string for the project environment.
276 </p><dl>
277 <dt>Returns:</dt>
278 <dd>
279 string for the project environment
280 </dd>
281 </dl><dl>
282 <dt>Return Type:</dt>
283 <dd>
284 str
285 </dd>
286 </dl><a NAME="Pip.getUserConfig" ID="Pip.getUserConfig"></a>
287 <h4>Pip.getUserConfig</h4>
288 <b>getUserConfig</b>(<i></i>)
289 <p>
290 Public method to get the name of the user configuration file.
291 </p><dl>
292 <dt>Returns:</dt>
293 <dd>
294 path of the user configuration file
295 </dd>
296 </dl><dl>
297 <dt>Return Type:</dt>
298 <dd>
299 str
300 </dd>
301 </dl><a NAME="Pip.getVirtualenvConfig" ID="Pip.getVirtualenvConfig"></a>
302 <h4>Pip.getVirtualenvConfig</h4>
303 <b>getVirtualenvConfig</b>(<i>venvName</i>)
304 <p>
305 Public method to get the name of the virtualenv configuration file.
306 </p><dl>
307 <dt><i>venvName</i> (str)</dt>
308 <dd>
309 name of the environment to get config file path for
310 </dd>
311 </dl><dl>
312 <dt>Returns:</dt>
313 <dd>
314 path of the virtualenv configuration file
315 </dd>
316 </dl><dl>
317 <dt>Return Type:</dt>
318 <dd>
319 str
320 </dd>
321 </dl><a NAME="Pip.getVirtualenvInterpreter" ID="Pip.getVirtualenvInterpreter"></a>
322 <h4>Pip.getVirtualenvInterpreter</h4>
323 <b>getVirtualenvInterpreter</b>(<i>venvName</i>)
324 <p>
325 Public method to get the interpreter for a virtual environment.
326 </p><dl>
327 <dt><i>venvName</i> (str)</dt>
328 <dd>
329 logical name for the virtual environment
330 </dd>
331 </dl><dl>
332 <dt>Returns:</dt>
333 <dd>
334 interpreter path
335 </dd>
336 </dl><dl>
337 <dt>Return Type:</dt>
338 <dd>
339 str
340 </dd>
341 </dl><a NAME="Pip.getVirtualenvNames" ID="Pip.getVirtualenvNames"></a>
342 <h4>Pip.getVirtualenvNames</h4>
343 <b>getVirtualenvNames</b>(<i>noRemote=False</i>)
344 <p>
345 Public method to get a sorted list of virtual environment names.
346 </p><dl>
347 <dt><i>noRemote</i> (bool)</dt>
348 <dd>
349 flag indicating to exclude environments for remote
350 debugging
351 </dd>
352 </dl><dl>
353 <dt>Returns:</dt>
354 <dd>
355 sorted list of virtual environment names
356 </dd>
357 </dl><dl>
358 <dt>Return Type:</dt>
359 <dd>
360 list of str
361 </dd>
362 </dl><a NAME="Pip.installPackages" ID="Pip.installPackages"></a>
363 <h4>Pip.installPackages</h4>
364 <b>installPackages</b>(<i>packages, venvName="", userSite=False, interpreter=""</i>)
365 <p>
366 Public method to install the given list of packages.
367 </p><dl>
368 <dt><i>packages</i> (list of str)</dt>
369 <dd>
370 list of packages to install
371 </dd><dt><i>venvName</i> (str)</dt>
372 <dd>
373 name of the virtual environment to be used
374 </dd><dt><i>userSite</i> (bool)</dt>
375 <dd>
376 flag indicating an install to the user install
377 directory
378 </dd><dt><i>interpreter</i> (str)</dt>
379 <dd>
380 interpreter to be used for execution
381 </dd>
382 </dl><a NAME="Pip.installPip" ID="Pip.installPip"></a>
383 <h4>Pip.installPip</h4>
384 <b>installPip</b>(<i>venvName, userSite=False</i>)
385 <p>
386 Public method to install pip.
387 </p><dl>
388 <dt><i>venvName</i> (str)</dt>
389 <dd>
390 name of the environment to install pip into
391 </dd><dt><i>userSite</i> (bool)</dt>
392 <dd>
393 flag indicating an install to the user install
394 directory
395 </dd>
396 </dl><a NAME="Pip.installRequirements" ID="Pip.installRequirements"></a>
397 <h4>Pip.installRequirements</h4>
398 <b>installRequirements</b>(<i>venvName</i>)
399 <p>
400 Public method to install packages as given in a requirements file.
401 </p><dl>
402 <dt><i>venvName</i> (str)</dt>
403 <dd>
404 name of the virtual environment to be used
405 </dd>
406 </dl><a NAME="Pip.repairPip" ID="Pip.repairPip"></a>
407 <h4>Pip.repairPip</h4>
408 <b>repairPip</b>(<i>venvName</i>)
409 <p>
410 Public method to repair the pip installation.
411 </p><dl>
412 <dt><i>venvName</i> (str)</dt>
413 <dd>
414 name of the environment to install pip into
415 </dd>
416 </dl><a NAME="Pip.runProcess" ID="Pip.runProcess"></a>
417 <h4>Pip.runProcess</h4>
418 <b>runProcess</b>(<i>args, interpreter</i>)
419 <p>
420 Public method to execute the current pip with the given arguments.
421 </p><p>
422 The selected pip executable is called with the given arguments and
423 waited for its end.
424 </p><dl>
425 <dt><i>args</i> (list of str)</dt>
426 <dd>
427 list of command line arguments
428 </dd><dt><i>interpreter</i> (str)</dt>
429 <dd>
430 path of the Python interpreter to be used
431 </dd>
432 </dl><dl>
433 <dt>Returns:</dt>
434 <dd>
435 tuple containing a flag indicating success and the output
436 of the process
437 </dd>
438 </dl><dl>
439 <dt>Return Type:</dt>
440 <dd>
441 tuple of (bool, str)
442 </dd>
443 </dl><a NAME="Pip.uninstallPackages" ID="Pip.uninstallPackages"></a>
444 <h4>Pip.uninstallPackages</h4>
445 <b>uninstallPackages</b>(<i>packages, venvName</i>)
446 <p>
447 Public method to uninstall the given list of packages.
448 </p><dl>
449 <dt><i>packages</i> (list of str)</dt>
450 <dd>
451 list of packages to uninstall
452 </dd><dt><i>venvName</i> (str)</dt>
453 <dd>
454 name of the virtual environment to be used
455 </dd>
456 </dl><dl>
457 <dt>Returns:</dt>
458 <dd>
459 flag indicating a successful execution
460 </dd>
461 </dl><dl>
462 <dt>Return Type:</dt>
463 <dd>
464 bool
465 </dd>
466 </dl><a NAME="Pip.uninstallRequirements" ID="Pip.uninstallRequirements"></a>
467 <h4>Pip.uninstallRequirements</h4>
468 <b>uninstallRequirements</b>(<i>venvName</i>)
469 <p>
470 Public method to uninstall packages as given in a requirements file.
471 </p><dl>
472 <dt><i>venvName</i> (str)</dt>
473 <dd>
474 name of the virtual environment to be used
475 </dd>
476 </dl><a NAME="Pip.upgradePackages" ID="Pip.upgradePackages"></a>
477 <h4>Pip.upgradePackages</h4>
478 <b>upgradePackages</b>(<i>packages, venvName, userSite=False</i>)
479 <p>
480 Public method to upgrade the given list of packages.
481 </p><dl>
482 <dt><i>packages</i> (list of str)</dt>
483 <dd>
484 list of packages to upgrade
485 </dd><dt><i>venvName</i> (str)</dt>
486 <dd>
487 name of the virtual environment to be used
488 </dd><dt><i>userSite</i> (bool)</dt>
489 <dd>
490 flag indicating an install to the user install
491 directory
492 </dd>
493 </dl><dl>
494 <dt>Returns:</dt>
495 <dd>
496 flag indicating a successful execution
497 </dd>
498 </dl><dl>
499 <dt>Return Type:</dt>
500 <dd>
501 bool
502 </dd>
503 </dl>
504 <div align="right"><a href="#top">Up</a></div>
505 <hr />
506 </body></html>

Mercurial Repository: eric

eric ide

mercurial