Mercurial Repositories > eric / file comparison

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

eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html

branch
eric7
changeset 8983
46eaed7bf3cb
parent 8596
d64760b2da50
child 8985
30e9e592732d
equal deleted inserted replaced
8982:afec1a04aed9 8983:46eaed7bf3cb
45 <h3>Derived from</h3> 45 <h3>Derived from</h3>
46 QWidget, Ui_PipPackagesWidget 46 QWidget, Ui_PipPackagesWidget
47 <h3>Class Attributes</h3> 47 <h3>Class Attributes</h3>
48 48
49 <table> 49 <table>
50 <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> 50 <tr><td>AvailableVersionColumn</td></tr><tr><td>InstalledVersionColumn</td></tr><tr><td>PackageColumn</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><tr><td>VulnerabilityColumn</td></tr><tr><td>VulnerabilityRole</td></tr>
51 </table> 51 </table>
52 <h3>Class Methods</h3> 52 <h3>Class Methods</h3>
53 53
54 <table> 54 <table>
55 <tr><td>None</td></tr> 55 <tr><td>None</td></tr>
73 <tr> 73 <tr>
74 <td><a href="#PipPackagesWidget.__availablePipVersion">__availablePipVersion</a></td> 74 <td><a href="#PipPackagesWidget.__availablePipVersion">__availablePipVersion</a></td>
75 <td>Private method to get the pip version of the selected environment.</td> 75 <td>Private method to get the pip version of the selected environment.</td>
76 </tr> 76 </tr>
77 <tr> 77 <tr>
78 <td><a href="#PipPackagesWidget.__clearVulnerabilityInfo">__clearVulnerabilityInfo</a></td>
79 <td>Private slot to clear the vulnerability info.</td>
80 </tr>
81 <tr>
78 <td><a href="#PipPackagesWidget.__editConfiguration">__editConfiguration</a></td> 82 <td><a href="#PipPackagesWidget.__editConfiguration">__editConfiguration</a></td>
79 <td>Private method to edit a configuration.</td> 83 <td>Private method to edit a configuration.</td>
80 </tr> 84 </tr>
81 <tr> 85 <tr>
82 <td><a href="#PipPackagesWidget.__editUserConfiguration">__editUserConfiguration</a></td> 86 <td><a href="#PipPackagesWidget.__editUserConfiguration">__editUserConfiguration</a></td>
177 <tr> 181 <tr>
178 <td><a href="#PipPackagesWidget.__showPackageDetails">__showPackageDetails</a></td> 182 <td><a href="#PipPackagesWidget.__showPackageDetails">__showPackageDetails</a></td>
179 <td>Private method to populate the package details dialog.</td> 183 <td>Private method to populate the package details dialog.</td>
180 </tr> 184 </tr>
181 <tr> 185 <tr>
186 <td><a href="#PipPackagesWidget.__showPackageInformation">__showPackageInformation</a></td>
187 <td>Private method to show information for a package.</td>
188 </tr>
189 <tr>
182 <td><a href="#PipPackagesWidget.__showSearchedDetails">__showSearchedDetails</a></td> 190 <td><a href="#PipPackagesWidget.__showSearchedDetails">__showSearchedDetails</a></td>
183 <td>Private slot to show details about the selected search result package.</td> 191 <td>Private slot to show details about the selected search result package.</td>
184 </tr> 192 </tr>
185 <tr> 193 <tr>
194 <td><a href="#PipPackagesWidget.__showVulnerabilityInformation">__showVulnerabilityInformation</a></td>
195 <td>Private method to show the detected vulnerability data.</td>
196 </tr>
197 <tr>
186 <td><a href="#PipPackagesWidget.__uninstallRequirements">__uninstallRequirements</a></td> 198 <td><a href="#PipPackagesWidget.__uninstallRequirements">__uninstallRequirements</a></td>
187 <td>Private slot to uninstall packages as given in a requirements file.</td> 199 <td>Private slot to uninstall packages as given in a requirements file.</td>
188 </tr> 200 </tr>
189 <tr> 201 <tr>
190 <td><a href="#PipPackagesWidget.__updateActionButtons">__updateActionButtons</a></td> 202 <td><a href="#PipPackagesWidget.__updateActionButtons">__updateActionButtons</a></td>
197 <tr> 209 <tr>
198 <td><a href="#PipPackagesWidget.__updateSearchButton">__updateSearchButton</a></td> 210 <td><a href="#PipPackagesWidget.__updateSearchButton">__updateSearchButton</a></td>
199 <td>Private method to update the state of the search button.</td> 211 <td>Private method to update the state of the search button.</td>
200 </tr> 212 </tr>
201 <tr> 213 <tr>
214 <td><a href="#PipPackagesWidget.__updateVulnerabilityData">__updateVulnerabilityData</a></td>
215 <td>Private slot to update the shown vulnerability info.</td>
216 </tr>
217 <tr>
218 <td><a href="#PipPackagesWidget.__updateVulnerabilityDbCache">__updateVulnerabilityDbCache</a></td>
219 <td>Private slot to initiate an update of the local cache of the vulnerability database.</td>
220 </tr>
221 <tr>
202 <td><a href="#PipPackagesWidget.executeInstallPackages">executeInstallPackages</a></td> 222 <td><a href="#PipPackagesWidget.executeInstallPackages">executeInstallPackages</a></td>
203 <td>Public method to install the given list of packages.</td> 223 <td>Public method to install the given list of packages.</td>
204 </tr> 224 </tr>
205 <tr> 225 <tr>
206 <td><a href="#PipPackagesWidget.executeUninstallPackages">executeUninstallPackages</a></td> 226 <td><a href="#PipPackagesWidget.executeUninstallPackages">executeUninstallPackages</a></td>
237 <tr> 257 <tr>
238 <td><a href="#PipPackagesWidget.on_notRequiredCheckBox_clicked">on_notRequiredCheckBox_clicked</a></td> 258 <td><a href="#PipPackagesWidget.on_notRequiredCheckBox_clicked">on_notRequiredCheckBox_clicked</a></td>
239 <td>Private slot handling the switching of the 'not required' mode.</td> 259 <td>Private slot handling the switching of the 'not required' mode.</td>
240 </tr> 260 </tr>
241 <tr> 261 <tr>
242 <td><a href="#PipPackagesWidget.on_packagesList_itemActivated">on_packagesList_itemActivated</a></td> 262 <td><a href="#PipPackagesWidget.on_packagesList_itemClicked">on_packagesList_itemClicked</a></td>
243 <td>Private slot reacting on a package item activation.</td> 263 <td>Private slot reacting on a package item click.</td>
244 </tr> 264 </tr>
245 <tr> 265 <tr>
246 <td><a href="#PipPackagesWidget.on_packagesList_itemSelectionChanged">on_packagesList_itemSelectionChanged</a></td> 266 <td><a href="#PipPackagesWidget.on_packagesList_itemDoubleClicked">on_packagesList_itemDoubleClicked</a></td>
247 <td>Private slot handling the selection of a package.</td> 267 <td>Private slot reacting on a package item double click.</td>
248 </tr> 268 </tr>
249 <tr> 269 <tr>
250 <td><a href="#PipPackagesWidget.on_refreshButton_clicked">on_refreshButton_clicked</a></td> 270 <td><a href="#PipPackagesWidget.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
251 <td>Private slot to refresh the display.</td> 271 <td>Private slot to refresh the display.</td>
252 </tr> 272 </tr>
299 <td>Private slot handling the switching of the 'user-site' mode.</td> 319 <td>Private slot handling the switching of the 'user-site' mode.</td>
300 </tr> 320 </tr>
301 <tr> 321 <tr>
302 <td><a href="#PipPackagesWidget.on_verboseCheckBox_clicked">on_verboseCheckBox_clicked</a></td> 322 <td><a href="#PipPackagesWidget.on_verboseCheckBox_clicked">on_verboseCheckBox_clicked</a></td>
303 <td>Private slot to handle a change of the verbose package information checkbox.</td> 323 <td>Private slot to handle a change of the verbose package information checkbox.</td>
324 </tr>
325 <tr>
326 <td><a href="#PipPackagesWidget.on_vulnerabilityCheckBox_clicked">on_vulnerabilityCheckBox_clicked</a></td>
327 <td>Private slot handling a change of the automatic vulnerability checks.</td>
304 </tr> 328 </tr>
305 </table> 329 </table>
306 <h3>Static Methods</h3> 330 <h3>Static Methods</h3>
307 331
308 <table> 332 <table>
371 <dt>Return Type:</dt> 395 <dt>Return Type:</dt>
372 <dd> 396 <dd>
373 tuple of int 397 tuple of int
374 </dd> 398 </dd>
375 </dl> 399 </dl>
400 <a NAME="PipPackagesWidget.__clearVulnerabilityInfo" ID="PipPackagesWidget.__clearVulnerabilityInfo"></a>
401 <h4>PipPackagesWidget.__clearVulnerabilityInfo</h4>
402 <b>__clearVulnerabilityInfo</b>(<i></i>)
403
404 <p>
405 Private slot to clear the vulnerability info.
406 </p>
376 <a NAME="PipPackagesWidget.__editConfiguration" ID="PipPackagesWidget.__editConfiguration"></a> 407 <a NAME="PipPackagesWidget.__editConfiguration" ID="PipPackagesWidget.__editConfiguration"></a>
377 <h4>PipPackagesWidget.__editConfiguration</h4> 408 <h4>PipPackagesWidget.__editConfiguration</h4>
378 <b>__editConfiguration</b>(<i>venvName=""</i>) 409 <b>__editConfiguration</b>(<i>venvName=""</i>)
379 410
380 <p> 411 <p>
623 <dd> 654 <dd>
624 flag indicating that the package may be installed 655 flag indicating that the package may be installed
625 (defaults to False) 656 (defaults to False)
626 </dd> 657 </dd>
627 </dl> 658 </dl>
659 <a NAME="PipPackagesWidget.__showPackageInformation" ID="PipPackagesWidget.__showPackageInformation"></a>
660 <h4>PipPackagesWidget.__showPackageInformation</h4>
661 <b>__showPackageInformation</b>(<i>packageName</i>)
662
663 <p>
664 Private method to show information for a package.
665 </p>
666 <dl>
667
668 <dt><i>packageName</i> (str)</dt>
669 <dd>
670 name of the package
671 </dd>
672 </dl>
628 <a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a> 673 <a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a>
629 <h4>PipPackagesWidget.__showSearchedDetails</h4> 674 <h4>PipPackagesWidget.__showSearchedDetails</h4>
630 <b>__showSearchedDetails</b>(<i>item=None</i>) 675 <b>__showSearchedDetails</b>(<i>item=None</i>)
631 676
632 <p> 677 <p>
637 <dt><i>item</i> (QTreeWidgetItem)</dt> 682 <dt><i>item</i> (QTreeWidgetItem)</dt>
638 <dd> 683 <dd>
639 reference to the search result item to show details for 684 reference to the search result item to show details for
640 </dd> 685 </dd>
641 </dl> 686 </dl>
687 <a NAME="PipPackagesWidget.__showVulnerabilityInformation" ID="PipPackagesWidget.__showVulnerabilityInformation"></a>
688 <h4>PipPackagesWidget.__showVulnerabilityInformation</h4>
689 <b>__showVulnerabilityInformation</b>(<i>packageName, packageVersion, vulnerabilities</i>)
690
691 <p>
692 Private method to show the detected vulnerability data.
693 </p>
694 <dl>
695
696 <dt><i>packageName</i> (str)</dt>
697 <dd>
698 name of the package
699 </dd>
700 <dt><i>packageVersion</i> (str)</dt>
701 <dd>
702 installed version number
703 </dd>
704 <dt><i>vulnerabilities</i> (list of Vulnerability)</dt>
705 <dd>
706 list of vulnerabilities
707 </dd>
708 </dl>
642 <a NAME="PipPackagesWidget.__uninstallRequirements" ID="PipPackagesWidget.__uninstallRequirements"></a> 709 <a NAME="PipPackagesWidget.__uninstallRequirements" ID="PipPackagesWidget.__uninstallRequirements"></a>
643 <h4>PipPackagesWidget.__uninstallRequirements</h4> 710 <h4>PipPackagesWidget.__uninstallRequirements</h4>
644 <b>__uninstallRequirements</b>(<i></i>) 711 <b>__uninstallRequirements</b>(<i></i>)
645 712
646 <p> 713 <p>
665 <b>__updateSearchButton</b>(<i></i>) 732 <b>__updateSearchButton</b>(<i></i>)
666 733
667 <p> 734 <p>
668 Private method to update the state of the search button. 735 Private method to update the state of the search button.
669 </p> 736 </p>
737 <a NAME="PipPackagesWidget.__updateVulnerabilityData" ID="PipPackagesWidget.__updateVulnerabilityData"></a>
738 <h4>PipPackagesWidget.__updateVulnerabilityData</h4>
739 <b>__updateVulnerabilityData</b>(<i>clearFirst=True</i>)
740
741 <p>
742 Private slot to update the shown vulnerability info.
743 </p>
744 <dl>
745
746 <dt><i>clearFirst</i> (bool (optional))</dt>
747 <dd>
748 flag indicating to clear the vulnerability info first
749 (defaults to True)
750 </dd>
751 </dl>
752 <a NAME="PipPackagesWidget.__updateVulnerabilityDbCache" ID="PipPackagesWidget.__updateVulnerabilityDbCache"></a>
753 <h4>PipPackagesWidget.__updateVulnerabilityDbCache</h4>
754 <b>__updateVulnerabilityDbCache</b>(<i></i>)
755
756 <p>
757 Private slot to initiate an update of the local cache of the
758 vulnerability database.
759 </p>
670 <a NAME="PipPackagesWidget.executeInstallPackages" ID="PipPackagesWidget.executeInstallPackages"></a> 760 <a NAME="PipPackagesWidget.executeInstallPackages" ID="PipPackagesWidget.executeInstallPackages"></a>
671 <h4>PipPackagesWidget.executeInstallPackages</h4> 761 <h4>PipPackagesWidget.executeInstallPackages</h4>
672 <b>executeInstallPackages</b>(<i>packages, userSite=False</i>) 762 <b>executeInstallPackages</b>(<i>packages, userSite=False</i>)
673 763
674 <p> 764 <p>
775 state of the checkbox 865 state of the checkbox
776 </dd> 866 </dd>
777 </dl> 867 </dl>
778 <a NAME="PipPackagesWidget.on_localCheckBox_clicked" ID="PipPackagesWidget.on_localCheckBox_clicked"></a> 868 <a NAME="PipPackagesWidget.on_localCheckBox_clicked" ID="PipPackagesWidget.on_localCheckBox_clicked"></a>
779 <h4>PipPackagesWidget.on_localCheckBox_clicked</h4> 869 <h4>PipPackagesWidget.on_localCheckBox_clicked</h4>
780 <b>on_localCheckBox_clicked</b>(<i>checked</i>) 870 <b>on_localCheckBox_clicked</b>(<i></i>)
781 871
782 <p> 872 <p>
783 Private slot handling the switching of the local mode. 873 Private slot handling the switching of the local mode.
784 </p> 874 </p>
785 <dl>
786
787 <dt><i>checked</i> (bool)</dt>
788 <dd>
789 state of the local check box
790 </dd>
791 </dl>
792 <a NAME="PipPackagesWidget.on_notRequiredCheckBox_clicked" ID="PipPackagesWidget.on_notRequiredCheckBox_clicked"></a> 875 <a NAME="PipPackagesWidget.on_notRequiredCheckBox_clicked" ID="PipPackagesWidget.on_notRequiredCheckBox_clicked"></a>
793 <h4>PipPackagesWidget.on_notRequiredCheckBox_clicked</h4> 876 <h4>PipPackagesWidget.on_notRequiredCheckBox_clicked</h4>
794 <b>on_notRequiredCheckBox_clicked</b>(<i>checked</i>) 877 <b>on_notRequiredCheckBox_clicked</b>(<i></i>)
795 878
796 <p> 879 <p>
797 Private slot handling the switching of the 'not required' mode. 880 Private slot handling the switching of the 'not required' mode.
798 </p> 881 </p>
799 <dl> 882 <a NAME="PipPackagesWidget.on_packagesList_itemClicked" ID="PipPackagesWidget.on_packagesList_itemClicked"></a>
800 883 <h4>PipPackagesWidget.on_packagesList_itemClicked</h4>
801 <dt><i>checked</i> (bool)</dt> 884 <b>on_packagesList_itemClicked</b>(<i>item, column</i>)
802 <dd> 885
803 state of the 'not required' check box 886 <p>
804 </dd> 887 Private slot reacting on a package item click.
805 </dl>
806 <a NAME="PipPackagesWidget.on_packagesList_itemActivated" ID="PipPackagesWidget.on_packagesList_itemActivated"></a>
807 <h4>PipPackagesWidget.on_packagesList_itemActivated</h4>
808 <b>on_packagesList_itemActivated</b>(<i>item, column</i>)
809
810 <p>
811 Private slot reacting on a package item activation.
812 </p> 888 </p>
813 <dl> 889 <dl>
814 890
815 <dt><i>item</i> (QTreeWidgetItem)</dt> 891 <dt><i>item</i> (QTreeWidgetItem)</dt>
816 <dd> 892 <dd>
817 reference to the activated item 893 reference to the clicked item
818 </dd> 894 </dd>
819 <dt><i>column</i> (int)</dt> 895 <dt><i>column</i> (int)</dt>
820 <dd> 896 <dd>
821 activated column 897 clicked column
822 </dd> 898 </dd>
823 </dl> 899 </dl>
824 <a NAME="PipPackagesWidget.on_packagesList_itemSelectionChanged" ID="PipPackagesWidget.on_packagesList_itemSelectionChanged"></a> 900 <a NAME="PipPackagesWidget.on_packagesList_itemDoubleClicked" ID="PipPackagesWidget.on_packagesList_itemDoubleClicked"></a>
825 <h4>PipPackagesWidget.on_packagesList_itemSelectionChanged</h4> 901 <h4>PipPackagesWidget.on_packagesList_itemDoubleClicked</h4>
826 <b>on_packagesList_itemSelectionChanged</b>(<i></i>) 902 <b>on_packagesList_itemDoubleClicked</b>(<i>item, column</i>)
827 903
828 <p> 904 <p>
829 Private slot handling the selection of a package. 905 Private slot reacting on a package item double click.
830 </p> 906 </p>
907 <dl>
908
909 <dt><i>item</i> (QTreeWidgetItem)</dt>
910 <dd>
911 reference to the double clicked item
912 </dd>
913 <dt><i>column</i> (int)</dt>
914 <dd>
915 double clicked column
916 </dd>
917 </dl>
831 <a NAME="PipPackagesWidget.on_refreshButton_clicked" ID="PipPackagesWidget.on_refreshButton_clicked"></a> 918 <a NAME="PipPackagesWidget.on_refreshButton_clicked" ID="PipPackagesWidget.on_refreshButton_clicked"></a>
832 <h4>PipPackagesWidget.on_refreshButton_clicked</h4> 919 <h4>PipPackagesWidget.on_refreshButton_clicked</h4>
833 <b>on_refreshButton_clicked</b>(<i></i>) 920 <b>on_refreshButton_clicked</b>(<i></i>)
834 921
835 <p> 922 <p>
937 <p> 1024 <p>
938 Private slot to upgrade selected packages of the selected environment. 1025 Private slot to upgrade selected packages of the selected environment.
939 </p> 1026 </p>
940 <a NAME="PipPackagesWidget.on_userCheckBox_clicked" ID="PipPackagesWidget.on_userCheckBox_clicked"></a> 1027 <a NAME="PipPackagesWidget.on_userCheckBox_clicked" ID="PipPackagesWidget.on_userCheckBox_clicked"></a>
941 <h4>PipPackagesWidget.on_userCheckBox_clicked</h4> 1028 <h4>PipPackagesWidget.on_userCheckBox_clicked</h4>
942 <b>on_userCheckBox_clicked</b>(<i>checked</i>) 1029 <b>on_userCheckBox_clicked</b>(<i></i>)
943 1030
944 <p> 1031 <p>
945 Private slot handling the switching of the 'user-site' mode. 1032 Private slot handling the switching of the 'user-site' mode.
946 </p> 1033 </p>
947 <dl>
948
949 <dt><i>checked</i> (bool)</dt>
950 <dd>
951 state of the 'user-site' check box
952 </dd>
953 </dl>
954 <a NAME="PipPackagesWidget.on_verboseCheckBox_clicked" ID="PipPackagesWidget.on_verboseCheckBox_clicked"></a> 1034 <a NAME="PipPackagesWidget.on_verboseCheckBox_clicked" ID="PipPackagesWidget.on_verboseCheckBox_clicked"></a>
955 <h4>PipPackagesWidget.on_verboseCheckBox_clicked</h4> 1035 <h4>PipPackagesWidget.on_verboseCheckBox_clicked</h4>
956 <b>on_verboseCheckBox_clicked</b>(<i>checked</i>) 1036 <b>on_verboseCheckBox_clicked</b>(<i>checked</i>)
957 1037
958 <p> 1038 <p>
962 <dl> 1042 <dl>
963 1043
964 <dt><i>checked</i> (bool)</dt> 1044 <dt><i>checked</i> (bool)</dt>
965 <dd> 1045 <dd>
966 state of the checkbox 1046 state of the checkbox
1047 </dd>
1048 </dl>
1049 <a NAME="PipPackagesWidget.on_vulnerabilityCheckBox_clicked" ID="PipPackagesWidget.on_vulnerabilityCheckBox_clicked"></a>
1050 <h4>PipPackagesWidget.on_vulnerabilityCheckBox_clicked</h4>
1051 <b>on_vulnerabilityCheckBox_clicked</b>(<i>checked</i>)
1052
1053 <p>
1054 Private slot handling a change of the automatic vulnerability checks.
1055 </p>
1056 <dl>
1057
1058 <dt><i>checked</i> (bool)</dt>
1059 <dd>
1060 flag indicating the state of the check box
967 </dd> 1061 </dd>
968 </dl> 1062 </dl>
969 <div align="right"><a href="#top">Up</a></div> 1063 <div align="right"><a href="#top">Up</a></div>
970 <hr /> 1064 <hr />
971 <hr /> 1065 <hr />

Mercurial Repository: eric

eric ide

mercurial