Mercurial Repositories > eric / file comparison

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

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

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7245
b47179fbb9d8
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
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>pip, parent=None</i>)
239 <p>
240 Constructor
241 </p><dl>
242 <dt><i>pip</i> (Pip)</dt>
243 <dd>
244 reference to the global pip interface
245 </dd><dt><i>parent</i> (QWidget)</dt>
246 <dd>
247 reference to the parent widget
248 </dd>
249 </dl><a NAME="PipPackagesWidget.__aboutToShowPipMenu" ID="PipPackagesWidget.__aboutToShowPipMenu"></a>
250 <h4>PipPackagesWidget.__aboutToShowPipMenu</h4>
251 <b>__aboutToShowPipMenu</b>(<i></i>)
252 <p>
253 Private slot to set the action enabled status.
254 </p><a NAME="PipPackagesWidget.__allUpdateableItems" ID="PipPackagesWidget.__allUpdateableItems"></a>
255 <h4>PipPackagesWidget.__allUpdateableItems</h4>
256 <b>__allUpdateableItems</b>(<i></i>)
257 <p>
258 Private method to get a list of all items that can be updated.
259 </p><dl>
260 <dt>Returns:</dt>
261 <dd>
262 list of all items that can be updated
263 </dd>
264 </dl><dl>
265 <dt>Return Type:</dt>
266 <dd>
267 list of QTreeWidgetItem
268 </dd>
269 </dl><a NAME="PipPackagesWidget.__editConfiguration" ID="PipPackagesWidget.__editConfiguration"></a>
270 <h4>PipPackagesWidget.__editConfiguration</h4>
271 <b>__editConfiguration</b>(<i>venvName=""</i>)
272 <p>
273 Private method to edit a configuration.
274 </p><dl>
275 <dt><i>venvName</i> (str)</dt>
276 <dd>
277 name of the environment to act upon
278 </dd>
279 </dl><a NAME="PipPackagesWidget.__editUserConfiguration" ID="PipPackagesWidget.__editUserConfiguration"></a>
280 <h4>PipPackagesWidget.__editUserConfiguration</h4>
281 <b>__editUserConfiguration</b>(<i></i>)
282 <p>
283 Private slot to edit the user configuration.
284 </p><a NAME="PipPackagesWidget.__editVirtualenvConfiguration" ID="PipPackagesWidget.__editVirtualenvConfiguration"></a>
285 <h4>PipPackagesWidget.__editVirtualenvConfiguration</h4>
286 <b>__editVirtualenvConfiguration</b>(<i></i>)
287 <p>
288 Private slot to edit the configuration of the selected environment.
289 </p><a NAME="PipPackagesWidget.__executeUpgradePackages" ID="PipPackagesWidget.__executeUpgradePackages"></a>
290 <h4>PipPackagesWidget.__executeUpgradePackages</h4>
291 <b>__executeUpgradePackages</b>(<i>packages</i>)
292 <p>
293 Private method to execute the pip upgrade command.
294 </p><dl>
295 <dt><i>packages</i> (list of str)</dt>
296 <dd>
297 list of package names to be upgraded
298 </dd>
299 </dl><dl>
300 <dt>Returns:</dt>
301 <dd>
302 flag indicating success
303 </dd>
304 </dl><dl>
305 <dt>Return Type:</dt>
306 <dd>
307 bool
308 </dd>
309 </dl><a NAME="PipPackagesWidget.__finishSearch" ID="PipPackagesWidget.__finishSearch"></a>
310 <h4>PipPackagesWidget.__finishSearch</h4>
311 <b>__finishSearch</b>(<i></i>)
312 <p>
313 Private slot performing the search finishing actions.
314 </p><a NAME="PipPackagesWidget.__generateRequirements" ID="PipPackagesWidget.__generateRequirements"></a>
315 <h4>PipPackagesWidget.__generateRequirements</h4>
316 <b>__generateRequirements</b>(<i></i>)
317 <p>
318 Private slot to generate the contents for a requirements file.
319 </p><a NAME="PipPackagesWidget.__initPipMenu" ID="PipPackagesWidget.__initPipMenu"></a>
320 <h4>PipPackagesWidget.__initPipMenu</h4>
321 <b>__initPipMenu</b>(<i></i>)
322 <p>
323 Private method to create the super menu and attach it to the super
324 menu button.
325 </p><a NAME="PipPackagesWidget.__install" ID="PipPackagesWidget.__install"></a>
326 <h4>PipPackagesWidget.__install</h4>
327 <b>__install</b>(<i>userSite=False</i>)
328 <p>
329 Private slot to install the selected packages.
330 </p><dl>
331 <dt><i>userSite</i> (bool)</dt>
332 <dd>
333 flag indicating to install to the user directory
334 </dd>
335 </dl><a NAME="PipPackagesWidget.__installLocalPackage" ID="PipPackagesWidget.__installLocalPackage"></a>
336 <h4>PipPackagesWidget.__installLocalPackage</h4>
337 <b>__installLocalPackage</b>(<i></i>)
338 <p>
339 Private slot to install a package available on local storage.
340 </p><a NAME="PipPackagesWidget.__installPackages" ID="PipPackagesWidget.__installPackages"></a>
341 <h4>PipPackagesWidget.__installPackages</h4>
342 <b>__installPackages</b>(<i></i>)
343 <p>
344 Private slot to install packages to be given by the user.
345 </p><a NAME="PipPackagesWidget.__installPip" ID="PipPackagesWidget.__installPip"></a>
346 <h4>PipPackagesWidget.__installPip</h4>
347 <b>__installPip</b>(<i></i>)
348 <p>
349 Private slot to install pip into the selected environment.
350 </p><a NAME="PipPackagesWidget.__installPipUser" ID="PipPackagesWidget.__installPipUser"></a>
351 <h4>PipPackagesWidget.__installPipUser</h4>
352 <b>__installPipUser</b>(<i></i>)
353 <p>
354 Private slot to install pip into the user site for the selected
355 environment.
356 </p><a NAME="PipPackagesWidget.__installRequirements" ID="PipPackagesWidget.__installRequirements"></a>
357 <h4>PipPackagesWidget.__installRequirements</h4>
358 <b>__installRequirements</b>(<i></i>)
359 <p>
360 Private slot to install packages as given in a requirements file.
361 </p><a NAME="PipPackagesWidget.__isPipAvailable" ID="PipPackagesWidget.__isPipAvailable"></a>
362 <h4>PipPackagesWidget.__isPipAvailable</h4>
363 <b>__isPipAvailable</b>(<i></i>)
364 <p>
365 Private method to check, if the pip package is available for the
366 selected environment.
367 </p><dl>
368 <dt>Returns:</dt>
369 <dd>
370 flag indicating availability
371 </dd>
372 </dl><dl>
373 <dt>Return Type:</dt>
374 <dd>
375 bool
376 </dd>
377 </dl><a NAME="PipPackagesWidget.__pipConfigure" ID="PipPackagesWidget.__pipConfigure"></a>
378 <h4>PipPackagesWidget.__pipConfigure</h4>
379 <b>__pipConfigure</b>(<i></i>)
380 <p>
381 Private slot to open the configuration page.
382 </p><a NAME="PipPackagesWidget.__populateEnvironments" ID="PipPackagesWidget.__populateEnvironments"></a>
383 <h4>PipPackagesWidget.__populateEnvironments</h4>
384 <b>__populateEnvironments</b>(<i></i>)
385 <p>
386 Private method to get a list of environments and populate the selector.
387 </p><a NAME="PipPackagesWidget.__processSearchResult" ID="PipPackagesWidget.__processSearchResult"></a>
388 <h4>PipPackagesWidget.__processSearchResult</h4>
389 <b>__processSearchResult</b>(<i>data</i>)
390 <p>
391 Private method to process the search result data from PyPI.
392 </p><dl>
393 <dt><i>data</i> (tuple)</dt>
394 <dd>
395 result data with hits in the first element
396 </dd>
397 </dl><a NAME="PipPackagesWidget.__refreshPackagesList" ID="PipPackagesWidget.__refreshPackagesList"></a>
398 <h4>PipPackagesWidget.__refreshPackagesList</h4>
399 <b>__refreshPackagesList</b>(<i></i>)
400 <p>
401 Private method to referesh the packages list.
402 </p><a NAME="PipPackagesWidget.__repairPip" ID="PipPackagesWidget.__repairPip"></a>
403 <h4>PipPackagesWidget.__repairPip</h4>
404 <b>__repairPip</b>(<i></i>)
405 <p>
406 Private slot to repair the pip installation of the selected
407 environment.
408 </p><a NAME="PipPackagesWidget.__score" ID="PipPackagesWidget.__score"></a>
409 <h4>PipPackagesWidget.__score</h4>
410 <b>__score</b>(<i>name, summary</i>)
411 <p>
412 Private method to calculate some score for a search result.
413 </p><dl>
414 <dt><i>name</i> (str)</dt>
415 <dd>
416 name of the returned package
417 </dd><dt><i>summary</i> (str)</dt>
418 <dd>
419 summary text for the package
420 </dd>
421 </dl><dl>
422 <dt>Returns:</dt>
423 <dd>
424 score value
425 </dd>
426 </dl><dl>
427 <dt>Return Type:</dt>
428 <dd>
429 int
430 </dd>
431 </dl><a NAME="PipPackagesWidget.__search" ID="PipPackagesWidget.__search"></a>
432 <h4>PipPackagesWidget.__search</h4>
433 <b>__search</b>(<i></i>)
434 <p>
435 Private method to perform the search.
436 </p><a NAME="PipPackagesWidget.__searchError" ID="PipPackagesWidget.__searchError"></a>
437 <h4>PipPackagesWidget.__searchError</h4>
438 <b>__searchError</b>(<i>errorCode, errorString</i>)
439 <p>
440 Private method handling a search error.
441 </p><dl>
442 <dt><i>errorCode</i> (int)</dt>
443 <dd>
444 code of the error
445 </dd><dt><i>errorString</i> (str)</dt>
446 <dd>
447 error message
448 </dd>
449 </dl><a NAME="PipPackagesWidget.__selectedUpdateableItems" ID="PipPackagesWidget.__selectedUpdateableItems"></a>
450 <h4>PipPackagesWidget.__selectedUpdateableItems</h4>
451 <b>__selectedUpdateableItems</b>(<i></i>)
452 <p>
453 Private method to get a list of selected items that can be updated.
454 </p><dl>
455 <dt>Returns:</dt>
456 <dd>
457 list of selected items that can be updated
458 </dd>
459 </dl><dl>
460 <dt>Return Type:</dt>
461 <dd>
462 list of QTreeWidgetItem
463 </dd>
464 </dl><a NAME="PipPackagesWidget.__showPackageDetails" ID="PipPackagesWidget.__showPackageDetails"></a>
465 <h4>PipPackagesWidget.__showPackageDetails</h4>
466 <b>__showPackageDetails</b>(<i>packageName, packageVersion</i>)
467 <p>
468 Private method to populate the package details dialog.
469 </p><dl>
470 <dt><i>packageName</i> (str)</dt>
471 <dd>
472 name of the package to show details for
473 </dd><dt><i>packageVersion</i> (str)</dt>
474 <dd>
475 version of the package
476 </dd>
477 </dl><a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a>
478 <h4>PipPackagesWidget.__showSearchedDetails</h4>
479 <b>__showSearchedDetails</b>(<i>item=None</i>)
480 <p>
481 Private slot to show details about the selected search result package.
482 </p><dl>
483 <dt><i>item</i> (QTreeWidgetItem)</dt>
484 <dd>
485 reference to the search result item to show details for
486 </dd>
487 </dl><a NAME="PipPackagesWidget.__transformHits" ID="PipPackagesWidget.__transformHits"></a>
488 <h4>PipPackagesWidget.__transformHits</h4>
489 <b>__transformHits</b>(<i>hits</i>)
490 <p>
491 Private method to convert the list returned from pypi into a
492 packages list.
493 </p><dl>
494 <dt><i>hits</i> (list of dict)</dt>
495 <dd>
496 list returned from pypi
497 </dd>
498 </dl><dl>
499 <dt>Returns:</dt>
500 <dd>
501 list of packages
502 </dd>
503 </dl><dl>
504 <dt>Return Type:</dt>
505 <dd>
506 list of dict
507 </dd>
508 </dl><a NAME="PipPackagesWidget.__uninstallRequirements" ID="PipPackagesWidget.__uninstallRequirements"></a>
509 <h4>PipPackagesWidget.__uninstallRequirements</h4>
510 <b>__uninstallRequirements</b>(<i></i>)
511 <p>
512 Private slot to uninstall packages as given in a requirements file.
513 </p><a NAME="PipPackagesWidget.__updateActionButtons" ID="PipPackagesWidget.__updateActionButtons"></a>
514 <h4>PipPackagesWidget.__updateActionButtons</h4>
515 <b>__updateActionButtons</b>(<i></i>)
516 <p>
517 Private method to set the state of the action buttons.
518 </p><a NAME="PipPackagesWidget.__updateSearchActionButtons" ID="PipPackagesWidget.__updateSearchActionButtons"></a>
519 <h4>PipPackagesWidget.__updateSearchActionButtons</h4>
520 <b>__updateSearchActionButtons</b>(<i></i>)
521 <p>
522 Private method to update the action button states of the search widget.
523 </p><a NAME="PipPackagesWidget.__updateSearchButton" ID="PipPackagesWidget.__updateSearchButton"></a>
524 <h4>PipPackagesWidget.__updateSearchButton</h4>
525 <b>__updateSearchButton</b>(<i></i>)
526 <p>
527 Private method to update the state of the search button.
528 </p><a NAME="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged" ID="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged"></a>
529 <h4>PipPackagesWidget.on_environmentsComboBox_currentIndexChanged</h4>
530 <b>on_environmentsComboBox_currentIndexChanged</b>(<i>index</i>)
531 <p>
532 Private slot handling the selection of a conda environment.
533 </p><dl>
534 <dt><i>index</i> (int)</dt>
535 <dd>
536 index of the selected conda environment
537 </dd>
538 </dl><a NAME="PipPackagesWidget.on_installButton_clicked" ID="PipPackagesWidget.on_installButton_clicked"></a>
539 <h4>PipPackagesWidget.on_installButton_clicked</h4>
540 <b>on_installButton_clicked</b>(<i></i>)
541 <p>
542 Private slot to handle pressing the Install button..
543 </p><a NAME="PipPackagesWidget.on_installUserSiteButton_clicked" ID="PipPackagesWidget.on_installUserSiteButton_clicked"></a>
544 <h4>PipPackagesWidget.on_installUserSiteButton_clicked</h4>
545 <b>on_installUserSiteButton_clicked</b>(<i></i>)
546 <p>
547 Private slot to handle pressing the Install to User-Site button..
548 </p><a NAME="PipPackagesWidget.on_installedFilesCheckBox_clicked" ID="PipPackagesWidget.on_installedFilesCheckBox_clicked"></a>
549 <h4>PipPackagesWidget.on_installedFilesCheckBox_clicked</h4>
550 <b>on_installedFilesCheckBox_clicked</b>(<i>checked</i>)
551 <p>
552 Private slot to handle a change of the installed files information
553 checkbox.
554 </p><dl>
555 <dt><i>checked</i> (bool)</dt>
556 <dd>
557 state of the checkbox
558 </dd>
559 </dl><a NAME="PipPackagesWidget.on_localCheckBox_clicked" ID="PipPackagesWidget.on_localCheckBox_clicked"></a>
560 <h4>PipPackagesWidget.on_localCheckBox_clicked</h4>
561 <b>on_localCheckBox_clicked</b>(<i>checked</i>)
562 <p>
563 Private slot handling the switching of the local mode.
564 </p><dl>
565 <dt><i>checked</i> (bool)</dt>
566 <dd>
567 state of the local check box
568 </dd>
569 </dl><a NAME="PipPackagesWidget.on_notRequiredCheckBox_clicked" ID="PipPackagesWidget.on_notRequiredCheckBox_clicked"></a>
570 <h4>PipPackagesWidget.on_notRequiredCheckBox_clicked</h4>
571 <b>on_notRequiredCheckBox_clicked</b>(<i>checked</i>)
572 <p>
573 Private slot handling the switching of the 'not required' mode.
574 </p><dl>
575 <dt><i>checked</i> (bool)</dt>
576 <dd>
577 state of the 'not required' check box
578 </dd>
579 </dl><a NAME="PipPackagesWidget.on_packagesList_itemActivated" ID="PipPackagesWidget.on_packagesList_itemActivated"></a>
580 <h4>PipPackagesWidget.on_packagesList_itemActivated</h4>
581 <b>on_packagesList_itemActivated</b>(<i>item, column</i>)
582 <p>
583 Private slot reacting on a package item activation.
584 </p><dl>
585 <dt><i>item</i> (QTreeWidgetItem)</dt>
586 <dd>
587 reference to the activated item
588 </dd><dt><i>column</i> (int)</dt>
589 <dd>
590 activated column
591 </dd>
592 </dl><a NAME="PipPackagesWidget.on_packagesList_itemSelectionChanged" ID="PipPackagesWidget.on_packagesList_itemSelectionChanged"></a>
593 <h4>PipPackagesWidget.on_packagesList_itemSelectionChanged</h4>
594 <b>on_packagesList_itemSelectionChanged</b>(<i></i>)
595 <p>
596 Private slot handling the selection of a package.
597 </p><a NAME="PipPackagesWidget.on_refreshButton_clicked" ID="PipPackagesWidget.on_refreshButton_clicked"></a>
598 <h4>PipPackagesWidget.on_refreshButton_clicked</h4>
599 <b>on_refreshButton_clicked</b>(<i></i>)
600 <p>
601 Private slot to refresh the display.
602 </p><a NAME="PipPackagesWidget.on_searchButton_clicked" ID="PipPackagesWidget.on_searchButton_clicked"></a>
603 <h4>PipPackagesWidget.on_searchButton_clicked</h4>
604 <b>on_searchButton_clicked</b>(<i></i>)
605 <p>
606 Private slot handling a press of the search button.
607 </p><a NAME="PipPackagesWidget.on_searchEditName_returnPressed" ID="PipPackagesWidget.on_searchEditName_returnPressed"></a>
608 <h4>PipPackagesWidget.on_searchEditName_returnPressed</h4>
609 <b>on_searchEditName_returnPressed</b>(<i></i>)
610 <p>
611 Private slot initiating a search via a press of the Return key.
612 </p><a NAME="PipPackagesWidget.on_searchEditName_textChanged" ID="PipPackagesWidget.on_searchEditName_textChanged"></a>
613 <h4>PipPackagesWidget.on_searchEditName_textChanged</h4>
614 <b>on_searchEditName_textChanged</b>(<i>txt</i>)
615 <p>
616 Private slot handling a change of the search term.
617 </p><dl>
618 <dt><i>txt</i> (str)</dt>
619 <dd>
620 search term
621 </dd>
622 </dl><a NAME="PipPackagesWidget.on_searchEditSummary_returnPressed" ID="PipPackagesWidget.on_searchEditSummary_returnPressed"></a>
623 <h4>PipPackagesWidget.on_searchEditSummary_returnPressed</h4>
624 <b>on_searchEditSummary_returnPressed</b>(<i></i>)
625 <p>
626 Private slot initiating a search via a press of the Return key.
627 </p><a NAME="PipPackagesWidget.on_searchEditSummary_textChanged" ID="PipPackagesWidget.on_searchEditSummary_textChanged"></a>
628 <h4>PipPackagesWidget.on_searchEditSummary_textChanged</h4>
629 <b>on_searchEditSummary_textChanged</b>(<i>txt</i>)
630 <p>
631 Private slot handling a change of the search term.
632 </p><dl>
633 <dt><i>txt</i> (str)</dt>
634 <dd>
635 search term
636 </dd>
637 </dl><a NAME="PipPackagesWidget.on_searchResultList_itemActivated" ID="PipPackagesWidget.on_searchResultList_itemActivated"></a>
638 <h4>PipPackagesWidget.on_searchResultList_itemActivated</h4>
639 <b>on_searchResultList_itemActivated</b>(<i>item, column</i>)
640 <p>
641 Private slot reacting on an search result item activation.
642 </p><dl>
643 <dt><i>item</i> (QTreeWidgetItem)</dt>
644 <dd>
645 reference to the activated item
646 </dd><dt><i>column</i> (int)</dt>
647 <dd>
648 activated column
649 </dd>
650 </dl><a NAME="PipPackagesWidget.on_searchResultList_itemSelectionChanged" ID="PipPackagesWidget.on_searchResultList_itemSelectionChanged"></a>
651 <h4>PipPackagesWidget.on_searchResultList_itemSelectionChanged</h4>
652 <b>on_searchResultList_itemSelectionChanged</b>(<i></i>)
653 <p>
654 Private slot handling changes of the search result selection.
655 </p><a NAME="PipPackagesWidget.on_searchToggleButton_toggled" ID="PipPackagesWidget.on_searchToggleButton_toggled"></a>
656 <h4>PipPackagesWidget.on_searchToggleButton_toggled</h4>
657 <b>on_searchToggleButton_toggled</b>(<i>checked</i>)
658 <p>
659 Private slot to togle the search widget.
660 </p><dl>
661 <dt><i>checked</i> (bool)</dt>
662 <dd>
663 state of the search widget button
664 </dd>
665 </dl><a NAME="PipPackagesWidget.on_showDetailsButton_clicked" ID="PipPackagesWidget.on_showDetailsButton_clicked"></a>
666 <h4>PipPackagesWidget.on_showDetailsButton_clicked</h4>
667 <b>on_showDetailsButton_clicked</b>(<i></i>)
668 <p>
669 Private slot to handle pressing the Show Details button.
670 </p><a NAME="PipPackagesWidget.on_showPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showPackageDetailsButton_clicked"></a>
671 <h4>PipPackagesWidget.on_showPackageDetailsButton_clicked</h4>
672 <b>on_showPackageDetailsButton_clicked</b>(<i></i>)
673 <p>
674 Private slot to show information for the selected package.
675 </p><a NAME="PipPackagesWidget.on_uninstallButton_clicked" ID="PipPackagesWidget.on_uninstallButton_clicked"></a>
676 <h4>PipPackagesWidget.on_uninstallButton_clicked</h4>
677 <b>on_uninstallButton_clicked</b>(<i></i>)
678 <p>
679 Private slot to remove selected packages of the selected environment.
680 </p><a NAME="PipPackagesWidget.on_upgradeAllButton_clicked" ID="PipPackagesWidget.on_upgradeAllButton_clicked"></a>
681 <h4>PipPackagesWidget.on_upgradeAllButton_clicked</h4>
682 <b>on_upgradeAllButton_clicked</b>(<i></i>)
683 <p>
684 Private slot to upgrade all packages of the selected environment.
685 </p><a NAME="PipPackagesWidget.on_upgradeButton_clicked" ID="PipPackagesWidget.on_upgradeButton_clicked"></a>
686 <h4>PipPackagesWidget.on_upgradeButton_clicked</h4>
687 <b>on_upgradeButton_clicked</b>(<i></i>)
688 <p>
689 Private slot to upgrade selected packages of the selected environment.
690 </p><a NAME="PipPackagesWidget.on_userCheckBox_clicked" ID="PipPackagesWidget.on_userCheckBox_clicked"></a>
691 <h4>PipPackagesWidget.on_userCheckBox_clicked</h4>
692 <b>on_userCheckBox_clicked</b>(<i>checked</i>)
693 <p>
694 Private slot handling the switching of the 'user-site' mode.
695 </p><dl>
696 <dt><i>checked</i> (bool)</dt>
697 <dd>
698 state of the 'user-site' check box
699 </dd>
700 </dl><a NAME="PipPackagesWidget.on_verboseCheckBox_clicked" ID="PipPackagesWidget.on_verboseCheckBox_clicked"></a>
701 <h4>PipPackagesWidget.on_verboseCheckBox_clicked</h4>
702 <b>on_verboseCheckBox_clicked</b>(<i>checked</i>)
703 <p>
704 Private slot to handle a change of the verbose package information
705 checkbox.
706 </p><dl>
707 <dt><i>checked</i> (bool)</dt>
708 <dd>
709 state of the checkbox
710 </dd>
711 </dl>
712 <div align="right"><a href="#top">Up</a></div>
713 <hr />
714 </body></html>

Mercurial Repository: eric

eric ide

mercurial