Mercurial Repositories > Vulture Checker / file diff

--- a/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog.html	Sat Mar 31 13:04:21 2018 +0200
+++ b/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog.html	Sun Nov 25 12:44:16 2018 +0100
@@ -32,6 +32,9 @@
 <tr>
 <td><a href="#VultureCheckerDialog">VultureCheckerDialog</a></td>
 <td>Class implementing a dialog to show the vulture check results.</td>
+</tr><tr>
+<td><a href="#VultureItem">VultureItem</a></td>
+<td>Class to hold the name, type, confidence and location of defined code.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -85,7 +88,7 @@
 <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>
+<td>Private slot called when the action finished or the user pressed the cancel 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>
@@ -100,7 +103,7 @@
 <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>
+<td>Private slot called after performing 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>
@@ -120,14 +123,20 @@
 <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.__unusedClasses">__unusedClasses</a></td>
+<td>Private method to get the list of unused classes.</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.__unusedImports">__unusedImports</a></td>
+<td>Private method to get a list of unused imports.</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>
+<td>Private method to get the list of unused PyQt/PySide slots.</td>
 </tr><tr>
 <td><a href="#VultureCheckerDialog.__unusedVariables">__unusedVariables</a></td>
 <td>Private method to get the list of unused variables.</td>
@@ -227,7 +236,7 @@
 <dt><i>parent</i> (QTreeWidgetItem)</dt>
 <dd>
 reference to the parent item
-</dd><dt><i>item</i> (vulture.Item)</dt>
+</dd><dt><i>item</i> (VultureItem)</dt>
 <dd>
 reference to the item
 </dd>
@@ -254,7 +263,7 @@
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-vulture.Item
+VultureItem
 </dd>
 </dl><a NAME="VultureCheckerDialog.__editWhiteList" ID="VultureCheckerDialog.__editWhiteList"></a>
 <h4>VultureCheckerDialog.__editWhiteList</h4>
@@ -268,7 +277,7 @@
         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>
+<dt><i>itemList</i> (list of VultureItem)</dt>
 <dd>
 list of items to be filtered
 </dd>
@@ -280,13 +289,14 @@
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-list of vulture.Item
+list of VultureItem
 </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.
+        Private slot called when the action finished or the user pressed the
+        cancel button.
 </p><a NAME="VultureCheckerDialog.__getSelectedNonFileItems" ID="VultureCheckerDialog.__getSelectedNonFileItems"></a>
 <h4>VultureCheckerDialog.__getSelectedNonFileItems</h4>
 <b>__getSelectedNonFileItems</b>(<i></i>)
@@ -308,12 +318,12 @@
 <p>
         Private method to get a list of unused items.
 </p><dl>
-<dt><i>defined</i> (list of vulture.Item)</dt>
+<dt><i>defined</i> (list of VultureItem)</dt>
 <dd>
 list of defined items
-</dd><dt><i>used</i> (list of vulture.Item)</dt>
+</dd><dt><i>used</i> (list of str)</dt>
 <dd>
-list of used items
+list of used names
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -323,7 +333,7 @@
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-list of vulture.Item
+list of VultureItem
 </dd>
 </dl><a NAME="VultureCheckerDialog.__prepareResultLists" ID="VultureCheckerDialog.__prepareResultLists"></a>
 <h4>VultureCheckerDialog.__prepareResultLists</h4>
@@ -347,7 +357,7 @@
 <h4>VultureCheckerDialog.__processResult</h4>
 <b>__processResult</b>(<i>fn, result</i>)
 <p>
-        Private slot called after perfoming a vulture analysis on one file.
+        Private slot called after performing a vulture analysis on one file.
 </p><dl>
 <dt><i>fn</i> (str)</dt>
 <dd>
@@ -409,7 +419,22 @@
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-list of vulture.Item
+list of VultureItem
+</dd>
+</dl><a NAME="VultureCheckerDialog.__unusedClasses" ID="VultureCheckerDialog.__unusedClasses"></a>
+<h4>VultureCheckerDialog.__unusedClasses</h4>
+<b>__unusedClasses</b>(<i></i>)
+<p>
+        Private method to get the list of unused classes.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of unused classes
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of VultureItem
 </dd>
 </dl><a NAME="VultureCheckerDialog.__unusedFunctions" ID="VultureCheckerDialog.__unusedFunctions"></a>
 <h4>VultureCheckerDialog.__unusedFunctions</h4>
@@ -424,7 +449,22 @@
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-list of vulture.Item
+list of VultureItem
+</dd>
+</dl><a NAME="VultureCheckerDialog.__unusedImports" ID="VultureCheckerDialog.__unusedImports"></a>
+<h4>VultureCheckerDialog.__unusedImports</h4>
+<b>__unusedImports</b>(<i></i>)
+<p>
+        Private method to get a list of unused imports.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of unused imports
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of VultureItem
 </dd>
 </dl><a NAME="VultureCheckerDialog.__unusedProperties" ID="VultureCheckerDialog.__unusedProperties"></a>
 <h4>VultureCheckerDialog.__unusedProperties</h4>
@@ -439,22 +479,22 @@
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-list of vulture.Item
+list of VultureItem
 </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.
+        Private method to get the list of unused PyQt/PySide slots.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-list of unused PyQt slots
+list of unused PyQt/PySide slots
 </dd>
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-list of vulture.Item
+list of VultureItem
 </dd>
 </dl><a NAME="VultureCheckerDialog.__unusedVariables" ID="VultureCheckerDialog.__unusedVariables"></a>
 <h4>VultureCheckerDialog.__unusedVariables</h4>
@@ -469,7 +509,7 @@
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-list of vulture.Item
+list of VultureItem
 </dd>
 </dl><a NAME="VultureCheckerDialog.__whiteList" ID="VultureCheckerDialog.__whiteList"></a>
 <h4>VultureCheckerDialog.__whiteList</h4>
@@ -538,17 +578,12 @@
 </dd>
 </dl><a NAME="VultureCheckerDialog.vultureCheck" ID="VultureCheckerDialog.vultureCheck"></a>
 <h4>VultureCheckerDialog.vultureCheck</h4>
-<b>vultureCheck</b>(<i>codestring=''</i>)
+<b>vultureCheck</b>(<i></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>
+</p><a NAME="VultureCheckerDialog.vultureCheckBatch" ID="VultureCheckerDialog.vultureCheckBatch"></a>
 <h4>VultureCheckerDialog.vultureCheckBatch</h4>
 <b>vultureCheckBatch</b>(<i></i>)
 <p>
@@ -557,5 +592,59 @@
         The results are reported to the __processResult slot.
 </p>
 <div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="VultureItem" ID="VultureItem"></a>
+<h2>VultureItem</h2>
+<p>
+    Class to hold the name, type, confidence and location of defined code.
+</p>
+<h3>Derived from</h3>
+object
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#VultureItem.__init__">VultureItem</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="VultureItem.__init__" ID="VultureItem.__init__"></a>
+<h4>VultureItem (Constructor)</h4>
+<b>VultureItem</b>(<i>name, typ, filename, firstLineno, lastLineno, confidence</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>name</i> (str)</dt>
+<dd>
+item name
+</dd><dt><i>typ</i> (str)</dt>
+<dd>
+item type
+</dd><dt><i>filename</i> (str)</dt>
+<dd>
+name of the file containing item
+</dd><dt><i>firstLineno</i> (int)</dt>
+<dd>
+first line number
+</dd><dt><i>lastLineno</i> (int)</dt>
+<dd>
+last line number
+</dd><dt><i>confidence</i> (int)</dt>
+<dd>
+confidence level
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file