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