Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
child 10690
fab36645aa7d
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.PipInterface.PipDialog</h1> 9 <h1>eric7.PipInterface.PipDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog showing the output of a pip command. 11 Module implementing a dialog showing the output of a pip command.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#PipDialog">PipDialog</a></td> 22 <td><a href="#PipDialog">PipDialog</a></td>
25 <td>Class implementing a dialog showing the output of a 'python -m pip' command.</td> 23 <td>Class implementing a dialog showing the output of a 'python -m pip' command.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="PipDialog" ID="PipDialog"></a> 34 <a NAME="PipDialog" ID="PipDialog"></a>
36 <h2>PipDialog</h2> 35 <h2>PipDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog showing the output of a 'python -m pip' 37 Class implementing a dialog showing the output of a 'python -m pip'
40 command. 38 command.
41 </p> 39 </p>
40
42 <h3>Derived from</h3> 41 <h3>Derived from</h3>
43 QDialog, Ui_PipDialog 42 QDialog, Ui_PipDialog
44 <h3>Class Attributes</h3> 43 <h3>Class Attributes</h3>
45 44 <table>
46 <table> 45 <tr><td>None</td></tr>
47 <tr><td>None</td></tr> 46 </table>
48 </table> 47
49 <h3>Class Methods</h3> 48 <h3>Class Methods</h3>
50 49 <table>
51 <table> 50 <tr><td>None</td></tr>
52 <tr><td>None</td></tr> 51 </table>
53 </table> 52
54 <h3>Methods</h3> 53 <h3>Methods</h3>
55 54 <table>
56 <table>
57
58 <tr> 55 <tr>
59 <td><a href="#PipDialog.__init__">PipDialog</a></td> 56 <td><a href="#PipDialog.__init__">PipDialog</a></td>
60 <td>Constructor</td> 57 <td>Constructor</td>
61 </tr> 58 </tr>
62 <tr> 59 <tr>
98 <tr> 95 <tr>
99 <td><a href="#PipDialog.startProcesses">startProcesses</a></td> 96 <td><a href="#PipDialog.startProcesses">startProcesses</a></td>
100 <td>Public method to issue a list of commands to be executed.</td> 97 <td>Public method to issue a list of commands to be executed.</td>
101 </tr> 98 </tr>
102 </table> 99 </table>
100
103 <h3>Static Methods</h3> 101 <h3>Static Methods</h3>
104 102 <table>
105 <table> 103 <tr><td>None</td></tr>
106 <tr><td>None</td></tr> 104 </table>
107 </table> 105
108 106
109 <a NAME="PipDialog.__init__" ID="PipDialog.__init__"></a> 107 <a NAME="PipDialog.__init__" ID="PipDialog.__init__"></a>
110 <h4>PipDialog (Constructor)</h4> 108 <h4>PipDialog (Constructor)</h4>
111 <b>PipDialog</b>(<i>text, parent=None</i>) 109 <b>PipDialog</b>(<i>text, parent=None</i>)
112
113 <p> 110 <p>
114 Constructor 111 Constructor
115 </p> 112 </p>
113
116 <dl> 114 <dl>
117 115
118 <dt><i>text</i> (str)</dt> 116 <dt><i>text</i> (str)</dt>
119 <dd> 117 <dd>
120 text to be shown by the label 118 text to be shown by the label
125 </dd> 123 </dd>
126 </dl> 124 </dl>
127 <a NAME="PipDialog.__addOutput" ID="PipDialog.__addOutput"></a> 125 <a NAME="PipDialog.__addOutput" ID="PipDialog.__addOutput"></a>
128 <h4>PipDialog.__addOutput</h4> 126 <h4>PipDialog.__addOutput</h4>
129 <b>__addOutput</b>(<i>txt</i>) 127 <b>__addOutput</b>(<i>txt</i>)
130
131 <p> 128 <p>
132 Private method to add some text to the output pane. 129 Private method to add some text to the output pane.
133 </p> 130 </p>
131
134 <dl> 132 <dl>
135 133
136 <dt><i>txt</i> (str)</dt> 134 <dt><i>txt</i> (str)</dt>
137 <dd> 135 <dd>
138 text to be added 136 text to be added
139 </dd> 137 </dd>
140 </dl> 138 </dl>
141 <a NAME="PipDialog.__cancel" ID="PipDialog.__cancel"></a> 139 <a NAME="PipDialog.__cancel" ID="PipDialog.__cancel"></a>
142 <h4>PipDialog.__cancel</h4> 140 <h4>PipDialog.__cancel</h4>
143 <b>__cancel</b>(<i></i>) 141 <b>__cancel</b>(<i></i>)
144
145 <p> 142 <p>
146 Private slot to cancel the current action. 143 Private slot to cancel the current action.
147 </p> 144 </p>
145
148 <a NAME="PipDialog.__finish" ID="PipDialog.__finish"></a> 146 <a NAME="PipDialog.__finish" ID="PipDialog.__finish"></a>
149 <h4>PipDialog.__finish</h4> 147 <h4>PipDialog.__finish</h4>
150 <b>__finish</b>(<i></i>) 148 <b>__finish</b>(<i></i>)
151
152 <p> 149 <p>
153 Private slot called when the process finished or the user pressed 150 Private slot called when the process finished or the user pressed
154 the button. 151 the button.
155 </p> 152 </p>
153
156 <a NAME="PipDialog.__procFinished" ID="PipDialog.__procFinished"></a> 154 <a NAME="PipDialog.__procFinished" ID="PipDialog.__procFinished"></a>
157 <h4>PipDialog.__procFinished</h4> 155 <h4>PipDialog.__procFinished</h4>
158 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 156 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
159
160 <p> 157 <p>
161 Private slot connected to the finished signal. 158 Private slot connected to the finished signal.
162 </p> 159 </p>
160
163 <dl> 161 <dl>
164 162
165 <dt><i>exitCode</i> (int)</dt> 163 <dt><i>exitCode</i> (int)</dt>
166 <dd> 164 <dd>
167 exit code of the process 165 exit code of the process
172 </dd> 170 </dd>
173 </dl> 171 </dl>
174 <a NAME="PipDialog.__readStderr" ID="PipDialog.__readStderr"></a> 172 <a NAME="PipDialog.__readStderr" ID="PipDialog.__readStderr"></a>
175 <h4>PipDialog.__readStderr</h4> 173 <h4>PipDialog.__readStderr</h4>
176 <b>__readStderr</b>(<i></i>) 174 <b>__readStderr</b>(<i></i>)
177
178 <p> 175 <p>
179 Private slot to handle the readyReadStandardError signal. 176 Private slot to handle the readyReadStandardError signal.
180 </p> 177 </p>
181 <p> 178 <p>
182 It reads the error output of the process and inserts it into the 179 It reads the error output of the process and inserts it into the
183 error pane. 180 error pane.
184 </p> 181 </p>
182
185 <a NAME="PipDialog.__readStdout" ID="PipDialog.__readStdout"></a> 183 <a NAME="PipDialog.__readStdout" ID="PipDialog.__readStdout"></a>
186 <h4>PipDialog.__readStdout</h4> 184 <h4>PipDialog.__readStdout</h4>
187 <b>__readStdout</b>(<i></i>) 185 <b>__readStdout</b>(<i></i>)
188
189 <p> 186 <p>
190 Private slot to handle the readyReadStandardOutput signal. 187 Private slot to handle the readyReadStandardOutput signal.
191 </p> 188 </p>
192 <p> 189 <p>
193 It reads the output of the process, formats it and inserts it into 190 It reads the output of the process, formats it and inserts it into
194 the contents pane. 191 the contents pane.
195 </p> 192 </p>
193
196 <a NAME="PipDialog.closeEvent" ID="PipDialog.closeEvent"></a> 194 <a NAME="PipDialog.closeEvent" ID="PipDialog.closeEvent"></a>
197 <h4>PipDialog.closeEvent</h4> 195 <h4>PipDialog.closeEvent</h4>
198 <b>closeEvent</b>(<i>e</i>) 196 <b>closeEvent</b>(<i>e</i>)
199
200 <p> 197 <p>
201 Protected slot implementing a close event handler. 198 Protected slot implementing a close event handler.
202 </p> 199 </p>
200
203 <dl> 201 <dl>
204 202
205 <dt><i>e</i> (QCloseEvent)</dt> 203 <dt><i>e</i> (QCloseEvent)</dt>
206 <dd> 204 <dd>
207 close event 205 close event
208 </dd> 206 </dd>
209 </dl> 207 </dl>
210 <a NAME="PipDialog.on_buttonBox_clicked" ID="PipDialog.on_buttonBox_clicked"></a> 208 <a NAME="PipDialog.on_buttonBox_clicked" ID="PipDialog.on_buttonBox_clicked"></a>
211 <h4>PipDialog.on_buttonBox_clicked</h4> 209 <h4>PipDialog.on_buttonBox_clicked</h4>
212 <b>on_buttonBox_clicked</b>(<i>button</i>) 210 <b>on_buttonBox_clicked</b>(<i>button</i>)
213
214 <p> 211 <p>
215 Private slot called by a button of the button box clicked. 212 Private slot called by a button of the button box clicked.
216 </p> 213 </p>
214
217 <dl> 215 <dl>
218 216
219 <dt><i>button</i> (QAbstractButton)</dt> 217 <dt><i>button</i> (QAbstractButton)</dt>
220 <dd> 218 <dd>
221 button that was clicked 219 button that was clicked
222 </dd> 220 </dd>
223 </dl> 221 </dl>
224 <a NAME="PipDialog.startProcess" ID="PipDialog.startProcess"></a> 222 <a NAME="PipDialog.startProcess" ID="PipDialog.startProcess"></a>
225 <h4>PipDialog.startProcess</h4> 223 <h4>PipDialog.startProcess</h4>
226 <b>startProcess</b>(<i>cmd, args, showArgs=True</i>) 224 <b>startProcess</b>(<i>cmd, args, showArgs=True</i>)
227
228 <p> 225 <p>
229 Public slot used to start the process. 226 Public slot used to start the process.
230 </p> 227 </p>
228
231 <dl> 229 <dl>
232 230
233 <dt><i>cmd</i> (str)</dt> 231 <dt><i>cmd</i> (str)</dt>
234 <dd> 232 <dd>
235 name of the pip executable to be used 233 name of the pip executable to be used
256 </dd> 254 </dd>
257 </dl> 255 </dl>
258 <a NAME="PipDialog.startProcesses" ID="PipDialog.startProcesses"></a> 256 <a NAME="PipDialog.startProcesses" ID="PipDialog.startProcesses"></a>
259 <h4>PipDialog.startProcesses</h4> 257 <h4>PipDialog.startProcesses</h4>
260 <b>startProcesses</b>(<i>processParams</i>) 258 <b>startProcesses</b>(<i>processParams</i>)
261
262 <p> 259 <p>
263 Public method to issue a list of commands to be executed. 260 Public method to issue a list of commands to be executed.
264 </p> 261 </p>
262
265 <dl> 263 <dl>
266 264
267 <dt><i>processParams</i> (list of tuples of (str, list of str))</dt> 265 <dt><i>processParams</i> (list of tuples of (str, list of str))</dt>
268 <dd> 266 <dd>
269 list of tuples containing the command 267 list of tuples containing the command

Mercurial Repository: eric

eric ide

mercurial