Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.PipInterface.PipDialog.html

eric7/Documentation/Source/eric7.PipInterface.PipDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.PipInterface.PipDialog</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.PipInterface.PipDialog</h1>
24
25 <p>
26 Module implementing a dialog showing the output of a pip command.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#PipDialog">PipDialog</a></td>
39 <td>Class implementing a dialog showing the output of a 'python -m pip' command.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="PipDialog" ID="PipDialog"></a>
50 <h2>PipDialog</h2>
51
52 <p>
53 Class implementing a dialog showing the output of a 'python -m pip'
54 command.
55 </p>
56 <h3>Derived from</h3>
57 QDialog, Ui_PipDialog
58 <h3>Class Attributes</h3>
59
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Class Methods</h3>
64
65 <table>
66 <tr><td>None</td></tr>
67 </table>
68 <h3>Methods</h3>
69
70 <table>
71
72 <tr>
73 <td><a href="#PipDialog.__init__">PipDialog</a></td>
74 <td>Constructor</td>
75 </tr>
76 <tr>
77 <td><a href="#PipDialog.__addOutput">__addOutput</a></td>
78 <td>Private method to add some text to the output pane.</td>
79 </tr>
80 <tr>
81 <td><a href="#PipDialog.__cancel">__cancel</a></td>
82 <td>Private slot to cancel the current action.</td>
83 </tr>
84 <tr>
85 <td><a href="#PipDialog.__finish">__finish</a></td>
86 <td>Private slot called when the process finished or the user pressed the button.</td>
87 </tr>
88 <tr>
89 <td><a href="#PipDialog.__procFinished">__procFinished</a></td>
90 <td>Private slot connected to the finished signal.</td>
91 </tr>
92 <tr>
93 <td><a href="#PipDialog.__readStderr">__readStderr</a></td>
94 <td>Private slot to handle the readyReadStandardError signal.</td>
95 </tr>
96 <tr>
97 <td><a href="#PipDialog.__readStdout">__readStdout</a></td>
98 <td>Private slot to handle the readyReadStandardOutput signal.</td>
99 </tr>
100 <tr>
101 <td><a href="#PipDialog.closeEvent">closeEvent</a></td>
102 <td>Protected slot implementing a close event handler.</td>
103 </tr>
104 <tr>
105 <td><a href="#PipDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
106 <td>Private slot called by a button of the button box clicked.</td>
107 </tr>
108 <tr>
109 <td><a href="#PipDialog.startProcess">startProcess</a></td>
110 <td>Public slot used to start the process.</td>
111 </tr>
112 <tr>
113 <td><a href="#PipDialog.startProcesses">startProcesses</a></td>
114 <td>Public method to issue a list of commands to be executed.</td>
115 </tr>
116 </table>
117 <h3>Static Methods</h3>
118
119 <table>
120 <tr><td>None</td></tr>
121 </table>
122
123 <a NAME="PipDialog.__init__" ID="PipDialog.__init__"></a>
124 <h4>PipDialog (Constructor)</h4>
125 <b>PipDialog</b>(<i>text, parent=None</i>)
126
127 <p>
128 Constructor
129 </p>
130 <dl>
131
132 <dt><i>text</i> (str)</dt>
133 <dd>
134 text to be shown by the label
135 </dd>
136 <dt><i>parent</i> (QWidget)</dt>
137 <dd>
138 reference to the parent widget
139 </dd>
140 </dl>
141 <a NAME="PipDialog.__addOutput" ID="PipDialog.__addOutput"></a>
142 <h4>PipDialog.__addOutput</h4>
143 <b>__addOutput</b>(<i>txt</i>)
144
145 <p>
146 Private method to add some text to the output pane.
147 </p>
148 <dl>
149
150 <dt><i>txt</i> (str)</dt>
151 <dd>
152 text to be added
153 </dd>
154 </dl>
155 <a NAME="PipDialog.__cancel" ID="PipDialog.__cancel"></a>
156 <h4>PipDialog.__cancel</h4>
157 <b>__cancel</b>(<i></i>)
158
159 <p>
160 Private slot to cancel the current action.
161 </p>
162 <a NAME="PipDialog.__finish" ID="PipDialog.__finish"></a>
163 <h4>PipDialog.__finish</h4>
164 <b>__finish</b>(<i></i>)
165
166 <p>
167 Private slot called when the process finished or the user pressed
168 the button.
169 </p>
170 <a NAME="PipDialog.__procFinished" ID="PipDialog.__procFinished"></a>
171 <h4>PipDialog.__procFinished</h4>
172 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
173
174 <p>
175 Private slot connected to the finished signal.
176 </p>
177 <dl>
178
179 <dt><i>exitCode</i> (int)</dt>
180 <dd>
181 exit code of the process
182 </dd>
183 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
184 <dd>
185 exit status of the process
186 </dd>
187 </dl>
188 <a NAME="PipDialog.__readStderr" ID="PipDialog.__readStderr"></a>
189 <h4>PipDialog.__readStderr</h4>
190 <b>__readStderr</b>(<i></i>)
191
192 <p>
193 Private slot to handle the readyReadStandardError signal.
194 </p>
195 <p>
196 It reads the error output of the process and inserts it into the
197 error pane.
198 </p>
199 <a NAME="PipDialog.__readStdout" ID="PipDialog.__readStdout"></a>
200 <h4>PipDialog.__readStdout</h4>
201 <b>__readStdout</b>(<i></i>)
202
203 <p>
204 Private slot to handle the readyReadStandardOutput signal.
205 </p>
206 <p>
207 It reads the output of the process, formats it and inserts it into
208 the contents pane.
209 </p>
210 <a NAME="PipDialog.closeEvent" ID="PipDialog.closeEvent"></a>
211 <h4>PipDialog.closeEvent</h4>
212 <b>closeEvent</b>(<i>e</i>)
213
214 <p>
215 Protected slot implementing a close event handler.
216 </p>
217 <dl>
218
219 <dt><i>e</i> (QCloseEvent)</dt>
220 <dd>
221 close event
222 </dd>
223 </dl>
224 <a NAME="PipDialog.on_buttonBox_clicked" ID="PipDialog.on_buttonBox_clicked"></a>
225 <h4>PipDialog.on_buttonBox_clicked</h4>
226 <b>on_buttonBox_clicked</b>(<i>button</i>)
227
228 <p>
229 Private slot called by a button of the button box clicked.
230 </p>
231 <dl>
232
233 <dt><i>button</i> (QAbstractButton)</dt>
234 <dd>
235 button that was clicked
236 </dd>
237 </dl>
238 <a NAME="PipDialog.startProcess" ID="PipDialog.startProcess"></a>
239 <h4>PipDialog.startProcess</h4>
240 <b>startProcess</b>(<i>cmd, args, showArgs=True</i>)
241
242 <p>
243 Public slot used to start the process.
244 </p>
245 <dl>
246
247 <dt><i>cmd</i> (str)</dt>
248 <dd>
249 name of the pip executable to be used
250 </dd>
251 <dt><i>args</i> (list of str)</dt>
252 <dd>
253 list of arguments for the process
254 </dd>
255 <dt><i>showArgs</i> (bool)</dt>
256 <dd>
257 flag indicating to show the arguments
258 </dd>
259 </dl>
260 <dl>
261 <dt>Return:</dt>
262 <dd>
263 flag indicating a successful start of the process
264 </dd>
265 </dl>
266 <dl>
267 <dt>Return Type:</dt>
268 <dd>
269 bool
270 </dd>
271 </dl>
272 <a NAME="PipDialog.startProcesses" ID="PipDialog.startProcesses"></a>
273 <h4>PipDialog.startProcesses</h4>
274 <b>startProcesses</b>(<i>processParams</i>)
275
276 <p>
277 Public method to issue a list of commands to be executed.
278 </p>
279 <dl>
280
281 <dt><i>processParams</i> (list of tuples of (str, list of str))</dt>
282 <dd>
283 list of tuples containing the command
284 and arguments
285 </dd>
286 </dl>
287 <dl>
288 <dt>Return:</dt>
289 <dd>
290 flag indicating a successful start of the first process
291 </dd>
292 </dl>
293 <dl>
294 <dt>Return Type:</dt>
295 <dd>
296 bool
297 </dd>
298 </dl>
299 <div align="right"><a href="#top">Up</a></div>
300 <hr />
301 </body></html>

Mercurial Repository: eric

eric ide

mercurial