--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CodeMetricsCalculator.html Wed Jan 01 11:58:55 2020 +0100 +++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CodeMetricsCalculator.html Tue Jun 23 19:05:15 2020 +0200 @@ -18,183 +18,234 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Metrics_Radon.RadonMetrics.CodeMetricsCalculator</h1> + <p> Module implementing the raw code metrics 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="#__raw2Dict">__raw2Dict</a></td> <td>Private function to convert an object holding raw analysis results into a dictionary.</td> -</tr><tr> +</tr> +<tr> <td><a href="#__rawCodeMetrics">__rawCodeMetrics</a></td> <td>Private function to calculate the raw code metrics for one Python file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#batchRawCodeMetrics">batchRawCodeMetrics</a></td> <td>Module function to calculate the raw code metrics for a batch of files.</td> -</tr><tr> +</tr> +<tr> <td><a href="#initBatchService">initBatchService</a></td> <td>Initialize the batch service and return the entry point.</td> -</tr><tr> +</tr> +<tr> <td><a href="#initService">initService</a></td> <td>Initialize the service and return the entry point.</td> -</tr><tr> +</tr> +<tr> <td><a href="#rawCodeMetrics">rawCodeMetrics</a></td> <td>Private function to calculate the raw code metrics of one file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#worker">worker</a></td> <td>Module function acting as the parallel worker for the raw code metrics calculation.</td> </tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="__raw2Dict" ID="__raw2Dict"></a> <h2>__raw2Dict</h2> <b>__raw2Dict</b>(<i>obj</i>) + <p> Private function to convert an object holding raw analysis results into a dictionary. -</p><dl> +</p> +<dl> + <dt><i>obj</i> (radon.raw.Module)</dt> <dd> object as returned from analyze() </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> conversion result </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> dict </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="__rawCodeMetrics" ID="__rawCodeMetrics"></a> <h2>__rawCodeMetrics</h2> <b>__rawCodeMetrics</b>(<i>file, text=""</i>) + <p> Private function to calculate the raw code metrics for one Python file. -</p><dl> +</p> +<dl> + <dt><i>file</i> (str)</dt> <dd> source filename -</dd><dt><i>text</i> (str)</dt> +</dd> +<dt><i>text</i> (str)</dt> <dd> source text </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> tuple containing the result dictionary </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> (tuple of dict) </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="batchRawCodeMetrics" ID="batchRawCodeMetrics"></a> <h2>batchRawCodeMetrics</h2> <b>batchRawCodeMetrics</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) + <p> Module function to calculate the raw code metrics for a batch of files. -</p><dl> +</p> +<dl> + <dt><i>argumentsList</i> (list)</dt> <dd> list of arguments tuples as given for rawCodeMetrics -</dd><dt><i>send</i> (function)</dt> +</dd> +<dt><i>send</i> (function)</dt> <dd> reference to send function -</dd><dt><i>fx</i> (str)</dt> +</dd> +<dt><i>fx</i> (str)</dt> <dd> registered service name -</dd><dt><i>cancelled</i> (function)</dt> +</dd> +<dt><i>cancelled</i> (function)</dt> <dd> reference to function checking for a cancellation -</dd><dt><i>maxProcesses</i> (int)</dt> +</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 /> +<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> +</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 /> +<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> +</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 /> +<hr /> +<hr /> <a NAME="rawCodeMetrics" ID="rawCodeMetrics"></a> <h2>rawCodeMetrics</h2> <b>rawCodeMetrics</b>(<i>file, text=""</i>) + <p> Private function to calculate the raw code metrics of one file. -</p><dl> +</p> +<dl> + <dt><i>file</i> (str)</dt> <dd> source filename -</dd><dt><i>text</i> (str)</dt> +</dd> +<dt><i>text</i> (str)</dt> <dd> source text </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> tuple containing the result dictionary </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> (tuple of dict) </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<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 raw code metrics calculation. -</p><dl> +</p> +<dl> + <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> <dd> input queue -</dd><dt><i>outputQueue</i> (multiprocessing.Queue)</dt> +</dd> +<dt><i>outputQueue</i> (multiprocessing.Queue)</dt> <dd> output queue </dd>