Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.PipInterface.PipPackagesWidget.html

changeset 6807
7e5eba19d86d
child 6828
bb6667ea9ae7
equal deleted inserted replaced
6806:d306647cb82d 6807:7e5eba19d86d
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.PipInterface.PipPackagesWidget</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.PipInterface.PipPackagesWidget</h1>
23 <p>
24 Module implementing the pip packages management widget.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#PipPackagesWidget">PipPackagesWidget</a></td>
34 <td>Class implementing the pip packages management widget.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="PipPackagesWidget" ID="PipPackagesWidget"></a>
43 <h2>PipPackagesWidget</h2>
44 <p>
45 Class implementing the pip packages management widget.
46 </p>
47 <h3>Derived from</h3>
48 QWidget, Ui_PipPackagesWidget
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>SearchStopwords</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>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#PipPackagesWidget.__init__">PipPackagesWidget</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#PipPackagesWidget.__aboutToShowPipMenu">__aboutToShowPipMenu</a></td>
64 <td>Private slot to set the action enabled status.</td>
65 </tr><tr>
66 <td><a href="#PipPackagesWidget.__allUpdateableItems">__allUpdateableItems</a></td>
67 <td>Private method to get a list of all items that can be updated.</td>
68 </tr><tr>
69 <td><a href="#PipPackagesWidget.__editConfiguration">__editConfiguration</a></td>
70 <td>Private method to edit a configuration.</td>
71 </tr><tr>
72 <td><a href="#PipPackagesWidget.__editUserConfiguration">__editUserConfiguration</a></td>
73 <td>Private slot to edit the user configuration.</td>
74 </tr><tr>
75 <td><a href="#PipPackagesWidget.__editVirtualenvConfiguration">__editVirtualenvConfiguration</a></td>
76 <td>Private slot to edit the configuration of the selected environment.</td>
77 </tr><tr>
78 <td><a href="#PipPackagesWidget.__executeUpgradePackages">__executeUpgradePackages</a></td>
79 <td>Private method to execute the pip upgrade command.</td>
80 </tr><tr>
81 <td><a href="#PipPackagesWidget.__finishSearch">__finishSearch</a></td>
82 <td>Private slot performing the search finishing actions.</td>
83 </tr><tr>
84 <td><a href="#PipPackagesWidget.__generateRequirements">__generateRequirements</a></td>
85 <td>Private slot to generate the contents for a requirements file.</td>
86 </tr><tr>
87 <td><a href="#PipPackagesWidget.__initPipMenu">__initPipMenu</a></td>
88 <td>Private method to create the super menu and attach it to the super menu button.</td>
89 </tr><tr>
90 <td><a href="#PipPackagesWidget.__install">__install</a></td>
91 <td>Private slot to install the selected packages.</td>
92 </tr><tr>
93 <td><a href="#PipPackagesWidget.__installLocalPackage">__installLocalPackage</a></td>
94 <td>Private slot to install a package available on local storage.</td>
95 </tr><tr>
96 <td><a href="#PipPackagesWidget.__installPackages">__installPackages</a></td>
97 <td>Private slot to install packages to be given by the user.</td>
98 </tr><tr>
99 <td><a href="#PipPackagesWidget.__installPip">__installPip</a></td>
100 <td>Private slot to install pip into the selected environment.</td>
101 </tr><tr>
102 <td><a href="#PipPackagesWidget.__installPipUser">__installPipUser</a></td>
103 <td>Private slot to install pip into the user site for the selected environment.</td>
104 </tr><tr>
105 <td><a href="#PipPackagesWidget.__installRequirements">__installRequirements</a></td>
106 <td>Private slot to install packages as given in a requirements file.</td>
107 </tr><tr>
108 <td><a href="#PipPackagesWidget.__isPipAvailable">__isPipAvailable</a></td>
109 <td>Private method to check, if the pip package is available for the selected environment.</td>
110 </tr><tr>
111 <td><a href="#PipPackagesWidget.__pipConfigure">__pipConfigure</a></td>
112 <td>Private slot to open the configuration page.</td>
113 </tr><tr>
114 <td><a href="#PipPackagesWidget.__populateEnvironments">__populateEnvironments</a></td>
115 <td>Private method to get a list of environments and populate the selector.</td>
116 </tr><tr>
117 <td><a href="#PipPackagesWidget.__processSearchResult">__processSearchResult</a></td>
118 <td>Private method to process the search result data from PyPI.</td>
119 </tr><tr>
120 <td><a href="#PipPackagesWidget.__refreshPackagesList">__refreshPackagesList</a></td>
121 <td>Private method to referesh the packages list.</td>
122 </tr><tr>
123 <td><a href="#PipPackagesWidget.__repairPip">__repairPip</a></td>
124 <td>Private slot to repair the pip installation of the selected environment.</td>
125 </tr><tr>
126 <td><a href="#PipPackagesWidget.__score">__score</a></td>
127 <td>Private method to calculate some score for a search result.</td>
128 </tr><tr>
129 <td><a href="#PipPackagesWidget.__search">__search</a></td>
130 <td>Private method to perform the search.</td>
131 </tr><tr>
132 <td><a href="#PipPackagesWidget.__searchError">__searchError</a></td>
133 <td>Private method handling a search error.</td>
134 </tr><tr>
135 <td><a href="#PipPackagesWidget.__selectedUpdateableItems">__selectedUpdateableItems</a></td>
136 <td>Private method to get a list of selected items that can be updated.</td>
137 </tr><tr>
138 <td><a href="#PipPackagesWidget.__showPackageDetails">__showPackageDetails</a></td>
139 <td>Private method to populate the package details dialog.</td>
140 </tr><tr>
141 <td><a href="#PipPackagesWidget.__showSearchedDetails">__showSearchedDetails</a></td>
142 <td>Private slot to show details about the selected search result package.</td>
143 </tr><tr>
144 <td><a href="#PipPackagesWidget.__transformHits">__transformHits</a></td>
145 <td>Private method to convert the list returned from pypi into a packages list.</td>
146 </tr><tr>
147 <td><a href="#PipPackagesWidget.__uninstallRequirements">__uninstallRequirements</a></td>
148 <td>Private slot to uninstall packages as given in a requirements file.</td>
149 </tr><tr>
150 <td><a href="#PipPackagesWidget.__updateActionButtons">__updateActionButtons</a></td>
151 <td>Private method to set the state of the action buttons.</td>
152 </tr><tr>
153 <td><a href="#PipPackagesWidget.__updateSearchActionButtons">__updateSearchActionButtons</a></td>
154 <td>Private method to update the action button states of the search widget.</td>
155 </tr><tr>
156 <td><a href="#PipPackagesWidget.__updateSearchButton">__updateSearchButton</a></td>
157 <td>Private method to update the state of the search button.</td>
158 </tr><tr>
159 <td><a href="#PipPackagesWidget.on_environmentsComboBox_currentIndexChanged">on_environmentsComboBox_currentIndexChanged</a></td>
160 <td>Private slot handling the selection of a conda environment.</td>
161 </tr><tr>
162 <td><a href="#PipPackagesWidget.on_installButton_clicked">on_installButton_clicked</a></td>
163 <td>Private slot to handle pressing the Install button..</td>
164 </tr><tr>
165 <td><a href="#PipPackagesWidget.on_installUserSiteButton_clicked">on_installUserSiteButton_clicked</a></td>
166 <td>Private slot to handle pressing the Install to User-Site button..</td>
167 </tr><tr>
168 <td><a href="#PipPackagesWidget.on_installedFilesCheckBox_clicked">on_installedFilesCheckBox_clicked</a></td>
169 <td>Private slot to handle a change of the installed files information checkbox.</td>
170 </tr><tr>
171 <td><a href="#PipPackagesWidget.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td>
172 <td>Private slot handling the switching of the local mode.</td>
173 </tr><tr>
174 <td><a href="#PipPackagesWidget.on_notRequiredCheckBox_clicked">on_notRequiredCheckBox_clicked</a></td>
175 <td>Private slot handling the switching of the 'not required' mode.</td>
176 </tr><tr>
177 <td><a href="#PipPackagesWidget.on_packagesList_itemActivated">on_packagesList_itemActivated</a></td>
178 <td>Private slot reacting on a package item activation.</td>
179 </tr><tr>
180 <td><a href="#PipPackagesWidget.on_packagesList_itemSelectionChanged">on_packagesList_itemSelectionChanged</a></td>
181 <td>Private slot handling the selection of a package.</td>
182 </tr><tr>
183 <td><a href="#PipPackagesWidget.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
184 <td>Private slot to refresh the display.</td>
185 </tr><tr>
186 <td><a href="#PipPackagesWidget.on_searchButton_clicked">on_searchButton_clicked</a></td>
187 <td>Private slot handling a press of the search button.</td>
188 </tr><tr>
189 <td><a href="#PipPackagesWidget.on_searchEditName_returnPressed">on_searchEditName_returnPressed</a></td>
190 <td>Private slot initiating a search via a press of the Return key.</td>
191 </tr><tr>
192 <td><a href="#PipPackagesWidget.on_searchEditName_textChanged">on_searchEditName_textChanged</a></td>
193 <td>Private slot handling a change of the search term.</td>
194 </tr><tr>
195 <td><a href="#PipPackagesWidget.on_searchEditSummary_returnPressed">on_searchEditSummary_returnPressed</a></td>
196 <td>Private slot initiating a search via a press of the Return key.</td>
197 </tr><tr>
198 <td><a href="#PipPackagesWidget.on_searchEditSummary_textChanged">on_searchEditSummary_textChanged</a></td>
199 <td>Private slot handling a change of the search term.</td>
200 </tr><tr>
201 <td><a href="#PipPackagesWidget.on_searchResultList_itemActivated">on_searchResultList_itemActivated</a></td>
202 <td>Private slot reacting on an search result item activation.</td>
203 </tr><tr>
204 <td><a href="#PipPackagesWidget.on_searchResultList_itemSelectionChanged">on_searchResultList_itemSelectionChanged</a></td>
205 <td>Private slot handling changes of the search result selection.</td>
206 </tr><tr>
207 <td><a href="#PipPackagesWidget.on_searchToggleButton_toggled">on_searchToggleButton_toggled</a></td>
208 <td>Private slot to togle the search widget.</td>
209 </tr><tr>
210 <td><a href="#PipPackagesWidget.on_showDetailsButton_clicked">on_showDetailsButton_clicked</a></td>
211 <td>Private slot to handle pressing the Show Details button.</td>
212 </tr><tr>
213 <td><a href="#PipPackagesWidget.on_showPackageDetailsButton_clicked">on_showPackageDetailsButton_clicked</a></td>
214 <td>Private slot to show information for the selected package.</td>
215 </tr><tr>
216 <td><a href="#PipPackagesWidget.on_uninstallButton_clicked">on_uninstallButton_clicked</a></td>
217 <td>Private slot to remove selected packages of the selected environment.</td>
218 </tr><tr>
219 <td><a href="#PipPackagesWidget.on_upgradeAllButton_clicked">on_upgradeAllButton_clicked</a></td>
220 <td>Private slot to upgrade all packages of the selected environment.</td>
221 </tr><tr>
222 <td><a href="#PipPackagesWidget.on_upgradeButton_clicked">on_upgradeButton_clicked</a></td>
223 <td>Private slot to upgrade selected packages of the selected environment.</td>
224 </tr><tr>
225 <td><a href="#PipPackagesWidget.on_userCheckBox_clicked">on_userCheckBox_clicked</a></td>
226 <td>Private slot handling the switching of the 'user-site' mode.</td>
227 </tr><tr>
228 <td><a href="#PipPackagesWidget.on_verboseCheckBox_clicked">on_verboseCheckBox_clicked</a></td>
229 <td>Private slot to handle a change of the verbose package information checkbox.</td>
230 </tr>
231 </table>
232 <h3>Static Methods</h3>
233 <table>
234 <tr><td>None</td></tr>
235 </table>
236 <a NAME="PipPackagesWidget.__init__" ID="PipPackagesWidget.__init__"></a>
237 <h4>PipPackagesWidget (Constructor)</h4>
238 <b>PipPackagesWidget</b>(<i>parent=None</i>)
239 <p>
240 Constructor
241 </p><dl>
242 <dt><i>parent</i> (QWidget)</dt>
243 <dd>
244 reference to the parent widget
245 </dd>
246 </dl><a NAME="PipPackagesWidget.__aboutToShowPipMenu" ID="PipPackagesWidget.__aboutToShowPipMenu"></a>
247 <h4>PipPackagesWidget.__aboutToShowPipMenu</h4>
248 <b>__aboutToShowPipMenu</b>(<i></i>)
249 <p>
250 Private slot to set the action enabled status.
251 </p><a NAME="PipPackagesWidget.__allUpdateableItems" ID="PipPackagesWidget.__allUpdateableItems"></a>
252 <h4>PipPackagesWidget.__allUpdateableItems</h4>
253 <b>__allUpdateableItems</b>(<i></i>)
254 <p>
255 Private method to get a list of all items that can be updated.
256 </p><dl>
257 <dt>Returns:</dt>
258 <dd>
259 list of all items that can be updated
260 </dd>
261 </dl><dl>
262 <dt>Return Type:</dt>
263 <dd>
264 list of QTreeWidgetItem
265 </dd>
266 </dl><a NAME="PipPackagesWidget.__editConfiguration" ID="PipPackagesWidget.__editConfiguration"></a>
267 <h4>PipPackagesWidget.__editConfiguration</h4>
268 <b>__editConfiguration</b>(<i>venvName=""</i>)
269 <p>
270 Private method to edit a configuration.
271 </p><dl>
272 <dt><i>venvName</i> (str)</dt>
273 <dd>
274 name of the environment to act upon
275 </dd>
276 </dl><a NAME="PipPackagesWidget.__editUserConfiguration" ID="PipPackagesWidget.__editUserConfiguration"></a>
277 <h4>PipPackagesWidget.__editUserConfiguration</h4>
278 <b>__editUserConfiguration</b>(<i></i>)
279 <p>
280 Private slot to edit the user configuration.
281 </p><a NAME="PipPackagesWidget.__editVirtualenvConfiguration" ID="PipPackagesWidget.__editVirtualenvConfiguration"></a>
282 <h4>PipPackagesWidget.__editVirtualenvConfiguration</h4>
283 <b>__editVirtualenvConfiguration</b>(<i></i>)
284 <p>
285 Private slot to edit the configuration of the selected environment.
286 </p><a NAME="PipPackagesWidget.__executeUpgradePackages" ID="PipPackagesWidget.__executeUpgradePackages"></a>
287 <h4>PipPackagesWidget.__executeUpgradePackages</h4>
288 <b>__executeUpgradePackages</b>(<i>packages</i>)
289 <p>
290 Private method to execute the pip upgrade command.
291 </p><dl>
292 <dt><i>packages</i> (list of str)</dt>
293 <dd>
294 list of package names to be upgraded
295 </dd>
296 </dl><dl>
297 <dt>Returns:</dt>
298 <dd>
299 flag indicating success
300 </dd>
301 </dl><dl>
302 <dt>Return Type:</dt>
303 <dd>
304 bool
305 </dd>
306 </dl><a NAME="PipPackagesWidget.__finishSearch" ID="PipPackagesWidget.__finishSearch"></a>
307 <h4>PipPackagesWidget.__finishSearch</h4>
308 <b>__finishSearch</b>(<i></i>)
309 <p>
310 Private slot performing the search finishing actions.
311 </p><a NAME="PipPackagesWidget.__generateRequirements" ID="PipPackagesWidget.__generateRequirements"></a>
312 <h4>PipPackagesWidget.__generateRequirements</h4>
313 <b>__generateRequirements</b>(<i></i>)
314 <p>
315 Private slot to generate the contents for a requirements file.
316 </p><a NAME="PipPackagesWidget.__initPipMenu" ID="PipPackagesWidget.__initPipMenu"></a>
317 <h4>PipPackagesWidget.__initPipMenu</h4>
318 <b>__initPipMenu</b>(<i></i>)
319 <p>
320 Private method to create the super menu and attach it to the super
321 menu button.
322 </p><a NAME="PipPackagesWidget.__install" ID="PipPackagesWidget.__install"></a>
323 <h4>PipPackagesWidget.__install</h4>
324 <b>__install</b>(<i>userSite=False</i>)
325 <p>
326 Private slot to install the selected packages.
327 </p><dl>
328 <dt><i>userSite</i> (bool)</dt>
329 <dd>
330 flag indicating to install to the user directory
331 </dd>
332 </dl><a NAME="PipPackagesWidget.__installLocalPackage" ID="PipPackagesWidget.__installLocalPackage"></a>
333 <h4>PipPackagesWidget.__installLocalPackage</h4>
334 <b>__installLocalPackage</b>(<i></i>)
335 <p>
336 Private slot to install a package available on local storage.
337 </p><a NAME="PipPackagesWidget.__installPackages" ID="PipPackagesWidget.__installPackages"></a>
338 <h4>PipPackagesWidget.__installPackages</h4>
339 <b>__installPackages</b>(<i></i>)
340 <p>
341 Private slot to install packages to be given by the user.
342 </p><a NAME="PipPackagesWidget.__installPip" ID="PipPackagesWidget.__installPip"></a>
343 <h4>PipPackagesWidget.__installPip</h4>
344 <b>__installPip</b>(<i></i>)
345 <p>
346 Private slot to install pip into the selected environment.
347 </p><a NAME="PipPackagesWidget.__installPipUser" ID="PipPackagesWidget.__installPipUser"></a>
348 <h4>PipPackagesWidget.__installPipUser</h4>
349 <b>__installPipUser</b>(<i></i>)
350 <p>
351 Private slot to install pip into the user site for the selected
352 environment.
353 </p><a NAME="PipPackagesWidget.__installRequirements" ID="PipPackagesWidget.__installRequirements"></a>
354 <h4>PipPackagesWidget.__installRequirements</h4>
355 <b>__installRequirements</b>(<i></i>)
356 <p>
357 Private slot to install packages as given in a requirements file.
358 </p><a NAME="PipPackagesWidget.__isPipAvailable" ID="PipPackagesWidget.__isPipAvailable"></a>
359 <h4>PipPackagesWidget.__isPipAvailable</h4>
360 <b>__isPipAvailable</b>(<i></i>)
361 <p>
362 Private method to check, if the pip package is available for the
363 selected environment.
364 </p><dl>
365 <dt>Returns:</dt>
366 <dd>
367 flag indicating availability
368 </dd>
369 </dl><dl>
370 <dt>Return Type:</dt>
371 <dd>
372 bool
373 </dd>
374 </dl><a NAME="PipPackagesWidget.__pipConfigure" ID="PipPackagesWidget.__pipConfigure"></a>
375 <h4>PipPackagesWidget.__pipConfigure</h4>
376 <b>__pipConfigure</b>(<i></i>)
377 <p>
378 Private slot to open the configuration page.
379 </p><a NAME="PipPackagesWidget.__populateEnvironments" ID="PipPackagesWidget.__populateEnvironments"></a>
380 <h4>PipPackagesWidget.__populateEnvironments</h4>
381 <b>__populateEnvironments</b>(<i></i>)
382 <p>
383 Private method to get a list of environments and populate the selector.
384 </p><a NAME="PipPackagesWidget.__processSearchResult" ID="PipPackagesWidget.__processSearchResult"></a>
385 <h4>PipPackagesWidget.__processSearchResult</h4>
386 <b>__processSearchResult</b>(<i>data</i>)
387 <p>
388 Private method to process the search result data from PyPI.
389 </p><dl>
390 <dt><i>data</i> (tuple)</dt>
391 <dd>
392 result data with hits in the first element
393 </dd>
394 </dl><a NAME="PipPackagesWidget.__refreshPackagesList" ID="PipPackagesWidget.__refreshPackagesList"></a>
395 <h4>PipPackagesWidget.__refreshPackagesList</h4>
396 <b>__refreshPackagesList</b>(<i></i>)
397 <p>
398 Private method to referesh the packages list.
399 </p><a NAME="PipPackagesWidget.__repairPip" ID="PipPackagesWidget.__repairPip"></a>
400 <h4>PipPackagesWidget.__repairPip</h4>
401 <b>__repairPip</b>(<i></i>)
402 <p>
403 Private slot to repair the pip installation of the selected
404 environment.
405 </p><a NAME="PipPackagesWidget.__score" ID="PipPackagesWidget.__score"></a>
406 <h4>PipPackagesWidget.__score</h4>
407 <b>__score</b>(<i>name, summary</i>)
408 <p>
409 Private method to calculate some score for a search result.
410 </p><dl>
411 <dt><i>name</i> (str)</dt>
412 <dd>
413 name of the returned package
414 </dd><dt><i>summary</i> (str)</dt>
415 <dd>
416 summary text for the package
417 </dd>
418 </dl><dl>
419 <dt>Returns:</dt>
420 <dd>
421 score value
422 </dd>
423 </dl><dl>
424 <dt>Return Type:</dt>
425 <dd>
426 int
427 </dd>
428 </dl><a NAME="PipPackagesWidget.__search" ID="PipPackagesWidget.__search"></a>
429 <h4>PipPackagesWidget.__search</h4>
430 <b>__search</b>(<i></i>)
431 <p>
432 Private method to perform the search.
433 </p><a NAME="PipPackagesWidget.__searchError" ID="PipPackagesWidget.__searchError"></a>
434 <h4>PipPackagesWidget.__searchError</h4>
435 <b>__searchError</b>(<i>errorCode, errorString</i>)
436 <p>
437 Private method handling a search error.
438 </p><dl>
439 <dt><i>errorCode</i> (int)</dt>
440 <dd>
441 code of the error
442 </dd><dt><i>errorString</i> (str)</dt>
443 <dd>
444 error message
445 </dd>
446 </dl><a NAME="PipPackagesWidget.__selectedUpdateableItems" ID="PipPackagesWidget.__selectedUpdateableItems"></a>
447 <h4>PipPackagesWidget.__selectedUpdateableItems</h4>
448 <b>__selectedUpdateableItems</b>(<i></i>)
449 <p>
450 Private method to get a list of selected items that can be updated.
451 </p><dl>
452 <dt>Returns:</dt>
453 <dd>
454 list of selected items that can be updated
455 </dd>
456 </dl><dl>
457 <dt>Return Type:</dt>
458 <dd>
459 list of QTreeWidgetItem
460 </dd>
461 </dl><a NAME="PipPackagesWidget.__showPackageDetails" ID="PipPackagesWidget.__showPackageDetails"></a>
462 <h4>PipPackagesWidget.__showPackageDetails</h4>
463 <b>__showPackageDetails</b>(<i>packageName, packageVersion</i>)
464 <p>
465 Private method to populate the package details dialog.
466 </p><dl>
467 <dt><i>packageName</i> (str)</dt>
468 <dd>
469 name of the package to show details for
470 </dd><dt><i>packageVersion</i> (str)</dt>
471 <dd>
472 version of the package
473 </dd>
474 </dl><a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a>
475 <h4>PipPackagesWidget.__showSearchedDetails</h4>
476 <b>__showSearchedDetails</b>(<i>item=None</i>)
477 <p>
478 Private slot to show details about the selected search result package.
479 </p><dl>
480 <dt><i>item</i> (QTreeWidgetItem)</dt>
481 <dd>
482 reference to the search result item to show details for
483 </dd>
484 </dl><a NAME="PipPackagesWidget.__transformHits" ID="PipPackagesWidget.__transformHits"></a>
485 <h4>PipPackagesWidget.__transformHits</h4>
486 <b>__transformHits</b>(<i>hits</i>)
487 <p>
488 Private method to convert the list returned from pypi into a
489 packages list.
490 </p><dl>
491 <dt><i>hits</i> (list of dict)</dt>
492 <dd>
493 list returned from pypi
494 </dd>
495 </dl><dl>
496 <dt>Returns:</dt>
497 <dd>
498 list of packages
499 </dd>
500 </dl><dl>
501 <dt>Return Type:</dt>
502 <dd>
503 list of dict
504 </dd>
505 </dl><a NAME="PipPackagesWidget.__uninstallRequirements" ID="PipPackagesWidget.__uninstallRequirements"></a>
506 <h4>PipPackagesWidget.__uninstallRequirements</h4>
507 <b>__uninstallRequirements</b>(<i></i>)
508 <p>
509 Private slot to uninstall packages as given in a requirements file.
510 </p><a NAME="PipPackagesWidget.__updateActionButtons" ID="PipPackagesWidget.__updateActionButtons"></a>
511 <h4>PipPackagesWidget.__updateActionButtons</h4>
512 <b>__updateActionButtons</b>(<i></i>)
513 <p>
514 Private method to set the state of the action buttons.
515 </p><a NAME="PipPackagesWidget.__updateSearchActionButtons" ID="PipPackagesWidget.__updateSearchActionButtons"></a>
516 <h4>PipPackagesWidget.__updateSearchActionButtons</h4>
517 <b>__updateSearchActionButtons</b>(<i></i>)
518 <p>
519 Private method to update the action button states of the search widget.
520 </p><a NAME="PipPackagesWidget.__updateSearchButton" ID="PipPackagesWidget.__updateSearchButton"></a>
521 <h4>PipPackagesWidget.__updateSearchButton</h4>
522 <b>__updateSearchButton</b>(<i></i>)
523 <p>
524 Private method to update the state of the search button.
525 </p><a NAME="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged" ID="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged"></a>
526 <h4>PipPackagesWidget.on_environmentsComboBox_currentIndexChanged</h4>
527 <b>on_environmentsComboBox_currentIndexChanged</b>(<i>index</i>)
528 <p>
529 Private slot handling the selection of a conda environment.
530 </p><dl>
531 <dt><i>index</i> (int)</dt>
532 <dd>
533 index of the selected conda environment
534 </dd>
535 </dl><a NAME="PipPackagesWidget.on_installButton_clicked" ID="PipPackagesWidget.on_installButton_clicked"></a>
536 <h4>PipPackagesWidget.on_installButton_clicked</h4>
537 <b>on_installButton_clicked</b>(<i></i>)
538 <p>
539 Private slot to handle pressing the Install button..
540 </p><a NAME="PipPackagesWidget.on_installUserSiteButton_clicked" ID="PipPackagesWidget.on_installUserSiteButton_clicked"></a>
541 <h4>PipPackagesWidget.on_installUserSiteButton_clicked</h4>
542 <b>on_installUserSiteButton_clicked</b>(<i></i>)
543 <p>
544 Private slot to handle pressing the Install to User-Site button..
545 </p><a NAME="PipPackagesWidget.on_installedFilesCheckBox_clicked" ID="PipPackagesWidget.on_installedFilesCheckBox_clicked"></a>
546 <h4>PipPackagesWidget.on_installedFilesCheckBox_clicked</h4>
547 <b>on_installedFilesCheckBox_clicked</b>(<i>checked</i>)
548 <p>
549 Private slot to handle a change of the installed files information
550 checkbox.
551 </p><dl>
552 <dt><i>checked</i> (bool)</dt>
553 <dd>
554 state of the checkbox
555 </dd>
556 </dl><a NAME="PipPackagesWidget.on_localCheckBox_clicked" ID="PipPackagesWidget.on_localCheckBox_clicked"></a>
557 <h4>PipPackagesWidget.on_localCheckBox_clicked</h4>
558 <b>on_localCheckBox_clicked</b>(<i>checked</i>)
559 <p>
560 Private slot handling the switching of the local mode.
561 </p><dl>
562 <dt><i>checked</i> (bool)</dt>
563 <dd>
564 state of the local check box
565 </dd>
566 </dl><a NAME="PipPackagesWidget.on_notRequiredCheckBox_clicked" ID="PipPackagesWidget.on_notRequiredCheckBox_clicked"></a>
567 <h4>PipPackagesWidget.on_notRequiredCheckBox_clicked</h4>
568 <b>on_notRequiredCheckBox_clicked</b>(<i>checked</i>)
569 <p>
570 Private slot handling the switching of the 'not required' mode.
571 </p><dl>
572 <dt><i>checked</i> (bool)</dt>
573 <dd>
574 state of the 'not required' check box
575 </dd>
576 </dl><a NAME="PipPackagesWidget.on_packagesList_itemActivated" ID="PipPackagesWidget.on_packagesList_itemActivated"></a>
577 <h4>PipPackagesWidget.on_packagesList_itemActivated</h4>
578 <b>on_packagesList_itemActivated</b>(<i>item, column</i>)
579 <p>
580 Private slot reacting on a package item activation.
581 </p><dl>
582 <dt><i>item</i> (QTreeWidgetItem)</dt>
583 <dd>
584 reference to the activated item
585 </dd><dt><i>column</i> (int)</dt>
586 <dd>
587 activated column
588 </dd>
589 </dl><a NAME="PipPackagesWidget.on_packagesList_itemSelectionChanged" ID="PipPackagesWidget.on_packagesList_itemSelectionChanged"></a>
590 <h4>PipPackagesWidget.on_packagesList_itemSelectionChanged</h4>
591 <b>on_packagesList_itemSelectionChanged</b>(<i></i>)
592 <p>
593 Private slot handling the selection of a package.
594 </p><a NAME="PipPackagesWidget.on_refreshButton_clicked" ID="PipPackagesWidget.on_refreshButton_clicked"></a>
595 <h4>PipPackagesWidget.on_refreshButton_clicked</h4>
596 <b>on_refreshButton_clicked</b>(<i></i>)
597 <p>
598 Private slot to refresh the display.
599 </p><a NAME="PipPackagesWidget.on_searchButton_clicked" ID="PipPackagesWidget.on_searchButton_clicked"></a>
600 <h4>PipPackagesWidget.on_searchButton_clicked</h4>
601 <b>on_searchButton_clicked</b>(<i></i>)
602 <p>
603 Private slot handling a press of the search button.
604 </p><a NAME="PipPackagesWidget.on_searchEditName_returnPressed" ID="PipPackagesWidget.on_searchEditName_returnPressed"></a>
605 <h4>PipPackagesWidget.on_searchEditName_returnPressed</h4>
606 <b>on_searchEditName_returnPressed</b>(<i></i>)
607 <p>
608 Private slot initiating a search via a press of the Return key.
609 </p><a NAME="PipPackagesWidget.on_searchEditName_textChanged" ID="PipPackagesWidget.on_searchEditName_textChanged"></a>
610 <h4>PipPackagesWidget.on_searchEditName_textChanged</h4>
611 <b>on_searchEditName_textChanged</b>(<i>txt</i>)
612 <p>
613 Private slot handling a change of the search term.
614 </p><dl>
615 <dt><i>txt</i> (str)</dt>
616 <dd>
617 search term
618 </dd>
619 </dl><a NAME="PipPackagesWidget.on_searchEditSummary_returnPressed" ID="PipPackagesWidget.on_searchEditSummary_returnPressed"></a>
620 <h4>PipPackagesWidget.on_searchEditSummary_returnPressed</h4>
621 <b>on_searchEditSummary_returnPressed</b>(<i></i>)
622 <p>
623 Private slot initiating a search via a press of the Return key.
624 </p><a NAME="PipPackagesWidget.on_searchEditSummary_textChanged" ID="PipPackagesWidget.on_searchEditSummary_textChanged"></a>
625 <h4>PipPackagesWidget.on_searchEditSummary_textChanged</h4>
626 <b>on_searchEditSummary_textChanged</b>(<i>txt</i>)
627 <p>
628 Private slot handling a change of the search term.
629 </p><dl>
630 <dt><i>txt</i> (str)</dt>
631 <dd>
632 search term
633 </dd>
634 </dl><a NAME="PipPackagesWidget.on_searchResultList_itemActivated" ID="PipPackagesWidget.on_searchResultList_itemActivated"></a>
635 <h4>PipPackagesWidget.on_searchResultList_itemActivated</h4>
636 <b>on_searchResultList_itemActivated</b>(<i>item, column</i>)
637 <p>
638 Private slot reacting on an search result item activation.
639 </p><dl>
640 <dt><i>item</i> (QTreeWidgetItem)</dt>
641 <dd>
642 reference to the activated item
643 </dd><dt><i>column</i> (int)</dt>
644 <dd>
645 activated column
646 </dd>
647 </dl><a NAME="PipPackagesWidget.on_searchResultList_itemSelectionChanged" ID="PipPackagesWidget.on_searchResultList_itemSelectionChanged"></a>
648 <h4>PipPackagesWidget.on_searchResultList_itemSelectionChanged</h4>
649 <b>on_searchResultList_itemSelectionChanged</b>(<i></i>)
650 <p>
651 Private slot handling changes of the search result selection.
652 </p><a NAME="PipPackagesWidget.on_searchToggleButton_toggled" ID="PipPackagesWidget.on_searchToggleButton_toggled"></a>
653 <h4>PipPackagesWidget.on_searchToggleButton_toggled</h4>
654 <b>on_searchToggleButton_toggled</b>(<i>checked</i>)
655 <p>
656 Private slot to togle the search widget.
657 </p><dl>
658 <dt><i>checked</i> (bool)</dt>
659 <dd>
660 state of the search widget button
661 </dd>
662 </dl><a NAME="PipPackagesWidget.on_showDetailsButton_clicked" ID="PipPackagesWidget.on_showDetailsButton_clicked"></a>
663 <h4>PipPackagesWidget.on_showDetailsButton_clicked</h4>
664 <b>on_showDetailsButton_clicked</b>(<i></i>)
665 <p>
666 Private slot to handle pressing the Show Details button.
667 </p><a NAME="PipPackagesWidget.on_showPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showPackageDetailsButton_clicked"></a>
668 <h4>PipPackagesWidget.on_showPackageDetailsButton_clicked</h4>
669 <b>on_showPackageDetailsButton_clicked</b>(<i></i>)
670 <p>
671 Private slot to show information for the selected package.
672 </p><a NAME="PipPackagesWidget.on_uninstallButton_clicked" ID="PipPackagesWidget.on_uninstallButton_clicked"></a>
673 <h4>PipPackagesWidget.on_uninstallButton_clicked</h4>
674 <b>on_uninstallButton_clicked</b>(<i></i>)
675 <p>
676 Private slot to remove selected packages of the selected environment.
677 </p><a NAME="PipPackagesWidget.on_upgradeAllButton_clicked" ID="PipPackagesWidget.on_upgradeAllButton_clicked"></a>
678 <h4>PipPackagesWidget.on_upgradeAllButton_clicked</h4>
679 <b>on_upgradeAllButton_clicked</b>(<i></i>)
680 <p>
681 Private slot to upgrade all packages of the selected environment.
682 </p><a NAME="PipPackagesWidget.on_upgradeButton_clicked" ID="PipPackagesWidget.on_upgradeButton_clicked"></a>
683 <h4>PipPackagesWidget.on_upgradeButton_clicked</h4>
684 <b>on_upgradeButton_clicked</b>(<i></i>)
685 <p>
686 Private slot to upgrade selected packages of the selected environment.
687 </p><a NAME="PipPackagesWidget.on_userCheckBox_clicked" ID="PipPackagesWidget.on_userCheckBox_clicked"></a>
688 <h4>PipPackagesWidget.on_userCheckBox_clicked</h4>
689 <b>on_userCheckBox_clicked</b>(<i>checked</i>)
690 <p>
691 Private slot handling the switching of the 'user-site' mode.
692 </p><dl>
693 <dt><i>checked</i> (bool)</dt>
694 <dd>
695 state of the 'user-site' check box
696 </dd>
697 </dl><a NAME="PipPackagesWidget.on_verboseCheckBox_clicked" ID="PipPackagesWidget.on_verboseCheckBox_clicked"></a>
698 <h4>PipPackagesWidget.on_verboseCheckBox_clicked</h4>
699 <b>on_verboseCheckBox_clicked</b>(<i>checked</i>)
700 <p>
701 Private slot to handle a change of the verbose package information
702 checkbox.
703 </p><dl>
704 <dt><i>checked</i> (bool)</dt>
705 <dd>
706 state of the checkbox
707 </dd>
708 </dl>
709 <div align="right"><a href="#top">Up</a></div>
710 <hr />
711 </body></html>

Mercurial Repository: eric

eric ide

mercurial