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 9209
b99e7fd55fd3
parent 9117
c6afba2049cf
child 9236
db53a9efe7ef
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.PipInterface.PipPackagesWidget</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.PipInterface.PipPackagesWidget</h1>
10
11 <p>
12 Module implementing the pip packages management widget.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#PipPackagesWidget">PipPackagesWidget</a></td>
25 <td>Class implementing the pip packages management widget.</td>
26 </tr>
27 <tr>
28 <td><a href="#PypiSearchResultsParser">PypiSearchResultsParser</a></td>
29 <td>Class implementing the parser for the PyPI search result page.</td>
30 </tr>
31 </table>
32 <h3>Functions</h3>
33
34 <table>
35 <tr><td>None</td></tr>
36 </table>
37 <hr />
38 <hr />
39 <a NAME="PipPackagesWidget" ID="PipPackagesWidget"></a>
40 <h2>PipPackagesWidget</h2>
41
42 <p>
43 Class implementing the pip packages management widget.
44 </p>
45 <h3>Derived from</h3>
46 QWidget, Ui_PipPackagesWidget
47 <h3>Class Attributes</h3>
48
49 <table>
50 <tr><td>AvailableVersionColumn</td></tr><tr><td>DepInstalledVersionColumn</td></tr><tr><td>DepPackageColumn</td></tr><tr><td>DepRequiredVersionColumn</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>
52 <h3>Class Methods</h3>
53
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58
59 <table>
60
61 <tr>
62 <td><a href="#PipPackagesWidget.__init__">PipPackagesWidget</a></td>
63 <td>Constructor</td>
64 </tr>
65 <tr>
66 <td><a href="#PipPackagesWidget.__aboutToShowPipMenu">__aboutToShowPipMenu</a></td>
67 <td>Private slot to set the action enabled status.</td>
68 </tr>
69 <tr>
70 <td><a href="#PipPackagesWidget.__addDependency">__addDependency</a></td>
71 <td>Private method to add a dependency branch to a given parent.</td>
72 </tr>
73 <tr>
74 <td><a href="#PipPackagesWidget.__allUpdateableItems">__allUpdateableItems</a></td>
75 <td>Private method to get a list of all items that can be updated.</td>
76 </tr>
77 <tr>
78 <td><a href="#PipPackagesWidget.__availablePipVersion">__availablePipVersion</a></td>
79 <td>Private method to get the pip version of the selected environment.</td>
80 </tr>
81 <tr>
82 <td><a href="#PipPackagesWidget.__clearVulnerabilityInfo">__clearVulnerabilityInfo</a></td>
83 <td>Private slot to clear the vulnerability info.</td>
84 </tr>
85 <tr>
86 <td><a href="#PipPackagesWidget.__createSBOMFile">__createSBOMFile</a></td>
87 <td>Private slot to create a "Software Bill Of Material" file.</td>
88 </tr>
89 <tr>
90 <td><a href="#PipPackagesWidget.__editConfiguration">__editConfiguration</a></td>
91 <td>Private method to edit a configuration.</td>
92 </tr>
93 <tr>
94 <td><a href="#PipPackagesWidget.__editUserConfiguration">__editUserConfiguration</a></td>
95 <td>Private slot to edit the user configuration.</td>
96 </tr>
97 <tr>
98 <td><a href="#PipPackagesWidget.__editVirtualenvConfiguration">__editVirtualenvConfiguration</a></td>
99 <td>Private slot to edit the configuration of the selected environment.</td>
100 </tr>
101 <tr>
102 <td><a href="#PipPackagesWidget.__finishSearch">__finishSearch</a></td>
103 <td>Private slot performing the search finishing actions.</td>
104 </tr>
105 <tr>
106 <td><a href="#PipPackagesWidget.__generateRequirements">__generateRequirements</a></td>
107 <td>Private slot to generate the contents for a requirements file.</td>
108 </tr>
109 <tr>
110 <td><a href="#PipPackagesWidget.__initPipMenu">__initPipMenu</a></td>
111 <td>Private method to create the super menu and attach it to the super menu button.</td>
112 </tr>
113 <tr>
114 <td><a href="#PipPackagesWidget.__installLocalPackage">__installLocalPackage</a></td>
115 <td>Private slot to install a package available on local storage.</td>
116 </tr>
117 <tr>
118 <td><a href="#PipPackagesWidget.__installPackages">__installPackages</a></td>
119 <td>Private slot to install packages to be given by the user.</td>
120 </tr>
121 <tr>
122 <td><a href="#PipPackagesWidget.__installPip">__installPip</a></td>
123 <td>Private slot to install pip into the selected environment.</td>
124 </tr>
125 <tr>
126 <td><a href="#PipPackagesWidget.__installPipUser">__installPipUser</a></td>
127 <td>Private slot to install pip into the user site for the selected environment.</td>
128 </tr>
129 <tr>
130 <td><a href="#PipPackagesWidget.__installRequirements">__installRequirements</a></td>
131 <td>Private slot to install packages as given in a requirements file.</td>
132 </tr>
133 <tr>
134 <td><a href="#PipPackagesWidget.__isPipAvailable">__isPipAvailable</a></td>
135 <td>Private method to check, if the pip package is available for the selected environment.</td>
136 </tr>
137 <tr>
138 <td><a href="#PipPackagesWidget.__pipConfigure">__pipConfigure</a></td>
139 <td>Private slot to open the configuration page.</td>
140 </tr>
141 <tr>
142 <td><a href="#PipPackagesWidget.__populateEnvironments">__populateEnvironments</a></td>
143 <td>Private method to get a list of environments and populate the selector.</td>
144 </tr>
145 <tr>
146 <td><a href="#PipPackagesWidget.__projectClosed">__projectClosed</a></td>
147 <td>Private slot to handle the projectClosed signal.</td>
148 </tr>
149 <tr>
150 <td><a href="#PipPackagesWidget.__projectOpened">__projectOpened</a></td>
151 <td>Private slot to handle the projectOpened signal.</td>
152 </tr>
153 <tr>
154 <td><a href="#PipPackagesWidget.__purgeCache">__purgeCache</a></td>
155 <td>Private slot to empty the pip cache.</td>
156 </tr>
157 <tr>
158 <td><a href="#PipPackagesWidget.__refreshDependencyTree">__refreshDependencyTree</a></td>
159 <td>Private method to refresh the dependency tree.</td>
160 </tr>
161 <tr>
162 <td><a href="#PipPackagesWidget.__refreshPackagesList">__refreshPackagesList</a></td>
163 <td>Private method to refresh the packages list.</td>
164 </tr>
165 <tr>
166 <td><a href="#PipPackagesWidget.__reinstallPackages">__reinstallPackages</a></td>
167 <td>Private slot to force a re-installation of the selected packages.</td>
168 </tr>
169 <tr>
170 <td><a href="#PipPackagesWidget.__removeCachedFiles">__removeCachedFiles</a></td>
171 <td>Private slot to remove files from the pip cache.</td>
172 </tr>
173 <tr>
174 <td><a href="#PipPackagesWidget.__repairPip">__repairPip</a></td>
175 <td>Private slot to repair the pip installation of the selected environment.</td>
176 </tr>
177 <tr>
178 <td><a href="#PipPackagesWidget.__search">__search</a></td>
179 <td>Private method to perform the search by calling the PyPI search URL.</td>
180 </tr>
181 <tr>
182 <td><a href="#PipPackagesWidget.__searchFirst">__searchFirst</a></td>
183 <td>Private method to perform the search for packages.</td>
184 </tr>
185 <tr>
186 <td><a href="#PipPackagesWidget.__searchResponse">__searchResponse</a></td>
187 <td>Private method to extract the search result data from the response.</td>
188 </tr>
189 <tr>
190 <td><a href="#PipPackagesWidget.__selectedUpdateableItems">__selectedUpdateableItems</a></td>
191 <td>Private method to get a list of selected items that can be updated.</td>
192 </tr>
193 <tr>
194 <td><a href="#PipPackagesWidget.__showCacheInfo">__showCacheInfo</a></td>
195 <td>Private slot to show information about the cache.</td>
196 </tr>
197 <tr>
198 <td><a href="#PipPackagesWidget.__showCacheList">__showCacheList</a></td>
199 <td>Private slot to show a list of cached files.</td>
200 </tr>
201 <tr>
202 <td><a href="#PipPackagesWidget.__showLicensesDialog">__showLicensesDialog</a></td>
203 <td>Private slot to show a dialog with the licenses of the selected environment.</td>
204 </tr>
205 <tr>
206 <td><a href="#PipPackagesWidget.__showPackageDetails">__showPackageDetails</a></td>
207 <td>Private method to populate the package details dialog.</td>
208 </tr>
209 <tr>
210 <td><a href="#PipPackagesWidget.__showPackageInformation">__showPackageInformation</a></td>
211 <td>Private method to show information for a package.</td>
212 </tr>
213 <tr>
214 <td><a href="#PipPackagesWidget.__showSearchedDetails">__showSearchedDetails</a></td>
215 <td>Private slot to show details about the selected search result package.</td>
216 </tr>
217 <tr>
218 <td><a href="#PipPackagesWidget.__showVulnerabilityInformation">__showVulnerabilityInformation</a></td>
219 <td>Private method to show the detected vulnerability data.</td>
220 </tr>
221 <tr>
222 <td><a href="#PipPackagesWidget.__uninstallRequirements">__uninstallRequirements</a></td>
223 <td>Private slot to uninstall packages as given in a requirements file.</td>
224 </tr>
225 <tr>
226 <td><a href="#PipPackagesWidget.__updateActionButtons">__updateActionButtons</a></td>
227 <td>Private method to set the state of the action buttons.</td>
228 </tr>
229 <tr>
230 <td><a href="#PipPackagesWidget.__updateDepActionButtons">__updateDepActionButtons</a></td>
231 <td>Private method to set the state of the dependency page action buttons.</td>
232 </tr>
233 <tr>
234 <td><a href="#PipPackagesWidget.__updateSearchActionButtons">__updateSearchActionButtons</a></td>
235 <td>Private method to update the action button states of the search widget.</td>
236 </tr>
237 <tr>
238 <td><a href="#PipPackagesWidget.__updateSearchButton">__updateSearchButton</a></td>
239 <td>Private method to update the state of the search button.</td>
240 </tr>
241 <tr>
242 <td><a href="#PipPackagesWidget.__updateSearchMoreButton">__updateSearchMoreButton</a></td>
243 <td>Private method to update the state of the search more button.</td>
244 </tr>
245 <tr>
246 <td><a href="#PipPackagesWidget.__updateVulnerabilityData">__updateVulnerabilityData</a></td>
247 <td>Private slot to update the shown vulnerability info.</td>
248 </tr>
249 <tr>
250 <td><a href="#PipPackagesWidget.__updateVulnerabilityDbCache">__updateVulnerabilityDbCache</a></td>
251 <td>Private slot to initiate an update of the local cache of the vulnerability database.</td>
252 </tr>
253 <tr>
254 <td><a href="#PipPackagesWidget.executeInstallPackages">executeInstallPackages</a></td>
255 <td>Public method to install the given list of packages.</td>
256 </tr>
257 <tr>
258 <td><a href="#PipPackagesWidget.executeUninstallPackages">executeUninstallPackages</a></td>
259 <td>Public method to uninstall the given list of packages.</td>
260 </tr>
261 <tr>
262 <td><a href="#PipPackagesWidget.executeUpgradePackages">executeUpgradePackages</a></td>
263 <td>Public method to execute the pip upgrade command.</td>
264 </tr>
265 <tr>
266 <td><a href="#PipPackagesWidget.getPip">getPip</a></td>
267 <td>Public method to get a reference to the pip interface object.</td>
268 </tr>
269 <tr>
270 <td><a href="#PipPackagesWidget.on_dependenciesList_itemActivated">on_dependenciesList_itemActivated</a></td>
271 <td>Private slot reacting on a package item of the dependency tree being activated.</td>
272 </tr>
273 <tr>
274 <td><a href="#PipPackagesWidget.on_dependenciesList_itemPressed">on_dependenciesList_itemPressed</a></td>
275 <td>Private slot reacting on a package item of the dependency tree being pressed.</td>
276 </tr>
277 <tr>
278 <td><a href="#PipPackagesWidget.on_dependenciesList_itemSelectionChanged">on_dependenciesList_itemSelectionChanged</a></td>
279 <td>Private slot reacting on a change of selected items of the dependency tree.</td>
280 </tr>
281 <tr>
282 <td><a href="#PipPackagesWidget.on_environmentsComboBox_currentTextChanged">on_environmentsComboBox_currentTextChanged</a></td>
283 <td>Private slot handling the selection of a Python environment.</td>
284 </tr>
285 <tr>
286 <td><a href="#PipPackagesWidget.on_installButton_clicked">on_installButton_clicked</a></td>
287 <td>Private slot to handle pressing the Install button..</td>
288 </tr>
289 <tr>
290 <td><a href="#PipPackagesWidget.on_installUserSiteButton_clicked">on_installUserSiteButton_clicked</a></td>
291 <td>Private slot to handle pressing the Install to User-Site button..</td>
292 </tr>
293 <tr>
294 <td><a href="#PipPackagesWidget.on_installedFilesCheckBox_clicked">on_installedFilesCheckBox_clicked</a></td>
295 <td>Private slot to handle a change of the installed files information checkbox.</td>
296 </tr>
297 <tr>
298 <td><a href="#PipPackagesWidget.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td>
299 <td>Private slot handling the switching of the local mode.</td>
300 </tr>
301 <tr>
302 <td><a href="#PipPackagesWidget.on_localDepCheckBox_clicked">on_localDepCheckBox_clicked</a></td>
303 <td>Private slot handling the switching of the local mode.</td>
304 </tr>
305 <tr>
306 <td><a href="#PipPackagesWidget.on_notRequiredCheckBox_clicked">on_notRequiredCheckBox_clicked</a></td>
307 <td>Private slot handling the switching of the 'not required' mode.</td>
308 </tr>
309 <tr>
310 <td><a href="#PipPackagesWidget.on_packagesList_itemActivated">on_packagesList_itemActivated</a></td>
311 <td>Private slot reacting on a package item being activated.</td>
312 </tr>
313 <tr>
314 <td><a href="#PipPackagesWidget.on_packagesList_itemPressed">on_packagesList_itemPressed</a></td>
315 <td>Private slot reacting on a package item being pressed.</td>
316 </tr>
317 <tr>
318 <td><a href="#PipPackagesWidget.on_packagesList_itemSelectionChanged">on_packagesList_itemSelectionChanged</a></td>
319 <td>Private slot reacting on a change of selected items.</td>
320 </tr>
321 <tr>
322 <td><a href="#PipPackagesWidget.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
323 <td>Private slot to refresh the display.</td>
324 </tr>
325 <tr>
326 <td><a href="#PipPackagesWidget.on_refreshDependenciesButton_clicked">on_refreshDependenciesButton_clicked</a></td>
327 <td>Private slot to refresh the dependency tree.</td>
328 </tr>
329 <tr>
330 <td><a href="#PipPackagesWidget.on_requiresButton_toggled">on_requiresButton_toggled</a></td>
331 <td>Private slot handling the selection of the view type.</td>
332 </tr>
333 <tr>
334 <td><a href="#PipPackagesWidget.on_searchButton_clicked">on_searchButton_clicked</a></td>
335 <td>Private slot handling a press of the search button.</td>
336 </tr>
337 <tr>
338 <td><a href="#PipPackagesWidget.on_searchEditName_returnPressed">on_searchEditName_returnPressed</a></td>
339 <td>Private slot initiating a search via a press of the Return key.</td>
340 </tr>
341 <tr>
342 <td><a href="#PipPackagesWidget.on_searchEditName_textChanged">on_searchEditName_textChanged</a></td>
343 <td>Private slot handling a change of the search term.</td>
344 </tr>
345 <tr>
346 <td><a href="#PipPackagesWidget.on_searchMoreButton_clicked">on_searchMoreButton_clicked</a></td>
347 <td>Private slot handling a press of the search more button.</td>
348 </tr>
349 <tr>
350 <td><a href="#PipPackagesWidget.on_searchResultList_itemActivated">on_searchResultList_itemActivated</a></td>
351 <td>Private slot reacting on an search result item activation.</td>
352 </tr>
353 <tr>
354 <td><a href="#PipPackagesWidget.on_searchResultList_itemSelectionChanged">on_searchResultList_itemSelectionChanged</a></td>
355 <td>Private slot handling changes of the search result selection.</td>
356 </tr>
357 <tr>
358 <td><a href="#PipPackagesWidget.on_searchToggleButton_toggled">on_searchToggleButton_toggled</a></td>
359 <td>Private slot to togle the search widget.</td>
360 </tr>
361 <tr>
362 <td><a href="#PipPackagesWidget.on_showDepPackageDetailsButton_clicked">on_showDepPackageDetailsButton_clicked</a></td>
363 <td>Private slot to show information for the selected package of the dependency tree.</td>
364 </tr>
365 <tr>
366 <td><a href="#PipPackagesWidget.on_showDetailsButton_clicked">on_showDetailsButton_clicked</a></td>
367 <td>Private slot to handle pressing the Show Details button.</td>
368 </tr>
369 <tr>
370 <td><a href="#PipPackagesWidget.on_showPackageDetailsButton_clicked">on_showPackageDetailsButton_clicked</a></td>
371 <td>Private slot to show information for the selected package.</td>
372 </tr>
373 <tr>
374 <td><a href="#PipPackagesWidget.on_uninstallButton_clicked">on_uninstallButton_clicked</a></td>
375 <td>Private slot to remove selected packages of the selected environment.</td>
376 </tr>
377 <tr>
378 <td><a href="#PipPackagesWidget.on_upgradeAllButton_clicked">on_upgradeAllButton_clicked</a></td>
379 <td>Private slot to upgrade all packages of the selected environment.</td>
380 </tr>
381 <tr>
382 <td><a href="#PipPackagesWidget.on_upgradeButton_clicked">on_upgradeButton_clicked</a></td>
383 <td>Private slot to upgrade selected packages of the selected environment.</td>
384 </tr>
385 <tr>
386 <td><a href="#PipPackagesWidget.on_userCheckBox_clicked">on_userCheckBox_clicked</a></td>
387 <td>Private slot handling the switching of the 'user-site' mode.</td>
388 </tr>
389 <tr>
390 <td><a href="#PipPackagesWidget.on_userDepCheckBox_clicked">on_userDepCheckBox_clicked</a></td>
391 <td>Private slot handling the switching of the 'user-site' mode.</td>
392 </tr>
393 <tr>
394 <td><a href="#PipPackagesWidget.on_verboseCheckBox_clicked">on_verboseCheckBox_clicked</a></td>
395 <td>Private slot to handle a change of the verbose package information checkbox.</td>
396 </tr>
397 <tr>
398 <td><a href="#PipPackagesWidget.on_viewToggleButton_toggled">on_viewToggleButton_toggled</a></td>
399 <td>Private slot handling the view selection.</td>
400 </tr>
401 <tr>
402 <td><a href="#PipPackagesWidget.on_vulnerabilityCheckBox_clicked">on_vulnerabilityCheckBox_clicked</a></td>
403 <td>Private slot handling a change of the automatic vulnerability checks.</td>
404 </tr>
405 </table>
406 <h3>Static Methods</h3>
407
408 <table>
409 <tr><td>None</td></tr>
410 </table>
411
412 <a NAME="PipPackagesWidget.__init__" ID="PipPackagesWidget.__init__"></a>
413 <h4>PipPackagesWidget (Constructor)</h4>
414 <b>PipPackagesWidget</b>(<i>pip, parent=None</i>)
415
416 <p>
417 Constructor
418 </p>
419 <dl>
420
421 <dt><i>pip</i> (Pip)</dt>
422 <dd>
423 reference to the global pip interface
424 </dd>
425 <dt><i>parent</i> (QWidget)</dt>
426 <dd>
427 reference to the parent widget
428 </dd>
429 </dl>
430 <a NAME="PipPackagesWidget.__aboutToShowPipMenu" ID="PipPackagesWidget.__aboutToShowPipMenu"></a>
431 <h4>PipPackagesWidget.__aboutToShowPipMenu</h4>
432 <b>__aboutToShowPipMenu</b>(<i></i>)
433
434 <p>
435 Private slot to set the action enabled status.
436 </p>
437 <a NAME="PipPackagesWidget.__addDependency" ID="PipPackagesWidget.__addDependency"></a>
438 <h4>PipPackagesWidget.__addDependency</h4>
439 <b>__addDependency</b>(<i>dependency, parent</i>)
440
441 <p>
442 Private method to add a dependency branch to a given parent.
443 </p>
444 <dl>
445
446 <dt><i>dependency</i> (dict)</dt>
447 <dd>
448 dependency to be added
449 </dd>
450 <dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt>
451 <dd>
452 reference to the parent item
453 </dd>
454 </dl>
455 <a NAME="PipPackagesWidget.__allUpdateableItems" ID="PipPackagesWidget.__allUpdateableItems"></a>
456 <h4>PipPackagesWidget.__allUpdateableItems</h4>
457 <b>__allUpdateableItems</b>(<i></i>)
458
459 <p>
460 Private method to get a list of all items that can be updated.
461 </p>
462 <dl>
463 <dt>Return:</dt>
464 <dd>
465 list of all items that can be updated
466 </dd>
467 </dl>
468 <dl>
469 <dt>Return Type:</dt>
470 <dd>
471 list of QTreeWidgetItem
472 </dd>
473 </dl>
474 <a NAME="PipPackagesWidget.__availablePipVersion" ID="PipPackagesWidget.__availablePipVersion"></a>
475 <h4>PipPackagesWidget.__availablePipVersion</h4>
476 <b>__availablePipVersion</b>(<i></i>)
477
478 <p>
479 Private method to get the pip version of the selected environment.
480 </p>
481 <dl>
482 <dt>Return:</dt>
483 <dd>
484 tuple containing the version number or tuple with all zeros
485 in case pip is not available
486 </dd>
487 </dl>
488 <dl>
489 <dt>Return Type:</dt>
490 <dd>
491 tuple of int
492 </dd>
493 </dl>
494 <a NAME="PipPackagesWidget.__clearVulnerabilityInfo" ID="PipPackagesWidget.__clearVulnerabilityInfo"></a>
495 <h4>PipPackagesWidget.__clearVulnerabilityInfo</h4>
496 <b>__clearVulnerabilityInfo</b>(<i></i>)
497
498 <p>
499 Private slot to clear the vulnerability info.
500 </p>
501 <a NAME="PipPackagesWidget.__createSBOMFile" ID="PipPackagesWidget.__createSBOMFile"></a>
502 <h4>PipPackagesWidget.__createSBOMFile</h4>
503 <b>__createSBOMFile</b>(<i></i>)
504
505 <p>
506 Private slot to create a "Software Bill Of Material" file.
507 </p>
508 <a NAME="PipPackagesWidget.__editConfiguration" ID="PipPackagesWidget.__editConfiguration"></a>
509 <h4>PipPackagesWidget.__editConfiguration</h4>
510 <b>__editConfiguration</b>(<i>venvName=""</i>)
511
512 <p>
513 Private method to edit a configuration.
514 </p>
515 <dl>
516
517 <dt><i>venvName</i> (str)</dt>
518 <dd>
519 name of the environment to act upon
520 </dd>
521 </dl>
522 <a NAME="PipPackagesWidget.__editUserConfiguration" ID="PipPackagesWidget.__editUserConfiguration"></a>
523 <h4>PipPackagesWidget.__editUserConfiguration</h4>
524 <b>__editUserConfiguration</b>(<i></i>)
525
526 <p>
527 Private slot to edit the user configuration.
528 </p>
529 <a NAME="PipPackagesWidget.__editVirtualenvConfiguration" ID="PipPackagesWidget.__editVirtualenvConfiguration"></a>
530 <h4>PipPackagesWidget.__editVirtualenvConfiguration</h4>
531 <b>__editVirtualenvConfiguration</b>(<i></i>)
532
533 <p>
534 Private slot to edit the configuration of the selected environment.
535 </p>
536 <a NAME="PipPackagesWidget.__finishSearch" ID="PipPackagesWidget.__finishSearch"></a>
537 <h4>PipPackagesWidget.__finishSearch</h4>
538 <b>__finishSearch</b>(<i></i>)
539
540 <p>
541 Private slot performing the search finishing actions.
542 </p>
543 <a NAME="PipPackagesWidget.__generateRequirements" ID="PipPackagesWidget.__generateRequirements"></a>
544 <h4>PipPackagesWidget.__generateRequirements</h4>
545 <b>__generateRequirements</b>(<i></i>)
546
547 <p>
548 Private slot to generate the contents for a requirements file.
549 </p>
550 <a NAME="PipPackagesWidget.__initPipMenu" ID="PipPackagesWidget.__initPipMenu"></a>
551 <h4>PipPackagesWidget.__initPipMenu</h4>
552 <b>__initPipMenu</b>(<i></i>)
553
554 <p>
555 Private method to create the super menu and attach it to the super
556 menu button.
557 </p>
558 <a NAME="PipPackagesWidget.__installLocalPackage" ID="PipPackagesWidget.__installLocalPackage"></a>
559 <h4>PipPackagesWidget.__installLocalPackage</h4>
560 <b>__installLocalPackage</b>(<i></i>)
561
562 <p>
563 Private slot to install a package available on local storage.
564 </p>
565 <a NAME="PipPackagesWidget.__installPackages" ID="PipPackagesWidget.__installPackages"></a>
566 <h4>PipPackagesWidget.__installPackages</h4>
567 <b>__installPackages</b>(<i></i>)
568
569 <p>
570 Private slot to install packages to be given by the user.
571 </p>
572 <a NAME="PipPackagesWidget.__installPip" ID="PipPackagesWidget.__installPip"></a>
573 <h4>PipPackagesWidget.__installPip</h4>
574 <b>__installPip</b>(<i></i>)
575
576 <p>
577 Private slot to install pip into the selected environment.
578 </p>
579 <a NAME="PipPackagesWidget.__installPipUser" ID="PipPackagesWidget.__installPipUser"></a>
580 <h4>PipPackagesWidget.__installPipUser</h4>
581 <b>__installPipUser</b>(<i></i>)
582
583 <p>
584 Private slot to install pip into the user site for the selected
585 environment.
586 </p>
587 <a NAME="PipPackagesWidget.__installRequirements" ID="PipPackagesWidget.__installRequirements"></a>
588 <h4>PipPackagesWidget.__installRequirements</h4>
589 <b>__installRequirements</b>(<i></i>)
590
591 <p>
592 Private slot to install packages as given in a requirements file.
593 </p>
594 <a NAME="PipPackagesWidget.__isPipAvailable" ID="PipPackagesWidget.__isPipAvailable"></a>
595 <h4>PipPackagesWidget.__isPipAvailable</h4>
596 <b>__isPipAvailable</b>(<i></i>)
597
598 <p>
599 Private method to check, if the pip package is available for the
600 selected environment.
601 </p>
602 <dl>
603 <dt>Return:</dt>
604 <dd>
605 flag indicating availability
606 </dd>
607 </dl>
608 <dl>
609 <dt>Return Type:</dt>
610 <dd>
611 bool
612 </dd>
613 </dl>
614 <a NAME="PipPackagesWidget.__pipConfigure" ID="PipPackagesWidget.__pipConfigure"></a>
615 <h4>PipPackagesWidget.__pipConfigure</h4>
616 <b>__pipConfigure</b>(<i></i>)
617
618 <p>
619 Private slot to open the configuration page.
620 </p>
621 <a NAME="PipPackagesWidget.__populateEnvironments" ID="PipPackagesWidget.__populateEnvironments"></a>
622 <h4>PipPackagesWidget.__populateEnvironments</h4>
623 <b>__populateEnvironments</b>(<i></i>)
624
625 <p>
626 Private method to get a list of environments and populate the selector.
627 </p>
628 <a NAME="PipPackagesWidget.__projectClosed" ID="PipPackagesWidget.__projectClosed"></a>
629 <h4>PipPackagesWidget.__projectClosed</h4>
630 <b>__projectClosed</b>(<i>shutdown</i>)
631
632 <p>
633 Private slot to handle the projectClosed signal.
634 </p>
635 <dl>
636
637 <dt><i>shutdown</i> (bool)</dt>
638 <dd>
639 flag indicating the IDE shutdown
640 </dd>
641 </dl>
642 <a NAME="PipPackagesWidget.__projectOpened" ID="PipPackagesWidget.__projectOpened"></a>
643 <h4>PipPackagesWidget.__projectOpened</h4>
644 <b>__projectOpened</b>(<i></i>)
645
646 <p>
647 Private slot to handle the projectOpened signal.
648 </p>
649 <a NAME="PipPackagesWidget.__purgeCache" ID="PipPackagesWidget.__purgeCache"></a>
650 <h4>PipPackagesWidget.__purgeCache</h4>
651 <b>__purgeCache</b>(<i></i>)
652
653 <p>
654 Private slot to empty the pip cache.
655 </p>
656 <a NAME="PipPackagesWidget.__refreshDependencyTree" ID="PipPackagesWidget.__refreshDependencyTree"></a>
657 <h4>PipPackagesWidget.__refreshDependencyTree</h4>
658 <b>__refreshDependencyTree</b>(<i></i>)
659
660 <p>
661 Private method to refresh the dependency tree.
662 </p>
663 <a NAME="PipPackagesWidget.__refreshPackagesList" ID="PipPackagesWidget.__refreshPackagesList"></a>
664 <h4>PipPackagesWidget.__refreshPackagesList</h4>
665 <b>__refreshPackagesList</b>(<i></i>)
666
667 <p>
668 Private method to refresh the packages list.
669 </p>
670 <a NAME="PipPackagesWidget.__reinstallPackages" ID="PipPackagesWidget.__reinstallPackages"></a>
671 <h4>PipPackagesWidget.__reinstallPackages</h4>
672 <b>__reinstallPackages</b>(<i></i>)
673
674 <p>
675 Private slot to force a re-installation of the selected packages.
676 </p>
677 <a NAME="PipPackagesWidget.__removeCachedFiles" ID="PipPackagesWidget.__removeCachedFiles"></a>
678 <h4>PipPackagesWidget.__removeCachedFiles</h4>
679 <b>__removeCachedFiles</b>(<i></i>)
680
681 <p>
682 Private slot to remove files from the pip cache.
683 </p>
684 <a NAME="PipPackagesWidget.__repairPip" ID="PipPackagesWidget.__repairPip"></a>
685 <h4>PipPackagesWidget.__repairPip</h4>
686 <b>__repairPip</b>(<i></i>)
687
688 <p>
689 Private slot to repair the pip installation of the selected
690 environment.
691 </p>
692 <a NAME="PipPackagesWidget.__search" ID="PipPackagesWidget.__search"></a>
693 <h4>PipPackagesWidget.__search</h4>
694 <b>__search</b>(<i>page=1</i>)
695
696 <p>
697 Private method to perform the search by calling the PyPI search URL.
698 </p>
699 <dl>
700
701 <dt><i>page</i> (int (optional))</dt>
702 <dd>
703 search page to retrieve (defaults to 1)
704 </dd>
705 </dl>
706 <a NAME="PipPackagesWidget.__searchFirst" ID="PipPackagesWidget.__searchFirst"></a>
707 <h4>PipPackagesWidget.__searchFirst</h4>
708 <b>__searchFirst</b>(<i></i>)
709
710 <p>
711 Private method to perform the search for packages.
712 </p>
713 <a NAME="PipPackagesWidget.__searchResponse" ID="PipPackagesWidget.__searchResponse"></a>
714 <h4>PipPackagesWidget.__searchResponse</h4>
715 <b>__searchResponse</b>(<i>reply</i>)
716
717 <p>
718 Private method to extract the search result data from the response.
719 </p>
720 <dl>
721
722 <dt><i>reply</i> (QNetworkReply)</dt>
723 <dd>
724 reference to the reply object containing the data
725 </dd>
726 </dl>
727 <a NAME="PipPackagesWidget.__selectedUpdateableItems" ID="PipPackagesWidget.__selectedUpdateableItems"></a>
728 <h4>PipPackagesWidget.__selectedUpdateableItems</h4>
729 <b>__selectedUpdateableItems</b>(<i></i>)
730
731 <p>
732 Private method to get a list of selected items that can be updated.
733 </p>
734 <dl>
735 <dt>Return:</dt>
736 <dd>
737 list of selected items that can be updated
738 </dd>
739 </dl>
740 <dl>
741 <dt>Return Type:</dt>
742 <dd>
743 list of QTreeWidgetItem
744 </dd>
745 </dl>
746 <a NAME="PipPackagesWidget.__showCacheInfo" ID="PipPackagesWidget.__showCacheInfo"></a>
747 <h4>PipPackagesWidget.__showCacheInfo</h4>
748 <b>__showCacheInfo</b>(<i></i>)
749
750 <p>
751 Private slot to show information about the cache.
752 </p>
753 <a NAME="PipPackagesWidget.__showCacheList" ID="PipPackagesWidget.__showCacheList"></a>
754 <h4>PipPackagesWidget.__showCacheList</h4>
755 <b>__showCacheList</b>(<i></i>)
756
757 <p>
758 Private slot to show a list of cached files.
759 </p>
760 <a NAME="PipPackagesWidget.__showLicensesDialog" ID="PipPackagesWidget.__showLicensesDialog"></a>
761 <h4>PipPackagesWidget.__showLicensesDialog</h4>
762 <b>__showLicensesDialog</b>(<i></i>)
763
764 <p>
765 Private slot to show a dialog with the licenses of the selected
766 environment.
767 </p>
768 <a NAME="PipPackagesWidget.__showPackageDetails" ID="PipPackagesWidget.__showPackageDetails"></a>
769 <h4>PipPackagesWidget.__showPackageDetails</h4>
770 <b>__showPackageDetails</b>(<i>packageName, packageVersion, upgradable=False, installable=False</i>)
771
772 <p>
773 Private method to populate the package details dialog.
774 </p>
775 <dl>
776
777 <dt><i>packageName</i> (str)</dt>
778 <dd>
779 name of the package to show details for
780 </dd>
781 <dt><i>packageVersion</i> (str)</dt>
782 <dd>
783 version of the package
784 </dd>
785 <dt><i>upgradable</i> (bool (optional))</dt>
786 <dd>
787 flag indicating that the package may be upgraded
788 (defaults to False)
789 </dd>
790 <dt><i>installable</i> (bool (optional))</dt>
791 <dd>
792 flag indicating that the package may be installed
793 (defaults to False)
794 </dd>
795 </dl>
796 <a NAME="PipPackagesWidget.__showPackageInformation" ID="PipPackagesWidget.__showPackageInformation"></a>
797 <h4>PipPackagesWidget.__showPackageInformation</h4>
798 <b>__showPackageInformation</b>(<i>packageName, infoWidget</i>)
799
800 <p>
801 Private method to show information for a package.
802 </p>
803 <dl>
804
805 <dt><i>packageName</i> (str)</dt>
806 <dd>
807 name of the package
808 </dd>
809 <dt><i>infoWidget</i> (QTreeWidget)</dt>
810 <dd>
811 reference to the widget to contain the information
812 </dd>
813 </dl>
814 <a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a>
815 <h4>PipPackagesWidget.__showSearchedDetails</h4>
816 <b>__showSearchedDetails</b>(<i>item=None</i>)
817
818 <p>
819 Private slot to show details about the selected search result package.
820 </p>
821 <dl>
822
823 <dt><i>item</i> (QTreeWidgetItem)</dt>
824 <dd>
825 reference to the search result item to show details for
826 </dd>
827 </dl>
828 <a NAME="PipPackagesWidget.__showVulnerabilityInformation" ID="PipPackagesWidget.__showVulnerabilityInformation"></a>
829 <h4>PipPackagesWidget.__showVulnerabilityInformation</h4>
830 <b>__showVulnerabilityInformation</b>(<i>packageName, packageVersion, vulnerabilities</i>)
831
832 <p>
833 Private method to show the detected vulnerability data.
834 </p>
835 <dl>
836
837 <dt><i>packageName</i> (str)</dt>
838 <dd>
839 name of the package
840 </dd>
841 <dt><i>packageVersion</i> (str)</dt>
842 <dd>
843 installed version number
844 </dd>
845 <dt><i>vulnerabilities</i> (list of Vulnerability)</dt>
846 <dd>
847 list of vulnerabilities
848 </dd>
849 </dl>
850 <a NAME="PipPackagesWidget.__uninstallRequirements" ID="PipPackagesWidget.__uninstallRequirements"></a>
851 <h4>PipPackagesWidget.__uninstallRequirements</h4>
852 <b>__uninstallRequirements</b>(<i></i>)
853
854 <p>
855 Private slot to uninstall packages as given in a requirements file.
856 </p>
857 <a NAME="PipPackagesWidget.__updateActionButtons" ID="PipPackagesWidget.__updateActionButtons"></a>
858 <h4>PipPackagesWidget.__updateActionButtons</h4>
859 <b>__updateActionButtons</b>(<i></i>)
860
861 <p>
862 Private method to set the state of the action buttons.
863 </p>
864 <a NAME="PipPackagesWidget.__updateDepActionButtons" ID="PipPackagesWidget.__updateDepActionButtons"></a>
865 <h4>PipPackagesWidget.__updateDepActionButtons</h4>
866 <b>__updateDepActionButtons</b>(<i></i>)
867
868 <p>
869 Private method to set the state of the dependency page action buttons.
870 </p>
871 <a NAME="PipPackagesWidget.__updateSearchActionButtons" ID="PipPackagesWidget.__updateSearchActionButtons"></a>
872 <h4>PipPackagesWidget.__updateSearchActionButtons</h4>
873 <b>__updateSearchActionButtons</b>(<i></i>)
874
875 <p>
876 Private method to update the action button states of the search widget.
877 </p>
878 <a NAME="PipPackagesWidget.__updateSearchButton" ID="PipPackagesWidget.__updateSearchButton"></a>
879 <h4>PipPackagesWidget.__updateSearchButton</h4>
880 <b>__updateSearchButton</b>(<i></i>)
881
882 <p>
883 Private method to update the state of the search button.
884 </p>
885 <a NAME="PipPackagesWidget.__updateSearchMoreButton" ID="PipPackagesWidget.__updateSearchMoreButton"></a>
886 <h4>PipPackagesWidget.__updateSearchMoreButton</h4>
887 <b>__updateSearchMoreButton</b>(<i>enable</i>)
888
889 <p>
890 Private method to update the state of the search more button.
891 </p>
892 <dl>
893
894 <dt><i>enable</i> (bool)</dt>
895 <dd>
896 flag indicating the desired enable state
897 </dd>
898 </dl>
899 <a NAME="PipPackagesWidget.__updateVulnerabilityData" ID="PipPackagesWidget.__updateVulnerabilityData"></a>
900 <h4>PipPackagesWidget.__updateVulnerabilityData</h4>
901 <b>__updateVulnerabilityData</b>(<i>clearFirst=True</i>)
902
903 <p>
904 Private slot to update the shown vulnerability info.
905 </p>
906 <dl>
907
908 <dt><i>clearFirst</i> (bool (optional))</dt>
909 <dd>
910 flag indicating to clear the vulnerability info first
911 (defaults to True)
912 </dd>
913 </dl>
914 <a NAME="PipPackagesWidget.__updateVulnerabilityDbCache" ID="PipPackagesWidget.__updateVulnerabilityDbCache"></a>
915 <h4>PipPackagesWidget.__updateVulnerabilityDbCache</h4>
916 <b>__updateVulnerabilityDbCache</b>(<i></i>)
917
918 <p>
919 Private slot to initiate an update of the local cache of the
920 vulnerability database.
921 </p>
922 <a NAME="PipPackagesWidget.executeInstallPackages" ID="PipPackagesWidget.executeInstallPackages"></a>
923 <h4>PipPackagesWidget.executeInstallPackages</h4>
924 <b>executeInstallPackages</b>(<i>packages, userSite=False</i>)
925
926 <p>
927 Public method to install the given list of packages.
928 </p>
929 <dl>
930
931 <dt><i>packages</i> (list of str)</dt>
932 <dd>
933 list of package names to be installed
934 </dd>
935 <dt><i>userSite</i> (bool)</dt>
936 <dd>
937 flag indicating to install to the user directory
938 </dd>
939 </dl>
940 <a NAME="PipPackagesWidget.executeUninstallPackages" ID="PipPackagesWidget.executeUninstallPackages"></a>
941 <h4>PipPackagesWidget.executeUninstallPackages</h4>
942 <b>executeUninstallPackages</b>(<i>packages</i>)
943
944 <p>
945 Public method to uninstall the given list of packages.
946 </p>
947 <dl>
948
949 <dt><i>packages</i> (list of str)</dt>
950 <dd>
951 list of package names to be uninstalled
952 </dd>
953 </dl>
954 <a NAME="PipPackagesWidget.executeUpgradePackages" ID="PipPackagesWidget.executeUpgradePackages"></a>
955 <h4>PipPackagesWidget.executeUpgradePackages</h4>
956 <b>executeUpgradePackages</b>(<i>packages</i>)
957
958 <p>
959 Public method to execute the pip upgrade command.
960 </p>
961 <dl>
962
963 <dt><i>packages</i> (list of str)</dt>
964 <dd>
965 list of package names to be upgraded
966 </dd>
967 </dl>
968 <a NAME="PipPackagesWidget.getPip" ID="PipPackagesWidget.getPip"></a>
969 <h4>PipPackagesWidget.getPip</h4>
970 <b>getPip</b>(<i></i>)
971
972 <p>
973 Public method to get a reference to the pip interface object.
974 </p>
975 <dl>
976 <dt>Return:</dt>
977 <dd>
978 reference to the pip interface object
979 </dd>
980 </dl>
981 <dl>
982 <dt>Return Type:</dt>
983 <dd>
984 Pip
985 </dd>
986 </dl>
987 <a NAME="PipPackagesWidget.on_dependenciesList_itemActivated" ID="PipPackagesWidget.on_dependenciesList_itemActivated"></a>
988 <h4>PipPackagesWidget.on_dependenciesList_itemActivated</h4>
989 <b>on_dependenciesList_itemActivated</b>(<i>item, column</i>)
990
991 <p>
992 Private slot reacting on a package item of the dependency tree being
993 activated.
994 </p>
995 <dl>
996
997 <dt><i>item</i> (QTreeWidgetItem)</dt>
998 <dd>
999 reference to the activated item
1000 </dd>
1001 <dt><i>column</i> (int)</dt>
1002 <dd>
1003 activated column
1004 </dd>
1005 </dl>
1006 <a NAME="PipPackagesWidget.on_dependenciesList_itemPressed" ID="PipPackagesWidget.on_dependenciesList_itemPressed"></a>
1007 <h4>PipPackagesWidget.on_dependenciesList_itemPressed</h4>
1008 <b>on_dependenciesList_itemPressed</b>(<i>item, column</i>)
1009
1010 <p>
1011 Private slot reacting on a package item of the dependency tree being
1012 pressed.
1013 </p>
1014 <dl>
1015
1016 <dt><i>item</i> (QTreeWidgetItem)</dt>
1017 <dd>
1018 reference to the pressed item
1019 </dd>
1020 <dt><i>column</i> (int)</dt>
1021 <dd>
1022 pressed column
1023 </dd>
1024 </dl>
1025 <a NAME="PipPackagesWidget.on_dependenciesList_itemSelectionChanged" ID="PipPackagesWidget.on_dependenciesList_itemSelectionChanged"></a>
1026 <h4>PipPackagesWidget.on_dependenciesList_itemSelectionChanged</h4>
1027 <b>on_dependenciesList_itemSelectionChanged</b>(<i></i>)
1028
1029 <p>
1030 Private slot reacting on a change of selected items of the dependency
1031 tree.
1032 </p>
1033 <a NAME="PipPackagesWidget.on_environmentsComboBox_currentTextChanged" ID="PipPackagesWidget.on_environmentsComboBox_currentTextChanged"></a>
1034 <h4>PipPackagesWidget.on_environmentsComboBox_currentTextChanged</h4>
1035 <b>on_environmentsComboBox_currentTextChanged</b>(<i>name</i>)
1036
1037 <p>
1038 Private slot handling the selection of a Python environment.
1039 </p>
1040 <dl>
1041
1042 <dt><i>name</i> (str)</dt>
1043 <dd>
1044 name of the selected Python environment
1045 </dd>
1046 </dl>
1047 <a NAME="PipPackagesWidget.on_installButton_clicked" ID="PipPackagesWidget.on_installButton_clicked"></a>
1048 <h4>PipPackagesWidget.on_installButton_clicked</h4>
1049 <b>on_installButton_clicked</b>(<i></i>)
1050
1051 <p>
1052 Private slot to handle pressing the Install button..
1053 </p>
1054 <a NAME="PipPackagesWidget.on_installUserSiteButton_clicked" ID="PipPackagesWidget.on_installUserSiteButton_clicked"></a>
1055 <h4>PipPackagesWidget.on_installUserSiteButton_clicked</h4>
1056 <b>on_installUserSiteButton_clicked</b>(<i></i>)
1057
1058 <p>
1059 Private slot to handle pressing the Install to User-Site button..
1060 </p>
1061 <a NAME="PipPackagesWidget.on_installedFilesCheckBox_clicked" ID="PipPackagesWidget.on_installedFilesCheckBox_clicked"></a>
1062 <h4>PipPackagesWidget.on_installedFilesCheckBox_clicked</h4>
1063 <b>on_installedFilesCheckBox_clicked</b>(<i>checked</i>)
1064
1065 <p>
1066 Private slot to handle a change of the installed files information
1067 checkbox.
1068 </p>
1069 <dl>
1070
1071 <dt><i>checked</i> (bool)</dt>
1072 <dd>
1073 state of the checkbox
1074 </dd>
1075 </dl>
1076 <a NAME="PipPackagesWidget.on_localCheckBox_clicked" ID="PipPackagesWidget.on_localCheckBox_clicked"></a>
1077 <h4>PipPackagesWidget.on_localCheckBox_clicked</h4>
1078 <b>on_localCheckBox_clicked</b>(<i></i>)
1079
1080 <p>
1081 Private slot handling the switching of the local mode.
1082 </p>
1083 <a NAME="PipPackagesWidget.on_localDepCheckBox_clicked" ID="PipPackagesWidget.on_localDepCheckBox_clicked"></a>
1084 <h4>PipPackagesWidget.on_localDepCheckBox_clicked</h4>
1085 <b>on_localDepCheckBox_clicked</b>(<i></i>)
1086
1087 <p>
1088 Private slot handling the switching of the local mode.
1089 </p>
1090 <a NAME="PipPackagesWidget.on_notRequiredCheckBox_clicked" ID="PipPackagesWidget.on_notRequiredCheckBox_clicked"></a>
1091 <h4>PipPackagesWidget.on_notRequiredCheckBox_clicked</h4>
1092 <b>on_notRequiredCheckBox_clicked</b>(<i></i>)
1093
1094 <p>
1095 Private slot handling the switching of the 'not required' mode.
1096 </p>
1097 <a NAME="PipPackagesWidget.on_packagesList_itemActivated" ID="PipPackagesWidget.on_packagesList_itemActivated"></a>
1098 <h4>PipPackagesWidget.on_packagesList_itemActivated</h4>
1099 <b>on_packagesList_itemActivated</b>(<i>item, column</i>)
1100
1101 <p>
1102 Private slot reacting on a package item being activated.
1103 </p>
1104 <dl>
1105
1106 <dt><i>item</i> (QTreeWidgetItem)</dt>
1107 <dd>
1108 reference to the activated item
1109 </dd>
1110 <dt><i>column</i> (int)</dt>
1111 <dd>
1112 activated column
1113 </dd>
1114 </dl>
1115 <a NAME="PipPackagesWidget.on_packagesList_itemPressed" ID="PipPackagesWidget.on_packagesList_itemPressed"></a>
1116 <h4>PipPackagesWidget.on_packagesList_itemPressed</h4>
1117 <b>on_packagesList_itemPressed</b>(<i>item, column</i>)
1118
1119 <p>
1120 Private slot reacting on a package item being pressed.
1121 </p>
1122 <dl>
1123
1124 <dt><i>item</i> (QTreeWidgetItem)</dt>
1125 <dd>
1126 reference to the pressed item
1127 </dd>
1128 <dt><i>column</i> (int)</dt>
1129 <dd>
1130 pressed column
1131 </dd>
1132 </dl>
1133 <a NAME="PipPackagesWidget.on_packagesList_itemSelectionChanged" ID="PipPackagesWidget.on_packagesList_itemSelectionChanged"></a>
1134 <h4>PipPackagesWidget.on_packagesList_itemSelectionChanged</h4>
1135 <b>on_packagesList_itemSelectionChanged</b>(<i></i>)
1136
1137 <p>
1138 Private slot reacting on a change of selected items.
1139 </p>
1140 <a NAME="PipPackagesWidget.on_refreshButton_clicked" ID="PipPackagesWidget.on_refreshButton_clicked"></a>
1141 <h4>PipPackagesWidget.on_refreshButton_clicked</h4>
1142 <b>on_refreshButton_clicked</b>(<i></i>)
1143
1144 <p>
1145 Private slot to refresh the display.
1146 </p>
1147 <a NAME="PipPackagesWidget.on_refreshDependenciesButton_clicked" ID="PipPackagesWidget.on_refreshDependenciesButton_clicked"></a>
1148 <h4>PipPackagesWidget.on_refreshDependenciesButton_clicked</h4>
1149 <b>on_refreshDependenciesButton_clicked</b>(<i></i>)
1150
1151 <p>
1152 Private slot to refresh the dependency tree.
1153 </p>
1154 <a NAME="PipPackagesWidget.on_requiresButton_toggled" ID="PipPackagesWidget.on_requiresButton_toggled"></a>
1155 <h4>PipPackagesWidget.on_requiresButton_toggled</h4>
1156 <b>on_requiresButton_toggled</b>(<i>checked</i>)
1157
1158 <p>
1159 Private slot handling the selection of the view type.
1160 </p>
1161 <dl>
1162
1163 <dt><i>checked</i> (bool)</dt>
1164 <dd>
1165 state of the radio button (unused)
1166 </dd>
1167 </dl>
1168 <a NAME="PipPackagesWidget.on_searchButton_clicked" ID="PipPackagesWidget.on_searchButton_clicked"></a>
1169 <h4>PipPackagesWidget.on_searchButton_clicked</h4>
1170 <b>on_searchButton_clicked</b>(<i></i>)
1171
1172 <p>
1173 Private slot handling a press of the search button.
1174 </p>
1175 <a NAME="PipPackagesWidget.on_searchEditName_returnPressed" ID="PipPackagesWidget.on_searchEditName_returnPressed"></a>
1176 <h4>PipPackagesWidget.on_searchEditName_returnPressed</h4>
1177 <b>on_searchEditName_returnPressed</b>(<i></i>)
1178
1179 <p>
1180 Private slot initiating a search via a press of the Return key.
1181 </p>
1182 <a NAME="PipPackagesWidget.on_searchEditName_textChanged" ID="PipPackagesWidget.on_searchEditName_textChanged"></a>
1183 <h4>PipPackagesWidget.on_searchEditName_textChanged</h4>
1184 <b>on_searchEditName_textChanged</b>(<i>txt</i>)
1185
1186 <p>
1187 Private slot handling a change of the search term.
1188 </p>
1189 <dl>
1190
1191 <dt><i>txt</i> (str)</dt>
1192 <dd>
1193 search term
1194 </dd>
1195 </dl>
1196 <a NAME="PipPackagesWidget.on_searchMoreButton_clicked" ID="PipPackagesWidget.on_searchMoreButton_clicked"></a>
1197 <h4>PipPackagesWidget.on_searchMoreButton_clicked</h4>
1198 <b>on_searchMoreButton_clicked</b>(<i></i>)
1199
1200 <p>
1201 Private slot handling a press of the search more button.
1202 </p>
1203 <a NAME="PipPackagesWidget.on_searchResultList_itemActivated" ID="PipPackagesWidget.on_searchResultList_itemActivated"></a>
1204 <h4>PipPackagesWidget.on_searchResultList_itemActivated</h4>
1205 <b>on_searchResultList_itemActivated</b>(<i>item, column</i>)
1206
1207 <p>
1208 Private slot reacting on an search result item activation.
1209 </p>
1210 <dl>
1211
1212 <dt><i>item</i> (QTreeWidgetItem)</dt>
1213 <dd>
1214 reference to the activated item
1215 </dd>
1216 <dt><i>column</i> (int)</dt>
1217 <dd>
1218 activated column
1219 </dd>
1220 </dl>
1221 <a NAME="PipPackagesWidget.on_searchResultList_itemSelectionChanged" ID="PipPackagesWidget.on_searchResultList_itemSelectionChanged"></a>
1222 <h4>PipPackagesWidget.on_searchResultList_itemSelectionChanged</h4>
1223 <b>on_searchResultList_itemSelectionChanged</b>(<i></i>)
1224
1225 <p>
1226 Private slot handling changes of the search result selection.
1227 </p>
1228 <a NAME="PipPackagesWidget.on_searchToggleButton_toggled" ID="PipPackagesWidget.on_searchToggleButton_toggled"></a>
1229 <h4>PipPackagesWidget.on_searchToggleButton_toggled</h4>
1230 <b>on_searchToggleButton_toggled</b>(<i>checked</i>)
1231
1232 <p>
1233 Private slot to togle the search widget.
1234 </p>
1235 <dl>
1236
1237 <dt><i>checked</i> (bool)</dt>
1238 <dd>
1239 state of the search widget button
1240 </dd>
1241 </dl>
1242 <a NAME="PipPackagesWidget.on_showDepPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showDepPackageDetailsButton_clicked"></a>
1243 <h4>PipPackagesWidget.on_showDepPackageDetailsButton_clicked</h4>
1244 <b>on_showDepPackageDetailsButton_clicked</b>(<i></i>)
1245
1246 <p>
1247 Private slot to show information for the selected package of the
1248 dependency tree.
1249 </p>
1250 <a NAME="PipPackagesWidget.on_showDetailsButton_clicked" ID="PipPackagesWidget.on_showDetailsButton_clicked"></a>
1251 <h4>PipPackagesWidget.on_showDetailsButton_clicked</h4>
1252 <b>on_showDetailsButton_clicked</b>(<i></i>)
1253
1254 <p>
1255 Private slot to handle pressing the Show Details button.
1256 </p>
1257 <a NAME="PipPackagesWidget.on_showPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showPackageDetailsButton_clicked"></a>
1258 <h4>PipPackagesWidget.on_showPackageDetailsButton_clicked</h4>
1259 <b>on_showPackageDetailsButton_clicked</b>(<i></i>)
1260
1261 <p>
1262 Private slot to show information for the selected package.
1263 </p>
1264 <a NAME="PipPackagesWidget.on_uninstallButton_clicked" ID="PipPackagesWidget.on_uninstallButton_clicked"></a>
1265 <h4>PipPackagesWidget.on_uninstallButton_clicked</h4>
1266 <b>on_uninstallButton_clicked</b>(<i></i>)
1267
1268 <p>
1269 Private slot to remove selected packages of the selected environment.
1270 </p>
1271 <a NAME="PipPackagesWidget.on_upgradeAllButton_clicked" ID="PipPackagesWidget.on_upgradeAllButton_clicked"></a>
1272 <h4>PipPackagesWidget.on_upgradeAllButton_clicked</h4>
1273 <b>on_upgradeAllButton_clicked</b>(<i></i>)
1274
1275 <p>
1276 Private slot to upgrade all packages of the selected environment.
1277 </p>
1278 <a NAME="PipPackagesWidget.on_upgradeButton_clicked" ID="PipPackagesWidget.on_upgradeButton_clicked"></a>
1279 <h4>PipPackagesWidget.on_upgradeButton_clicked</h4>
1280 <b>on_upgradeButton_clicked</b>(<i></i>)
1281
1282 <p>
1283 Private slot to upgrade selected packages of the selected environment.
1284 </p>
1285 <a NAME="PipPackagesWidget.on_userCheckBox_clicked" ID="PipPackagesWidget.on_userCheckBox_clicked"></a>
1286 <h4>PipPackagesWidget.on_userCheckBox_clicked</h4>
1287 <b>on_userCheckBox_clicked</b>(<i></i>)
1288
1289 <p>
1290 Private slot handling the switching of the 'user-site' mode.
1291 </p>
1292 <a NAME="PipPackagesWidget.on_userDepCheckBox_clicked" ID="PipPackagesWidget.on_userDepCheckBox_clicked"></a>
1293 <h4>PipPackagesWidget.on_userDepCheckBox_clicked</h4>
1294 <b>on_userDepCheckBox_clicked</b>(<i></i>)
1295
1296 <p>
1297 Private slot handling the switching of the 'user-site' mode.
1298 </p>
1299 <a NAME="PipPackagesWidget.on_verboseCheckBox_clicked" ID="PipPackagesWidget.on_verboseCheckBox_clicked"></a>
1300 <h4>PipPackagesWidget.on_verboseCheckBox_clicked</h4>
1301 <b>on_verboseCheckBox_clicked</b>(<i>checked</i>)
1302
1303 <p>
1304 Private slot to handle a change of the verbose package information
1305 checkbox.
1306 </p>
1307 <dl>
1308
1309 <dt><i>checked</i> (bool)</dt>
1310 <dd>
1311 state of the checkbox
1312 </dd>
1313 </dl>
1314 <a NAME="PipPackagesWidget.on_viewToggleButton_toggled" ID="PipPackagesWidget.on_viewToggleButton_toggled"></a>
1315 <h4>PipPackagesWidget.on_viewToggleButton_toggled</h4>
1316 <b>on_viewToggleButton_toggled</b>(<i>checked</i>)
1317
1318 <p>
1319 Private slot handling the view selection.
1320 </p>
1321 <dl>
1322
1323 <dt><i>checked</i> (bool)</dt>
1324 <dd>
1325 state of the toggle button
1326 </dd>
1327 </dl>
1328 <a NAME="PipPackagesWidget.on_vulnerabilityCheckBox_clicked" ID="PipPackagesWidget.on_vulnerabilityCheckBox_clicked"></a>
1329 <h4>PipPackagesWidget.on_vulnerabilityCheckBox_clicked</h4>
1330 <b>on_vulnerabilityCheckBox_clicked</b>(<i>checked</i>)
1331
1332 <p>
1333 Private slot handling a change of the automatic vulnerability checks.
1334 </p>
1335 <dl>
1336
1337 <dt><i>checked</i> (bool)</dt>
1338 <dd>
1339 flag indicating the state of the check box
1340 </dd>
1341 </dl>
1342 <div align="right"><a href="#top">Up</a></div>
1343 <hr />
1344 <hr />
1345 <a NAME="PypiSearchResultsParser" ID="PypiSearchResultsParser"></a>
1346 <h2>PypiSearchResultsParser</h2>
1347
1348 <p>
1349 Class implementing the parser for the PyPI search result page.
1350 </p>
1351 <h3>Derived from</h3>
1352 html.parser.HTMLParser
1353 <h3>Class Attributes</h3>
1354
1355 <table>
1356 <tr><td>ClassPrefix</td></tr>
1357 </table>
1358 <h3>Class Methods</h3>
1359
1360 <table>
1361 <tr><td>None</td></tr>
1362 </table>
1363 <h3>Methods</h3>
1364
1365 <table>
1366
1367 <tr>
1368 <td><a href="#PypiSearchResultsParser.__init__">PypiSearchResultsParser</a></td>
1369 <td>Constructor</td>
1370 </tr>
1371 <tr>
1372 <td><a href="#PypiSearchResultsParser.__getClass">__getClass</a></td>
1373 <td>Private method to extract the class attribute out of the list of attributes.</td>
1374 </tr>
1375 <tr>
1376 <td><a href="#PypiSearchResultsParser.__getDate">__getDate</a></td>
1377 <td>Private method to extract the datetime attribute out of the list of attributes and process it.</td>
1378 </tr>
1379 <tr>
1380 <td><a href="#PypiSearchResultsParser.getResults">getResults</a></td>
1381 <td>Public method to get the extracted search results.</td>
1382 </tr>
1383 <tr>
1384 <td><a href="#PypiSearchResultsParser.handle_data">handle_data</a></td>
1385 <td>Public method process arbitrary data.</td>
1386 </tr>
1387 <tr>
1388 <td><a href="#PypiSearchResultsParser.handle_endtag">handle_endtag</a></td>
1389 <td>Public method to process the end tag.</td>
1390 </tr>
1391 <tr>
1392 <td><a href="#PypiSearchResultsParser.handle_starttag">handle_starttag</a></td>
1393 <td>Public method to process the start tag.</td>
1394 </tr>
1395 </table>
1396 <h3>Static Methods</h3>
1397
1398 <table>
1399 <tr><td>None</td></tr>
1400 </table>
1401
1402 <a NAME="PypiSearchResultsParser.__init__" ID="PypiSearchResultsParser.__init__"></a>
1403 <h4>PypiSearchResultsParser (Constructor)</h4>
1404 <b>PypiSearchResultsParser</b>(<i>data</i>)
1405
1406 <p>
1407 Constructor
1408 </p>
1409 <dl>
1410
1411 <dt><i>data</i> (str)</dt>
1412 <dd>
1413 data to be parsed
1414 </dd>
1415 </dl>
1416 <a NAME="PypiSearchResultsParser.__getClass" ID="PypiSearchResultsParser.__getClass"></a>
1417 <h4>PypiSearchResultsParser.__getClass</h4>
1418 <b>__getClass</b>(<i>attrs</i>)
1419
1420 <p>
1421 Private method to extract the class attribute out of the list of
1422 attributes.
1423 </p>
1424 <dl>
1425
1426 <dt><i>attrs</i> (list of tuple of (str, str))</dt>
1427 <dd>
1428 list of tag attributes as (name, value) tuples
1429 </dd>
1430 </dl>
1431 <dl>
1432 <dt>Return:</dt>
1433 <dd>
1434 value of the 'class' attribute or None
1435 </dd>
1436 </dl>
1437 <dl>
1438 <dt>Return Type:</dt>
1439 <dd>
1440 str
1441 </dd>
1442 </dl>
1443 <a NAME="PypiSearchResultsParser.__getDate" ID="PypiSearchResultsParser.__getDate"></a>
1444 <h4>PypiSearchResultsParser.__getDate</h4>
1445 <b>__getDate</b>(<i>attrs</i>)
1446
1447 <p>
1448 Private method to extract the datetime attribute out of the list of
1449 attributes and process it.
1450 </p>
1451 <dl>
1452
1453 <dt><i>attrs</i> (list of tuple of (str, str))</dt>
1454 <dd>
1455 list of tag attributes as (name, value) tuples
1456 </dd>
1457 </dl>
1458 <dl>
1459 <dt>Return:</dt>
1460 <dd>
1461 value of the 'class' attribute or None
1462 </dd>
1463 </dl>
1464 <dl>
1465 <dt>Return Type:</dt>
1466 <dd>
1467 str
1468 </dd>
1469 </dl>
1470 <a NAME="PypiSearchResultsParser.getResults" ID="PypiSearchResultsParser.getResults"></a>
1471 <h4>PypiSearchResultsParser.getResults</h4>
1472 <b>getResults</b>(<i></i>)
1473
1474 <p>
1475 Public method to get the extracted search results.
1476 </p>
1477 <dl>
1478 <dt>Return:</dt>
1479 <dd>
1480 extracted result data
1481 </dd>
1482 </dl>
1483 <dl>
1484 <dt>Return Type:</dt>
1485 <dd>
1486 list of dict
1487 </dd>
1488 </dl>
1489 <a NAME="PypiSearchResultsParser.handle_data" ID="PypiSearchResultsParser.handle_data"></a>
1490 <h4>PypiSearchResultsParser.handle_data</h4>
1491 <b>handle_data</b>(<i>data</i>)
1492
1493 <p>
1494 Public method process arbitrary data.
1495 </p>
1496 <dl>
1497
1498 <dt><i>data</i> (str)</dt>
1499 <dd>
1500 data to be processed
1501 </dd>
1502 </dl>
1503 <a NAME="PypiSearchResultsParser.handle_endtag" ID="PypiSearchResultsParser.handle_endtag"></a>
1504 <h4>PypiSearchResultsParser.handle_endtag</h4>
1505 <b>handle_endtag</b>(<i>tag</i>)
1506
1507 <p>
1508 Public method to process the end tag.
1509 </p>
1510 <dl>
1511
1512 <dt><i>tag</i> (str)</dt>
1513 <dd>
1514 tag name (all lowercase)
1515 </dd>
1516 </dl>
1517 <a NAME="PypiSearchResultsParser.handle_starttag" ID="PypiSearchResultsParser.handle_starttag"></a>
1518 <h4>PypiSearchResultsParser.handle_starttag</h4>
1519 <b>handle_starttag</b>(<i>tag, attrs</i>)
1520
1521 <p>
1522 Public method to process the start tag.
1523 </p>
1524 <dl>
1525
1526 <dt><i>tag</i> (str)</dt>
1527 <dd>
1528 tag name (all lowercase)
1529 </dd>
1530 <dt><i>attrs</i> (list of tuple of (str, str))</dt>
1531 <dd>
1532 list of tag attributes as (name, value) tuples
1533 </dd>
1534 </dl>
1535 <div align="right"><a href="#top">Up</a></div>
1536 <hr />
1537 </body></html>

Mercurial Repository: eric

eric ide

mercurial