|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog</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><a NAME="top" ID="top"></a> |
|
22 <h1>Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog</h1> |
|
23 <p> |
|
24 Module implementing a dialog to show the vulture check results. |
|
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="#VultureCheckerDialog">VultureCheckerDialog</a></td> |
|
34 <td>Class implementing a dialog to show the vulture check results.</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="VultureCheckerDialog" ID="VultureCheckerDialog"></a> |
|
43 <h2>VultureCheckerDialog</h2> |
|
44 <p> |
|
45 Class implementing a dialog to show the vulture check results. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QDialog, Ui_VultureCheckerDialog |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>FilePathRole</td></tr><tr><td>TypeRole</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#VultureCheckerDialog.__init__">VultureCheckerDialog</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#VultureCheckerDialog.__batchFinished">__batchFinished</a></td> |
|
64 <td>Private slot handling the completion of a batch job.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#VultureCheckerDialog.__createErrorItem">__createErrorItem</a></td> |
|
67 <td>Private slot to create a new error item in the result list.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#VultureCheckerDialog.__createFileItem">__createFileItem</a></td> |
|
70 <td>Private method to create a file item.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#VultureCheckerDialog.__createResultItem">__createResultItem</a></td> |
|
73 <td>Private method to create a result item.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#VultureCheckerDialog.__createResultItems">__createResultItems</a></td> |
|
76 <td>Private method to populate the list with the analysis result.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#VultureCheckerDialog.__dict2Item">__dict2Item</a></td> |
|
79 <td>Private method to convert an item dictionary to a vulture item.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#VultureCheckerDialog.__editWhiteList">__editWhiteList</a></td> |
|
82 <td>Private slot to edit the whitelist.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#VultureCheckerDialog.__filteredList">__filteredList</a></td> |
|
85 <td>Private method to filter a list against the whitelist patterns returning items not matching the whitelist.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#VultureCheckerDialog.__finish">__finish</a></td> |
|
88 <td>Private slot called when the action or the user pressed the button.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#VultureCheckerDialog.__getSelectedNonFileItems">__getSelectedNonFileItems</a></td> |
|
91 <td>Private method to get a list of selected non file items.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#VultureCheckerDialog.__getUnusedItems">__getUnusedItems</a></td> |
|
94 <td>Private method to get a list of unused items.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#VultureCheckerDialog.__prepareResultLists">__prepareResultLists</a></td> |
|
97 <td>Private method to prepare the result lists.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#VultureCheckerDialog.__processError">__processError</a></td> |
|
100 <td>Private slot to process an error indication from the service.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#VultureCheckerDialog.__processResult">__processResult</a></td> |
|
103 <td>Private slot called after perfoming a vulture analysis on one file.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#VultureCheckerDialog.__resultCollapse">__resultCollapse</a></td> |
|
106 <td>Private slot to collapse all entries of the resultlist.</td> |
|
107 </tr><tr> |
|
108 <td><a href="#VultureCheckerDialog.__resultExpand">__resultExpand</a></td> |
|
109 <td>Private slot to expand all entries of the resultlist.</td> |
|
110 </tr><tr> |
|
111 <td><a href="#VultureCheckerDialog.__showContextMenu">__showContextMenu</a></td> |
|
112 <td>Private slot to show the context menu of the listview.</td> |
|
113 </tr><tr> |
|
114 <td><a href="#VultureCheckerDialog.__storeResult">__storeResult</a></td> |
|
115 <td>Private method to store the result of an analysis.</td> |
|
116 </tr><tr> |
|
117 <td><a href="#VultureCheckerDialog.__storeWhiteLists">__storeWhiteLists</a></td> |
|
118 <td>Private method to store the new whitelists, if they have changed.</td> |
|
119 </tr><tr> |
|
120 <td><a href="#VultureCheckerDialog.__unusedAttributes">__unusedAttributes</a></td> |
|
121 <td>Private method to get the list of unused attributes.</td> |
|
122 </tr><tr> |
|
123 <td><a href="#VultureCheckerDialog.__unusedFunctions">__unusedFunctions</a></td> |
|
124 <td>Private method to get the list of unused functions.</td> |
|
125 </tr><tr> |
|
126 <td><a href="#VultureCheckerDialog.__unusedProperties">__unusedProperties</a></td> |
|
127 <td>Private method to get the list of unused properties.</td> |
|
128 </tr><tr> |
|
129 <td><a href="#VultureCheckerDialog.__unusedSlots">__unusedSlots</a></td> |
|
130 <td>Private method to get the list of unused PyQt slots.</td> |
|
131 </tr><tr> |
|
132 <td><a href="#VultureCheckerDialog.__unusedVariables">__unusedVariables</a></td> |
|
133 <td>Private method to get the list of unused variables.</td> |
|
134 </tr><tr> |
|
135 <td><a href="#VultureCheckerDialog.__whiteList">__whiteList</a></td> |
|
136 <td>Private slot to add entries to the whitelist.</td> |
|
137 </tr><tr> |
|
138 <td><a href="#VultureCheckerDialog.clear">clear</a></td> |
|
139 <td>Public method to clear all results.</td> |
|
140 </tr><tr> |
|
141 <td><a href="#VultureCheckerDialog.filename">filename</a></td> |
|
142 <td></td> |
|
143 </tr><tr> |
|
144 <td><a href="#VultureCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
145 <td>Private slot called by a button of the button box clicked.</td> |
|
146 </tr><tr> |
|
147 <td><a href="#VultureCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> |
|
148 <td>Private slot to handle the activation of a result item.</td> |
|
149 </tr><tr> |
|
150 <td><a href="#VultureCheckerDialog.on_startButton_clicked">on_startButton_clicked</a></td> |
|
151 <td>Private slot to start a code metrics run.</td> |
|
152 </tr><tr> |
|
153 <td><a href="#VultureCheckerDialog.prepare">prepare</a></td> |
|
154 <td>Public method to prepare the dialog with a list of filenames.</td> |
|
155 </tr><tr> |
|
156 <td><a href="#VultureCheckerDialog.start">start</a></td> |
|
157 <td>Public slot to start the code metrics determination.</td> |
|
158 </tr><tr> |
|
159 <td><a href="#VultureCheckerDialog.vultureCheck">vultureCheck</a></td> |
|
160 <td>Public method to start a vulture check for one Python file.</td> |
|
161 </tr><tr> |
|
162 <td><a href="#VultureCheckerDialog.vultureCheckBatch">vultureCheckBatch</a></td> |
|
163 <td>Public method to start a vulture check batch job.</td> |
|
164 </tr> |
|
165 </table> |
|
166 <h3>Static Methods</h3> |
|
167 <table> |
|
168 <tr><td>None</td></tr> |
|
169 </table> |
|
170 <a NAME="VultureCheckerDialog.__init__" ID="VultureCheckerDialog.__init__"></a> |
|
171 <h4>VultureCheckerDialog (Constructor)</h4> |
|
172 <b>VultureCheckerDialog</b>(<i>vultureService, parent=None</i>) |
|
173 <p> |
|
174 Constructor |
|
175 </p><dl> |
|
176 <dt><i>vultureService</i> (VulturePlugin)</dt> |
|
177 <dd> |
|
178 reference to the service |
|
179 </dd><dt><i>parent</i> (QWidget)</dt> |
|
180 <dd> |
|
181 reference to the parent widget |
|
182 </dd> |
|
183 </dl><a NAME="VultureCheckerDialog.__batchFinished" ID="VultureCheckerDialog.__batchFinished"></a> |
|
184 <h4>VultureCheckerDialog.__batchFinished</h4> |
|
185 <b>__batchFinished</b>(<i></i>) |
|
186 <p> |
|
187 Private slot handling the completion of a batch job. |
|
188 </p><a NAME="VultureCheckerDialog.__createErrorItem" ID="VultureCheckerDialog.__createErrorItem"></a> |
|
189 <h4>VultureCheckerDialog.__createErrorItem</h4> |
|
190 <b>__createErrorItem</b>(<i>filename, message</i>) |
|
191 <p> |
|
192 Private slot to create a new error item in the result list. |
|
193 </p><dl> |
|
194 <dt><i>filename</i> (str)</dt> |
|
195 <dd> |
|
196 name of the file |
|
197 </dd><dt><i>message</i> (str)</dt> |
|
198 <dd> |
|
199 error message |
|
200 </dd> |
|
201 </dl><a NAME="VultureCheckerDialog.__createFileItem" ID="VultureCheckerDialog.__createFileItem"></a> |
|
202 <h4>VultureCheckerDialog.__createFileItem</h4> |
|
203 <b>__createFileItem</b>(<i>filename</i>) |
|
204 <p> |
|
205 Private method to create a file item. |
|
206 </p><dl> |
|
207 <dt><i>filename</i> (str)</dt> |
|
208 <dd> |
|
209 file name for the item |
|
210 </dd> |
|
211 </dl><dl> |
|
212 <dt>Returns:</dt> |
|
213 <dd> |
|
214 reference to the created item |
|
215 </dd> |
|
216 </dl><dl> |
|
217 <dt>Return Type:</dt> |
|
218 <dd> |
|
219 QTreeWidgetItem |
|
220 </dd> |
|
221 </dl><a NAME="VultureCheckerDialog.__createResultItem" ID="VultureCheckerDialog.__createResultItem"></a> |
|
222 <h4>VultureCheckerDialog.__createResultItem</h4> |
|
223 <b>__createResultItem</b>(<i>parent, item</i>) |
|
224 <p> |
|
225 Private method to create a result item. |
|
226 </p><dl> |
|
227 <dt><i>parent</i> (QTreeWidgetItem)</dt> |
|
228 <dd> |
|
229 reference to the parent item |
|
230 </dd><dt><i>item</i> (vulture.Item)</dt> |
|
231 <dd> |
|
232 reference to the item |
|
233 </dd> |
|
234 </dl><a NAME="VultureCheckerDialog.__createResultItems" ID="VultureCheckerDialog.__createResultItems"></a> |
|
235 <h4>VultureCheckerDialog.__createResultItems</h4> |
|
236 <b>__createResultItems</b>(<i></i>) |
|
237 <p> |
|
238 Private method to populate the list with the analysis result. |
|
239 </p><a NAME="VultureCheckerDialog.__dict2Item" ID="VultureCheckerDialog.__dict2Item"></a> |
|
240 <h4>VultureCheckerDialog.__dict2Item</h4> |
|
241 <b>__dict2Item</b>(<i>d</i>) |
|
242 <p> |
|
243 Private method to convert an item dictionary to a vulture item. |
|
244 </p><dl> |
|
245 <dt><i>d</i> (dict)</dt> |
|
246 <dd> |
|
247 item dictionary |
|
248 </dd> |
|
249 </dl><dl> |
|
250 <dt>Returns:</dt> |
|
251 <dd> |
|
252 vulture item |
|
253 </dd> |
|
254 </dl><dl> |
|
255 <dt>Return Type:</dt> |
|
256 <dd> |
|
257 vulture.Item |
|
258 </dd> |
|
259 </dl><a NAME="VultureCheckerDialog.__editWhiteList" ID="VultureCheckerDialog.__editWhiteList"></a> |
|
260 <h4>VultureCheckerDialog.__editWhiteList</h4> |
|
261 <b>__editWhiteList</b>(<i></i>) |
|
262 <p> |
|
263 Private slot to edit the whitelist. |
|
264 </p><a NAME="VultureCheckerDialog.__filteredList" ID="VultureCheckerDialog.__filteredList"></a> |
|
265 <h4>VultureCheckerDialog.__filteredList</h4> |
|
266 <b>__filteredList</b>(<i>itemList</i>) |
|
267 <p> |
|
268 Private method to filter a list against the whitelist patterns |
|
269 returning items not matching the whitelist. |
|
270 </p><dl> |
|
271 <dt><i>itemList</i> (list of vulture.Item)</dt> |
|
272 <dd> |
|
273 list of items to be filtered |
|
274 </dd> |
|
275 </dl><dl> |
|
276 <dt>Returns:</dt> |
|
277 <dd> |
|
278 list of filtered items |
|
279 </dd> |
|
280 </dl><dl> |
|
281 <dt>Return Type:</dt> |
|
282 <dd> |
|
283 list of vulture.Item |
|
284 </dd> |
|
285 </dl><a NAME="VultureCheckerDialog.__finish" ID="VultureCheckerDialog.__finish"></a> |
|
286 <h4>VultureCheckerDialog.__finish</h4> |
|
287 <b>__finish</b>(<i></i>) |
|
288 <p> |
|
289 Private slot called when the action or the user pressed the button. |
|
290 </p><a NAME="VultureCheckerDialog.__getSelectedNonFileItems" ID="VultureCheckerDialog.__getSelectedNonFileItems"></a> |
|
291 <h4>VultureCheckerDialog.__getSelectedNonFileItems</h4> |
|
292 <b>__getSelectedNonFileItems</b>(<i></i>) |
|
293 <p> |
|
294 Private method to get a list of selected non file items. |
|
295 </p><dl> |
|
296 <dt>Returns:</dt> |
|
297 <dd> |
|
298 list of selected non file items |
|
299 </dd> |
|
300 </dl><dl> |
|
301 <dt>Return Type:</dt> |
|
302 <dd> |
|
303 list of QTreeWidgetItem |
|
304 </dd> |
|
305 </dl><a NAME="VultureCheckerDialog.__getUnusedItems" ID="VultureCheckerDialog.__getUnusedItems"></a> |
|
306 <h4>VultureCheckerDialog.__getUnusedItems</h4> |
|
307 <b>__getUnusedItems</b>(<i>defined, used</i>) |
|
308 <p> |
|
309 Private method to get a list of unused items. |
|
310 </p><dl> |
|
311 <dt><i>defined</i> (list of vulture.Item)</dt> |
|
312 <dd> |
|
313 list of defined items |
|
314 </dd><dt><i>used</i> (list of vulture.Item)</dt> |
|
315 <dd> |
|
316 list of used items |
|
317 </dd> |
|
318 </dl><dl> |
|
319 <dt>Returns:</dt> |
|
320 <dd> |
|
321 list of unused items |
|
322 </dd> |
|
323 </dl><dl> |
|
324 <dt>Return Type:</dt> |
|
325 <dd> |
|
326 list of vulture.Item |
|
327 </dd> |
|
328 </dl><a NAME="VultureCheckerDialog.__prepareResultLists" ID="VultureCheckerDialog.__prepareResultLists"></a> |
|
329 <h4>VultureCheckerDialog.__prepareResultLists</h4> |
|
330 <b>__prepareResultLists</b>(<i></i>) |
|
331 <p> |
|
332 Private method to prepare the result lists. |
|
333 </p><a NAME="VultureCheckerDialog.__processError" ID="VultureCheckerDialog.__processError"></a> |
|
334 <h4>VultureCheckerDialog.__processError</h4> |
|
335 <b>__processError</b>(<i>fn, msg</i>) |
|
336 <p> |
|
337 Private slot to process an error indication from the service. |
|
338 </p><dl> |
|
339 <dt><i>fn</i> (str)</dt> |
|
340 <dd> |
|
341 filename of the file |
|
342 </dd><dt><i>msg</i> (str)</dt> |
|
343 <dd> |
|
344 error message |
|
345 </dd> |
|
346 </dl><a NAME="VultureCheckerDialog.__processResult" ID="VultureCheckerDialog.__processResult"></a> |
|
347 <h4>VultureCheckerDialog.__processResult</h4> |
|
348 <b>__processResult</b>(<i>fn, result</i>) |
|
349 <p> |
|
350 Private slot called after perfoming a vulture analysis on one file. |
|
351 </p><dl> |
|
352 <dt><i>fn</i> (str)</dt> |
|
353 <dd> |
|
354 filename of the file |
|
355 </dd><dt><i>result</i> (dict)</dt> |
|
356 <dd> |
|
357 result dict |
|
358 </dd> |
|
359 </dl><a NAME="VultureCheckerDialog.__resultCollapse" ID="VultureCheckerDialog.__resultCollapse"></a> |
|
360 <h4>VultureCheckerDialog.__resultCollapse</h4> |
|
361 <b>__resultCollapse</b>(<i></i>) |
|
362 <p> |
|
363 Private slot to collapse all entries of the resultlist. |
|
364 </p><a NAME="VultureCheckerDialog.__resultExpand" ID="VultureCheckerDialog.__resultExpand"></a> |
|
365 <h4>VultureCheckerDialog.__resultExpand</h4> |
|
366 <b>__resultExpand</b>(<i></i>) |
|
367 <p> |
|
368 Private slot to expand all entries of the resultlist. |
|
369 </p><a NAME="VultureCheckerDialog.__showContextMenu" ID="VultureCheckerDialog.__showContextMenu"></a> |
|
370 <h4>VultureCheckerDialog.__showContextMenu</h4> |
|
371 <b>__showContextMenu</b>(<i>coord</i>) |
|
372 <p> |
|
373 Private slot to show the context menu of the listview. |
|
374 </p><dl> |
|
375 <dt><i>coord</i> (QPoint)</dt> |
|
376 <dd> |
|
377 the position of the mouse pointer |
|
378 </dd> |
|
379 </dl><a NAME="VultureCheckerDialog.__storeResult" ID="VultureCheckerDialog.__storeResult"></a> |
|
380 <h4>VultureCheckerDialog.__storeResult</h4> |
|
381 <b>__storeResult</b>(<i>result</i>) |
|
382 <p> |
|
383 Private method to store the result of an analysis. |
|
384 </p><dl> |
|
385 <dt><i>result</i> (dict)</dt> |
|
386 <dd> |
|
387 result dictionary |
|
388 </dd> |
|
389 </dl><a NAME="VultureCheckerDialog.__storeWhiteLists" ID="VultureCheckerDialog.__storeWhiteLists"></a> |
|
390 <h4>VultureCheckerDialog.__storeWhiteLists</h4> |
|
391 <b>__storeWhiteLists</b>(<i>whitelists</i>) |
|
392 <p> |
|
393 Private method to store the new whitelists, if they have changed. |
|
394 </p><dl> |
|
395 <dt><i>whitelists</i> (dict of list of str)</dt> |
|
396 <dd> |
|
397 dictionary of lists of whitelisted names |
|
398 </dd> |
|
399 </dl><a NAME="VultureCheckerDialog.__unusedAttributes" ID="VultureCheckerDialog.__unusedAttributes"></a> |
|
400 <h4>VultureCheckerDialog.__unusedAttributes</h4> |
|
401 <b>__unusedAttributes</b>(<i></i>) |
|
402 <p> |
|
403 Private method to get the list of unused attributes. |
|
404 </p><dl> |
|
405 <dt>Returns:</dt> |
|
406 <dd> |
|
407 list of unused attributes |
|
408 </dd> |
|
409 </dl><dl> |
|
410 <dt>Return Type:</dt> |
|
411 <dd> |
|
412 list of vulture.Item |
|
413 </dd> |
|
414 </dl><a NAME="VultureCheckerDialog.__unusedFunctions" ID="VultureCheckerDialog.__unusedFunctions"></a> |
|
415 <h4>VultureCheckerDialog.__unusedFunctions</h4> |
|
416 <b>__unusedFunctions</b>(<i></i>) |
|
417 <p> |
|
418 Private method to get the list of unused functions. |
|
419 </p><dl> |
|
420 <dt>Returns:</dt> |
|
421 <dd> |
|
422 list of unused functions |
|
423 </dd> |
|
424 </dl><dl> |
|
425 <dt>Return Type:</dt> |
|
426 <dd> |
|
427 list of vulture.Item |
|
428 </dd> |
|
429 </dl><a NAME="VultureCheckerDialog.__unusedProperties" ID="VultureCheckerDialog.__unusedProperties"></a> |
|
430 <h4>VultureCheckerDialog.__unusedProperties</h4> |
|
431 <b>__unusedProperties</b>(<i></i>) |
|
432 <p> |
|
433 Private method to get the list of unused properties. |
|
434 </p><dl> |
|
435 <dt>Returns:</dt> |
|
436 <dd> |
|
437 list of unused properties |
|
438 </dd> |
|
439 </dl><dl> |
|
440 <dt>Return Type:</dt> |
|
441 <dd> |
|
442 list of vulture.Item |
|
443 </dd> |
|
444 </dl><a NAME="VultureCheckerDialog.__unusedSlots" ID="VultureCheckerDialog.__unusedSlots"></a> |
|
445 <h4>VultureCheckerDialog.__unusedSlots</h4> |
|
446 <b>__unusedSlots</b>(<i></i>) |
|
447 <p> |
|
448 Private method to get the list of unused PyQt slots. |
|
449 </p><dl> |
|
450 <dt>Returns:</dt> |
|
451 <dd> |
|
452 list of unused PyQt slots |
|
453 </dd> |
|
454 </dl><dl> |
|
455 <dt>Return Type:</dt> |
|
456 <dd> |
|
457 list of vulture.Item |
|
458 </dd> |
|
459 </dl><a NAME="VultureCheckerDialog.__unusedVariables" ID="VultureCheckerDialog.__unusedVariables"></a> |
|
460 <h4>VultureCheckerDialog.__unusedVariables</h4> |
|
461 <b>__unusedVariables</b>(<i></i>) |
|
462 <p> |
|
463 Private method to get the list of unused variables. |
|
464 </p><dl> |
|
465 <dt>Returns:</dt> |
|
466 <dd> |
|
467 list of unused variables |
|
468 </dd> |
|
469 </dl><dl> |
|
470 <dt>Return Type:</dt> |
|
471 <dd> |
|
472 list of vulture.Item |
|
473 </dd> |
|
474 </dl><a NAME="VultureCheckerDialog.__whiteList" ID="VultureCheckerDialog.__whiteList"></a> |
|
475 <h4>VultureCheckerDialog.__whiteList</h4> |
|
476 <b>__whiteList</b>(<i></i>) |
|
477 <p> |
|
478 Private slot to add entries to the whitelist. |
|
479 </p><a NAME="VultureCheckerDialog.clear" ID="VultureCheckerDialog.clear"></a> |
|
480 <h4>VultureCheckerDialog.clear</h4> |
|
481 <b>clear</b>(<i></i>) |
|
482 <p> |
|
483 Public method to clear all results. |
|
484 </p><a NAME="VultureCheckerDialog.filename" ID="VultureCheckerDialog.filename"></a> |
|
485 <h4>VultureCheckerDialog.filename</h4> |
|
486 <b>filename</b>(<i></i>) |
|
487 <a NAME="VultureCheckerDialog.on_buttonBox_clicked" ID="VultureCheckerDialog.on_buttonBox_clicked"></a> |
|
488 <h4>VultureCheckerDialog.on_buttonBox_clicked</h4> |
|
489 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
490 <p> |
|
491 Private slot called by a button of the button box clicked. |
|
492 </p><dl> |
|
493 <dt><i>button</i> (QAbstractButton)</dt> |
|
494 <dd> |
|
495 button that was clicked |
|
496 </dd> |
|
497 </dl><a NAME="VultureCheckerDialog.on_resultList_itemActivated" ID="VultureCheckerDialog.on_resultList_itemActivated"></a> |
|
498 <h4>VultureCheckerDialog.on_resultList_itemActivated</h4> |
|
499 <b>on_resultList_itemActivated</b>(<i>item, column</i>) |
|
500 <p> |
|
501 Private slot to handle the activation of a result item. |
|
502 </p><dl> |
|
503 <dt><i>item</i> (QTreeWidgetItem)</dt> |
|
504 <dd> |
|
505 reference to the activated item |
|
506 </dd><dt><i>column</i> (int)</dt> |
|
507 <dd> |
|
508 column the item was activated in |
|
509 </dd> |
|
510 </dl><a NAME="VultureCheckerDialog.on_startButton_clicked" ID="VultureCheckerDialog.on_startButton_clicked"></a> |
|
511 <h4>VultureCheckerDialog.on_startButton_clicked</h4> |
|
512 <b>on_startButton_clicked</b>(<i></i>) |
|
513 <p> |
|
514 Private slot to start a code metrics run. |
|
515 </p><a NAME="VultureCheckerDialog.prepare" ID="VultureCheckerDialog.prepare"></a> |
|
516 <h4>VultureCheckerDialog.prepare</h4> |
|
517 <b>prepare</b>(<i>fileList, project</i>) |
|
518 <p> |
|
519 Public method to prepare the dialog with a list of filenames. |
|
520 </p><dl> |
|
521 <dt><i>fileList</i> (list of str)</dt> |
|
522 <dd> |
|
523 list of filenames |
|
524 </dd><dt><i>project</i> (Project)</dt> |
|
525 <dd> |
|
526 reference to the project object |
|
527 </dd> |
|
528 </dl><a NAME="VultureCheckerDialog.start" ID="VultureCheckerDialog.start"></a> |
|
529 <h4>VultureCheckerDialog.start</h4> |
|
530 <b>start</b>(<i>fn</i>) |
|
531 <p> |
|
532 Public slot to start the code metrics determination. |
|
533 </p><dl> |
|
534 <dt><i>fn</i> (str or list of str)</dt> |
|
535 <dd> |
|
536 file or list of files or directory to show |
|
537 the code metrics for |
|
538 </dd> |
|
539 </dl><a NAME="VultureCheckerDialog.vultureCheck" ID="VultureCheckerDialog.vultureCheck"></a> |
|
540 <h4>VultureCheckerDialog.vultureCheck</h4> |
|
541 <b>vultureCheck</b>(<i>codestring=''</i>) |
|
542 <p> |
|
543 Public method to start a vulture check for one Python file. |
|
544 </p><p> |
|
545 The results are reported to the __processResult slot. |
|
546 </p><dl> |
|
547 <dt><i>codestring=</i> (str)</dt> |
|
548 <dd> |
|
549 optional sourcestring |
|
550 </dd> |
|
551 </dl><a NAME="VultureCheckerDialog.vultureCheckBatch" ID="VultureCheckerDialog.vultureCheckBatch"></a> |
|
552 <h4>VultureCheckerDialog.vultureCheckBatch</h4> |
|
553 <b>vultureCheckBatch</b>(<i></i>) |
|
554 <p> |
|
555 Public method to start a vulture check batch job. |
|
556 </p><p> |
|
557 The results are reported to the __processResult slot. |
|
558 </p> |
|
559 <div align="right"><a href="#top">Up</a></div> |
|
560 <hr /> |
|
561 </body></html> |