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