VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog</h1>
<p>
Module implementing a dialog to show the vulture check results.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#VultureCheckerDialog">VultureCheckerDialog</a></td>
<td>Class implementing a dialog to show the vulture check results.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="VultureCheckerDialog" ID="VultureCheckerDialog"></a>
<h2>VultureCheckerDialog</h2>
<p>
    Class implementing a dialog to show the vulture check results.
</p>
<h3>Derived from</h3>
QDialog, Ui_VultureCheckerDialog
<h3>Class Attributes</h3>
<table>
<tr><td>FilePathRole</td></tr><tr><td>TypeRole</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#VultureCheckerDialog.__init__">VultureCheckerDialog</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__batchFinished">__batchFinished</a></td>
<td>Private slot handling the completion of a batch job.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__createErrorItem">__createErrorItem</a></td>
<td>Private slot to create a new error item in the result list.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__createFileItem">__createFileItem</a></td>
<td>Private method to create a file item.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__createResultItem">__createResultItem</a></td>
<td>Private method to create a result item.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__createResultItems">__createResultItems</a></td>
<td>Private method to populate the list with the analysis result.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__dict2Item">__dict2Item</a></td>
<td>Private method to convert an item dictionary to a vulture item.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__editWhiteList">__editWhiteList</a></td>
<td>Private slot to edit the whitelist.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__filteredList">__filteredList</a></td>
<td>Private method to filter a list against the whitelist patterns returning items not matching the whitelist.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__finish">__finish</a></td>
<td>Private slot called when the action or the user pressed the button.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__getSelectedNonFileItems">__getSelectedNonFileItems</a></td>
<td>Private method to get a list of selected non file items.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__getUnusedItems">__getUnusedItems</a></td>
<td>Private method to get a list of unused items.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__prepareResultLists">__prepareResultLists</a></td>
<td>Private method to prepare the result lists.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__processError">__processError</a></td>
<td>Private slot to process an error indication from the service.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__processResult">__processResult</a></td>
<td>Private slot called after perfoming a vulture analysis on one file.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__resultCollapse">__resultCollapse</a></td>
<td>Private slot to collapse all entries of the resultlist.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__resultExpand">__resultExpand</a></td>
<td>Private slot to expand all entries of the resultlist.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__showContextMenu">__showContextMenu</a></td>
<td>Private slot to show the context menu of the listview.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__storeResult">__storeResult</a></td>
<td>Private method to store the result of an analysis.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__storeWhiteLists">__storeWhiteLists</a></td>
<td>Private method to store the new whitelists, if they have changed.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__unusedAttributes">__unusedAttributes</a></td>
<td>Private method to get the list of unused attributes.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__unusedFunctions">__unusedFunctions</a></td>
<td>Private method to get the list of unused functions.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__unusedProperties">__unusedProperties</a></td>
<td>Private method to get the list of unused properties.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__unusedSlots">__unusedSlots</a></td>
<td>Private method to get the list of unused PyQt slots.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__unusedVariables">__unusedVariables</a></td>
<td>Private method to get the list of unused variables.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.__whiteList">__whiteList</a></td>
<td>Private slot to add entries to the whitelist.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.clear">clear</a></td>
<td>Public method to clear all results.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.filename">filename</a></td>
<td></td>
</tr><tr>
<td><a href="#VultureCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
<td>Private slot called by a button of the button box clicked.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
<td>Private slot to handle the activation of a result item.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.on_startButton_clicked">on_startButton_clicked</a></td>
<td>Private slot to start a code metrics run.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.prepare">prepare</a></td>
<td>Public method to prepare the dialog with a list of filenames.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.start">start</a></td>
<td>Public slot to start the code metrics determination.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.vultureCheck">vultureCheck</a></td>
<td>Public method to start a vulture check for one Python file.</td>
</tr><tr>
<td><a href="#VultureCheckerDialog.vultureCheckBatch">vultureCheckBatch</a></td>
<td>Public method to start a vulture check batch job.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="VultureCheckerDialog.__init__" ID="VultureCheckerDialog.__init__"></a>
<h4>VultureCheckerDialog (Constructor)</h4>
<b>VultureCheckerDialog</b>(<i>vultureService, parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>vultureService</i> (VulturePlugin)</dt>
<dd>
reference to the service
</dd><dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl><a NAME="VultureCheckerDialog.__batchFinished" ID="VultureCheckerDialog.__batchFinished"></a>
<h4>VultureCheckerDialog.__batchFinished</h4>
<b>__batchFinished</b>(<i></i>)
<p>
        Private slot handling the completion of a batch job.
</p><a NAME="VultureCheckerDialog.__createErrorItem" ID="VultureCheckerDialog.__createErrorItem"></a>
<h4>VultureCheckerDialog.__createErrorItem</h4>
<b>__createErrorItem</b>(<i>filename, message</i>)
<p>
        Private slot to create a new error item in the result list.
</p><dl>
<dt><i>filename</i> (str)</dt>
<dd>
name of the file
</dd><dt><i>message</i> (str)</dt>
<dd>
error message
</dd>
</dl><a NAME="VultureCheckerDialog.__createFileItem" ID="VultureCheckerDialog.__createFileItem"></a>
<h4>VultureCheckerDialog.__createFileItem</h4>
<b>__createFileItem</b>(<i>filename</i>)
<p>
        Private method to create a file item.
</p><dl>
<dt><i>filename</i> (str)</dt>
<dd>
file name for the item
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
reference to the created item
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
QTreeWidgetItem
</dd>
</dl><a NAME="VultureCheckerDialog.__createResultItem" ID="VultureCheckerDialog.__createResultItem"></a>
<h4>VultureCheckerDialog.__createResultItem</h4>
<b>__createResultItem</b>(<i>parent, item</i>)
<p>
        Private method to create a result item.
</p><dl>
<dt><i>parent</i> (QTreeWidgetItem)</dt>
<dd>
reference to the parent item
</dd><dt><i>item</i> (vulture.Item)</dt>
<dd>
reference to the item
</dd>
</dl><a NAME="VultureCheckerDialog.__createResultItems" ID="VultureCheckerDialog.__createResultItems"></a>
<h4>VultureCheckerDialog.__createResultItems</h4>
<b>__createResultItems</b>(<i></i>)
<p>
        Private method to populate the list with the analysis result.
</p><a NAME="VultureCheckerDialog.__dict2Item" ID="VultureCheckerDialog.__dict2Item"></a>
<h4>VultureCheckerDialog.__dict2Item</h4>
<b>__dict2Item</b>(<i>d</i>)
<p>
        Private method to convert an item dictionary to a vulture item.
</p><dl>
<dt><i>d</i> (dict)</dt>
<dd>
item dictionary
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
vulture item
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
vulture.Item
</dd>
</dl><a NAME="VultureCheckerDialog.__editWhiteList" ID="VultureCheckerDialog.__editWhiteList"></a>
<h4>VultureCheckerDialog.__editWhiteList</h4>
<b>__editWhiteList</b>(<i></i>)
<p>
        Private slot to edit the whitelist.
</p><a NAME="VultureCheckerDialog.__filteredList" ID="VultureCheckerDialog.__filteredList"></a>
<h4>VultureCheckerDialog.__filteredList</h4>
<b>__filteredList</b>(<i>itemList</i>)
<p>
        Private method to filter a list against the whitelist patterns
        returning items not matching the whitelist.
</p><dl>
<dt><i>itemList</i> (list of vulture.Item)</dt>
<dd>
list of items to be filtered
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of filtered items
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
list of vulture.Item
</dd>
</dl><a NAME="VultureCheckerDialog.__finish" ID="VultureCheckerDialog.__finish"></a>
<h4>VultureCheckerDialog.__finish</h4>
<b>__finish</b>(<i></i>)
<p>
        Private slot called when the action or the user pressed the button.
</p><a NAME="VultureCheckerDialog.__getSelectedNonFileItems" ID="VultureCheckerDialog.__getSelectedNonFileItems"></a>
<h4>VultureCheckerDialog.__getSelectedNonFileItems</h4>
<b>__getSelectedNonFileItems</b>(<i></i>)
<p>
        Private method to get a list of selected non file items.
</p><dl>
<dt>Returns:</dt>
<dd>
list of selected non file items
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
list of QTreeWidgetItem
</dd>
</dl><a NAME="VultureCheckerDialog.__getUnusedItems" ID="VultureCheckerDialog.__getUnusedItems"></a>
<h4>VultureCheckerDialog.__getUnusedItems</h4>
<b>__getUnusedItems</b>(<i>defined, used</i>)
<p>
        Private method to get a list of unused items.
</p><dl>
<dt><i>defined</i> (list of vulture.Item)</dt>
<dd>
list of defined items
</dd><dt><i>used</i> (list of vulture.Item)</dt>
<dd>
list of used items
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of unused items
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
list of vulture.Item
</dd>
</dl><a NAME="VultureCheckerDialog.__prepareResultLists" ID="VultureCheckerDialog.__prepareResultLists"></a>
<h4>VultureCheckerDialog.__prepareResultLists</h4>
<b>__prepareResultLists</b>(<i></i>)
<p>
        Private method to prepare the result lists.
</p><a NAME="VultureCheckerDialog.__processError" ID="VultureCheckerDialog.__processError"></a>
<h4>VultureCheckerDialog.__processError</h4>
<b>__processError</b>(<i>fn, msg</i>)
<p>
        Private slot to process an error indication from the service.
</p><dl>
<dt><i>fn</i> (str)</dt>
<dd>
filename of the file
</dd><dt><i>msg</i> (str)</dt>
<dd>
error message
</dd>
</dl><a NAME="VultureCheckerDialog.__processResult" ID="VultureCheckerDialog.__processResult"></a>
<h4>VultureCheckerDialog.__processResult</h4>
<b>__processResult</b>(<i>fn, result</i>)
<p>
        Private slot called after perfoming a vulture analysis on one file.
</p><dl>
<dt><i>fn</i> (str)</dt>
<dd>
filename of the file
</dd><dt><i>result</i> (dict)</dt>
<dd>
result dict
</dd>
</dl><a NAME="VultureCheckerDialog.__resultCollapse" ID="VultureCheckerDialog.__resultCollapse"></a>
<h4>VultureCheckerDialog.__resultCollapse</h4>
<b>__resultCollapse</b>(<i></i>)
<p>
        Private slot to collapse all entries of the resultlist.
</p><a NAME="VultureCheckerDialog.__resultExpand" ID="VultureCheckerDialog.__resultExpand"></a>
<h4>VultureCheckerDialog.__resultExpand</h4>
<b>__resultExpand</b>(<i></i>)
<p>
        Private slot to expand all entries of the resultlist.
</p><a NAME="VultureCheckerDialog.__showContextMenu" ID="VultureCheckerDialog.__showContextMenu"></a>
<h4>VultureCheckerDialog.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>coord</i>)
<p>
        Private slot to show the context menu of the listview.
