Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.CondaInterface.CondaExecDialog.html

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

Mercurial Repository: eric

eric ide

mercurial