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

branch
eric7
changeset 10479
856476537696
parent 10070
9f5758c0fec1
child 10689
3ede487187f2
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.CondaInterface.CondaExecDialog</h1> 9 <h1>eric7.CondaInterface.CondaExecDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to show the output of a conda execution. 11 Module implementing a dialog to show the output of a conda execution.
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="#CondaExecDialog">CondaExecDialog</a></td> 22 <td><a href="#CondaExecDialog">CondaExecDialog</a></td>
25 <td>Class implementing a dialog to show the output of a conda execution.</td> 23 <td>Class implementing a dialog to show the output of a conda execution.</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="CondaExecDialog" ID="CondaExecDialog"></a> 34 <a NAME="CondaExecDialog" ID="CondaExecDialog"></a>
36 <h2>CondaExecDialog</h2> 35 <h2>CondaExecDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to show the output of a conda execution. 37 Class implementing a dialog to show the output of a conda execution.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_CondaExecDialog 41 QDialog, Ui_CondaExecDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#CondaExecDialog.__init__">CondaExecDialog</a></td> 55 <td><a href="#CondaExecDialog.__init__">CondaExecDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
93 <tr> 90 <tr>
94 <td><a href="#CondaExecDialog.start">start</a></td> 91 <td><a href="#CondaExecDialog.start">start</a></td>
95 <td>Public slot to start the conda command.</td> 92 <td>Public slot to start the conda command.</td>
96 </tr> 93 </tr>
97 </table> 94 </table>
95
98 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
99 97 <table>
100 <table> 98 <tr><td>None</td></tr>
101 <tr><td>None</td></tr> 99 </table>
102 </table> 100
103 101
104 <a NAME="CondaExecDialog.__init__" ID="CondaExecDialog.__init__"></a> 102 <a NAME="CondaExecDialog.__init__" ID="CondaExecDialog.__init__"></a>
105 <h4>CondaExecDialog (Constructor)</h4> 103 <h4>CondaExecDialog (Constructor)</h4>
106 <b>CondaExecDialog</b>(<i>command, parent=None</i>) 104 <b>CondaExecDialog</b>(<i>command, parent=None</i>)
107
108 <p> 105 <p>
109 Constructor 106 Constructor
110 </p> 107 </p>
108
111 <dl> 109 <dl>
112 110
113 <dt><i>command</i> (str)</dt> 111 <dt><i>command</i> (str)</dt>
114 <dd> 112 <dd>
115 conda command executed 113 conda command executed
120 </dd> 118 </dd>
121 </dl> 119 </dl>
122 <a NAME="CondaExecDialog.__finish" ID="CondaExecDialog.__finish"></a> 120 <a NAME="CondaExecDialog.__finish" ID="CondaExecDialog.__finish"></a>
123 <h4>CondaExecDialog.__finish</h4> 121 <h4>CondaExecDialog.__finish</h4>
124 <b>__finish</b>(<i>exitCode, exitStatus</i>) 122 <b>__finish</b>(<i>exitCode, exitStatus</i>)
125
126 <p> 123 <p>
127 Private slot called when the process finished. 124 Private slot called when the process finished.
128 </p> 125 </p>
129 <p> 126 <p>
130 It is called when the process finished or 127 It is called when the process finished or
131 the user pressed the button. 128 the user pressed the button.
132 </p> 129 </p>
130
133 <dl> 131 <dl>
134 132
135 <dt><i>exitCode</i> (int)</dt> 133 <dt><i>exitCode</i> (int)</dt>
136 <dd> 134 <dd>
137 exit code of the process 135 exit code of the process
142 </dd> 140 </dd>
143 </dl> 141 </dl>
144 <a NAME="CondaExecDialog.__logError" ID="CondaExecDialog.__logError"></a> 142 <a NAME="CondaExecDialog.__logError" ID="CondaExecDialog.__logError"></a>
145 <h4>CondaExecDialog.__logError</h4> 143 <h4>CondaExecDialog.__logError</h4>
146 <b>__logError</b>(<i>stderr</i>) 144 <b>__logError</b>(<i>stderr</i>)
147
148 <p> 145 <p>
149 Private method to log an error. 146 Private method to log an error.
150 </p> 147 </p>
148
151 <dl> 149 <dl>
152 150
153 <dt><i>stderr</i> (str)</dt> 151 <dt><i>stderr</i> (str)</dt>
154 <dd> 152 <dd>
155 error string to log 153 error string to log
156 </dd> 154 </dd>
157 </dl> 155 </dl>
158 <a NAME="CondaExecDialog.__logOutput" ID="CondaExecDialog.__logOutput"></a> 156 <a NAME="CondaExecDialog.__logOutput" ID="CondaExecDialog.__logOutput"></a>
159 <h4>CondaExecDialog.__logOutput</h4> 157 <h4>CondaExecDialog.__logOutput</h4>
160 <b>__logOutput</b>(<i>stdout</i>) 158 <b>__logOutput</b>(<i>stdout</i>)
161
162 <p> 159 <p>
163 Private method to log some output. 160 Private method to log some output.
164 </p> 161 </p>
162
165 <dl> 163 <dl>
166 164
167 <dt><i>stdout</i> (str)</dt> 165 <dt><i>stdout</i> (str)</dt>
168 <dd> 166 <dd>
169 output string to log 167 output string to log
170 </dd> 168 </dd>
171 </dl> 169 </dl>
172 <a NAME="CondaExecDialog.__readStderr" ID="CondaExecDialog.__readStderr"></a> 170 <a NAME="CondaExecDialog.__readStderr" ID="CondaExecDialog.__readStderr"></a>
173 <h4>CondaExecDialog.__readStderr</h4> 171 <h4>CondaExecDialog.__readStderr</h4>
174 <b>__readStderr</b>(<i></i>) 172 <b>__readStderr</b>(<i></i>)
175
176 <p> 173 <p>
177 Private slot to handle the readyReadStandardError signal. 174 Private slot to handle the readyReadStandardError signal.
178 </p> 175 </p>
179 <p> 176 <p>
180 It reads the error output of the process and inserts it into the 177 It reads the error output of the process and inserts it into the
181 error pane. 178 error pane.
182 </p> 179 </p>
180
183 <a NAME="CondaExecDialog.__readStdout" ID="CondaExecDialog.__readStdout"></a> 181 <a NAME="CondaExecDialog.__readStdout" ID="CondaExecDialog.__readStdout"></a>
184 <h4>CondaExecDialog.__readStdout</h4> 182 <h4>CondaExecDialog.__readStdout</h4>
185 <b>__readStdout</b>(<i></i>) 183 <b>__readStdout</b>(<i></i>)
186
187 <p> 184 <p>
188 Private slot to handle the readyReadStandardOutput signal. 185 Private slot to handle the readyReadStandardOutput signal.
189 </p> 186 </p>
190 <p> 187 <p>
191 It reads the output of the process, formats it and inserts it into 188 It reads the output of the process, formats it and inserts it into
192 the contents pane. 189 the contents pane.
193 </p> 190 </p>
191
194 <a NAME="CondaExecDialog.__setProgressValues" ID="CondaExecDialog.__setProgressValues"></a> 192 <a NAME="CondaExecDialog.__setProgressValues" ID="CondaExecDialog.__setProgressValues"></a>
195 <h4>CondaExecDialog.__setProgressValues</h4> 193 <h4>CondaExecDialog.__setProgressValues</h4>
196 <b>__setProgressValues</b>(<i>jsonDict, progressType</i>) 194 <b>__setProgressValues</b>(<i>jsonDict, progressType</i>)
197
198 <p> 195 <p>
199 Private method to set the value of the progress bar. 196 Private method to set the value of the progress bar.
200 </p> 197 </p>
198
201 <dl> 199 <dl>
202 200
203 <dt><i>jsonDict</i> (dict)</dt> 201 <dt><i>jsonDict</i> (dict)</dt>
204 <dd> 202 <dd>
205 dictionary containing the progress info 203 dictionary containing the progress info
222 </dd> 220 </dd>
223 </dl> 221 </dl>
224 <a NAME="CondaExecDialog.getResult" ID="CondaExecDialog.getResult"></a> 222 <a NAME="CondaExecDialog.getResult" ID="CondaExecDialog.getResult"></a>
225 <h4>CondaExecDialog.getResult</h4> 223 <h4>CondaExecDialog.getResult</h4>
226 <b>getResult</b>(<i></i>) 224 <b>getResult</b>(<i></i>)
227
228 <p> 225 <p>
229 Public method to the result of the command execution. 226 Public method to the result of the command execution.
230 </p> 227 </p>
228
231 <dl> 229 <dl>
232 <dt>Return:</dt> 230 <dt>Return:</dt>
233 <dd> 231 <dd>
234 tuple containing a flag indicating success and the result data. 232 tuple containing a flag indicating success and the result data.
235 </dd> 233 </dd>
241 </dd> 239 </dd>
242 </dl> 240 </dl>
243 <a NAME="CondaExecDialog.on_buttonBox_clicked" ID="CondaExecDialog.on_buttonBox_clicked"></a> 241 <a NAME="CondaExecDialog.on_buttonBox_clicked" ID="CondaExecDialog.on_buttonBox_clicked"></a>
244 <h4>CondaExecDialog.on_buttonBox_clicked</h4> 242 <h4>CondaExecDialog.on_buttonBox_clicked</h4>
245 <b>on_buttonBox_clicked</b>(<i>button</i>) 243 <b>on_buttonBox_clicked</b>(<i>button</i>)
246
247 <p> 244 <p>
248 Private slot called by a button of the button box clicked. 245 Private slot called by a button of the button box clicked.
249 </p> 246 </p>
247
250 <dl> 248 <dl>
251 249
252 <dt><i>button</i> (QAbstractButton)</dt> 250 <dt><i>button</i> (QAbstractButton)</dt>
253 <dd> 251 <dd>
254 button that was clicked 252 button that was clicked
255 </dd> 253 </dd>
256 </dl> 254 </dl>
257 <a NAME="CondaExecDialog.start" ID="CondaExecDialog.start"></a> 255 <a NAME="CondaExecDialog.start" ID="CondaExecDialog.start"></a>
258 <h4>CondaExecDialog.start</h4> 256 <h4>CondaExecDialog.start</h4>
259 <b>start</b>(<i>arguments</i>) 257 <b>start</b>(<i>arguments</i>)
260
261 <p> 258 <p>
262 Public slot to start the conda command. 259 Public slot to start the conda command.
263 </p> 260 </p>
261
264 <dl> 262 <dl>
265 263
266 <dt><i>arguments</i> (list of str)</dt> 264 <dt><i>arguments</i> (list of str)</dt>
267 <dd> 265 <dd>
268 commandline arguments for conda program 266 commandline arguments for conda program

eric ide

mercurial