</p><dl>
<dt><i>coord</i> (QPoint)</dt>
<dd>
the position of the mouse pointer
</dd>
</dl><a NAME="VultureCheckerDialog.__storeResult" ID="VultureCheckerDialog.__storeResult"></a>
<h4>VultureCheckerDialog.__storeResult</h4>
<b>__storeResult</b>(<i>result</i>)
<p>
        Private method to store the result of an analysis.
</p><dl>
<dt><i>result</i> (dict)</dt>
<dd>
result dictionary
</dd>
</dl><a NAME="VultureCheckerDialog.__storeWhiteLists" ID="VultureCheckerDialog.__storeWhiteLists"></a>
<h4>VultureCheckerDialog.__storeWhiteLists</h4>
<b>__storeWhiteLists</b>(<i>whitelists</i>)
<p>
        Private method to store the new whitelists, if they have changed.
</p><dl>
<dt><i>whitelists</i> (dict of list of str)</dt>
<dd>
dictionary of lists of whitelisted names
</dd>
</dl><a NAME="VultureCheckerDialog.__unusedAttributes" ID="VultureCheckerDialog.__unusedAttributes"></a>
<h4>VultureCheckerDialog.__unusedAttributes</h4>
<b>__unusedAttributes</b>(<i></i>)
<p>
        Private method to get the list of unused attributes.
