src/eric7/Documentation/Source/eric7.CondaInterface.CondaPackagesWidget.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9587
6486d40c26f0
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.CondaInterface.CondaPackagesWidget</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.CondaInterface.CondaPackagesWidget</h1>
10
11 <p>
12 Module implementing the conda 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="#CondaPackagesWidget">CondaPackagesWidget</a></td>
25 <td>Class implementing the conda packages management widget.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="CondaPackagesWidget" ID="CondaPackagesWidget"></a>
36 <h2>CondaPackagesWidget</h2>
37
38 <p>
39 Class implementing the conda packages management widget.
40 </p>
41 <h3>Derived from</h3>
42 QWidget, Ui_CondaPackagesWidget
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>PackageBuildRole</td></tr><tr><td>PackageDetailedDataRole</td></tr><tr><td>PackageVersionRole</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#CondaPackagesWidget.__init__">CondaPackagesWidget</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#CondaPackagesWidget.__aboutConda">__aboutConda</a></td>
63 <td>Private slot to show some information about the conda installation.</td>
64 </tr>
65 <tr>
66 <td><a href="#CondaPackagesWidget.__aboutToShowCondaMenu">__aboutToShowCondaMenu</a></td>
67 <td>Private slot to handle the conda menu about to be shown.</td>
68 </tr>
69 <tr>
70 <td><a href="#CondaPackagesWidget.__allUpdateableItems">__allUpdateableItems</a></td>
71 <td>Private method to get a list of all items that can be updated.</td>
72 </tr>
73 <tr>
74 <td><a href="#CondaPackagesWidget.__cloneEnvironment">__cloneEnvironment</a></td>
75 <td>Private slot to clone a conda environment.</td>
76 </tr>
77 <tr>
78 <td><a href="#CondaPackagesWidget.__condaConfigure">__condaConfigure</a></td>
79 <td>Private slot to open the configuration page.</td>
80 </tr>
81 <tr>
82 <td><a href="#CondaPackagesWidget.__createEnvironment">__createEnvironment</a></td>
83 <td>Private slot to create a conda environment from a requirements file.</td>
84 </tr>
85 <tr>
86 <td><a href="#CondaPackagesWidget.__deleteEnvironment">__deleteEnvironment</a></td>
87 <td>Private slot to delete a conda environment.</td>
88 </tr>
89 <tr>
90 <td><a href="#CondaPackagesWidget.__doSearch">__doSearch</a></td>
91 <td>Private method to search for packages.</td>
92 </tr>
93 <tr>
94 <td><a href="#CondaPackagesWidget.__editUserConfiguration">__editUserConfiguration</a></td>
95 <td>Private slot to edit the user configuration.</td>
96 </tr>
97 <tr>
98 <td><a href="#CondaPackagesWidget.__generateRequirements">__generateRequirements</a></td>
99 <td>Private slot to generate a requirements file.</td>
100 </tr>
101 <tr>
102 <td><a href="#CondaPackagesWidget.__initCondaInterface">__initCondaInterface</a></td>
103 <td>Private method to initialize the conda interface elements.</td>
104 </tr>
105 <tr>
106 <td><a href="#CondaPackagesWidget.__initCondaMenu">__initCondaMenu</a></td>
107 <td>Private method to create the super menu and attach it to the super menu button.</td>
108 </tr>
109 <tr>
110 <td><a href="#CondaPackagesWidget.__installPackages">__installPackages</a></td>
111 <td>Private slot to install packages.</td>
112 </tr>
113 <tr>
114 <td><a href="#CondaPackagesWidget.__installRequirements">__installRequirements</a></td>
115 <td>Private slot to install packages from requirements files.</td>
116 </tr>
117 <tr>
118 <td><a href="#CondaPackagesWidget.__populateEnvironments">__populateEnvironments</a></td>
119 <td>Private method to get a list of environments and populate the selector.</td>
120 </tr>
121 <tr>
122 <td><a href="#CondaPackagesWidget.__selectedUpdateableItems">__selectedUpdateableItems</a></td>
123 <td>Private method to get a list of selected items that can be updated.</td>
124 </tr>
125 <tr>
126 <td><a href="#CondaPackagesWidget.__showDetails">__showDetails</a></td>
127 <td>Private method to show a dialog with details about a package item.</td>
128 </tr>
129 <tr>
130 <td><a href="#CondaPackagesWidget.__updateActionButtons">__updateActionButtons</a></td>
131 <td>Private method to set the state of the action buttons.</td>
132 </tr>
133 <tr>
134 <td><a href="#CondaPackagesWidget.__updateSearchActionButtons">__updateSearchActionButtons</a></td>
135 <td>Private method to update the action button states of the search widget.</td>
136 </tr>
137 <tr>
138 <td><a href="#CondaPackagesWidget.on_environmentsComboBox_currentIndexChanged">on_environmentsComboBox_currentIndexChanged</a></td>
139 <td>Private slot handling the selection of a conda environment.</td>
140 </tr>
141 <tr>
142 <td><a href="#CondaPackagesWidget.on_installButton_clicked">on_installButton_clicked</a></td>
143 <td>Private slot to install a selected package.</td>
144 </tr>
145 <tr>
146 <td><a href="#CondaPackagesWidget.on_packagesList_itemSelectionChanged">on_packagesList_itemSelectionChanged</a></td>
147 <td>Private slot to handle the selection of some items..</td>
148 </tr>
149 <tr>
150 <td><a href="#CondaPackagesWidget.on_recheckButton_clicked">on_recheckButton_clicked</a></td>
151 <td>Private slot to re-check the availability of conda and adjust the interface if it became available.</td>
152 </tr>
153 <tr>
154 <td><a href="#CondaPackagesWidget.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
155 <td>Private slot to refresh the display.</td>
156 </tr>
157 <tr>
158 <td><a href="#CondaPackagesWidget.on_searchButton_clicked">on_searchButton_clicked</a></td>
159 <td>Private slot handling the press of the search button.</td>
160 </tr>
161 <tr>
162 <td><a href="#CondaPackagesWidget.on_searchEdit_returnPressed">on_searchEdit_returnPressed</a></td>
163 <td>Private slot handling the user pressing the Return button in the search edit.</td>
164 </tr>
165 <tr>
166 <td><a href="#CondaPackagesWidget.on_searchEdit_textChanged">on_searchEdit_textChanged</a></td>
167 <td>Private slot handling changes of the entered search specification.</td>
168 </tr>
169 <tr>
170 <td><a href="#CondaPackagesWidget.on_searchResultList_itemDoubleClicked">on_searchResultList_itemDoubleClicked</a></td>
171 <td>Private slot handling a double click of an item.</td>
172 </tr>
173 <tr>
174 <td><a href="#CondaPackagesWidget.on_searchResultList_itemExpanded">on_searchResultList_itemExpanded</a></td>
175 <td>Private slot handling the expansion of an item.</td>
176 </tr>
177 <tr>
178 <td><a href="#CondaPackagesWidget.on_searchResultList_itemSelectionChanged">on_searchResultList_itemSelectionChanged</a></td>
179 <td>Private slot handling a change of selected search results.</td>
180 </tr>
181 <tr>
182 <td><a href="#CondaPackagesWidget.on_searchToggleButton_toggled">on_searchToggleButton_toggled</a></td>
183 <td>Private slot to togle the search widget.</td>
184 </tr>
185 <tr>
186 <td><a href="#CondaPackagesWidget.on_showDetailsButton_clicked">on_showDetailsButton_clicked</a></td>
187 <td>Private slot handling the 'Show Details' button.</td>
188 </tr>
189 <tr>
190 <td><a href="#CondaPackagesWidget.on_uninstallButton_clicked">on_uninstallButton_clicked</a></td>
191 <td>Private slot to remove selected packages of the selected environment.</td>
192 </tr>
193 <tr>
194 <td><a href="#CondaPackagesWidget.on_upgradeAllButton_clicked">on_upgradeAllButton_clicked</a></td>
195 <td>Private slot to upgrade all packages of the selected environment.</td>
196 </tr>
197 <tr>
198 <td><a href="#CondaPackagesWidget.on_upgradeButton_clicked">on_upgradeButton_clicked</a></td>
199 <td>Private slot to upgrade selected packages of the selected environment.</td>
200 </tr>
201 </table>
202 <h3>Static Methods</h3>
203
204 <table>
205 <tr><td>None</td></tr>
206 </table>
207
208 <a NAME="CondaPackagesWidget.__init__" ID="CondaPackagesWidget.__init__"></a>
209 <h4>CondaPackagesWidget (Constructor)</h4>
210 <b>CondaPackagesWidget</b>(<i>conda, parent=None</i>)
211
212 <p>
213 Constructor
214 </p>
215 <dl>
216
217 <dt><i>conda</i> (Conda)</dt>
218 <dd>
219 reference to the conda interface
220 </dd>
221 <dt><i>parent</i> (QWidget)</dt>
222 <dd>
223 reference to the parent widget
224 </dd>
225 </dl>
226 <a NAME="CondaPackagesWidget.__aboutConda" ID="CondaPackagesWidget.__aboutConda"></a>
227 <h4>CondaPackagesWidget.__aboutConda</h4>
228 <b>__aboutConda</b>(<i></i>)
229
230 <p>
231 Private slot to show some information about the conda installation.
232 </p>
233 <a NAME="CondaPackagesWidget.__aboutToShowCondaMenu" ID="CondaPackagesWidget.__aboutToShowCondaMenu"></a>
234 <h4>CondaPackagesWidget.__aboutToShowCondaMenu</h4>
235 <b>__aboutToShowCondaMenu</b>(<i></i>)
236
237 <p>
238 Private slot to handle the conda menu about to be shown.
239 </p>
240 <a NAME="CondaPackagesWidget.__allUpdateableItems" ID="CondaPackagesWidget.__allUpdateableItems"></a>
241 <h4>CondaPackagesWidget.__allUpdateableItems</h4>
242 <b>__allUpdateableItems</b>(<i></i>)
243
244 <p>
245 Private method to get a list of all items that can be updated.
246 </p>
247 <dl>
248 <dt>Return:</dt>
249 <dd>
250 list of all items that can be updated
251 </dd>
252 </dl>
253 <dl>
254 <dt>Return Type:</dt>
255 <dd>
256 list of QTreeWidgetItem
257 </dd>
258 </dl>
259 <a NAME="CondaPackagesWidget.__cloneEnvironment" ID="CondaPackagesWidget.__cloneEnvironment"></a>
260 <h4>CondaPackagesWidget.__cloneEnvironment</h4>
261 <b>__cloneEnvironment</b>(<i></i>)
262
263 <p>
264 Private slot to clone a conda environment.
265 </p>
266 <a NAME="CondaPackagesWidget.__condaConfigure" ID="CondaPackagesWidget.__condaConfigure"></a>
267 <h4>CondaPackagesWidget.__condaConfigure</h4>
268 <b>__condaConfigure</b>(<i></i>)
269
270 <p>
271 Private slot to open the configuration page.
272 </p>
273 <a NAME="CondaPackagesWidget.__createEnvironment" ID="CondaPackagesWidget.__createEnvironment"></a>
274 <h4>CondaPackagesWidget.__createEnvironment</h4>
275 <b>__createEnvironment</b>(<i></i>)
276
277 <p>
278 Private slot to create a conda environment from a requirements file.
279 </p>
280 <a NAME="CondaPackagesWidget.__deleteEnvironment" ID="CondaPackagesWidget.__deleteEnvironment"></a>
281 <h4>CondaPackagesWidget.__deleteEnvironment</h4>
282 <b>__deleteEnvironment</b>(<i></i>)
283
284 <p>
285 Private slot to delete a conda environment.
286 </p>
287 <a NAME="CondaPackagesWidget.__doSearch" ID="CondaPackagesWidget.__doSearch"></a>
288 <h4>CondaPackagesWidget.__doSearch</h4>
289 <b>__doSearch</b>(<i></i>)
290
291 <p>
292 Private method to search for packages.
293 </p>
294 <a NAME="CondaPackagesWidget.__editUserConfiguration" ID="CondaPackagesWidget.__editUserConfiguration"></a>
295 <h4>CondaPackagesWidget.__editUserConfiguration</h4>
296 <b>__editUserConfiguration</b>(<i></i>)
297
298 <p>
299 Private slot to edit the user configuration.
300 </p>
301 <a NAME="CondaPackagesWidget.__generateRequirements" ID="CondaPackagesWidget.__generateRequirements"></a>
302 <h4>CondaPackagesWidget.__generateRequirements</h4>
303 <b>__generateRequirements</b>(<i></i>)
304
305 <p>
306 Private slot to generate a requirements file.
307 </p>
308 <a NAME="CondaPackagesWidget.__initCondaInterface" ID="CondaPackagesWidget.__initCondaInterface"></a>
309 <h4>CondaPackagesWidget.__initCondaInterface</h4>
310 <b>__initCondaInterface</b>(<i></i>)
311
312 <p>
313 Private method to initialize the conda interface elements.
314 </p>
315 <a NAME="CondaPackagesWidget.__initCondaMenu" ID="CondaPackagesWidget.__initCondaMenu"></a>
316 <h4>CondaPackagesWidget.__initCondaMenu</h4>
317 <b>__initCondaMenu</b>(<i></i>)
318
319 <p>
320 Private method to create the super menu and attach it to the super
321 menu button.
322 </p>
323 <a NAME="CondaPackagesWidget.__installPackages" ID="CondaPackagesWidget.__installPackages"></a>
324 <h4>CondaPackagesWidget.__installPackages</h4>
325 <b>__installPackages</b>(<i></i>)
326
327 <p>
328 Private slot to install packages.
329 </p>
330 <a NAME="CondaPackagesWidget.__installRequirements" ID="CondaPackagesWidget.__installRequirements"></a>
331 <h4>CondaPackagesWidget.__installRequirements</h4>
332 <b>__installRequirements</b>(<i></i>)
333
334 <p>
335 Private slot to install packages from requirements files.
336 </p>
337 <a NAME="CondaPackagesWidget.__populateEnvironments" ID="CondaPackagesWidget.__populateEnvironments"></a>
338 <h4>CondaPackagesWidget.__populateEnvironments</h4>
339 <b>__populateEnvironments</b>(<i></i>)
340
341 <p>
342 Private method to get a list of environments and populate the selector.
343 </p>
344 <a NAME="CondaPackagesWidget.__selectedUpdateableItems" ID="CondaPackagesWidget.__selectedUpdateableItems"></a>
345 <h4>CondaPackagesWidget.__selectedUpdateableItems</h4>
346 <b>__selectedUpdateableItems</b>(<i></i>)
347
348 <p>
349 Private method to get a list of selected items that can be updated.
350 </p>
351 <dl>
352 <dt>Return:</dt>
353 <dd>
354 list of selected items that can be updated
355 </dd>
356 </dl>
357 <dl>
358 <dt>Return Type:</dt>
359 <dd>
360 list of QTreeWidgetItem
361 </dd>
362 </dl>
363 <a NAME="CondaPackagesWidget.__showDetails" ID="CondaPackagesWidget.__showDetails"></a>
364 <h4>CondaPackagesWidget.__showDetails</h4>
365 <b>__showDetails</b>(<i>item</i>)
366
367 <p>
368 Private method to show a dialog with details about a package item.
369 </p>
370 <dl>
371
372 <dt><i>item</i> (QTreeWidgetItem)</dt>
373 <dd>
374 reference to the package item
375 </dd>
376 </dl>
377 <a NAME="CondaPackagesWidget.__updateActionButtons" ID="CondaPackagesWidget.__updateActionButtons"></a>
378 <h4>CondaPackagesWidget.__updateActionButtons</h4>
379 <b>__updateActionButtons</b>(<i></i>)
380
381 <p>
382 Private method to set the state of the action buttons.
383 </p>
384 <a NAME="CondaPackagesWidget.__updateSearchActionButtons" ID="CondaPackagesWidget.__updateSearchActionButtons"></a>
385 <h4>CondaPackagesWidget.__updateSearchActionButtons</h4>
386 <b>__updateSearchActionButtons</b>(<i></i>)
387
388 <p>
389 Private method to update the action button states of the search widget.
390 </p>
391 <a NAME="CondaPackagesWidget.on_environmentsComboBox_currentIndexChanged" ID="CondaPackagesWidget.on_environmentsComboBox_currentIndexChanged"></a>
392 <h4>CondaPackagesWidget.on_environmentsComboBox_currentIndexChanged</h4>
393 <b>on_environmentsComboBox_currentIndexChanged</b>(<i>index</i>)
394
395 <p>
396 Private slot handling the selection of a conda environment.
397 </p>
398 <dl>
399
400 <dt><i>index</i> (int)</dt>
401 <dd>
402 index of the selected conda environment
403 </dd>
404 </dl>
405 <a NAME="CondaPackagesWidget.on_installButton_clicked" ID="CondaPackagesWidget.on_installButton_clicked"></a>
406 <h4>CondaPackagesWidget.on_installButton_clicked</h4>
407 <b>on_installButton_clicked</b>(<i></i>)
408
409 <p>
410 Private slot to install a selected package.
411 </p>
412 <a NAME="CondaPackagesWidget.on_packagesList_itemSelectionChanged" ID="CondaPackagesWidget.on_packagesList_itemSelectionChanged"></a>
413 <h4>CondaPackagesWidget.on_packagesList_itemSelectionChanged</h4>
414 <b>on_packagesList_itemSelectionChanged</b>(<i></i>)
415
416 <p>
417 Private slot to handle the selection of some items..
418 </p>
419 <a NAME="CondaPackagesWidget.on_recheckButton_clicked" ID="CondaPackagesWidget.on_recheckButton_clicked"></a>
420 <h4>CondaPackagesWidget.on_recheckButton_clicked</h4>
421 <b>on_recheckButton_clicked</b>(<i></i>)
422
423 <p>
424 Private slot to re-check the availability of conda and adjust the
425 interface if it became available.
426 </p>
427 <a NAME="CondaPackagesWidget.on_refreshButton_clicked" ID="CondaPackagesWidget.on_refreshButton_clicked"></a>
428 <h4>CondaPackagesWidget.on_refreshButton_clicked</h4>
429 <b>on_refreshButton_clicked</b>(<i></i>)
430
431 <p>
432 Private slot to refresh the display.
433 </p>
434 <a NAME="CondaPackagesWidget.on_searchButton_clicked" ID="CondaPackagesWidget.on_searchButton_clicked"></a>
435 <h4>CondaPackagesWidget.on_searchButton_clicked</h4>
436 <b>on_searchButton_clicked</b>(<i></i>)
437
438 <p>
439 Private slot handling the press of the search button.
440 </p>
441 <a NAME="CondaPackagesWidget.on_searchEdit_returnPressed" ID="CondaPackagesWidget.on_searchEdit_returnPressed"></a>
442 <h4>CondaPackagesWidget.on_searchEdit_returnPressed</h4>
443 <b>on_searchEdit_returnPressed</b>(<i></i>)
444
445 <p>
446 Private slot handling the user pressing the Return button in the
447 search edit.
448 </p>
449 <a NAME="CondaPackagesWidget.on_searchEdit_textChanged" ID="CondaPackagesWidget.on_searchEdit_textChanged"></a>
450 <h4>CondaPackagesWidget.on_searchEdit_textChanged</h4>
451 <b>on_searchEdit_textChanged</b>(<i>txt</i>)
452
453 <p>
454 Private slot handling changes of the entered search specification.
455 </p>
456 <dl>
457
458 <dt><i>txt</i> (str)</dt>
459 <dd>
460 current search entry
461 </dd>
462 </dl>
463 <a NAME="CondaPackagesWidget.on_searchResultList_itemDoubleClicked" ID="CondaPackagesWidget.on_searchResultList_itemDoubleClicked"></a>
464 <h4>CondaPackagesWidget.on_searchResultList_itemDoubleClicked</h4>
465 <b>on_searchResultList_itemDoubleClicked</b>(<i>item, column</i>)
466
467 <p>
468 Private slot handling a double click of an item.
469 </p>
470 <dl>
471
472 <dt><i>item</i> (QTreeWidgetItem)</dt>
473 <dd>
474 reference to the item that was double clicked
475 </dd>
476 <dt><i>column</i> (int)</dt>
477 <dd>
478 column of the double click
479 </dd>
480 </dl>
481 <a NAME="CondaPackagesWidget.on_searchResultList_itemExpanded" ID="CondaPackagesWidget.on_searchResultList_itemExpanded"></a>
482 <h4>CondaPackagesWidget.on_searchResultList_itemExpanded</h4>
483 <b>on_searchResultList_itemExpanded</b>(<i>item</i>)
484
485 <p>
486 Private slot handling the expansion of an item.
487 </p>
488 <dl>
489
490 <dt><i>item</i> (QTreeWidgetItem)</dt>
491 <dd>
492 reference to the expanded item
493 </dd>
494 </dl>
495 <a NAME="CondaPackagesWidget.on_searchResultList_itemSelectionChanged" ID="CondaPackagesWidget.on_searchResultList_itemSelectionChanged"></a>
496 <h4>CondaPackagesWidget.on_searchResultList_itemSelectionChanged</h4>
497 <b>on_searchResultList_itemSelectionChanged</b>(<i></i>)
498
499 <p>
500 Private slot handling a change of selected search results.
501 </p>
502 <a NAME="CondaPackagesWidget.on_searchToggleButton_toggled" ID="CondaPackagesWidget.on_searchToggleButton_toggled"></a>
503 <h4>CondaPackagesWidget.on_searchToggleButton_toggled</h4>
504 <b>on_searchToggleButton_toggled</b>(<i>checked</i>)
505
506 <p>
507 Private slot to togle the search widget.
508 </p>
509 <dl>
510
511 <dt><i>checked</i> (bool)</dt>
512 <dd>
513 state of the search widget button
514 </dd>
515 </dl>
516 <a NAME="CondaPackagesWidget.on_showDetailsButton_clicked" ID="CondaPackagesWidget.on_showDetailsButton_clicked"></a>
517 <h4>CondaPackagesWidget.on_showDetailsButton_clicked</h4>
518 <b>on_showDetailsButton_clicked</b>(<i></i>)
519
520 <p>
521 Private slot handling the 'Show Details' button.
522 </p>
523 <a NAME="CondaPackagesWidget.on_uninstallButton_clicked" ID="CondaPackagesWidget.on_uninstallButton_clicked"></a>
524 <h4>CondaPackagesWidget.on_uninstallButton_clicked</h4>
525 <b>on_uninstallButton_clicked</b>(<i></i>)
526
527 <p>
528 Private slot to remove selected packages of the selected environment.
529 </p>
530 <a NAME="CondaPackagesWidget.on_upgradeAllButton_clicked" ID="CondaPackagesWidget.on_upgradeAllButton_clicked"></a>
531 <h4>CondaPackagesWidget.on_upgradeAllButton_clicked</h4>
532 <b>on_upgradeAllButton_clicked</b>(<i></i>)
533
534 <p>
535 Private slot to upgrade all packages of the selected environment.
536 </p>
537 <a NAME="CondaPackagesWidget.on_upgradeButton_clicked" ID="CondaPackagesWidget.on_upgradeButton_clicked"></a>
538 <h4>CondaPackagesWidget.on_upgradeButton_clicked</h4>
539 <b>on_upgradeButton_clicked</b>(<i></i>)
540
541 <p>
542 Private slot to upgrade selected packages of the selected environment.
543 </p>
544 <div align="right"><a href="#top">Up</a></div>
545 <hr />
546 </body></html>

eric ide

mercurial