Mercurial Repositories > Radon Code Metrics / file comparison
comparison: RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator.html
RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator.html
- changeset 69
- cdf51e6abaee
- parent 49
- ab84f5a5edd8
- child 78
- 4ce16e1d29f3
equal
deleted
inserted
replaced
| 68:69445de59a30 | 69:cdf51e6abaee |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator</h1> | 23 <h1>Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the maintainability index service. | 26 Module implementing the maintainability index service. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 32 <tr><td>None</td></tr> | 36 <tr><td>None</td></tr> |
| 33 </table> | 37 </table> |
| 34 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 | |
| 35 <table> | 40 <table> |
| 41 | |
| 36 <tr> | 42 <tr> |
| 37 <td><a href="#__maintainabilityIndex">__maintainabilityIndex</a></td> | 43 <td><a href="#__maintainabilityIndex">__maintainabilityIndex</a></td> |
| 38 <td>Private function to calculate the maintainability index for one Python file.</td> | 44 <td>Private function to calculate the maintainability index for one Python file.</td> |
| 39 </tr><tr> | 45 </tr> |
| 46 <tr> | |
| 40 <td><a href="#batchMaintainabilityIndex">batchMaintainabilityIndex</a></td> | 47 <td><a href="#batchMaintainabilityIndex">batchMaintainabilityIndex</a></td> |
| 41 <td>Module function to calculate the maintainability index for a batch of files.</td> | 48 <td>Module function to calculate the maintainability index for a batch of files.</td> |
| 42 </tr><tr> | 49 </tr> |
| 50 <tr> | |
| 43 <td><a href="#initBatchService">initBatchService</a></td> | 51 <td><a href="#initBatchService">initBatchService</a></td> |
| 44 <td>Initialize the batch service and return the entry point.</td> | 52 <td>Initialize the batch service and return the entry point.</td> |
| 45 </tr><tr> | 53 </tr> |
| 54 <tr> | |
| 46 <td><a href="#initService">initService</a></td> | 55 <td><a href="#initService">initService</a></td> |
| 47 <td>Initialize the service and return the entry point.</td> | 56 <td>Initialize the service and return the entry point.</td> |
| 48 </tr><tr> | 57 </tr> |
| 58 <tr> | |
| 49 <td><a href="#maintainabilityIndex">maintainabilityIndex</a></td> | 59 <td><a href="#maintainabilityIndex">maintainabilityIndex</a></td> |
| 50 <td>Private function to calculate the maintainability index of one file.</td> | 60 <td>Private function to calculate the maintainability index of one file.</td> |
| 51 </tr><tr> | 61 </tr> |
| 62 <tr> | |
| 52 <td><a href="#worker">worker</a></td> | 63 <td><a href="#worker">worker</a></td> |
| 53 <td>Module function acting as the parallel worker for the maintainability index calculation.</td> | 64 <td>Module function acting as the parallel worker for the maintainability index calculation.</td> |
| 54 </tr> | 65 </tr> |
| 55 </table> | 66 </table> |
| 56 <hr /><hr /> | 67 <hr /> |
| 68 <hr /> | |
| 57 <a NAME="__maintainabilityIndex" ID="__maintainabilityIndex"></a> | 69 <a NAME="__maintainabilityIndex" ID="__maintainabilityIndex"></a> |
| 58 <h2>__maintainabilityIndex</h2> | 70 <h2>__maintainabilityIndex</h2> |
| 59 <b>__maintainabilityIndex</b>(<i>file, text=""</i>) | 71 <b>__maintainabilityIndex</b>(<i>file, text=""</i>) |
| 72 | |
| 60 <p> | 73 <p> |
| 61 Private function to calculate the maintainability index for one Python | 74 Private function to calculate the maintainability index for one Python |
| 62 file. | 75 file. |
| 63 </p><dl> | 76 </p> |
| 77 <dl> | |
| 78 | |
| 64 <dt><i>file</i> (str)</dt> | 79 <dt><i>file</i> (str)</dt> |
| 65 <dd> | 80 <dd> |
| 66 source filename | 81 source filename |
| 67 </dd><dt><i>text</i> (str)</dt> | 82 </dd> |
| 83 <dt><i>text</i> (str)</dt> | |
| 68 <dd> | 84 <dd> |
| 69 source text | 85 source text |
| 70 </dd> | 86 </dd> |
| 71 </dl><dl> | 87 </dl> |
| 88 <dl> | |
| 72 <dt>Returns:</dt> | 89 <dt>Returns:</dt> |
| 73 <dd> | 90 <dd> |
| 74 tuple containing the result dictionary | 91 tuple containing the result dictionary |
| 75 </dd> | 92 </dd> |
| 76 </dl><dl> | 93 </dl> |
| 94 <dl> | |
| 77 <dt>Return Type:</dt> | 95 <dt>Return Type:</dt> |
| 78 <dd> | 96 <dd> |
| 79 (tuple of dict) | 97 (tuple of dict) |
| 80 </dd> | 98 </dd> |
| 81 </dl> | 99 </dl> |
| 82 <div align="right"><a href="#top">Up</a></div> | 100 <div align="right"><a href="#top">Up</a></div> |
| 83 <hr /><hr /> | 101 <hr /> |
| 102 <hr /> | |
| 84 <a NAME="batchMaintainabilityIndex" ID="batchMaintainabilityIndex"></a> | 103 <a NAME="batchMaintainabilityIndex" ID="batchMaintainabilityIndex"></a> |
| 85 <h2>batchMaintainabilityIndex</h2> | 104 <h2>batchMaintainabilityIndex</h2> |
| 86 <b>batchMaintainabilityIndex</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) | 105 <b>batchMaintainabilityIndex</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) |
| 106 | |
| 87 <p> | 107 <p> |
| 88 Module function to calculate the maintainability index for a batch of | 108 Module function to calculate the maintainability index for a batch of |
| 89 files. | 109 files. |
| 90 </p><dl> | 110 </p> |
| 111 <dl> | |
| 112 | |
| 91 <dt><i>argumentsList</i> (list)</dt> | 113 <dt><i>argumentsList</i> (list)</dt> |
| 92 <dd> | 114 <dd> |
| 93 list of arguments tuples as given for | 115 list of arguments tuples as given for |
| 94 maintainabilityIndex | 116 maintainabilityIndex |
| 95 </dd><dt><i>send</i> (function)</dt> | 117 </dd> |
| 118 <dt><i>send</i> (function)</dt> | |
| 96 <dd> | 119 <dd> |
| 97 reference to send function | 120 reference to send function |
| 98 </dd><dt><i>fx</i> (str)</dt> | 121 </dd> |
| 122 <dt><i>fx</i> (str)</dt> | |
| 99 <dd> | 123 <dd> |
| 100 registered service name | 124 registered service name |
| 101 </dd><dt><i>cancelled</i> (function)</dt> | 125 </dd> |
| 126 <dt><i>cancelled</i> (function)</dt> | |
| 102 <dd> | 127 <dd> |
| 103 reference to function checking for a cancellation | 128 reference to function checking for a cancellation |
| 104 </dd><dt><i>maxProcesses</i> (int)</dt> | 129 </dd> |
| 130 <dt><i>maxProcesses</i> (int)</dt> | |
| 105 <dd> | 131 <dd> |
| 106 number of processes to be used | 132 number of processes to be used |
| 107 </dd> | 133 </dd> |
| 108 </dl> | 134 </dl> |
| 109 <div align="right"><a href="#top">Up</a></div> | 135 <div align="right"><a href="#top">Up</a></div> |
| 110 <hr /><hr /> | 136 <hr /> |
| 137 <hr /> | |
| 111 <a NAME="initBatchService" ID="initBatchService"></a> | 138 <a NAME="initBatchService" ID="initBatchService"></a> |
| 112 <h2>initBatchService</h2> | 139 <h2>initBatchService</h2> |
| 113 <b>initBatchService</b>(<i></i>) | 140 <b>initBatchService</b>(<i></i>) |
| 141 | |
| 114 <p> | 142 <p> |
| 115 Initialize the batch service and return the entry point. | 143 Initialize the batch service and return the entry point. |
| 116 </p><dl> | 144 </p> |
| 145 <dl> | |
| 117 <dt>Returns:</dt> | 146 <dt>Returns:</dt> |
| 118 <dd> | 147 <dd> |
| 119 the entry point for the background client (function) | 148 the entry point for the background client (function) |
| 120 </dd> | 149 </dd> |
| 121 </dl> | 150 </dl> |
| 122 <div align="right"><a href="#top">Up</a></div> | 151 <div align="right"><a href="#top">Up</a></div> |
| 123 <hr /><hr /> | 152 <hr /> |
| 153 <hr /> | |
| 124 <a NAME="initService" ID="initService"></a> | 154 <a NAME="initService" ID="initService"></a> |
| 125 <h2>initService</h2> | 155 <h2>initService</h2> |
| 126 <b>initService</b>(<i></i>) | 156 <b>initService</b>(<i></i>) |
| 157 | |
| 127 <p> | 158 <p> |
| 128 Initialize the service and return the entry point. | 159 Initialize the service and return the entry point. |
| 129 </p><dl> | 160 </p> |
| 161 <dl> | |
| 130 <dt>Returns:</dt> | 162 <dt>Returns:</dt> |
| 131 <dd> | 163 <dd> |
| 132 the entry point for the background client (function) | 164 the entry point for the background client (function) |
| 133 </dd> | 165 </dd> |
| 134 </dl> | 166 </dl> |
| 135 <div align="right"><a href="#top">Up</a></div> | 167 <div align="right"><a href="#top">Up</a></div> |
| 136 <hr /><hr /> | 168 <hr /> |
| 169 <hr /> | |
| 137 <a NAME="maintainabilityIndex" ID="maintainabilityIndex"></a> | 170 <a NAME="maintainabilityIndex" ID="maintainabilityIndex"></a> |
| 138 <h2>maintainabilityIndex</h2> | 171 <h2>maintainabilityIndex</h2> |
| 139 <b>maintainabilityIndex</b>(<i>file, text=""</i>) | 172 <b>maintainabilityIndex</b>(<i>file, text=""</i>) |
| 173 | |
| 140 <p> | 174 <p> |
| 141 Private function to calculate the maintainability index of one file. | 175 Private function to calculate the maintainability index of one file. |
| 142 </p><dl> | 176 </p> |
| 177 <dl> | |
| 178 | |
| 143 <dt><i>file</i> (str)</dt> | 179 <dt><i>file</i> (str)</dt> |
| 144 <dd> | 180 <dd> |
| 145 source filename | 181 source filename |
| 146 </dd><dt><i>text</i> (str)</dt> | 182 </dd> |
| 183 <dt><i>text</i> (str)</dt> | |
| 147 <dd> | 184 <dd> |
| 148 source text | 185 source text |
| 149 </dd> | 186 </dd> |
| 150 </dl><dl> | 187 </dl> |
| 188 <dl> | |
| 151 <dt>Returns:</dt> | 189 <dt>Returns:</dt> |
| 152 <dd> | 190 <dd> |
| 153 tuple containing the result dictionary | 191 tuple containing the result dictionary |
| 154 </dd> | 192 </dd> |
| 155 </dl><dl> | 193 </dl> |
| 194 <dl> | |
| 156 <dt>Return Type:</dt> | 195 <dt>Return Type:</dt> |
| 157 <dd> | 196 <dd> |
| 158 (tuple of dict) | 197 (tuple of dict) |
| 159 </dd> | 198 </dd> |
| 160 </dl> | 199 </dl> |
| 161 <div align="right"><a href="#top">Up</a></div> | 200 <div align="right"><a href="#top">Up</a></div> |
| 162 <hr /><hr /> | 201 <hr /> |
| 202 <hr /> | |
| 163 <a NAME="worker" ID="worker"></a> | 203 <a NAME="worker" ID="worker"></a> |
| 164 <h2>worker</h2> | 204 <h2>worker</h2> |
| 165 <b>worker</b>(<i>inputQueue, outputQueue</i>) | 205 <b>worker</b>(<i>inputQueue, outputQueue</i>) |
| 206 | |
| 166 <p> | 207 <p> |
| 167 Module function acting as the parallel worker for the maintainability | 208 Module function acting as the parallel worker for the maintainability |
| 168 index calculation. | 209 index calculation. |
| 169 </p><dl> | 210 </p> |
| 211 <dl> | |
| 212 | |
| 170 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> | 213 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> |
| 171 <dd> | 214 <dd> |
| 172 input queue | 215 input queue |
| 173 </dd><dt><i>outputQueue</i> (multiprocessing.Queue)</dt> | 216 </dd> |
| 217 <dt><i>outputQueue</i> (multiprocessing.Queue)</dt> | |
| 174 <dd> | 218 <dd> |
| 175 output queue | 219 output queue |
| 176 </dd> | 220 </dd> |
| 177 </dl> | 221 </dl> |
| 178 <div align="right"><a href="#top">Up</a></div> | 222 <div align="right"><a href="#top">Up</a></div> |
