Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.CondaInterface.CondaExecDialog.html

eric7/Documentation/Source/eric7.CondaInterface.CondaExecDialog.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.CondaInterface.CondaExecDialog</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.CondaInterface.CondaExecDialog</h1>
24
25 <p>
26 Module implementing a dialog to show the output of a conda execution.
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="#CondaExecDialog">CondaExecDialog</a></td>
39 <td>Class implementing a dialog to show the output of a conda execution.</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="CondaExecDialog" ID="CondaExecDialog"></a>
50 <h2>CondaExecDialog</h2>
51
52 <p>
53 Class implementing a dialog to show the output of a conda execution.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_CondaExecDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#CondaExecDialog.__init__">CondaExecDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#CondaExecDialog.__finish">__finish</a></td>
77 <td>Private slot called when the process finished.</td>
78 </tr>
79 <tr>
80 <td><a href="#CondaExecDialog.__logError">__logError</a></td>
81 <td>Private method to log an error.</td>
82 </tr>
83 <tr>
84 <td><a href="#CondaExecDialog.__logOutput">__logOutput</a></td>
85 <td>Private method to log some output.</td>
86 </tr>
87 <tr>
88 <td><a href="#CondaExecDialog.__readStderr">__readStderr</a></td>
89 <td>Private slot to handle the readyReadStandardError signal.</td>
90 </tr>
91 <tr>
92 <td><a href="#CondaExecDialog.__readStdout">__readStdout</a></td>
93 <td>Private slot to handle the readyReadStandardOutput signal.</td>
94 </tr>
95 <tr>
96 <td><a href="#CondaExecDialog.__setProgressValues">__setProgressValues</a></td>
97 <td>Private method to set the value of the progress bar.</td>
98 </tr>
99 <tr>
100 <td><a href="#CondaExecDialog.getResult">getResult</a></td>
101 <td>Public method to the result of the command execution.</td>
102 </tr>
103 <tr>
104 <td><a href="#CondaExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
105 <td>Private slot called by a button of the button box clicked.</td>
106 </tr>
107 <tr>
108 <td><a href="#CondaExecDialog.start">start</a></td>
109 <td>Public slot to start the conda command.</td>
110 </tr>
111 </table>
112 <h3>Static Methods</h3>
113
114 <table>
115 <tr><td>None</td></tr>
116 </table>
117
118 <a NAME="CondaExecDialog.__init__" ID="CondaExecDialog.__init__"></a>
119 <h4>CondaExecDialog (Constructor)</h4>
120 <b>CondaExecDialog</b>(<i>command, parent=None</i>)
121
122 <p>
123 Constructor
124 </p>
125 <dl>
126
127 <dt><i>command</i> (str)</dt>
128 <dd>
129 conda command executed
130 </dd>
131 <dt><i>parent</i> (QWidget)</dt>
132 <dd>
133 reference to the parent widget
134 </dd>
135 </dl>
136 <a NAME="CondaExecDialog.__finish" ID="CondaExecDialog.__finish"></a>
137 <h4>CondaExecDialog.__finish</h4>
138 <b>__finish</b>(<i>exitCode, exitStatus, giveUp=False</i>)
139
140 <p>
141 Private slot called when the process finished.
142 </p>
143 <p>
144 It is called when the process finished or
145 the user pressed the button.
146 </p>
147 <dl>
148
149 <dt><i>exitCode</i> (int)</dt>
150 <dd>
151 exit code of the process
152 </dd>
153 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
154 <dd>
155 exit status of the process
156 </dd>
157 <dt><i>giveUp</i> (bool)</dt>
158 <dd>
159 flag indicating to not start another attempt
160 </dd>
161 </dl>
162 <a NAME="CondaExecDialog.__logError" ID="CondaExecDialog.__logError"></a>
163 <h4>CondaExecDialog.__logError</h4>
164 <b>__logError</b>(<i>stderr</i>)
165
166 <p>
167 Private method to log an error.
168 </p>
169 <dl>
170
171 <dt><i>stderr</i> (str)</dt>
172 <dd>
173 error string to log
174 </dd>
175 </dl>
176 <a NAME="CondaExecDialog.__logOutput" ID="CondaExecDialog.__logOutput"></a>
177 <h4>CondaExecDialog.__logOutput</h4>
178 <b>__logOutput</b>(<i>stdout</i>)
179
180 <p>
181 Private method to log some output.
182 </p>
183 <dl>
184
185 <dt><i>stdout</i> (str)</dt>
186 <dd>
187 output string to log
188 </dd>
189 </dl>
190 <a NAME="CondaExecDialog.__readStderr" ID="CondaExecDialog.__readStderr"></a>
191 <h4>CondaExecDialog.__readStderr</h4>
192 <b>__readStderr</b>(<i></i>)
193
194 <p>
195 Private slot to handle the readyReadStandardError signal.
196 </p>
197 <p>
198 It reads the error output of the process and inserts it into the
199 error pane.
200 </p>
201 <a NAME="CondaExecDialog.__readStdout" ID="CondaExecDialog.__readStdout"></a>
202 <h4>CondaExecDialog.__readStdout</h4>
203 <b>__readStdout</b>(<i></i>)
204
205 <p>
206 Private slot to handle the readyReadStandardOutput signal.
207 </p>
208 <p>
209 It reads the output of the process, formats it and inserts it into
210 the contents pane.
211 </p>
212 <a NAME="CondaExecDialog.__setProgressValues" ID="CondaExecDialog.__setProgressValues"></a>
213 <h4>CondaExecDialog.__setProgressValues</h4>
214 <b>__setProgressValues</b>(<i>jsonDict, progressType</i>)
215
216 <p>
217 Private method to set the value of the progress bar.
218 </p>
219 <dl>
220
221 <dt><i>jsonDict</i> (dict)</dt>
222 <dd>
223 dictionary containing the progress info
224 </dd>
225 <dt><i>progressType</i> (str)</dt>
226 <dd>
227 action type to check for
228 </dd>
229 </dl>
230 <dl>
231 <dt>Return:</dt>
232 <dd>
233 flag indicating success
234 </dd>
235 </dl>
236 <dl>
237 <dt>Return Type:</dt>
238 <dd>
239 bool
240 </dd>
241 </dl>
242 <a NAME="CondaExecDialog.getResult" ID="CondaExecDialog.getResult"></a>
243 <h4>CondaExecDialog.getResult</h4>
244 <b>getResult</b>(<i></i>)
245
246 <p>
247 Public method to the result of the command execution.
248 </p>
249 <dl>
250 <dt>Return:</dt>
251 <dd>
252 tuple containing a flag indicating success and the result data.
253 </dd>
254 </dl>
255 <dl>
256 <dt>Return Type:</dt>
257 <dd>
258 tuple of (bool, dict)
259 </dd>
260 </dl>
261 <a NAME="CondaExecDialog.on_buttonBox_clicked" ID="CondaExecDialog.on_buttonBox_clicked"></a>
262 <h4>CondaExecDialog.on_buttonBox_clicked</h4>
263 <b>on_buttonBox_clicked</b>(<i>button</i>)
264
265 <p>
266 Private slot called by a button of the button box clicked.
267 </p>
268 <dl>
269
270 <dt><i>button</i> (QAbstractButton)</dt>
271 <dd>
272 button that was clicked
273 </dd>
274 </dl>
275 <a NAME="CondaExecDialog.start" ID="CondaExecDialog.start"></a>
276 <h4>CondaExecDialog.start</h4>
277 <b>start</b>(<i>arguments</i>)
278
279 <p>
280 Public slot to start the conda command.
281 </p>
282 <dl>
283
284 <dt><i>arguments</i> (list of str)</dt>
285 <dd>
286 commandline arguments for conda program
287 </dd>
288 </dl>
289 <div align="right"><a href="#top">Up</a></div>
290 <hr />
291 </body></html>

Mercurial Repository: eric

eric ide

mercurial