Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html

Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html

changeset 6805
10fefa6f331a
parent 6797
d9e56b0aa7ac
parent 6804
dc20bde4af90
child 6806
d306647cb82d
equal deleted inserted replaced
6797:d9e56b0aa7ac 6805:10fefa6f331a
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog</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.Plugins.UiExtensionPlugins.PipInterface.PipListDialog</h1>
23 <p>
24 Module implementing a dialog to list installed packages.
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="#PipListDialog">PipListDialog</a></td>
34 <td>Class implementing a dialog to list installed packages.</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="PipListDialog" ID="PipListDialog"></a>
43 <h2>PipListDialog</h2>
44 <p>
45 Class implementing a dialog to list installed packages.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_PipListDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>CommandArguments</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="#PipListDialog.__init__">PipListDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#PipListDialog.__executeUpgradePackages">__executeUpgradePackages</a></td>
64 <td>Private method to execute the pip upgrade command.</td>
65 </tr><tr>
66 <td><a href="#PipListDialog.__finish">__finish</a></td>
67 <td>Private slot called when the process finished or the user pressed the cancel button.</td>
68 </tr><tr>
69 <td><a href="#PipListDialog.__procFinished">__procFinished</a></td>
70 <td>Private slot connected to the finished signal.</td>
71 </tr><tr>
72 <td><a href="#PipListDialog.__processOutput">__processOutput</a></td>
73 <td>Private method to process the captured output.</td>
74 </tr><tr>
75 <td><a href="#PipListDialog.__readStderr">__readStderr</a></td>
76 <td>Private slot to handle the readyReadStandardError signal.</td>
77 </tr><tr>
78 <td><a href="#PipListDialog.__readStdout">__readStdout</a></td>
79 <td>Private slot to handle the readyReadStandardOutput signal.</td>
80 </tr><tr>
81 <td><a href="#PipListDialog.__refresh">__refresh</a></td>
82 <td>Private slot to refresh the displayed list.</td>
83 </tr><tr>
84 <td><a href="#PipListDialog.__stopProcess">__stopProcess</a></td>
85 <td>Private slot to stop the running process.</td>
86 </tr><tr>
87 <td><a href="#PipListDialog.__uninstallPackages">__uninstallPackages</a></td>
88 <td>Private slot to uninstall the selected packages.</td>
89 </tr><tr>
90 <td><a href="#PipListDialog.__upgradeAllPackages">__upgradeAllPackages</a></td>
91 <td>Private slot to upgrade all listed packages.</td>
92 </tr><tr>
93 <td><a href="#PipListDialog.__upgradePackages">__upgradePackages</a></td>
94 <td>Private slot to upgrade the selected packages.</td>
95 </tr><tr>
96 <td><a href="#PipListDialog.__upgradePip">__upgradePip</a></td>
97 <td>Private slot to upgrade pip itself.</td>
98 </tr><tr>
99 <td><a href="#PipListDialog.closeEvent">closeEvent</a></td>
100 <td>Protected slot implementing a close event handler.</td>
101 </tr><tr>
102 <td><a href="#PipListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
103 <td>Private slot called by a button of the button box clicked.</td>
104 </tr><tr>
105 <td><a href="#PipListDialog.on_installedFilesCheckBox_clicked">on_installedFilesCheckBox_clicked</a></td>
106 <td>Private slot to handle a change of the installed files information checkbox.</td>
107 </tr><tr>
108 <td><a href="#PipListDialog.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td>
109 <td>Private slot handling the switching of the local mode.</td>
110 </tr><tr>
111 <td><a href="#PipListDialog.on_notRequiredCheckBox_clicked">on_notRequiredCheckBox_clicked</a></td>
112 <td>Private slot handling the switching of the 'not required' mode.</td>
113 </tr><tr>
114 <td><a href="#PipListDialog.on_packageList_itemSelectionChanged">on_packageList_itemSelectionChanged</a></td>
115 <td>Private slot handling the selection of a package.</td>
116 </tr><tr>
117 <td><a href="#PipListDialog.on_userCheckBox_clicked">on_userCheckBox_clicked</a></td>
118 <td>Private slot handling the switching of the 'user-site' mode.</td>
119 </tr><tr>
120 <td><a href="#PipListDialog.on_venvComboBox_activated">on_venvComboBox_activated</a></td>
121 <td>Private slot handling the selection of a virtual environment.</td>
122 </tr><tr>
123 <td><a href="#PipListDialog.on_verboseCheckBox_clicked">on_verboseCheckBox_clicked</a></td>
124 <td>Private slot to handle a change of the verbose package information checkbox.</td>
125 </tr><tr>
126 <td><a href="#PipListDialog.start">start</a></td>
127 <td>Public method to start the command.</td>
128 </tr>
129 </table>
130 <h3>Static Methods</h3>
131 <table>
132 <tr><td>None</td></tr>
133 </table>
134 <a NAME="PipListDialog.__init__" ID="PipListDialog.__init__"></a>
135 <h4>PipListDialog (Constructor)</h4>
136 <b>PipListDialog</b>(<i>pip, mode, indexUrl, title, parent=None</i>)
137 <p>
138 Constructor
139 </p><dl>
140 <dt><i>pip</i> (Pip)</dt>
141 <dd>
142 reference to the master object
143 </dd><dt><i>mode</i> (str)</dt>
144 <dd>
145 list command mode (one of 'list', 'uptodate', 'outdated')
146 </dd><dt><i>indexUrl</i> (str)</dt>
147 <dd>
148 URL of the pypi index
149 </dd><dt><i>title</i> (str)</dt>
150 <dd>
151 title of the dialog
152 </dd><dt><i>parent</i> (QWidget)</dt>
153 <dd>
154 reference to the parent widget
155 </dd>
156 </dl><a NAME="PipListDialog.__executeUpgradePackages" ID="PipListDialog.__executeUpgradePackages"></a>
157 <h4>PipListDialog.__executeUpgradePackages</h4>
158 <b>__executeUpgradePackages</b>(<i>packages</i>)
159 <p>
160 Private method to execute the pip upgrade command.
161 </p><dl>
162 <dt><i>packages</i> (list of str)</dt>
163 <dd>
164 list of package names to be upgraded
165 </dd>
166 </dl><a NAME="PipListDialog.__finish" ID="PipListDialog.__finish"></a>
167 <h4>PipListDialog.__finish</h4>
168 <b>__finish</b>(<i></i>)
169 <p>
170 Private slot called when the process finished or the user pressed
171 the cancel button.
172 </p><a NAME="PipListDialog.__procFinished" ID="PipListDialog.__procFinished"></a>
173 <h4>PipListDialog.__procFinished</h4>
174 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
175 <p>
176 Private slot connected to the finished signal.
177 </p><dl>
178 <dt><i>exitCode</i> (int)</dt>
179 <dd>
180 exit code of the process
181 </dd><dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
182 <dd>
183 exit status of the process
184 </dd>
185 </dl><a NAME="PipListDialog.__processOutput" ID="PipListDialog.__processOutput"></a>
186 <h4>PipListDialog.__processOutput</h4>
187 <b>__processOutput</b>(<i></i>)
188 <p>
189 Private method to process the captured output.
190 </p><a NAME="PipListDialog.__readStderr" ID="PipListDialog.__readStderr"></a>
191 <h4>PipListDialog.__readStderr</h4>
192 <b>__readStderr</b>(<i></i>)
193 <p>
194 Private slot to handle the readyReadStandardError signal.
195 </p><p>
196 It reads the error output of the process and inserts it into the
197 error pane.
198 </p><a NAME="PipListDialog.__readStdout" ID="PipListDialog.__readStdout"></a>
199 <h4>PipListDialog.__readStdout</h4>
200 <b>__readStdout</b>(<i></i>)
201 <p>
202 Private slot to handle the readyReadStandardOutput signal.
203 </p><p>
204 It reads the output of the process, formats it and inserts it into
205 the contents pane.
206 </p><a NAME="PipListDialog.__refresh" ID="PipListDialog.__refresh"></a>
207 <h4>PipListDialog.__refresh</h4>
208 <b>__refresh</b>(<i></i>)
209 <p>
210 Private slot to refresh the displayed list.
211 </p><a NAME="PipListDialog.__stopProcess" ID="PipListDialog.__stopProcess"></a>
212 <h4>PipListDialog.__stopProcess</h4>
213 <b>__stopProcess</b>(<i></i>)
214 <p>
215 Private slot to stop the running process.
216 </p><a NAME="PipListDialog.__uninstallPackages" ID="PipListDialog.__uninstallPackages"></a>
217 <h4>PipListDialog.__uninstallPackages</h4>
218 <b>__uninstallPackages</b>(<i></i>)
219 <p>
220 Private slot to uninstall the selected packages.
221 </p><a NAME="PipListDialog.__upgradeAllPackages" ID="PipListDialog.__upgradeAllPackages"></a>
222 <h4>PipListDialog.__upgradeAllPackages</h4>
223 <b>__upgradeAllPackages</b>(<i></i>)
224 <p>
225 Private slot to upgrade all listed packages.
226 </p><a NAME="PipListDialog.__upgradePackages" ID="PipListDialog.__upgradePackages"></a>
227 <h4>PipListDialog.__upgradePackages</h4>
228 <b>__upgradePackages</b>(<i></i>)
229 <p>
230 Private slot to upgrade the selected packages.
231 </p><a NAME="PipListDialog.__upgradePip" ID="PipListDialog.__upgradePip"></a>
232 <h4>PipListDialog.__upgradePip</h4>
233 <b>__upgradePip</b>(<i></i>)
234 <p>
235 Private slot to upgrade pip itself.
236 </p><a NAME="PipListDialog.closeEvent" ID="PipListDialog.closeEvent"></a>
237 <h4>PipListDialog.closeEvent</h4>
238 <b>closeEvent</b>(<i>e</i>)
239 <p>
240 Protected slot implementing a close event handler.
241 </p><dl>
242 <dt><i>e</i> (QCloseEvent)</dt>
243 <dd>
244 close event
245 </dd>
246 </dl><a NAME="PipListDialog.on_buttonBox_clicked" ID="PipListDialog.on_buttonBox_clicked"></a>
247 <h4>PipListDialog.on_buttonBox_clicked</h4>
248 <b>on_buttonBox_clicked</b>(<i>button</i>)
249 <p>
250 Private slot called by a button of the button box clicked.
251 </p><dl>
252 <dt><i>button</i> (QAbstractButton)</dt>
253 <dd>
254 button that was clicked
255 </dd>
256 </dl><a NAME="PipListDialog.on_installedFilesCheckBox_clicked" ID="PipListDialog.on_installedFilesCheckBox_clicked"></a>
257 <h4>PipListDialog.on_installedFilesCheckBox_clicked</h4>
258 <b>on_installedFilesCheckBox_clicked</b>(<i>checked</i>)
259 <p>
260 Private slot to handle a change of the installed files information
261 checkbox.
262 </p><dl>
263 <dt><i>checked</i> (bool)</dt>
264 <dd>
265 state of the checkbox
266 </dd>
267 </dl><a NAME="PipListDialog.on_localCheckBox_clicked" ID="PipListDialog.on_localCheckBox_clicked"></a>
268 <h4>PipListDialog.on_localCheckBox_clicked</h4>
269 <b>on_localCheckBox_clicked</b>(<i>checked</i>)
270 <p>
271 Private slot handling the switching of the local mode.
272 </p><dl>
273 <dt><i>checked</i> (bool)</dt>
274 <dd>
275 state of the local check box
276 </dd>
277 </dl><a NAME="PipListDialog.on_notRequiredCheckBox_clicked" ID="PipListDialog.on_notRequiredCheckBox_clicked"></a>
278 <h4>PipListDialog.on_notRequiredCheckBox_clicked</h4>
279 <b>on_notRequiredCheckBox_clicked</b>(<i>checked</i>)
280 <p>
281 Private slot handling the switching of the 'not required' mode.
282 </p><dl>
283 <dt><i>checked</i> (bool)</dt>
284 <dd>
285 state of the 'not required' check box
286 </dd>
287 </dl><a NAME="PipListDialog.on_packageList_itemSelectionChanged" ID="PipListDialog.on_packageList_itemSelectionChanged"></a>
288 <h4>PipListDialog.on_packageList_itemSelectionChanged</h4>
289 <b>on_packageList_itemSelectionChanged</b>(<i></i>)
290 <p>
291 Private slot handling the selection of a package.
292 </p><a NAME="PipListDialog.on_userCheckBox_clicked" ID="PipListDialog.on_userCheckBox_clicked"></a>
293 <h4>PipListDialog.on_userCheckBox_clicked</h4>
294 <b>on_userCheckBox_clicked</b>(<i>checked</i>)
295 <p>
296 Private slot handling the switching of the 'user-site' mode.
297 </p><dl>
298 <dt><i>checked</i> (bool)</dt>
299 <dd>
300 state of the 'user-site' check box
301 </dd>
302 </dl><a NAME="PipListDialog.on_venvComboBox_activated" ID="PipListDialog.on_venvComboBox_activated"></a>
303 <h4>PipListDialog.on_venvComboBox_activated</h4>
304 <b>on_venvComboBox_activated</b>(<i>txt</i>)
305 <p>
306 Private slot handling the selection of a virtual environment.
307 </p><dl>
308 <dt><i>txt</i> (str)</dt>
309 <dd>
310 virtual environment
311 </dd>
312 </dl><a NAME="PipListDialog.on_verboseCheckBox_clicked" ID="PipListDialog.on_verboseCheckBox_clicked"></a>
313 <h4>PipListDialog.on_verboseCheckBox_clicked</h4>
314 <b>on_verboseCheckBox_clicked</b>(<i>checked</i>)
315 <p>
316 Private slot to handle a change of the verbose package information
317 checkbox.
318 </p><dl>
319 <dt><i>checked</i> (bool)</dt>
320 <dd>
321 state of the checkbox
322 </dd>
323 </dl><a NAME="PipListDialog.start" ID="PipListDialog.start"></a>
324 <h4>PipListDialog.start</h4>
325 <b>start</b>(<i></i>)
326 <p>
327 Public method to start the command.
328 </p>
329 <div align="right"><a href="#top">Up</a></div>
330 <hr />
331 </body></html>

Mercurial Repository: eric

eric ide

mercurial