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 18
- ae62d56e345d
- child 22
- 68beeb22dade
equal
deleted
inserted
replaced
| 17:be64e1afc5c2 | 18:ae62d56e345d |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Checker_PyLint.PyLint.PyLintExecDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background:white; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #4FA4FF; } | |
| 13 h2 { color: white; background: #4FA4FF; } | |
| 14 h3 { color: white; background: #00557F; } | |
| 15 h4 { color: white; background: #00557F; } | |
| 16 | |
| 17 a { color: #AA5500; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Checker_PyLint.PyLint.PyLintExecDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to show the results of the PyLint run. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#PyLintExecDialog">PyLintExecDialog</a></td> | |
| 34 <td>Class implementing a dialog to show the results of the PyLint run.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="PyLintExecDialog" ID="PyLintExecDialog"></a> | |
| 43 <h2>PyLintExecDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to show the results of the PyLint run. | |
| 46 </p><p> | |
| 47 This class starts a QProcess and displays a dialog that | |
| 48 shows the results of the PyLint command process. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 QWidget, Ui_PyLintExecDialog | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>filenameRole</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#PyLintExecDialog.__init__">PyLintExecDialog</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><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><tr> | |
| 69 <td><a href="#PyLintExecDialog.__finish">__finish</a></td> | |
| 70 <td>Private slot called when the process finished.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#PyLintExecDialog.__readParseStdout">__readParseStdout</a></td> | |
| 73 <td>Private slot to handle the readyReadStandardOutput signal for parseable output.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#PyLintExecDialog.__readStderr">__readStderr</a></td> | |
| 76 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#PyLintExecDialog.__readStdout">__readStdout</a></td> | |
| 79 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#PyLintExecDialog.__writeReport">__writeReport</a></td> | |
| 82 <td>Private slot to write the report to a report file.</td> | |
| 83 </tr><tr> | |
| 84 <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> | |
| 86 </tr><tr> | |
| 87 <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> | |
| 89 </tr><tr> | |
| 90 <td><a href="#PyLintExecDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> | |
| 91 <td>Private slot to refresh the status display.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#PyLintExecDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> | |
| 94 <td>Private slot to save the report to a file.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#PyLintExecDialog.start">start</a></td> | |
| 97 <td>Public slot to start PyLint.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <h3>Static Methods</h3> | |
| 101 <table> | |
| 102 <tr><td>None</td></tr> | |
| 103 </table> | |
| 104 <a NAME="PyLintExecDialog.__init__" ID="PyLintExecDialog.__init__"></a> | |
| 105 <h4>PyLintExecDialog (Constructor)</h4> | |
| 106 <b>PyLintExecDialog</b>(<i>parent=None</i>) | |
| 107 <p> | |
| 108 Constructor | |
| 109 </p><dl> | |
| 110 <dt><i>parent</i></dt> | |
| 111 <dd> | |
| 112 parent widget of this dialog (QWidget) | |
| 113 </dd> | |
| 114 </dl><a NAME="PyLintExecDialog.__createItem" ID="PyLintExecDialog.__createItem"></a> | |
| 115 <h4>PyLintExecDialog.__createItem</h4> | |
| 116 <b>__createItem</b>(<i>file, line, type_, message</i>) | |
| 117 <p> | |
| 118 Private method to create an entry in the message list. | |
| 119 </p><dl> | |
| 120 <dt><i>file</i></dt> | |
| 121 <dd> | |
| 122 filename of file (string) | |
| 123 </dd><dt><i>line</i></dt> | |
| 124 <dd> | |
| 125 linenumber of message (integer or string) | |
| 126 </dd><dt><i>type_</i></dt> | |
| 127 <dd> | |
| 128 type of message (string) | |
| 129 </dd><dt><i>message</i></dt> | |
| 130 <dd> | |
| 131 message text (string) | |
| 132 </dd> | |
| 133 </dl><a NAME="PyLintExecDialog.__finish" ID="PyLintExecDialog.__finish"></a> | |
| 134 <h4>PyLintExecDialog.__finish</h4> | |
| 135 <b>__finish</b>(<i></i>) | |
| 136 <p> | |
| 137 Private slot called when the process finished. | |
| 138 </p><p> | |
| 139 It is called when the process finished or | |
| 140 the user pressed the button. | |
| 141 </p><a NAME="PyLintExecDialog.__readParseStdout" ID="PyLintExecDialog.__readParseStdout"></a> | |
| 142 <h4>PyLintExecDialog.__readParseStdout</h4> | |
| 143 <b>__readParseStdout</b>(<i></i>) | |
| 144 <p> | |
| 145 Private slot to handle the readyReadStandardOutput signal for parseable output. | |
| 146 </p><p> | |
| 147 It reads the output of the process, formats it and inserts it into | |
| 148 the message list pane. | |
| 149 </p><a NAME="PyLintExecDialog.__readStderr" ID="PyLintExecDialog.__readStderr"></a> | |
| 150 <h4>PyLintExecDialog.__readStderr</h4> | |
| 151 <b>__readStderr</b>(<i></i>) | |
| 152 <p> | |
| 153 Private slot to handle the readyReadStandardError signal. | |
| 154 </p><p> | |
| 155 It reads the error output of the process and inserts it into the | |
| 156 error pane. | |
| 157 </p><a NAME="PyLintExecDialog.__readStdout" ID="PyLintExecDialog.__readStdout"></a> | |
| 158 <h4>PyLintExecDialog.__readStdout</h4> | |
| 159 <b>__readStdout</b>(<i></i>) | |
| 160 <p> | |
| 161 Private slot to handle the readyReadStandardOutput signal. | |
| 162 </p><p> | |
| 163 It reads the output of the process, formats it and inserts it into | |
| 164 the contents pane. | |
| 165 </p><a NAME="PyLintExecDialog.__writeReport" ID="PyLintExecDialog.__writeReport"></a> | |
| 166 <h4>PyLintExecDialog.__writeReport</h4> | |
| 167 <b>__writeReport</b>(<i></i>) | |
| 168 <p> | |
| 169 Private slot to write the report to a report file. | |
| 170 </p><a NAME="PyLintExecDialog.on_buttonBox_clicked" ID="PyLintExecDialog.on_buttonBox_clicked"></a> | |
| 171 <h4>PyLintExecDialog.on_buttonBox_clicked</h4> | |
| 172 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 173 <p> | |
| 174 Private slot called by a button of the button box clicked. | |
| 175 </p><dl> | |
| 176 <dt><i>button</i></dt> | |
| 177 <dd> | |
| 178 button that was clicked (QAbstractButton) | |
| 179 </dd> | |
| 180 </dl><a NAME="PyLintExecDialog.on_messageList_itemActivated" ID="PyLintExecDialog.on_messageList_itemActivated"></a> | |
| 181 <h4>PyLintExecDialog.on_messageList_itemActivated</h4> | |
| 182 <b>on_messageList_itemActivated</b>(<i>itm, column</i>) | |
| 183 <p> | |
| 184 Private slot to handle the itemActivated signal of the message list. | |
| 185 </p><dl> | |
| 186 <dt><i>itm</i></dt> | |
| 187 <dd> | |
| 188 The message item that was activated (QTreeWidgetItem) | |
| 189 </dd><dt><i>column</i></dt> | |
| 190 <dd> | |
| 191 column the item was activated in (integer) | |
| 192 </dd> | |
| 193 </dl><a NAME="PyLintExecDialog.on_refreshButton_clicked" ID="PyLintExecDialog.on_refreshButton_clicked"></a> | |
| 194 <h4>PyLintExecDialog.on_refreshButton_clicked</h4> | |
| 195 <b>on_refreshButton_clicked</b>(<i></i>) | |
| 196 <p> | |
| 197 Private slot to refresh the status display. | |
| 198 </p><a NAME="PyLintExecDialog.on_saveButton_clicked" ID="PyLintExecDialog.on_saveButton_clicked"></a> | |
| 199 <h4>PyLintExecDialog.on_saveButton_clicked</h4> | |
| 200 <b>on_saveButton_clicked</b>(<i></i>) | |
| 201 <p> | |
| 202 Private slot to save the report to a file. | |
| 203 </p><a NAME="PyLintExecDialog.start" ID="PyLintExecDialog.start"></a> | |
| 204 <h4>PyLintExecDialog.start</h4> | |
| 205 <b>start</b>(<i>args, fn, reportFile, ppath</i>) | |
| 206 <p> | |
| 207 Public slot to start PyLint. | |
| 208 </p><dl> | |
| 209 <dt><i>args</i></dt> | |
| 210 <dd> | |
| 211 commandline arguments for documentation programPyLint | |
| 212 (list of strings) | |
| 213 </dd><dt><i>fn</i></dt> | |
| 214 <dd> | |
| 215 filename or dirname to be processed by PyLint (string) | |
| 216 </dd><dt><i>reportFile</i></dt> | |
| 217 <dd> | |
| 218 filename of file to write the report to (string) | |
| 219 </dd><dt><i>ppath</i></dt> | |
| 220 <dd> | |
| 221 project path (string) | |
| 222 </dd> | |
| 223 </dl><dl> | |
| 224 <dt>Returns:</dt> | |
| 225 <dd> | |
| 226 flag indicating the successful start of the process (boolean) | |
| 227 </dd> | |
| 228 </dl> | |
| 229 <div align="right"><a href="#top">Up</a></div> | |
| 230 <hr /> | |
| 231 </body></html> |
