Mercurial Repositories > eric / file comparison

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

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

changeset 6343
86cea8abd0f7
parent 6333
3d4e7155d48f
child 6619
1d34365c082c
equal deleted inserted replaced
6342:c79ecba9cde7 6343:86cea8abd0f7
76 <td>Private slot to edit the current virtualenv configuration.</td> 76 <td>Private slot to edit the current virtualenv configuration.</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#Pip.__generateRequirements">__generateRequirements</a></td> 78 <td><a href="#Pip.__generateRequirements">__generateRequirements</a></td>
79 <td>Private slot to generate the contents for a requirements file.</td> 79 <td>Private slot to generate the contents for a requirements file.</td>
80 </tr><tr> 80 </tr><tr>
81 <td><a href="#Pip.__getPython">__getPython</a></td>
82 <td>Private method to derive the path to the python executable given the path to the pip executable.</td>
83 </tr><tr>
84 <td><a href="#Pip.__getUserConfig">__getUserConfig</a></td> 81 <td><a href="#Pip.__getUserConfig">__getUserConfig</a></td>
85 <td>Private method to get the name of the user configuration file.</td> 82 <td>Private method to get the name of the user configuration file.</td>
86 </tr><tr> 83 </tr><tr>
87 <td><a href="#Pip.__getVirtualenvConfig">__getVirtualenvConfig</a></td> 84 <td><a href="#Pip.__getVirtualenvConfig">__getVirtualenvConfig</a></td>
88 <td>Private method to get the name of the virtualenv configuration file.</td> 85 <td>Private method to get the name of the virtualenv configuration file.</td>
89 </tr><tr> 86 </tr><tr>
90 <td><a href="#Pip.__handleTearOffMenu">__handleTearOffMenu</a></td> 87 <td><a href="#Pip.__handleTearOffMenu">__handleTearOffMenu</a></td>
91 <td>Private slot to handle a change of the pip executable.</td> 88 <td>Private slot to handle a change of the selected virtual environment.</td>
92 </tr><tr> 89 </tr><tr>
93 <td><a href="#Pip.__installLocalPackage">__installLocalPackage</a></td> 90 <td><a href="#Pip.__installLocalPackage">__installLocalPackage</a></td>
94 <td>Private slot to install a package available on local storage.</td> 91 <td>Private slot to install a package available on local storage.</td>
95 </tr><tr> 92 </tr><tr>
96 <td><a href="#Pip.__installPackages">__installPackages</a></td> 93 <td><a href="#Pip.__installPackages">__installPackages</a></td>
118 <td>Private method to repair the pip installation.</td> 115 <td>Private method to repair the pip installation.</td>
119 </tr><tr> 116 </tr><tr>
120 <td><a href="#Pip.__searchPyPI">__searchPyPI</a></td> 117 <td><a href="#Pip.__searchPyPI">__searchPyPI</a></td>
121 <td>Private slot to search the Python Package Index.</td> 118 <td>Private slot to search the Python Package Index.</td>
122 </tr><tr> 119 </tr><tr>
123 <td><a href="#Pip.__selectPipExecutable">__selectPipExecutable</a></td> 120 <td><a href="#Pip.__selectPipVirtualenv">__selectPipVirtualenv</a></td>
124 <td>Private method to select the pip executable to be used.</td> 121 <td>Private method to select the virtual environment to be used.</td>
125 </tr><tr> 122 </tr><tr>
126 <td><a href="#Pip.__uninstallPackages">__uninstallPackages</a></td> 123 <td><a href="#Pip.__uninstallPackages">__uninstallPackages</a></td>
127 <td>Private slot to uninstall packages to be given by the user.</td> 124 <td>Private slot to uninstall packages to be given by the user.</td>
128 </tr><tr> 125 </tr><tr>
129 <td><a href="#Pip.__uninstallRequirements">__uninstallRequirements</a></td> 126 <td><a href="#Pip.__uninstallRequirements">__uninstallRequirements</a></td>
130 <td>Private slot to uninstall packages as given in a requirements file.</td> 127 <td>Private slot to uninstall packages as given in a requirements file.</td>
131 </tr><tr> 128 </tr><tr>
132 <td><a href="#Pip.__upgradePackages">__upgradePackages</a></td> 129 <td><a href="#Pip.__upgradePackages">__upgradePackages</a></td>
133 <td>Private slot to upgrade packages to be given by the user.</td> 130 <td>Private slot to upgrade packages to be given by the user.</td>
134 </tr><tr> 131 </tr><tr>
132 <td><a href="#Pip.getDefaultEnvironmentString">getDefaultEnvironmentString</a></td>
133 <td>Public method to get the string for the default environment.</td>
134 </tr><tr>
135 <td><a href="#Pip.getMenu">getMenu</a></td> 135 <td><a href="#Pip.getMenu">getMenu</a></td>
136 <td>Public method to get a reference to the requested menu.</td> 136 <td>Public method to get a reference to the requested menu.</td>
137 </tr><tr> 137 </tr><tr>
138 <td><a href="#Pip.getMenuNames">getMenuNames</a></td> 138 <td><a href="#Pip.getMenuNames">getMenuNames</a></td>
139 <td>Public method to get the names of all menus.</td> 139 <td>Public method to get the names of all menus.</td>
140 </tr><tr> 140 </tr><tr>
141 <td><a href="#Pip.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td>
142 <td>Public method to get the interpreter for a virtual environment.</td>
143 </tr><tr>
144 <td><a href="#Pip.getVirtualenvNames">getVirtualenvNames</a></td>
145 <td>Public method to get a sorted list of virtual environment names.</td>
146 </tr><tr>
141 <td><a href="#Pip.initActions">initActions</a></td> 147 <td><a href="#Pip.initActions">initActions</a></td>
142 <td>Public method to define the Django actions.</td> 148 <td>Public method to define the actions.</td>
143 </tr><tr> 149 </tr><tr>
144 <td><a href="#Pip.initMenu">initMenu</a></td> 150 <td><a href="#Pip.initMenu">initMenu</a></td>
145 <td>Public slot to initialize the Django menu.</td> 151 <td>Public slot to initialize the menu.</td>
146 </tr><tr> 152 </tr><tr>
147 <td><a href="#Pip.installPackages">installPackages</a></td> 153 <td><a href="#Pip.installPackages">installPackages</a></td>
148 <td>Public method to install the given list of packages.</td> 154 <td>Public method to install the given list of packages.</td>
149 </tr><tr> 155 </tr><tr>
150 <td><a href="#Pip.runProcess">runProcess</a></td> 156 <td><a href="#Pip.runProcess">runProcess</a></td>
168 <h4>Pip (Constructor)</h4> 174 <h4>Pip (Constructor)</h4>
169 <b>Pip</b>(<i>plugin, parent=None</i>) 175 <b>Pip</b>(<i>plugin, parent=None</i>)
170 <p> 176 <p>
171 Constructor 177 Constructor
172 </p><dl> 178 </p><dl>
173 <dt><i>plugin</i></dt> 179 <dt><i>plugin</i> (PipInterfacePlugin)</dt>
174 <dd> 180 <dd>
175 reference to the plugin object 181 reference to the plugin object
176 </dd><dt><i>parent</i></dt> 182 </dd><dt><i>parent</i> (QObject)</dt>
177 <dd> 183 <dd>
178 parent (QObject) 184 parent
179 </dd> 185 </dd>
180 </dl><a NAME="Pip.__aboutToShowMenu" ID="Pip.__aboutToShowMenu"></a> 186 </dl><a NAME="Pip.__aboutToShowMenu" ID="Pip.__aboutToShowMenu"></a>
181 <h4>Pip.__aboutToShowMenu</h4> 187 <h4>Pip.__aboutToShowMenu</h4>
182 <b>__aboutToShowMenu</b>(<i></i>) 188 <b>__aboutToShowMenu</b>(<i></i>)
183 <p> 189 <p>
206 <h4>Pip.__editConfiguration</h4> 212 <h4>Pip.__editConfiguration</h4>
207 <b>__editConfiguration</b>(<i>virtualenv=False</i>) 213 <b>__editConfiguration</b>(<i>virtualenv=False</i>)
208 <p> 214 <p>
209 Private method to edit a configuration. 215 Private method to edit a configuration.
210 </p><dl> 216 </p><dl>
211 <dt><i>virtualenv</i></dt> 217 <dt><i>virtualenv</i> (bool)</dt>
212 <dd> 218 <dd>
213 flag indicating to edit the current virtualenv 219 flag indicating to edit the current virtualenv
214 configuration file (boolean) 220 configuration file
215 </dd> 221 </dd>
216 </dl><a NAME="Pip.__editUserConfiguration" ID="Pip.__editUserConfiguration"></a> 222 </dl><a NAME="Pip.__editUserConfiguration" ID="Pip.__editUserConfiguration"></a>
217 <h4>Pip.__editUserConfiguration</h4> 223 <h4>Pip.__editUserConfiguration</h4>
218 <b>__editUserConfiguration</b>(<i></i>) 224 <b>__editUserConfiguration</b>(<i></i>)
219 <p> 225 <p>
226 </p><a NAME="Pip.__generateRequirements" ID="Pip.__generateRequirements"></a> 232 </p><a NAME="Pip.__generateRequirements" ID="Pip.__generateRequirements"></a>
227 <h4>Pip.__generateRequirements</h4> 233 <h4>Pip.__generateRequirements</h4>
228 <b>__generateRequirements</b>(<i></i>) 234 <b>__generateRequirements</b>(<i></i>)
229 <p> 235 <p>
230 Private slot to generate the contents for a requirements file. 236 Private slot to generate the contents for a requirements file.
231 </p><a NAME="Pip.__getPython" ID="Pip.__getPython"></a> 237 </p><a NAME="Pip.__getUserConfig" ID="Pip.__getUserConfig"></a>
232 <h4>Pip.__getPython</h4>
233 <b>__getPython</b>(<i>cmd</i>)
234 <p>
235 Private method to derive the path to the python executable given the
236 path to the pip executable.
237 </p><dl>
238 <dt><i>cmd</i> (str)</dt>
239 <dd>
240 path of the pip executable
241 </dd>
242 </dl><dl>
243 <dt>Returns:</dt>
244 <dd>
245 path of the python executable
246 </dd>
247 </dl><dl>
248 <dt>Return Type:</dt>
249 <dd>
250 str
251 </dd>
252 </dl><a NAME="Pip.__getUserConfig" ID="Pip.__getUserConfig"></a>
253 <h4>Pip.__getUserConfig</h4> 238 <h4>Pip.__getUserConfig</h4>
254 <b>__getUserConfig</b>(<i></i>) 239 <b>__getUserConfig</b>(<i></i>)
255 <p> 240 <p>
256 Private method to get the name of the user configuration file. 241 Private method to get the name of the user configuration file.
257 </p><dl> 242 </p><dl>
258 <dt>Returns:</dt> 243 <dt>Returns:</dt>
259 <dd> 244 <dd>
260 path of the user configuration file (string) 245 path of the user configuration file
246 </dd>
247 </dl><dl>
248 <dt>Return Type:</dt>
249 <dd>
250 str
261 </dd> 251 </dd>
262 </dl><a NAME="Pip.__getVirtualenvConfig" ID="Pip.__getVirtualenvConfig"></a> 252 </dl><a NAME="Pip.__getVirtualenvConfig" ID="Pip.__getVirtualenvConfig"></a>
263 <h4>Pip.__getVirtualenvConfig</h4> 253 <h4>Pip.__getVirtualenvConfig</h4>
264 <b>__getVirtualenvConfig</b>(<i></i>) 254 <b>__getVirtualenvConfig</b>(<i></i>)
265 <p> 255 <p>
266 Private method to get the name of the virtualenv configuration file. 256 Private method to get the name of the virtualenv configuration file.
267 </p><dl> 257 </p><dl>
268 <dt>Returns:</dt> 258 <dt>Returns:</dt>
269 <dd> 259 <dd>
270 path of the virtualenv configuration file (string) 260 path of the virtualenv configuration file
261 </dd>
262 </dl><dl>
263 <dt>Return Type:</dt>
264 <dd>
265 str
271 </dd> 266 </dd>
272 </dl><a NAME="Pip.__handleTearOffMenu" ID="Pip.__handleTearOffMenu"></a> 267 </dl><a NAME="Pip.__handleTearOffMenu" ID="Pip.__handleTearOffMenu"></a>
273 <h4>Pip.__handleTearOffMenu</h4> 268 <h4>Pip.__handleTearOffMenu</h4>
274 <b>__handleTearOffMenu</b>(<i>pip</i>) 269 <b>__handleTearOffMenu</b>(<i>venvName</i>)
275 <p> 270 <p>
276 Private slot to handle a change of the pip executable. 271 Private slot to handle a change of the selected virtual environment.
277 </p><dl> 272 </p><dl>
278 <dt><i>pip</i> (str)</dt> 273 <dt><i>venvName</i> (str)</dt>
279 <dd> 274 <dd>
280 path of the pip executable 275 logical name of the virtual environment
281 </dd> 276 </dd>
282 </dl><a NAME="Pip.__installLocalPackage" ID="Pip.__installLocalPackage"></a> 277 </dl><a NAME="Pip.__installLocalPackage" ID="Pip.__installLocalPackage"></a>
283 <h4>Pip.__installLocalPackage</h4> 278 <h4>Pip.__installLocalPackage</h4>
284 <b>__installLocalPackage</b>(<i></i>) 279 <b>__installLocalPackage</b>(<i></i>)
285 <p> 280 <p>
343 </dl><a NAME="Pip.__searchPyPI" ID="Pip.__searchPyPI"></a> 338 </dl><a NAME="Pip.__searchPyPI" ID="Pip.__searchPyPI"></a>
344 <h4>Pip.__searchPyPI</h4> 339 <h4>Pip.__searchPyPI</h4>
345 <b>__searchPyPI</b>(<i></i>) 340 <b>__searchPyPI</b>(<i></i>)
346 <p> 341 <p>
347 Private slot to search the Python Package Index. 342 Private slot to search the Python Package Index.
348 </p><a NAME="Pip.__selectPipExecutable" ID="Pip.__selectPipExecutable"></a> 343 </p><a NAME="Pip.__selectPipVirtualenv" ID="Pip.__selectPipVirtualenv"></a>
349 <h4>Pip.__selectPipExecutable</h4> 344 <h4>Pip.__selectPipVirtualenv</h4>
350 <b>__selectPipExecutable</b>(<i></i>) 345 <b>__selectPipVirtualenv</b>(<i></i>)
351 <p> 346 <p>
352 Private method to select the pip executable to be used. 347 Private method to select the virtual environment to be used.
353 </p><a NAME="Pip.__uninstallPackages" ID="Pip.__uninstallPackages"></a> 348 </p><a NAME="Pip.__uninstallPackages" ID="Pip.__uninstallPackages"></a>
354 <h4>Pip.__uninstallPackages</h4> 349 <h4>Pip.__uninstallPackages</h4>
355 <b>__uninstallPackages</b>(<i></i>) 350 <b>__uninstallPackages</b>(<i></i>)
356 <p> 351 <p>
357 Private slot to uninstall packages to be given by the user. 352 Private slot to uninstall packages to be given by the user.
363 </p><a NAME="Pip.__upgradePackages" ID="Pip.__upgradePackages"></a> 358 </p><a NAME="Pip.__upgradePackages" ID="Pip.__upgradePackages"></a>
364 <h4>Pip.__upgradePackages</h4> 359 <h4>Pip.__upgradePackages</h4>
365 <b>__upgradePackages</b>(<i></i>) 360 <b>__upgradePackages</b>(<i></i>)
366 <p> 361 <p>
367 Private slot to upgrade packages to be given by the user. 362 Private slot to upgrade packages to be given by the user.
368 </p><a NAME="Pip.getMenu" ID="Pip.getMenu"></a> 363 </p><a NAME="Pip.getDefaultEnvironmentString" ID="Pip.getDefaultEnvironmentString"></a>
364 <h4>Pip.getDefaultEnvironmentString</h4>
365 <b>getDefaultEnvironmentString</b>(<i></i>)
366 <p>
367 Public method to get the string for the default environment.
368 </p><dl>
369 <dt>Returns:</dt>
370 <dd>
371 string for the default environment
372 </dd>
373 </dl><dl>
374 <dt>Return Type:</dt>
375 <dd>
376 str
377 </dd>
378 </dl><a NAME="Pip.getMenu" ID="Pip.getMenu"></a>
369 <h4>Pip.getMenu</h4> 379 <h4>Pip.getMenu</h4>
370 <b>getMenu</b>(<i>name</i>) 380 <b>getMenu</b>(<i>name</i>)
371 <p> 381 <p>
372 Public method to get a reference to the requested menu. 382 Public method to get a reference to the requested menu.
373 </p><dl> 383 </p><dl>
374 <dt><i>name</i></dt> 384 <dt><i>name</i> (str)</dt>
375 <dd> 385 <dd>
376 name of the menu (string) 386 name of the menu
377 </dd> 387 </dd>
378 </dl><dl> 388 </dl><dl>
379 <dt>Returns:</dt> 389 <dt>Returns:</dt>
380 <dd> 390 <dd>
381 reference to the menu (QMenu) or None, if no 391 reference to the menu or None, if no
382 menu with the given name exists 392 menu with the given name exists
393 </dd>
394 </dl><dl>
395 <dt>Return Type:</dt>
396 <dd>
397 QMenu or None
383 </dd> 398 </dd>
384 </dl><a NAME="Pip.getMenuNames" ID="Pip.getMenuNames"></a> 399 </dl><a NAME="Pip.getMenuNames" ID="Pip.getMenuNames"></a>
385 <h4>Pip.getMenuNames</h4> 400 <h4>Pip.getMenuNames</h4>
386 <b>getMenuNames</b>(<i></i>) 401 <b>getMenuNames</b>(<i></i>)
387 <p> 402 <p>
388 Public method to get the names of all menus. 403 Public method to get the names of all menus.
389 </p><dl> 404 </p><dl>
390 <dt>Returns:</dt> 405 <dt>Returns:</dt>
391 <dd> 406 <dd>
392 menu names (list of string) 407 menu names
408 </dd>
409 </dl><dl>
410 <dt>Return Type:</dt>
411 <dd>
412 list of str
413 </dd>
414 </dl><a NAME="Pip.getVirtualenvInterpreter" ID="Pip.getVirtualenvInterpreter"></a>
415 <h4>Pip.getVirtualenvInterpreter</h4>
416 <b>getVirtualenvInterpreter</b>(<i>venvName</i>)
417 <p>
418 Public method to get the interpreter for a virtual environment.
419 </p><dl>
420 <dt><i>venvName</i> (str)</dt>
421 <dd>
422 logical name for the virtual environment
423 </dd>
424 </dl><dl>
425 <dt>Returns:</dt>
426 <dd>
427 interpreter path
428 </dd>
429 </dl><dl>
430 <dt>Return Type:</dt>
431 <dd>
432 str
433 </dd>
434 </dl><a NAME="Pip.getVirtualenvNames" ID="Pip.getVirtualenvNames"></a>
435 <h4>Pip.getVirtualenvNames</h4>
436 <b>getVirtualenvNames</b>(<i></i>)
437 <p>
438 Public method to get a sorted list of virtual environment names.
439 </p><dl>
440 <dt>Returns:</dt>
441 <dd>
442 sorted list of virtual environment names
443 </dd>
444 </dl><dl>
445 <dt>Return Type:</dt>
446 <dd>
447 list of str
393 </dd> 448 </dd>
394 </dl><a NAME="Pip.initActions" ID="Pip.initActions"></a> 449 </dl><a NAME="Pip.initActions" ID="Pip.initActions"></a>
395 <h4>Pip.initActions</h4> 450 <h4>Pip.initActions</h4>
396 <b>initActions</b>(<i></i>) 451 <b>initActions</b>(<i></i>)
397 <p> 452 <p>
398 Public method to define the Django actions. 453 Public method to define the actions.
399 </p><a NAME="Pip.initMenu" ID="Pip.initMenu"></a> 454 </p><a NAME="Pip.initMenu" ID="Pip.initMenu"></a>
400 <h4>Pip.initMenu</h4> 455 <h4>Pip.initMenu</h4>
401 <b>initMenu</b>(<i></i>) 456 <b>initMenu</b>(<i></i>)
402 <p> 457 <p>
403 Public slot to initialize the Django menu. 458 Public slot to initialize the menu.
404 </p><dl> 459 </p><dl>
405 <dt>Returns:</dt> 460 <dt>Returns:</dt>
406 <dd> 461 <dd>
407 the menu generated (QMenu) 462 the menu generated
463 </dd>
464 </dl><dl>
465 <dt>Return Type:</dt>
466 <dd>
467 QMenu
408 </dd> 468 </dd>
409 </dl><a NAME="Pip.installPackages" ID="Pip.installPackages"></a> 469 </dl><a NAME="Pip.installPackages" ID="Pip.installPackages"></a>
410 <h4>Pip.installPackages</h4> 470 <h4>Pip.installPackages</h4>
411 <b>installPackages</b>(<i>packages, cmd="", userSite=False</i>) 471 <b>installPackages</b>(<i>packages, venvName="", userSite=False</i>)
412 <p> 472 <p>
413 Public method to install the given list of packages. 473 Public method to install the given list of packages.
414 </p><dl> 474 </p><dl>
415 <dt><i>packages</i> (list of str)</dt> 475 <dt><i>packages</i> (list of str)</dt>
416 <dd> 476 <dd>
417 list of packages to install 477 list of packages to install
418 </dd><dt><i>cmd</i> (str)</dt> 478 </dd><dt><i>venvName</i> (str)</dt>
419 <dd> 479 <dd>
420 pip command to be used 480 name of the virtual environment to be used
421 </dd><dt><i>userSite</i> (bool)</dt> 481 </dd><dt><i>userSite</i> (bool)</dt>
422 <dd> 482 <dd>
423 flag indicating an install to the user install 483 flag indicating an install to the user install
424 directory 484 directory
425 </dd> 485 </dd>
426 </dl><a NAME="Pip.runProcess" ID="Pip.runProcess"></a> 486 </dl><a NAME="Pip.runProcess" ID="Pip.runProcess"></a>
427 <h4>Pip.runProcess</h4> 487 <h4>Pip.runProcess</h4>
428 <b>runProcess</b>(<i>args, cmd=""</i>) 488 <b>runProcess</b>(<i>args, interpreter</i>)
429 <p> 489 <p>
430 Public method to execute the current pip with the given arguments. 490 Public method to execute the current pip with the given arguments.
431 </p><p> 491 </p><p>
432 The selected pip executable is called with the given arguments and 492 The selected pip executable is called with the given arguments and
433 waited for its end. 493 waited for its end.
434 </p><dl> 494 </p><dl>
435 <dt><i>args</i> (list of str)</dt> 495 <dt><i>args</i> (list of str)</dt>
436 <dd> 496 <dd>
437 list of command line arguments 497 list of command line arguments
438 </dd><dt><i>cmd</i> (str)</dt> 498 </dd><dt><i>interpreter</i> (str)</dt>
439 <dd> 499 <dd>
440 pip executable to be used 500 path of the Python interpreter to be used
441 </dd> 501 </dd>
442 </dl><dl> 502 </dl><dl>
443 <dt>Returns:</dt> 503 <dt>Returns:</dt>
444 <dd> 504 <dd>
445 tuple containing a flag indicating success and the output 505 tuple containing a flag indicating success and the output
450 <dd> 510 <dd>
451 tuple of (bool, str) 511 tuple of (bool, str)
452 </dd> 512 </dd>
453 </dl><a NAME="Pip.uninstallPackages" ID="Pip.uninstallPackages"></a> 513 </dl><a NAME="Pip.uninstallPackages" ID="Pip.uninstallPackages"></a>
454 <h4>Pip.uninstallPackages</h4> 514 <h4>Pip.uninstallPackages</h4>
455 <b>uninstallPackages</b>(<i>packages, cmd=""</i>) 515 <b>uninstallPackages</b>(<i>packages, venvName=""</i>)
456 <p> 516 <p>
457 Public method to uninstall the given list of packages. 517 Public method to uninstall the given list of packages.
458 </p><dl> 518 </p><dl>
459 <dt><i>packages</i></dt> 519 <dt><i>packages</i> (list of str)</dt>
460 <dd> 520 <dd>
461 list of packages to uninstall (list of string) 521 list of packages to uninstall
462 </dd><dt><i>cmd</i></dt> 522 </dd><dt><i>venvName</i> (str)</dt>
463 <dd> 523 <dd>
464 pip command to be used (string) 524 name of the virtual environment to be used
465 </dd> 525 </dd>
466 </dl><dl> 526 </dl><dl>
467 <dt>Returns:</dt> 527 <dt>Returns:</dt>
468 <dd> 528 <dd>
469 flag indicating a successful execution (boolean) 529 flag indicating a successful execution
530 </dd>
531 </dl><dl>
532 <dt>Return Type:</dt>
533 <dd>
534 bool
470 </dd> 535 </dd>
471 </dl><a NAME="Pip.upgradePackages" ID="Pip.upgradePackages"></a> 536 </dl><a NAME="Pip.upgradePackages" ID="Pip.upgradePackages"></a>
472 <h4>Pip.upgradePackages</h4> 537 <h4>Pip.upgradePackages</h4>
473 <b>upgradePackages</b>(<i>packages, cmd="", userSite=False</i>) 538 <b>upgradePackages</b>(<i>packages, venvName="", userSite=False</i>)
474 <p> 539 <p>
475 Public method to upgrade the given list of packages. 540 Public method to upgrade the given list of packages.
476 </p><dl> 541 </p><dl>
477 <dt><i>packages</i> (list of str)</dt> 542 <dt><i>packages</i> (list of str)</dt>
478 <dd> 543 <dd>
479 list of packages to upgrade 544 list of packages to upgrade
480 </dd><dt><i>cmd</i> (str)</dt> 545 </dd><dt><i>venvName</i> (str)</dt>
481 <dd> 546 <dd>
482 pip command to be used 547 name of the virtual environment to be used
483 </dd><dt><i>userSite</i> (bool)</dt> 548 </dd><dt><i>userSite</i> (bool)</dt>
484 <dd> 549 <dd>
485 flag indicating an install to the user install 550 flag indicating an install to the user install
486 directory 551 directory
487 </dd> 552 </dd>
495 <dd> 560 <dd>
496 bool 561 bool
497 </dd> 562 </dd>
498 </dl><a NAME="Pip.upgradePip" ID="Pip.upgradePip"></a> 563 </dl><a NAME="Pip.upgradePip" ID="Pip.upgradePip"></a>
499 <h4>Pip.upgradePip</h4> 564 <h4>Pip.upgradePip</h4>
500 <b>upgradePip</b>(<i>pip="", userSite=False</i>) 565 <b>upgradePip</b>(<i>venvName="", userSite=False</i>)
501 <p> 566 <p>
502 Public method to upgrade pip itself. 567 Public method to upgrade pip itself.
503 </p><dl> 568 </p><dl>
504 <dt><i>pip</i> (str)</dt> 569 <dt><i>venvName</i> (str)</dt>
505 <dd> 570 <dd>
506 pip command to be used 571 name of the virtual environment to be used
507 </dd><dt><i>userSite</i> (bool)</dt> 572 </dd><dt><i>userSite</i> (bool)</dt>
508 <dd> 573 <dd>
509 flag indicating an install to the user install 574 flag indicating an install to the user install
510 directory 575 directory
511 </dd> 576 </dd>

Mercurial Repository: eric

eric ide

mercurial