Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.PipInterface.PipPackagesWidget.html

changeset 8090
c53117374255
parent 8085
f6db8b3ecea9
child 8152
0c740fcffd34
equal deleted inserted replaced
8089:e43bf8d7baf9 8090:c53117374255
59 <h3>Derived from</h3> 59 <h3>Derived from</h3>
60 QWidget, Ui_PipPackagesWidget 60 QWidget, Ui_PipPackagesWidget
61 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
62 62
63 <table> 63 <table>
64 <tr><td>SearchUrl</td></tr><tr><td>SearchVersionRole</td></tr><tr><td>ShowProcessClassifiersMode</td></tr><tr><td>ShowProcessEntryPointsMode</td></tr><tr><td>ShowProcessFilesListMode</td></tr><tr><td>ShowProcessGeneralMode</td></tr> 64 <tr><td>SearchVersionRole</td></tr><tr><td>ShowProcessClassifiersMode</td></tr><tr><td>ShowProcessEntryPointsMode</td></tr><tr><td>ShowProcessFilesListMode</td></tr><tr><td>ShowProcessGeneralMode</td></tr>
65 </table> 65 </table>
66 <h3>Class Methods</h3> 66 <h3>Class Methods</h3>
67 67
68 <table> 68 <table>
69 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
99 <tr> 99 <tr>
100 <td><a href="#PipPackagesWidget.__editVirtualenvConfiguration">__editVirtualenvConfiguration</a></td> 100 <td><a href="#PipPackagesWidget.__editVirtualenvConfiguration">__editVirtualenvConfiguration</a></td>
101 <td>Private slot to edit the configuration of the selected environment.</td> 101 <td>Private slot to edit the configuration of the selected environment.</td>
102 </tr> 102 </tr>
103 <tr> 103 <tr>
104 <td><a href="#PipPackagesWidget.__executeUpgradePackages">__executeUpgradePackages</a></td>
105 <td>Private method to execute the pip upgrade command.</td>
106 </tr>
107 <tr>
108 <td><a href="#PipPackagesWidget.__finishSearch">__finishSearch</a></td> 104 <td><a href="#PipPackagesWidget.__finishSearch">__finishSearch</a></td>
109 <td>Private slot performing the search finishing actions.</td> 105 <td>Private slot performing the search finishing actions.</td>
110 </tr> 106 </tr>
111 <tr> 107 <tr>
112 <td><a href="#PipPackagesWidget.__generateRequirements">__generateRequirements</a></td> 108 <td><a href="#PipPackagesWidget.__generateRequirements">__generateRequirements</a></td>
115 <tr> 111 <tr>
116 <td><a href="#PipPackagesWidget.__initPipMenu">__initPipMenu</a></td> 112 <td><a href="#PipPackagesWidget.__initPipMenu">__initPipMenu</a></td>
117 <td>Private method to create the super menu and attach it to the super menu button.</td> 113 <td>Private method to create the super menu and attach it to the super menu button.</td>
118 </tr> 114 </tr>
119 <tr> 115 <tr>
120 <td><a href="#PipPackagesWidget.__install">__install</a></td>
121 <td>Private slot to install the selected packages.</td>
122 </tr>
123 <tr>
124 <td><a href="#PipPackagesWidget.__installLocalPackage">__installLocalPackage</a></td> 116 <td><a href="#PipPackagesWidget.__installLocalPackage">__installLocalPackage</a></td>
125 <td>Private slot to install a package available on local storage.</td> 117 <td>Private slot to install a package available on local storage.</td>
126 </tr> 118 </tr>
127 <tr> 119 <tr>
128 <td><a href="#PipPackagesWidget.__installPackages">__installPackages</a></td> 120 <td><a href="#PipPackagesWidget.__installPackages">__installPackages</a></td>
209 <td>Private method to update the action button states of the search widget.</td> 201 <td>Private method to update the action button states of the search widget.</td>
210 </tr> 202 </tr>
211 <tr> 203 <tr>
212 <td><a href="#PipPackagesWidget.__updateSearchButton">__updateSearchButton</a></td> 204 <td><a href="#PipPackagesWidget.__updateSearchButton">__updateSearchButton</a></td>
213 <td>Private method to update the state of the search button.</td> 205 <td>Private method to update the state of the search button.</td>
206 </tr>
207 <tr>
208 <td><a href="#PipPackagesWidget.executeInstallPackages">executeInstallPackages</a></td>
209 <td>Public method to install the given list of packages.</td>
210 </tr>
211 <tr>
212 <td><a href="#PipPackagesWidget.executeUninstallPackages">executeUninstallPackages</a></td>
213 <td>Public method to uninstall the given list of packages.</td>
214 </tr>
215 <tr>
216 <td><a href="#PipPackagesWidget.executeUpgradePackages">executeUpgradePackages</a></td>
217 <td>Public method to execute the pip upgrade command.</td>
218 </tr>
219 <tr>
220 <td><a href="#PipPackagesWidget.getPip">getPip</a></td>
221 <td>Public method to get a reference to the pip interface object.</td>
214 </tr> 222 </tr>
215 <tr> 223 <tr>
216 <td><a href="#PipPackagesWidget.on_environmentsComboBox_currentIndexChanged">on_environmentsComboBox_currentIndexChanged</a></td> 224 <td><a href="#PipPackagesWidget.on_environmentsComboBox_currentIndexChanged">on_environmentsComboBox_currentIndexChanged</a></td>
217 <td>Private slot handling the selection of a Python environment.</td> 225 <td>Private slot handling the selection of a Python environment.</td>
218 </tr> 226 </tr>
397 <b>__editVirtualenvConfiguration</b>(<i></i>) 405 <b>__editVirtualenvConfiguration</b>(<i></i>)
398 406
399 <p> 407 <p>
400 Private slot to edit the configuration of the selected environment. 408 Private slot to edit the configuration of the selected environment.
401 </p> 409 </p>
402 <a NAME="PipPackagesWidget.__executeUpgradePackages" ID="PipPackagesWidget.__executeUpgradePackages"></a>
403 <h4>PipPackagesWidget.__executeUpgradePackages</h4>
404 <b>__executeUpgradePackages</b>(<i>packages</i>)
405
406 <p>
407 Private method to execute the pip upgrade command.
408 </p>
409 <dl>
410
411 <dt><i>packages</i> (list of str)</dt>
412 <dd>
413 list of package names to be upgraded
414 </dd>
415 </dl>
416 <dl>
417 <dt>Return:</dt>
418 <dd>
419 flag indicating success
420 </dd>
421 </dl>
422 <dl>
423 <dt>Return Type:</dt>
424 <dd>
425 bool
426 </dd>
427 </dl>
428 <a NAME="PipPackagesWidget.__finishSearch" ID="PipPackagesWidget.__finishSearch"></a> 410 <a NAME="PipPackagesWidget.__finishSearch" ID="PipPackagesWidget.__finishSearch"></a>
429 <h4>PipPackagesWidget.__finishSearch</h4> 411 <h4>PipPackagesWidget.__finishSearch</h4>
430 <b>__finishSearch</b>(<i></i>) 412 <b>__finishSearch</b>(<i></i>)
431 413
432 <p> 414 <p>
445 427
446 <p> 428 <p>
447 Private method to create the super menu and attach it to the super 429 Private method to create the super menu and attach it to the super
448 menu button. 430 menu button.
449 </p> 431 </p>
450 <a NAME="PipPackagesWidget.__install" ID="PipPackagesWidget.__install"></a>
451 <h4>PipPackagesWidget.__install</h4>
452 <b>__install</b>(<i>userSite=False</i>)
453
454 <p>
455 Private slot to install the selected packages.
456 </p>
457 <dl>
458
459 <dt><i>userSite</i> (bool)</dt>
460 <dd>
461 flag indicating to install to the user directory
462 </dd>
463 </dl>
464 <a NAME="PipPackagesWidget.__installLocalPackage" ID="PipPackagesWidget.__installLocalPackage"></a> 432 <a NAME="PipPackagesWidget.__installLocalPackage" ID="PipPackagesWidget.__installLocalPackage"></a>
465 <h4>PipPackagesWidget.__installLocalPackage</h4> 433 <h4>PipPackagesWidget.__installLocalPackage</h4>
466 <b>__installLocalPackage</b>(<i></i>) 434 <b>__installLocalPackage</b>(<i></i>)
467 435
468 <p> 436 <p>
614 <p> 582 <p>
615 Private slot to show a list of cached files. 583 Private slot to show a list of cached files.
616 </p> 584 </p>
617 <a NAME="PipPackagesWidget.__showPackageDetails" ID="PipPackagesWidget.__showPackageDetails"></a> 585 <a NAME="PipPackagesWidget.__showPackageDetails" ID="PipPackagesWidget.__showPackageDetails"></a>
618 <h4>PipPackagesWidget.__showPackageDetails</h4> 586 <h4>PipPackagesWidget.__showPackageDetails</h4>
619 <b>__showPackageDetails</b>(<i>packageName, packageVersion</i>) 587 <b>__showPackageDetails</b>(<i>packageName, packageVersion, upgradable=False, installable=False</i>)
620 588
621 <p> 589 <p>
622 Private method to populate the package details dialog. 590 Private method to populate the package details dialog.
623 </p> 591 </p>
624 <dl> 592 <dl>
628 name of the package to show details for 596 name of the package to show details for
629 </dd> 597 </dd>
630 <dt><i>packageVersion</i> (str)</dt> 598 <dt><i>packageVersion</i> (str)</dt>
631 <dd> 599 <dd>
632 version of the package 600 version of the package
601 </dd>
602 <dt><i>upgradable</i> (bool (optional))</dt>
603 <dd>
604 flag indicating that the package may be upgraded
605 (defaults to False)
606 </dd>
607 <dt><i>installable</i> (bool (optional))</dt>
608 <dd>
609 flag indicating that the package may be installed
610 (defaults to False)
633 </dd> 611 </dd>
634 </dl> 612 </dl>
635 <a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a> 613 <a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a>
636 <h4>PipPackagesWidget.__showSearchedDetails</h4> 614 <h4>PipPackagesWidget.__showSearchedDetails</h4>
637 <b>__showSearchedDetails</b>(<i>item=None</i>) 615 <b>__showSearchedDetails</b>(<i>item=None</i>)
672 <b>__updateSearchButton</b>(<i></i>) 650 <b>__updateSearchButton</b>(<i></i>)
673 651
674 <p> 652 <p>
675 Private method to update the state of the search button. 653 Private method to update the state of the search button.
676 </p> 654 </p>
655 <a NAME="PipPackagesWidget.executeInstallPackages" ID="PipPackagesWidget.executeInstallPackages"></a>
656 <h4>PipPackagesWidget.executeInstallPackages</h4>
657 <b>executeInstallPackages</b>(<i>packages, userSite=False</i>)
658
659 <p>
660 Public method to install the given list of packages.
661 </p>
662 <dl>
663
664 <dt><i>packages</i> (list of str)</dt>
665 <dd>
666 list of package names to be installed
667 </dd>
668 <dt><i>userSite</i> (bool)</dt>
669 <dd>
670 flag indicating to install to the user directory
671 </dd>
672 </dl>
673 <a NAME="PipPackagesWidget.executeUninstallPackages" ID="PipPackagesWidget.executeUninstallPackages"></a>
674 <h4>PipPackagesWidget.executeUninstallPackages</h4>
675 <b>executeUninstallPackages</b>(<i>packages</i>)
676
677 <p>
678 Public method to uninstall the given list of packages.
679 </p>
680 <dl>
681
682 <dt><i>packages</i> (list of str)</dt>
683 <dd>
684 list of package names to be uninstalled
685 </dd>
686 </dl>
687 <a NAME="PipPackagesWidget.executeUpgradePackages" ID="PipPackagesWidget.executeUpgradePackages"></a>
688 <h4>PipPackagesWidget.executeUpgradePackages</h4>
689 <b>executeUpgradePackages</b>(<i>packages</i>)
690
691 <p>
692 Public method to execute the pip upgrade command.
693 </p>
694 <dl>
695
696 <dt><i>packages</i> (list of str)</dt>
697 <dd>
698 list of package names to be upgraded
699 </dd>
700 </dl>
701 <a NAME="PipPackagesWidget.getPip" ID="PipPackagesWidget.getPip"></a>
702 <h4>PipPackagesWidget.getPip</h4>
703 <b>getPip</b>(<i></i>)
704
705 <p>
706 Public method to get a reference to the pip interface object.
707 </p>
708 <dl>
709 <dt>Return:</dt>
710 <dd>
711 reference to the pip interface object
712 </dd>
713 </dl>
714 <dl>
715 <dt>Return Type:</dt>
716 <dd>
717 Pip
718 </dd>
719 </dl>
677 <a NAME="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged" ID="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged"></a> 720 <a NAME="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged" ID="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged"></a>
678 <h4>PipPackagesWidget.on_environmentsComboBox_currentIndexChanged</h4> 721 <h4>PipPackagesWidget.on_environmentsComboBox_currentIndexChanged</h4>
679 <b>on_environmentsComboBox_currentIndexChanged</b>(<i>index</i>) 722 <b>on_environmentsComboBox_currentIndexChanged</b>(<i>index</i>)
680 723
681 <p> 724 <p>

Mercurial Repository: eric

eric ide

mercurial