Mercurial Repositories > PyLint Checker / file comparison
comparison: PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog.html
PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog.html
- branch
- eric7
- changeset 102
- e40ecfd9ec37
- child 117
- f8955e5dba87
equal
deleted
inserted
replaced
| 101:98784d037491 | 102:e40ecfd9ec37 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>Plugin_Checker_PyLint.PyLintInterface.PyLintExecDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to show the results of the PyLint run. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#PyLintExecDialog">PyLintExecDialog</a></td> | |
| 25 <td>Class implementing a dialog to show the results of the PyLint run.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="PyLintExecDialog" ID="PyLintExecDialog"></a> | |
| 36 <h2>PyLintExecDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to show the results of the PyLint run. | |
| 40 </p> | |
| 41 <p> | |
| 42 This class starts a QProcess and displays a dialog that | |
| 43 shows the results of the PyLint command process. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 QWidget, Ui_PyLintExecDialog | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>filenameRole</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#PyLintExecDialog.__init__">PyLintExecDialog</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#PyLintExecDialog.__createItem">__createItem</a></td> | |
| 67 <td>Private method to create an entry in the message list.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#PyLintExecDialog.__finish">__finish</a></td> | |
| 71 <td>Private slot called when the process finished.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#PyLintExecDialog.__readParseStdout">__readParseStdout</a></td> | |
| 75 <td>Private slot to handle the readyReadStandardOutput signal for parseable output.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#PyLintExecDialog.__readStderr">__readStderr</a></td> | |
| 79 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#PyLintExecDialog.__readStdout">__readStdout</a></td> | |
| 83 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#PyLintExecDialog.__writeReport">__writeReport</a></td> | |
| 87 <td>Private slot to write the report to a report file.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#PyLintExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 91 <td>Private slot called by a button of the button box clicked.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#PyLintExecDialog.on_messageList_itemActivated">on_messageList_itemActivated</a></td> | |
| 95 <td>Private slot to handle the itemActivated signal of the message list.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#PyLintExecDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> | |
| 99 <td>Private slot to refresh the status display.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#PyLintExecDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> | |
| 103 <td>Private slot to save the report to a file.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#PyLintExecDialog.start">start</a></td> | |
| 107 <td>Public slot to start PyLint.</td> | |
| 108 </tr> | |
| 109 </table> | |
| 110 <h3>Static Methods</h3> | |
| 111 | |
| 112 <table> | |
| 113 <tr><td>None</td></tr> | |
| 114 </table> | |
| 115 | |
| 116 <a NAME="PyLintExecDialog.__init__" ID="PyLintExecDialog.__init__"></a> | |
| 117 <h4>PyLintExecDialog (Constructor)</h4> | |
| 118 <b>PyLintExecDialog</b>(<i>parent=None</i>) | |
| 119 | |
| 120 <p> | |
| 121 Constructor | |
| 122 </p> | |
| 123 <dl> | |
| 124 | |
| 125 <dt><i>parent</i> (QWidget)</dt> | |
| 126 <dd> | |
| 127 parent widget of this dialog | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <a NAME="PyLintExecDialog.__createItem" ID="PyLintExecDialog.__createItem"></a> | |
| 131 <h4>PyLintExecDialog.__createItem</h4> | |
| 132 <b>__createItem</b>(<i>file, line, type_, message</i>) | |
| 133 | |
| 134 <p> | |
| 135 Private method to create an entry in the message list. | |
| 136 </p> | |
| 137 <dl> | |
| 138 | |
| 139 <dt><i>file</i> (str)</dt> | |
| 140 <dd> | |
| 141 filename of file | |
| 142 </dd> | |
| 143 <dt><i>line</i> (int or str)</dt> | |
| 144 <dd> | |
| 145 linenumber of message | |
| 146 </dd> | |
| 147 <dt><i>type_</i> (str)</dt> | |
| 148 <dd> | |
| 149 type of message | |
| 150 </dd> | |
| 151 <dt><i>message</i> (str)</dt> | |
| 152 <dd> | |
| 153 message text | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <a NAME="PyLintExecDialog.__finish" ID="PyLintExecDialog.__finish"></a> | |
| 157 <h4>PyLintExecDialog.__finish</h4> | |
| 158 <b>__finish</b>(<i></i>) | |
| 159 | |
| 160 <p> | |
| 161 Private slot called when the process finished. | |
| 162 </p> | |
| 163 <p> | |
| 164 It is called when the process finished or the user pressed the button. | |
| 165 </p> | |
| 166 <a NAME="PyLintExecDialog.__readParseStdout" ID="PyLintExecDialog.__readParseStdout"></a> | |
| 167 <h4>PyLintExecDialog.__readParseStdout</h4> | |
| 168 <b>__readParseStdout</b>(<i></i>) | |
| 169 | |
| 170 <p> | |
| 171 Private slot to handle the readyReadStandardOutput signal for | |
| 172 parseable output. | |
| 173 </p> | |
| 174 <p> | |
| 175 It reads the output of the process, formats it and inserts it into | |
| 176 the message list pane. | |
| 177 </p> | |
| 178 <a NAME="PyLintExecDialog.__readStderr" ID="PyLintExecDialog.__readStderr"></a> | |
| 179 <h4>PyLintExecDialog.__readStderr</h4> | |
| 180 <b>__readStderr</b>(<i></i>) | |
| 181 | |
| 182 <p> | |
| 183 Private slot to handle the readyReadStandardError signal. | |
| 184 </p> | |
| 185 <p> | |
| 186 It reads the error output of the process and inserts it into the | |
| 187 error pane. | |
| 188 </p> | |
| 189 <a NAME="PyLintExecDialog.__readStdout" ID="PyLintExecDialog.__readStdout"></a> | |
| 190 <h4>PyLintExecDialog.__readStdout</h4> | |
| 191 <b>__readStdout</b>(<i></i>) | |
| 192 | |
| 193 <p> | |
| 194 Private slot to handle the readyReadStandardOutput signal. | |
| 195 </p> | |
| 196 <p> | |
| 197 It reads the output of the process, formats it and inserts it into | |
| 198 the contents pane. | |
| 199 </p> | |
| 200 <a NAME="PyLintExecDialog.__writeReport" ID="PyLintExecDialog.__writeReport"></a> | |
| 201 <h4>PyLintExecDialog.__writeReport</h4> | |
| 202 <b>__writeReport</b>(<i></i>) | |
| 203 | |
| 204 <p> | |
| 205 Private slot to write the report to a report file. | |
| 206 </p> | |
| 207 <a NAME="PyLintExecDialog.on_buttonBox_clicked" ID="PyLintExecDialog.on_buttonBox_clicked"></a> | |
| 208 <h4>PyLintExecDialog.on_buttonBox_clicked</h4> | |
| 209 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 210 | |
| 211 <p> | |
| 212 Private slot called by a button of the button box clicked. | |
| 213 </p> | |
| 214 <dl> | |
| 215 | |
| 216 <dt><i>button</i> (QAbstractButton)</dt> | |
| 217 <dd> | |
| 218 button that was clicked | |
| 219 </dd> | |
| 220 </dl> | |
| 221 <a NAME="PyLintExecDialog.on_messageList_itemActivated" ID="PyLintExecDialog.on_messageList_itemActivated"></a> | |
| 222 <h4>PyLintExecDialog.on_messageList_itemActivated</h4> | |
| 223 <b>on_messageList_itemActivated</b>(<i>itm, column</i>) | |
| 224 | |
| 225 <p> | |
| 226 Private slot to handle the itemActivated signal of the message list. | |
| 227 </p> | |
| 228 <dl> | |
| 229 | |
| 230 <dt><i>itm</i> (QTreeWidgetItem)</dt> | |
| 231 <dd> | |
| 232 The message item that was activated | |
| 233 </dd> | |
| 234 <dt><i>column</i> (int)</dt> | |
| 235 <dd> | |
| 236 column the item was activated in | |
| 237 </dd> | |
| 238 </dl> | |
| 239 <a NAME="PyLintExecDialog.on_refreshButton_clicked" ID="PyLintExecDialog.on_refreshButton_clicked"></a> | |
| 240 <h4>PyLintExecDialog.on_refreshButton_clicked</h4> | |
| 241 <b>on_refreshButton_clicked</b>(<i></i>) | |
| 242 | |
| 243 <p> | |
| 244 Private slot to refresh the status display. | |
| 245 </p> | |
| 246 <a NAME="PyLintExecDialog.on_saveButton_clicked" ID="PyLintExecDialog.on_saveButton_clicked"></a> | |
| 247 <h4>PyLintExecDialog.on_saveButton_clicked</h4> | |
| 248 <b>on_saveButton_clicked</b>(<i></i>) | |
| 249 | |
| 250 <p> | |
| 251 Private slot to save the report to a file. | |
| 252 </p> | |
| 253 <a NAME="PyLintExecDialog.start" ID="PyLintExecDialog.start"></a> | |
| 254 <h4>PyLintExecDialog.start</h4> | |
| 255 <b>start</b>(<i>args, fn, reportFile, ppath</i>) | |
| 256 | |
| 257 <p> | |
| 258 Public slot to start PyLint. | |
| 259 </p> | |
| 260 <dl> | |
| 261 | |
| 262 <dt><i>args</i> (list of str)</dt> | |
| 263 <dd> | |
| 264 commandline arguments for documentation programPyLint | |
| 265 </dd> | |
| 266 <dt><i>fn</i> (str)</dt> | |
| 267 <dd> | |
| 268 filename or dirname to be processed by PyLint | |
| 269 </dd> | |
| 270 <dt><i>reportFile</i> (str)</dt> | |
| 271 <dd> | |
| 272 filename of file to write the report to | |
| 273 </dd> | |
| 274 <dt><i>ppath</i> (str)</dt> | |
| 275 <dd> | |
| 276 project path | |
| 277 </dd> | |
| 278 </dl> | |
| 279 <dl> | |
| 280 <dt>Return:</dt> | |
| 281 <dd> | |
| 282 flag indicating the successful start of the process | |
| 283 </dd> | |
| 284 </dl> | |
| 285 <dl> | |
| 286 <dt>Return Type:</dt> | |
| 287 <dd> | |
| 288 bool | |
| 289 </dd> | |
| 290 </dl> | |
| 291 <div align="right"><a href="#top">Up</a></div> | |
| 292 <hr /> | |
| 293 </body></html> |