</p><dl>
<dt>Returns:</dt>
<dd>
list of unused attributes
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
list of vulture.Item
</dd>
</dl><a NAME="VultureCheckerDialog.__unusedFunctions" ID="VultureCheckerDialog.__unusedFunctions"></a>
<h4>VultureCheckerDialog.__unusedFunctions</h4>
<b>__unusedFunctions</b>(<i></i>)
<p>
        Private method to get the list of unused functions.
</p><dl>
<dt>Returns:</dt>
<dd>
list of unused functions
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
list of vulture.Item
</dd>
</dl><a NAME="VultureCheckerDialog.__unusedProperties" ID="VultureCheckerDialog.__unusedProperties"></a>
<h4>VultureCheckerDialog.__unusedProperties</h4>
<b>__unusedProperties</b>(<i></i>)
<p>
        Private method to get the list of unused properties.
</p><dl>
<dt>Returns:</dt>
<dd>
list of unused properties
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
list of vulture.Item
</dd>
</dl><a NAME="VultureCheckerDialog.__unusedSlots" ID="VultureCheckerDialog.__unusedSlots"></a>
<h4>VultureCheckerDialog.__unusedSlots</h4>
<b>__unusedSlots</b>(<i></i>)
<p>
        Private method to get the list of unused PyQt slots.
