RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator</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_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator</h1>

<p>
Module implementing the maintainability index service.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#__maintainabilityIndex">__maintainabilityIndex</a></td>
<td>Private function to calculate the maintainability index for one Python file.</td>
</tr>
<tr>
<td><a href="#batchMaintainabilityIndex">batchMaintainabilityIndex</a></td>
<td>Module function to calculate the maintainability index for 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="#maintainabilityIndex">maintainabilityIndex</a></td>
<td>Private function to calculate the maintainability index of one file.</td>
</tr>
<tr>
<td><a href="#worker">worker</a></td>
<td>Module function acting as the parallel worker for the maintainability index calculation.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="__maintainabilityIndex" ID="__maintainabilityIndex"></a>
<h2>__maintainabilityIndex</h2>
<b>__maintainabilityIndex</b>(<i>file, text=""</i>)

<p>
    Private function to calculate the maintainability index for one Python
    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>Return:</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="batchMaintainabilityIndex" ID="batchMaintainabilityIndex"></a>
<h2>batchMaintainabilityIndex</h2>
<b>batchMaintainabilityIndex</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>)

<p>
    Module function to calculate the maintainability index for a batch of
    files.
</p>
<dl>

<dt><i>argumentsList</i> (list)</dt>
<dd>
list of arguments tuples as given for
        maintainabilityIndex
</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>
<dt><i>maxProcesses</i> (int)</dt>
<dd>
number of processes to be used
</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>Return:</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>Return:</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="maintainabilityIndex" ID="maintainabilityIndex"></a>
<h2>maintainabilityIndex</h2>
<b>maintainabilityIndex</b>(<i>file, text=""</i>)

<p>
    Private function to calculate the maintainability index of 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>Return:</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>inputQueue, outputQueue</i>)

<p>
    Module function acting as the parallel worker for the maintainability
    index calculation.
</p>
<dl>

<dt><i>inputQueue</i> (multiprocessing.Queue)</dt>
<dd>
input queue
</dd>
<dt><i>outputQueue</i> (multiprocessing.Queue)</dt>
<dd>
output queue
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>