Mercurial Repositories > PyLint Checker / file comparison

comparison: PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLint.PyLintExecDialog.html

PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLint.PyLintExecDialog.html

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

Mercurial Repository: PyLint Checker

eric ide

mercurial