Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 11093
e8932a99beb4
parent 11091
3a1ba42ac50a
child 11128
04a9579c9c54
equal deleted inserted replaced
11092:e2aaf07ef8fd 11093:e8932a99beb4
23 <td>Class defining the show information process modes.</td> 23 <td>Class defining the show information process modes.</td>
24 </tr> 24 </tr>
25 <tr> 25 <tr>
26 <td><a href="#PipPackagesWidget">PipPackagesWidget</a></td> 26 <td><a href="#PipPackagesWidget">PipPackagesWidget</a></td>
27 <td>Class implementing the pip packages management widget.</td> 27 <td>Class implementing the pip packages management widget.</td>
28 </tr>
29 <tr>
30 <td><a href="#PypiSearchResultsParser">PypiSearchResultsParser</a></td>
31 <td>Class implementing the parser for the PyPI search result page.</td>
32 </tr> 28 </tr>
33 </table> 29 </table>
34 30
35 <h3>Functions</h3> 31 <h3>Functions</h3>
36 <table> 32 <table>
150 <tr> 146 <tr>
151 <td><a href="#PipPackagesWidget.__editVirtualenvConfiguration">__editVirtualenvConfiguration</a></td> 147 <td><a href="#PipPackagesWidget.__editVirtualenvConfiguration">__editVirtualenvConfiguration</a></td>
152 <td>Private slot to edit the configuration of the selected environment.</td> 148 <td>Private slot to edit the configuration of the selected environment.</td>
153 </tr> 149 </tr>
154 <tr> 150 <tr>
155 <td><a href="#PipPackagesWidget.__finishSearch">__finishSearch</a></td>
156 <td>Private slot performing the search finishing actions.</td>
157 </tr>
158 <tr>
159 <td><a href="#PipPackagesWidget.__generateConstraints">__generateConstraints</a></td> 151 <td><a href="#PipPackagesWidget.__generateConstraints">__generateConstraints</a></td>
160 <td>Private slot to generate the contents for a constraints file.</td> 152 <td>Private slot to generate the contents for a constraints file.</td>
161 </tr> 153 </tr>
162 <tr> 154 <tr>
163 <td><a href="#PipPackagesWidget.__generateRequirements">__generateRequirements</a></td> 155 <td><a href="#PipPackagesWidget.__generateRequirements">__generateRequirements</a></td>
234 <tr> 226 <tr>
235 <td><a href="#PipPackagesWidget.__repairPip">__repairPip</a></td> 227 <td><a href="#PipPackagesWidget.__repairPip">__repairPip</a></td>
236 <td>Private slot to repair the pip installation of the selected environment.</td> 228 <td>Private slot to repair the pip installation of the selected environment.</td>
237 </tr> 229 </tr>
238 <tr> 230 <tr>
239 <td><a href="#PipPackagesWidget.__search">__search</a></td>
240 <td>Private method to perform the search by calling the PyPI search URL.</td>
241 </tr>
242 <tr>
243 <td><a href="#PipPackagesWidget.__searchFirst">__searchFirst</a></td>
244 <td>Private method to perform the search for packages.</td>
245 </tr>
246 <tr>
247 <td><a href="#PipPackagesWidget.__searchResponse">__searchResponse</a></td>
248 <td>Private method to extract the search result data from the response.</td>
249 </tr>
250 <tr>
251 <td><a href="#PipPackagesWidget.__selectedUpdateableItems">__selectedUpdateableItems</a></td> 231 <td><a href="#PipPackagesWidget.__selectedUpdateableItems">__selectedUpdateableItems</a></td>
252 <td>Private method to get a list of selected items that can be updated.</td> 232 <td>Private method to get a list of selected items that can be updated.</td>
253 </tr> 233 </tr>
254 <tr> 234 <tr>
255 <td><a href="#PipPackagesWidget.__showCacheInfo">__showCacheInfo</a></td> 235 <td><a href="#PipPackagesWidget.__showCacheInfo">__showCacheInfo</a></td>
270 <tr> 250 <tr>
271 <td><a href="#PipPackagesWidget.__showPackageInformation">__showPackageInformation</a></td> 251 <td><a href="#PipPackagesWidget.__showPackageInformation">__showPackageInformation</a></td>
272 <td>Private method to show information for a package.</td> 252 <td>Private method to show information for a package.</td>
273 </tr> 253 </tr>
274 <tr> 254 <tr>
275 <td><a href="#PipPackagesWidget.__showSearchedDetails">__showSearchedDetails</a></td>
276 <td>Private slot to show details about the selected search result package.</td>
277 </tr>
278 <tr>
279 <td><a href="#PipPackagesWidget.__showVulnerabilityInformation">__showVulnerabilityInformation</a></td> 255 <td><a href="#PipPackagesWidget.__showVulnerabilityInformation">__showVulnerabilityInformation</a></td>
280 <td>Private method to show the detected vulnerability data.</td> 256 <td>Private method to show the detected vulnerability data.</td>
281 </tr> 257 </tr>
282 <tr> 258 <tr>
283 <td><a href="#PipPackagesWidget.__uninstallPyprojectDependencies">__uninstallPyprojectDependencies</a></td> 259 <td><a href="#PipPackagesWidget.__uninstallPyprojectDependencies">__uninstallPyprojectDependencies</a></td>
298 <tr> 274 <tr>
299 <td><a href="#PipPackagesWidget.__updateOutdatedInfo">__updateOutdatedInfo</a></td> 275 <td><a href="#PipPackagesWidget.__updateOutdatedInfo">__updateOutdatedInfo</a></td>
300 <td>Private method to process the list of outdated packages.</td> 276 <td>Private method to process the list of outdated packages.</td>
301 </tr> 277 </tr>
302 <tr> 278 <tr>
303 <td><a href="#PipPackagesWidget.__updateSearchActionButtons">__updateSearchActionButtons</a></td>
304 <td>Private method to update the action button states of the search widget.</td>
305 </tr>
306 <tr>
307 <td><a href="#PipPackagesWidget.__updateSearchButton">__updateSearchButton</a></td>
308 <td>Private method to update the state of the search button.</td>
309 </tr>
310 <tr>
311 <td><a href="#PipPackagesWidget.__updateSearchMoreButton">__updateSearchMoreButton</a></td>
312 <td>Private method to update the state of the search more button.</td>
313 </tr>
314 <tr>
315 <td><a href="#PipPackagesWidget.__updateVulnerabilityData">__updateVulnerabilityData</a></td> 279 <td><a href="#PipPackagesWidget.__updateVulnerabilityData">__updateVulnerabilityData</a></td>
316 <td>Private slot to update the shown vulnerability info.</td> 280 <td>Private slot to update the shown vulnerability info.</td>
317 </tr> 281 </tr>
318 <tr> 282 <tr>
319 <td><a href="#PipPackagesWidget.__updateVulnerabilityDbCache">__updateVulnerabilityDbCache</a></td> 283 <td><a href="#PipPackagesWidget.__updateVulnerabilityDbCache">__updateVulnerabilityDbCache</a></td>
362 <tr> 326 <tr>
363 <td><a href="#PipPackagesWidget.on_environmentsComboBox_currentTextChanged">on_environmentsComboBox_currentTextChanged</a></td> 327 <td><a href="#PipPackagesWidget.on_environmentsComboBox_currentTextChanged">on_environmentsComboBox_currentTextChanged</a></td>
364 <td>Private slot handling the selection of a Python environment.</td> 328 <td>Private slot handling the selection of a Python environment.</td>
365 </tr> 329 </tr>
366 <tr> 330 <tr>
367 <td><a href="#PipPackagesWidget.on_installButton_clicked">on_installButton_clicked</a></td>
368 <td>Private slot to handle pressing the Install button..</td>
369 </tr>
370 <tr>
371 <td><a href="#PipPackagesWidget.on_installUserSiteButton_clicked">on_installUserSiteButton_clicked</a></td>
372 <td>Private slot to handle pressing the Install to User-Site button..</td>
373 </tr>
374 <tr>
375 <td><a href="#PipPackagesWidget.on_installedFilesCheckBox_clicked">on_installedFilesCheckBox_clicked</a></td> 331 <td><a href="#PipPackagesWidget.on_installedFilesCheckBox_clicked">on_installedFilesCheckBox_clicked</a></td>
376 <td>Private slot to handle a change of the installed files information checkbox.</td> 332 <td>Private slot to handle a change of the installed files information checkbox.</td>
377 </tr> 333 </tr>
378 <tr> 334 <tr>
379 <td><a href="#PipPackagesWidget.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td> 335 <td><a href="#PipPackagesWidget.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td>
407 <td><a href="#PipPackagesWidget.on_requiresButton_toggled">on_requiresButton_toggled</a></td> 363 <td><a href="#PipPackagesWidget.on_requiresButton_toggled">on_requiresButton_toggled</a></td>
408 <td>Private slot handling the selection of the view type.</td> 364 <td>Private slot handling the selection of the view type.</td>
409 </tr> 365 </tr>
410 <tr> 366 <tr>
411 <td><a href="#PipPackagesWidget.on_searchButton_clicked">on_searchButton_clicked</a></td> 367 <td><a href="#PipPackagesWidget.on_searchButton_clicked">on_searchButton_clicked</a></td>
412 <td>Private slot handling a press of the search button.</td> 368 <td>Private slot to open a web browser for package searching.</td>
413 </tr> 369 </tr>
414 <tr> 370 <tr>
415 <td><a href="#PipPackagesWidget.on_searchMoreButton_clicked">on_searchMoreButton_clicked</a></td> 371 <td><a href="#PipPackagesWidget.on_searchEdit_returnPressed">on_searchEdit_returnPressed</a></td>
416 <td>Private slot handling a press of the search more button.</td> 372 <td>Private slot to handle the press of the Return key in the search line edit.</td>
417 </tr>
418 <tr>
419 <td><a href="#PipPackagesWidget.on_searchNameEdit_returnPressed">on_searchNameEdit_returnPressed</a></td>
420 <td>Private slot initiating a search via a press of the Return key.</td>
421 </tr>
422 <tr>
423 <td><a href="#PipPackagesWidget.on_searchNameEdit_textChanged">on_searchNameEdit_textChanged</a></td>
424 <td>Private slot handling a change of the search term.</td>
425 </tr>
426 <tr>
427 <td><a href="#PipPackagesWidget.on_searchResultList_itemActivated">on_searchResultList_itemActivated</a></td>
428 <td>Private slot reacting on an search result item activation.</td>
429 </tr>
430 <tr>
431 <td><a href="#PipPackagesWidget.on_searchResultList_itemSelectionChanged">on_searchResultList_itemSelectionChanged</a></td>
432 <td>Private slot handling changes of the search result selection.</td>
433 </tr>
434 <tr>
435 <td><a href="#PipPackagesWidget.on_searchToggleButton_1_toggled">on_searchToggleButton_1_toggled</a></td>
436 <td>Private slot to toggle the search widget.</td>
437 </tr>
438 <tr>
439 <td><a href="#PipPackagesWidget.on_searchToggleButton_2_toggled">on_searchToggleButton_2_toggled</a></td>
440 <td>Private slot to toggle the search widget.</td>
441 </tr> 373 </tr>
442 <tr> 374 <tr>
443 <td><a href="#PipPackagesWidget.on_showDepPackageDetailsButton_clicked">on_showDepPackageDetailsButton_clicked</a></td> 375 <td><a href="#PipPackagesWidget.on_showDepPackageDetailsButton_clicked">on_showDepPackageDetailsButton_clicked</a></td>
444 <td>Private slot to show information for the selected package of the dependency tree.</td> 376 <td>Private slot to show information for the selected package of the dependency tree.</td>
445 </tr>
446 <tr>
447 <td><a href="#PipPackagesWidget.on_showDetailsButton_clicked">on_showDetailsButton_clicked</a></td>
448 <td>Private slot to handle pressing the Show Details button.</td>
449 </tr> 377 </tr>
450 <tr> 378 <tr>
451 <td><a href="#PipPackagesWidget.on_showPackageDetailsButton_clicked">on_showPackageDetailsButton_clicked</a></td> 379 <td><a href="#PipPackagesWidget.on_showPackageDetailsButton_clicked">on_showPackageDetailsButton_clicked</a></td>
452 <td>Private slot to show information for the selected package.</td> 380 <td>Private slot to show information for the selected package.</td>
453 </tr> 381 </tr>
647 <b>__editVirtualenvConfiguration</b>(<i></i>) 575 <b>__editVirtualenvConfiguration</b>(<i></i>)
648 <p> 576 <p>
649 Private slot to edit the configuration of the selected environment. 577 Private slot to edit the configuration of the selected environment.
650 </p> 578 </p>
651 579
652 <a NAME="PipPackagesWidget.__finishSearch" ID="PipPackagesWidget.__finishSearch"></a>
653 <h4>PipPackagesWidget.__finishSearch</h4>
654 <b>__finishSearch</b>(<i></i>)
655 <p>
656 Private slot performing the search finishing actions.
657 </p>
658
659 <a NAME="PipPackagesWidget.__generateConstraints" ID="PipPackagesWidget.__generateConstraints"></a> 580 <a NAME="PipPackagesWidget.__generateConstraints" ID="PipPackagesWidget.__generateConstraints"></a>
660 <h4>PipPackagesWidget.__generateConstraints</h4> 581 <h4>PipPackagesWidget.__generateConstraints</h4>
661 <b>__generateConstraints</b>(<i></i>) 582 <b>__generateConstraints</b>(<i></i>)
662 <p> 583 <p>
663 Private slot to generate the contents for a constraints file. 584 Private slot to generate the contents for a constraints file.
817 <p> 738 <p>
818 Private slot to repair the pip installation of the selected 739 Private slot to repair the pip installation of the selected
819 environment. 740 environment.
820 </p> 741 </p>
821 742
822 <a NAME="PipPackagesWidget.__search" ID="PipPackagesWidget.__search"></a>
823 <h4>PipPackagesWidget.__search</h4>
824 <b>__search</b>(<i>page=1</i>)
825 <p>
826 Private method to perform the search by calling the PyPI search URL.
827 </p>
828
829 <dl>
830
831 <dt><i>page</i> (int (optional))</dt>
832 <dd>
833 search page to retrieve (defaults to 1)
834 </dd>
835 </dl>
836 <a NAME="PipPackagesWidget.__searchFirst" ID="PipPackagesWidget.__searchFirst"></a>
837 <h4>PipPackagesWidget.__searchFirst</h4>
838 <b>__searchFirst</b>(<i></i>)
839 <p>
840 Private method to perform the search for packages.
841 </p>
842
843 <a NAME="PipPackagesWidget.__searchResponse" ID="PipPackagesWidget.__searchResponse"></a>
844 <h4>PipPackagesWidget.__searchResponse</h4>
845 <b>__searchResponse</b>(<i>reply</i>)
846 <p>
847 Private method to extract the search result data from the response.
848 </p>
849
850 <dl>
851
852 <dt><i>reply</i> (QNetworkReply)</dt>
853 <dd>
854 reference to the reply object containing the data
855 </dd>
856 </dl>
857 <a NAME="PipPackagesWidget.__selectedUpdateableItems" ID="PipPackagesWidget.__selectedUpdateableItems"></a> 743 <a NAME="PipPackagesWidget.__selectedUpdateableItems" ID="PipPackagesWidget.__selectedUpdateableItems"></a>
858 <h4>PipPackagesWidget.__selectedUpdateableItems</h4> 744 <h4>PipPackagesWidget.__selectedUpdateableItems</h4>
859 <b>__selectedUpdateableItems</b>(<i></i>) 745 <b>__selectedUpdateableItems</b>(<i></i>)
860 <p> 746 <p>
861 Private method to get a list of selected items that can be updated. 747 Private method to get a list of selected items that can be updated.
943 <dt><i>infoWidget</i> (QTreeWidget)</dt> 829 <dt><i>infoWidget</i> (QTreeWidget)</dt>
944 <dd> 830 <dd>
945 reference to the widget to contain the information 831 reference to the widget to contain the information
946 </dd> 832 </dd>
947 </dl> 833 </dl>
948 <a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a>
949 <h4>PipPackagesWidget.__showSearchedDetails</h4>
950 <b>__showSearchedDetails</b>(<i>item=None</i>)
951 <p>
952 Private slot to show details about the selected search result package.
953 </p>
954
955 <dl>
956
957 <dt><i>item</i> (QTreeWidgetItem)</dt>
958 <dd>
959 reference to the search result item to show details for
960 </dd>
961 </dl>
962 <a NAME="PipPackagesWidget.__showVulnerabilityInformation" ID="PipPackagesWidget.__showVulnerabilityInformation"></a> 834 <a NAME="PipPackagesWidget.__showVulnerabilityInformation" ID="PipPackagesWidget.__showVulnerabilityInformation"></a>
963 <h4>PipPackagesWidget.__showVulnerabilityInformation</h4> 835 <h4>PipPackagesWidget.__showVulnerabilityInformation</h4>
964 <b>__showVulnerabilityInformation</b>(<i>packageName, packageVersion, vulnerabilities</i>) 836 <b>__showVulnerabilityInformation</b>(<i>packageName, packageVersion, vulnerabilities</i>)
965 <p> 837 <p>
966 Private method to show the detected vulnerability data. 838 Private method to show the detected vulnerability data.
1022 <dd> 894 <dd>
1023 dictionary with the package name as key and 895 dictionary with the package name as key and
1024 a tuple containing the installed and available version as the value 896 a tuple containing the installed and available version as the value
1025 </dd> 897 </dd>
1026 </dl> 898 </dl>
1027 <a NAME="PipPackagesWidget.__updateSearchActionButtons" ID="PipPackagesWidget.__updateSearchActionButtons"></a>
1028 <h4>PipPackagesWidget.__updateSearchActionButtons</h4>
1029 <b>__updateSearchActionButtons</b>(<i></i>)
1030 <p>
1031 Private method to update the action button states of the search widget.
1032 </p>
1033
1034 <a NAME="PipPackagesWidget.__updateSearchButton" ID="PipPackagesWidget.__updateSearchButton"></a>
1035 <h4>PipPackagesWidget.__updateSearchButton</h4>
1036 <b>__updateSearchButton</b>(<i></i>)
1037 <p>
1038 Private method to update the state of the search button.
1039 </p>
1040
1041 <a NAME="PipPackagesWidget.__updateSearchMoreButton" ID="PipPackagesWidget.__updateSearchMoreButton"></a>
1042 <h4>PipPackagesWidget.__updateSearchMoreButton</h4>
1043 <b>__updateSearchMoreButton</b>(<i>enable</i>)
1044 <p>
1045 Private method to update the state of the search more button.
1046 </p>
1047
1048 <dl>
1049
1050 <dt><i>enable</i> (bool)</dt>
1051 <dd>
1052 flag indicating the desired enable state
1053 </dd>
1054 </dl>
1055 <a NAME="PipPackagesWidget.__updateVulnerabilityData" ID="PipPackagesWidget.__updateVulnerabilityData"></a> 899 <a NAME="PipPackagesWidget.__updateVulnerabilityData" ID="PipPackagesWidget.__updateVulnerabilityData"></a>
1056 <h4>PipPackagesWidget.__updateVulnerabilityData</h4> 900 <h4>PipPackagesWidget.__updateVulnerabilityData</h4>
1057 <b>__updateVulnerabilityData</b>(<i>clearFirst=True</i>) 901 <b>__updateVulnerabilityData</b>(<i>clearFirst=True</i>)
1058 <p> 902 <p>
1059 Private slot to update the shown vulnerability info. 903 Private slot to update the shown vulnerability info.
1220 <dt><i>name</i> (str)</dt> 1064 <dt><i>name</i> (str)</dt>
1221 <dd> 1065 <dd>
1222 name of the selected Python environment 1066 name of the selected Python environment
1223 </dd> 1067 </dd>
1224 </dl> 1068 </dl>
1225 <a NAME="PipPackagesWidget.on_installButton_clicked" ID="PipPackagesWidget.on_installButton_clicked"></a>
1226 <h4>PipPackagesWidget.on_installButton_clicked</h4>
1227 <b>on_installButton_clicked</b>(<i></i>)
1228 <p>
1229 Private slot to handle pressing the Install button..
1230 </p>
1231
1232 <a NAME="PipPackagesWidget.on_installUserSiteButton_clicked" ID="PipPackagesWidget.on_installUserSiteButton_clicked"></a>
1233 <h4>PipPackagesWidget.on_installUserSiteButton_clicked</h4>
1234 <b>on_installUserSiteButton_clicked</b>(<i></i>)
1235 <p>
1236 Private slot to handle pressing the Install to User-Site button..
1237 </p>
1238
1239 <a NAME="PipPackagesWidget.on_installedFilesCheckBox_clicked" ID="PipPackagesWidget.on_installedFilesCheckBox_clicked"></a> 1069 <a NAME="PipPackagesWidget.on_installedFilesCheckBox_clicked" ID="PipPackagesWidget.on_installedFilesCheckBox_clicked"></a>
1240 <h4>PipPackagesWidget.on_installedFilesCheckBox_clicked</h4> 1070 <h4>PipPackagesWidget.on_installedFilesCheckBox_clicked</h4>
1241 <b>on_installedFilesCheckBox_clicked</b>(<i>checked</i>) 1071 <b>on_installedFilesCheckBox_clicked</b>(<i>checked</i>)
1242 <p> 1072 <p>
1243 Private slot to handle a change of the installed files information 1073 Private slot to handle a change of the installed files information
1327 </dl> 1157 </dl>
1328 <a NAME="PipPackagesWidget.on_searchButton_clicked" ID="PipPackagesWidget.on_searchButton_clicked"></a> 1158 <a NAME="PipPackagesWidget.on_searchButton_clicked" ID="PipPackagesWidget.on_searchButton_clicked"></a>
1329 <h4>PipPackagesWidget.on_searchButton_clicked</h4> 1159 <h4>PipPackagesWidget.on_searchButton_clicked</h4>
1330 <b>on_searchButton_clicked</b>(<i></i>) 1160 <b>on_searchButton_clicked</b>(<i></i>)
1331 <p> 1161 <p>
1332 Private slot handling a press of the search button. 1162 Private slot to open a web browser for package searching.
1333 </p> 1163 </p>
1334 1164
1335 <a NAME="PipPackagesWidget.on_searchMoreButton_clicked" ID="PipPackagesWidget.on_searchMoreButton_clicked"></a> 1165 <a NAME="PipPackagesWidget.on_searchEdit_returnPressed" ID="PipPackagesWidget.on_searchEdit_returnPressed"></a>
1336 <h4>PipPackagesWidget.on_searchMoreButton_clicked</h4> 1166 <h4>PipPackagesWidget.on_searchEdit_returnPressed</h4>
1337 <b>on_searchMoreButton_clicked</b>(<i></i>) 1167 <b>on_searchEdit_returnPressed</b>(<i></i>)
1338 <p> 1168 <p>
1339 Private slot handling a press of the search more button. 1169 Private slot to handle the press of the Return key in the search line edit.
1340 </p> 1170 </p>
1341 1171
1342 <a NAME="PipPackagesWidget.on_searchNameEdit_returnPressed" ID="PipPackagesWidget.on_searchNameEdit_returnPressed"></a>
1343 <h4>PipPackagesWidget.on_searchNameEdit_returnPressed</h4>
1344 <b>on_searchNameEdit_returnPressed</b>(<i></i>)
1345 <p>
1346 Private slot initiating a search via a press of the Return key.
1347 </p>
1348
1349 <a NAME="PipPackagesWidget.on_searchNameEdit_textChanged" ID="PipPackagesWidget.on_searchNameEdit_textChanged"></a>
1350 <h4>PipPackagesWidget.on_searchNameEdit_textChanged</h4>
1351 <b>on_searchNameEdit_textChanged</b>(<i>_txt</i>)
1352 <p>
1353 Private slot handling a change of the search term.
1354 </p>
1355
1356 <dl>
1357
1358 <dt><i>_txt</i> (str)</dt>
1359 <dd>
1360 search term (unused)
1361 </dd>
1362 </dl>
1363 <a NAME="PipPackagesWidget.on_searchResultList_itemActivated" ID="PipPackagesWidget.on_searchResultList_itemActivated"></a>
1364 <h4>PipPackagesWidget.on_searchResultList_itemActivated</h4>
1365 <b>on_searchResultList_itemActivated</b>(<i>item, column</i>)
1366 <p>
1367 Private slot reacting on an search result item activation.
1368 </p>
1369
1370 <dl>
1371
1372 <dt><i>item</i> (QTreeWidgetItem)</dt>
1373 <dd>
1374 reference to the activated item
1375 </dd>
1376 <dt><i>column</i> (int)</dt>
1377 <dd>
1378 activated column
1379 </dd>
1380 </dl>
1381 <a NAME="PipPackagesWidget.on_searchResultList_itemSelectionChanged" ID="PipPackagesWidget.on_searchResultList_itemSelectionChanged"></a>
1382 <h4>PipPackagesWidget.on_searchResultList_itemSelectionChanged</h4>
1383 <b>on_searchResultList_itemSelectionChanged</b>(<i></i>)
1384 <p>
1385 Private slot handling changes of the search result selection.
1386 </p>
1387
1388 <a NAME="PipPackagesWidget.on_searchToggleButton_1_toggled" ID="PipPackagesWidget.on_searchToggleButton_1_toggled"></a>
1389 <h4>PipPackagesWidget.on_searchToggleButton_1_toggled</h4>
1390 <b>on_searchToggleButton_1_toggled</b>(<i>checked</i>)
1391 <p>
1392 Private slot to toggle the search widget.
1393 </p>
1394
1395 <dl>
1396
1397 <dt><i>checked</i> (bool)</dt>
1398 <dd>
1399 state of the search widget button
1400 </dd>
1401 </dl>
1402 <a NAME="PipPackagesWidget.on_searchToggleButton_2_toggled" ID="PipPackagesWidget.on_searchToggleButton_2_toggled"></a>
1403 <h4>PipPackagesWidget.on_searchToggleButton_2_toggled</h4>
1404 <b>on_searchToggleButton_2_toggled</b>(<i>checked</i>)
1405 <p>
1406 Private slot to toggle the search widget.
1407 </p>
1408
1409 <dl>
1410
1411 <dt><i>checked</i> (bool)</dt>
1412 <dd>
1413 state of the search widget button
1414 </dd>
1415 </dl>
1416 <a NAME="PipPackagesWidget.on_showDepPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showDepPackageDetailsButton_clicked"></a> 1172 <a NAME="PipPackagesWidget.on_showDepPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showDepPackageDetailsButton_clicked"></a>
1417 <h4>PipPackagesWidget.on_showDepPackageDetailsButton_clicked</h4> 1173 <h4>PipPackagesWidget.on_showDepPackageDetailsButton_clicked</h4>
1418 <b>on_showDepPackageDetailsButton_clicked</b>(<i></i>) 1174 <b>on_showDepPackageDetailsButton_clicked</b>(<i></i>)
1419 <p> 1175 <p>
1420 Private slot to show information for the selected package of the 1176 Private slot to show information for the selected package of the
1421 dependency tree. 1177 dependency tree.
1422 </p> 1178 </p>
1423 1179
1424 <a NAME="PipPackagesWidget.on_showDetailsButton_clicked" ID="PipPackagesWidget.on_showDetailsButton_clicked"></a>
1425 <h4>PipPackagesWidget.on_showDetailsButton_clicked</h4>
1426 <b>on_showDetailsButton_clicked</b>(<i></i>)
1427 <p>
1428 Private slot to handle pressing the Show Details button.
1429 </p>
1430
1431 <a NAME="PipPackagesWidget.on_showPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showPackageDetailsButton_clicked"></a> 1180 <a NAME="PipPackagesWidget.on_showPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showPackageDetailsButton_clicked"></a>
1432 <h4>PipPackagesWidget.on_showPackageDetailsButton_clicked</h4> 1181 <h4>PipPackagesWidget.on_showPackageDetailsButton_clicked</h4>
1433 <b>on_showPackageDetailsButton_clicked</b>(<i></i>) 1182 <b>on_showPackageDetailsButton_clicked</b>(<i></i>)
1434 <p> 1183 <p>
1435 Private slot to show information for the selected package. 1184 Private slot to show information for the selected package.
1534 vulnerability checks enabled state 1283 vulnerability checks enabled state
1535 </dd> 1284 </dd>
1536 </dl> 1285 </dl>
1537 <div align="right"><a href="#top">Up</a></div> 1286 <div align="right"><a href="#top">Up</a></div>
1538 <hr /> 1287 <hr />
1539 <hr />
1540 <a NAME="PypiSearchResultsParser" ID="PypiSearchResultsParser"></a>
1541 <h2>PypiSearchResultsParser</h2>
1542 <p>
1543 Class implementing the parser for the PyPI search result page.
1544 </p>
1545
1546 <h3>Derived from</h3>
1547 html.parser.HTMLParser
1548 <h3>Class Attributes</h3>
1549 <table>
1550 <tr><td>ClassPrefix</td></tr>
1551 </table>
1552
1553 <h3>Class Methods</h3>
1554 <table>
1555 <tr><td>None</td></tr>
1556 </table>
1557
1558 <h3>Methods</h3>
1559 <table>
1560 <tr>
1561 <td><a href="#PypiSearchResultsParser.__init__">PypiSearchResultsParser</a></td>
1562 <td>Constructor</td>
1563 </tr>
1564 <tr>
1565 <td><a href="#PypiSearchResultsParser.__getClass">__getClass</a></td>
1566 <td>Private method to extract the class attribute out of the list of attributes.</td>
1567 </tr>
1568 <tr>
1569 <td><a href="#PypiSearchResultsParser.__getDate">__getDate</a></td>
1570 <td>Private method to extract the datetime attribute out of the list of attributes and process it.</td>
1571 </tr>
1572 <tr>
1573 <td><a href="#PypiSearchResultsParser.getResults">getResults</a></td>
1574 <td>Public method to get the extracted search results.</td>
1575 </tr>
1576 <tr>
1577 <td><a href="#PypiSearchResultsParser.handle_data">handle_data</a></td>
1578 <td>Public method process arbitrary data.</td>
1579 </tr>
1580 <tr>
1581 <td><a href="#PypiSearchResultsParser.handle_endtag">handle_endtag</a></td>
1582 <td>Public method to process the end tag.</td>
1583 </tr>
1584 <tr>
1585 <td><a href="#PypiSearchResultsParser.handle_starttag">handle_starttag</a></td>
1586 <td>Public method to process the start tag.</td>
1587 </tr>
1588 </table>
1589
1590 <h3>Static Methods</h3>
1591 <table>
1592 <tr><td>None</td></tr>
1593 </table>
1594
1595
1596 <a NAME="PypiSearchResultsParser.__init__" ID="PypiSearchResultsParser.__init__"></a>
1597 <h4>PypiSearchResultsParser (Constructor)</h4>
1598 <b>PypiSearchResultsParser</b>(<i>data</i>)
1599 <p>
1600 Constructor
1601 </p>
1602
1603 <dl>
1604
1605 <dt><i>data</i> (str)</dt>
1606 <dd>
1607 data to be parsed
1608 </dd>
1609 </dl>
1610 <a NAME="PypiSearchResultsParser.__getClass" ID="PypiSearchResultsParser.__getClass"></a>
1611 <h4>PypiSearchResultsParser.__getClass</h4>
1612 <b>__getClass</b>(<i>attrs</i>)
1613 <p>
1614 Private method to extract the class attribute out of the list of
1615 attributes.
1616 </p>
1617
1618 <dl>
1619
1620 <dt><i>attrs</i> (list of tuple of (str, str))</dt>
1621 <dd>
1622 list of tag attributes as (name, value) tuples
1623 </dd>
1624 </dl>
1625 <dl>
1626 <dt>Return:</dt>
1627 <dd>
1628 value of the 'class' attribute or None
1629 </dd>
1630 </dl>
1631 <dl>
1632 <dt>Return Type:</dt>
1633 <dd>
1634 str
1635 </dd>
1636 </dl>
1637 <a NAME="PypiSearchResultsParser.__getDate" ID="PypiSearchResultsParser.__getDate"></a>
1638 <h4>PypiSearchResultsParser.__getDate</h4>
1639 <b>__getDate</b>(<i>attrs</i>)
1640 <p>
1641 Private method to extract the datetime attribute out of the list of
1642 attributes and process it.
1643 </p>
1644
1645 <dl>
1646
1647 <dt><i>attrs</i> (list of tuple of (str, str))</dt>
1648 <dd>
1649 list of tag attributes as (name, value) tuples
1650 </dd>
1651 </dl>
1652 <dl>
1653 <dt>Return:</dt>
1654 <dd>
1655 value of the 'class' attribute or None
1656 </dd>
1657 </dl>
1658 <dl>
1659 <dt>Return Type:</dt>
1660 <dd>
1661 str
1662 </dd>
1663 </dl>
1664 <a NAME="PypiSearchResultsParser.getResults" ID="PypiSearchResultsParser.getResults"></a>
1665 <h4>PypiSearchResultsParser.getResults</h4>
1666 <b>getResults</b>(<i></i>)
1667 <p>
1668 Public method to get the extracted search results.
1669 </p>
1670
1671 <dl>
1672 <dt>Return:</dt>
1673 <dd>
1674 extracted result data
1675 </dd>
1676 </dl>
1677 <dl>
1678 <dt>Return Type:</dt>
1679 <dd>
1680 list of dict
1681 </dd>
1682 </dl>
1683 <a NAME="PypiSearchResultsParser.handle_data" ID="PypiSearchResultsParser.handle_data"></a>
1684 <h4>PypiSearchResultsParser.handle_data</h4>
1685 <b>handle_data</b>(<i>data</i>)
1686 <p>
1687 Public method process arbitrary data.
1688 </p>
1689
1690 <dl>
1691
1692 <dt><i>data</i> (str)</dt>
1693 <dd>
1694 data to be processed
1695 </dd>
1696 </dl>
1697 <a NAME="PypiSearchResultsParser.handle_endtag" ID="PypiSearchResultsParser.handle_endtag"></a>
1698 <h4>PypiSearchResultsParser.handle_endtag</h4>
1699 <b>handle_endtag</b>(<i>_tag</i>)
1700 <p>
1701 Public method to process the end tag.
1702 </p>
1703
1704 <dl>
1705
1706 <dt><i>_tag</i> (str)</dt>
1707 <dd>
1708 tag name (all lowercase) (unused)
1709 </dd>
1710 </dl>
1711 <a NAME="PypiSearchResultsParser.handle_starttag" ID="PypiSearchResultsParser.handle_starttag"></a>
1712 <h4>PypiSearchResultsParser.handle_starttag</h4>
1713 <b>handle_starttag</b>(<i>tag, attrs</i>)
1714 <p>
1715 Public method to process the start tag.
1716 </p>
1717
1718 <dl>
1719
1720 <dt><i>tag</i> (str)</dt>
1721 <dd>
1722 tag name (all lowercase)
1723 </dd>
1724 <dt><i>attrs</i> (list of tuple of (str, str))</dt>
1725 <dd>
1726 list of tag attributes as (name, value) tuples
1727 </dd>
1728 </dl>
1729 <div align="right"><a href="#top">Up</a></div>
1730 <hr />
1731 </body></html> 1288 </body></html>

Mercurial Repository: eric

eric ide

mercurial