Mercurial Repositories > Vulture Checker / file diff

diff: VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerService.html

VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerService.html

changeset 10
00890e72e19c
child 18
e19e7622a428
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerService.html	Wed Oct 07 19:28:17 2015 +0200
@@ -0,0 +1,270 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Checker_Vulture.VultureChecker.VultureCheckerService</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.VultureCheckerService</h1>
+<p>
+Module implementing the cyclomatic complexity service.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#EricVulture">EricVulture</a></td>
+<td>Class to adopt the Vulture class to the eric plug-in functionality.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#__analyze">__analyze</a></td>
+<td>Private function to analyze one Python file.</td>
+</tr><tr>
+<td><a href="#batchVultureCheck">batchVultureCheck</a></td>
+<td>Module function to analyze a batch of files.</td>
+</tr><tr>
+<td><a href="#initBatchService">initBatchService</a></td>
+<td>Initialize the batch service and return the entry point.</td>
+</tr><tr>
+<td><a href="#initService">initService</a></td>
+<td>Initialize the service and return the entry point.</td>
+</tr><tr>
+<td><a href="#vultureCheck">vultureCheck</a></td>
+<td>Private function to analyze one file.</td>
+</tr><tr>
+<td><a href="#worker">worker</a></td>
+<td>Module function acting as the parallel worker for the cyclomatic complexity calculation.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="EricVulture" ID="EricVulture"></a>
+<h2>EricVulture</h2>
+<p>
+    Class to adopt the Vulture class to the eric plug-in functionality.
+</p>
+<h3>Derived from</h3>
+Vulture
+<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="#EricVulture.__init__">EricVulture</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#EricVulture.__item2Dict">__item2Dict</a></td>
+<td>Private method to convert a vulture item to a dictionary.</td>
+</tr><tr>
+<td><a href="#EricVulture.getResults">getResults</a></td>
+<td>Public method to get the scan results.</td>
+</tr><tr>
+<td><a href="#EricVulture.scan">scan</a></td>
+<td>Public method to scan the source text.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="EricVulture.__init__" ID="EricVulture.__init__"></a>
+<h4>EricVulture (Constructor)</h4>
+<b>EricVulture</b>(<i>filename</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>filename</i> (str)</dt>
+<dd>
+source file name
+</dd>
+</dl><a NAME="EricVulture.__item2Dict" ID="EricVulture.__item2Dict"></a>
+<h4>EricVulture.__item2Dict</h4>
+<b>__item2Dict</b>(<i>item</i>)
+<p>
+        Private method to convert a vulture item to a dictionary.
+</p><dl>
+<dt><i>item</i> (vulture.Item)</dt>
+<dd>
+vulture item
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+item dictionary
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl><a NAME="EricVulture.getResults" ID="EricVulture.getResults"></a>
+<h4>EricVulture.getResults</h4>
+<b>getResults</b>(<i></i>)
+<p>
+        Public method to get the scan results.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+scan results
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl><a NAME="EricVulture.scan" ID="EricVulture.scan"></a>
+<h4>EricVulture.scan</h4>
+<b>scan</b>(<i>source</i>)
+<p>
+        Public method to scan the source text.
+</p><dl>
+<dt><i>source</i> (str)</dt>
+<dd>
+source text
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="__analyze" ID="__analyze"></a>
+<h2>__analyze</h2>
+<b>__analyze</b>(<i>file, text=""</i>)
+<p>
+    Private function to analyze one Python file.
+</p><dl>
+<dt><i>file</i> (str)</dt>
+<dd>
+source file name
+</dd><dt><i>text</i> (str)</dt>
+<dd>
+source text
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing the result dictionary
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+(tuple of dict)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="batchVultureCheck" ID="batchVultureCheck"></a>
+<h2>batchVultureCheck</h2>
+<b>batchVultureCheck</b>(<i>argumentsList, send, fx, cancelled</i>)
+<p>
+    Module function to analyze a batch of files.
+</p><dl>
+<dt><i>argumentsList</i> (list)</dt>
+<dd>
+list of arguments tuples as given for vultureCheck
+</dd><dt><i>send</i> (function)</dt>
+<dd>
+reference to send function
+</dd><dt><i>fx</i> (str)</dt>
+<dd>
+registered service name
+</dd><dt><i>cancelled</i> (function)</dt>
+<dd>
+reference to function checking for a cancellation
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="initBatchService" ID="initBatchService"></a>
+<h2>initBatchService</h2>
+<b>initBatchService</b>(<i></i>)
+<p>
+    Initialize the batch service and return the entry point.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+the entry point for the background client (function)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="initService" ID="initService"></a>
+<h2>initService</h2>
+<b>initService</b>(<i></i>)
+<p>
+    Initialize the service and return the entry point.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+the entry point for the background client (function)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="vultureCheck" ID="vultureCheck"></a>
+<h2>vultureCheck</h2>
+<b>vultureCheck</b>(<i>file, text=""</i>)
+<p>
+    Private function to analyze one file.
+</p><dl>
+<dt><i>file</i> (str)</dt>
+<dd>
+source filename
+</dd><dt><i>text</i> (str)</dt>
+<dd>
+source text
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing the result dictionary
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+(tuple of dict)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="worker" ID="worker"></a>
+<h2>worker</h2>
+<b>worker</b>(<i>input, output</i>)
+<p>
+    Module function acting as the parallel worker for the cyclomatic
+    complexity calculation.
+</p><dl>
+<dt><i>input</i> (multiprocessing.Queue)</dt>
+<dd>
+input queue
+</dd><dt><i>output</i> (multiprocessing.Queue)</dt>
+<dd>
+output queue
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

Mercurial Repository: Vulture Checker

eric ide

mercurial