</p><dl>
<dt>Returns:</dt>
<dd>
list of unused PyQt slots
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
list of vulture.Item
</dd>
</dl><a NAME="VultureCheckerDialog.__unusedVariables" ID="VultureCheckerDialog.__unusedVariables"></a>
<h4>VultureCheckerDialog.__unusedVariables</h4>
<b>__unusedVariables</b>(<i></i>)
<p>
        Private method to get the list of unused variables.
</p><dl>
<dt>Returns:</dt>
<dd>
list of unused variables
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
list of vulture.Item
</dd>
</dl><a NAME="VultureCheckerDialog.__whiteList" ID="VultureCheckerDialog.__whiteList"></a>
<h4>VultureCheckerDialog.__whiteList</h4>
<b>__whiteList</b>(<i></i>)
<p>
        Private slot to add entries to the whitelist.
</p><a NAME="VultureCheckerDialog.clear" ID="VultureCheckerDialog.clear"></a>
<h4>VultureCheckerDialog.clear</h4>
<b>clear</b>(<i></i>)
<p>
        Public method to clear all results.
</p><a NAME="VultureCheckerDialog.filename" ID="VultureCheckerDialog.filename"></a>
<h4>VultureCheckerDialog.filename</h4>
<b>filename</b>(<i></i>)
<a NAME="VultureCheckerDialog.on_buttonBox_clicked" ID="VultureCheckerDialog.on_buttonBox_clicked"></a>
<h4>VultureCheckerDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)
<p>
        Private slot called by a button of the button box clicked.
</p><dl>
<dt><i>button</i> (QAbstractButton)</dt>
<dd>
button that was clicked
</dd>
</dl><a NAME="VultureCheckerDialog.on_resultList_itemActivated" ID="VultureCheckerDialog.on_resultList_itemActivated"></a>
<h4>VultureCheckerDialog.on_resultList_itemActivated</h4>
<b>on_resultList_itemActivated</b>(<i>item, column</i>)
<p>
        Private slot to handle the activation of a result item.
</p><dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
<dd>
reference to the activated item
</dd><dt><i>column</i> (int)</dt>
<dd>
column the item was activated in
</dd>
</dl><a NAME="VultureCheckerDialog.on_startButton_clicked" ID="VultureCheckerDialog.on_startButton_clicked"></a>
<h4>VultureCheckerDialog.on_startButton_clicked</h4>
<b>on_startButton_clicked</b>(<i></i>)
<p>
        Private slot to start a code metrics run.
</p><a NAME="VultureCheckerDialog.prepare" ID="VultureCheckerDialog.prepare"></a>
<h4>VultureCheckerDialog.prepare</h4>
<b>prepare</b>(<i>fileList, project</i>)
<p>
        Public method to prepare the dialog with a list of filenames.
</p><dl>
<dt><i>fileList</i> (list of str)</dt>
<dd>
list of filenames
</dd><dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
</dl><a NAME="VultureCheckerDialog.start" ID="VultureCheckerDialog.start"></a>
<h4>VultureCheckerDialog.start</h4>
<b>start</b>(<i>fn</i>)
<p>
        Public slot to start the code metrics determination.
</p><dl>
<dt><i>fn</i> (str or list of str)</dt>
<dd>
file or list of files or directory to show
            the code metrics for
</dd>
</dl><a NAME="VultureCheckerDialog.vultureCheck" ID="VultureCheckerDialog.vultureCheck"></a>
<h4>VultureCheckerDialog.vultureCheck</h4>
<b>vultureCheck</b>(<i>codestring=''</i>)
<p>
        Public method to start a vulture check for one Python file.
</p><p>
        The results are reported to the __processResult slot.
</p><dl>
<dt><i>codestring=</i> (str)</dt>
<dd>
optional sourcestring
</dd>
</dl><a NAME="VultureCheckerDialog.vultureCheckBatch" ID="VultureCheckerDialog.vultureCheckBatch"></a>
<h4>VultureCheckerDialog.vultureCheckBatch</h4>
<b>vultureCheckBatch</b>(<i></i>)
<p>
        Public method to start a vulture check batch job.
</p><p>
        The results are reported to the __processResult slot.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>