Mercurial Repositories > Radon Code Metrics / file comparison
comparison: RadonMetrics/Documentation/source/Plugin_Metrics_Radon.PluginMetricsRadon.html
RadonMetrics/Documentation/source/Plugin_Metrics_Radon.PluginMetricsRadon.html
- changeset 14
- 5f206edea27e
- child 18
- 58ce8a433422
equal
deleted
inserted
replaced
| 13:22bc345844e7 | 14:5f206edea27e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Metrics_Radon.PluginMetricsRadon</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Metrics_Radon.PluginMetricsRadon</h1> | |
| 23 <p> | |
| 24 Module implementing the radon code metrics plug-in. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#RadonMetricsPlugin">RadonMetricsPlugin</a></td> | |
| 34 <td>Class implementing the radon code metrics plug-in.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="RadonMetricsPlugin" ID="RadonMetricsPlugin"></a> | |
| 43 <h2>RadonMetricsPlugin</h2> | |
| 44 <p> | |
| 45 Class implementing the radon code metrics plug-in. | |
| 46 </p><h3>Signals</h3> | |
| 47 <dl> | |
| 48 <dt>batchFinished(str)</dt> | |
| 49 <dd> | |
| 50 emitted when a code metrics batch is done | |
| 51 </dd><dt>complexityDone(str, dict)</dt> | |
| 52 <dd> | |
| 53 emitted when the | |
| 54 cyclomatic complexity was determined for a file | |
| 55 </dd><dt>error(str, str, str)</dt> | |
| 56 <dd> | |
| 57 emitted in case of an error | |
| 58 </dd><dt>maintainabilityIndexDone(str, dict)</dt> | |
| 59 <dd> | |
| 60 emitted when the | |
| 61 maintainability index was determined for a file | |
| 62 </dd><dt>metricsDone(str, dict)</dt> | |
| 63 <dd> | |
| 64 emitted when the code metrics were | |
| 65 determined for a file | |
| 66 </dd> | |
| 67 </dl> | |
| 68 <h3>Derived from</h3> | |
| 69 QObject | |
| 70 <h3>Class Attributes</h3> | |
| 71 <table> | |
| 72 <tr><td>None</td></tr> | |
| 73 </table> | |
| 74 <h3>Class Methods</h3> | |
| 75 <table> | |
| 76 <tr><td>None</td></tr> | |
| 77 </table> | |
| 78 <h3>Methods</h3> | |
| 79 <table> | |
| 80 <tr> | |
| 81 <td><a href="#RadonMetricsPlugin.__init__">RadonMetricsPlugin</a></td> | |
| 82 <td>Constructor</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#RadonMetricsPlugin.__editorClosed">__editorClosed</a></td> | |
| 85 <td>Private slot called, when an editor was closed.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#RadonMetricsPlugin.__editorCyclomaticComplexity">__editorCyclomaticComplexity</a></td> | |
| 88 <td>Private slot to handle the cyclomatic complexity action of the editor show menu.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#RadonMetricsPlugin.__editorMaintainabilityIndex">__editorMaintainabilityIndex</a></td> | |
| 91 <td>Private slot to handle the maintainability index action of the editor show menu.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#RadonMetricsPlugin.__editorOpened">__editorOpened</a></td> | |
| 94 <td>Private slot called, when a new editor was opened.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#RadonMetricsPlugin.__editorRawMetrics">__editorRawMetrics</a></td> | |
| 97 <td>Private slot to handle the raw code metrics action of the editor show menu.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#RadonMetricsPlugin.__editorShowMenu">__editorShowMenu</a></td> | |
| 100 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#RadonMetricsPlugin.__initialize">__initialize</a></td> | |
| 103 <td>Private slot to (re)initialize the plugin.</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#RadonMetricsPlugin.__loadTranslator">__loadTranslator</a></td> | |
| 106 <td>Private method to load the translation file.</td> | |
| 107 </tr><tr> | |
| 108 <td><a href="#RadonMetricsPlugin.__projectBrowserCyclomaticComplexity">__projectBrowserCyclomaticComplexity</a></td> | |
| 109 <td>Private method to handle the cyclomatic complexity context menu action of the project sources browser.</td> | |
| 110 </tr><tr> | |
| 111 <td><a href="#RadonMetricsPlugin.__projectBrowserMaintainabilityIndex">__projectBrowserMaintainabilityIndex</a></td> | |
| 112 <td>Private method to handle the maintainability index context menu action of the project sources browser.</td> | |
| 113 </tr><tr> | |
| 114 <td><a href="#RadonMetricsPlugin.__projectBrowserRawMetrics">__projectBrowserRawMetrics</a></td> | |
| 115 <td>Private method to handle the code metrics context menu action of the project sources browser.</td> | |
| 116 </tr><tr> | |
| 117 <td><a href="#RadonMetricsPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td> | |
| 118 <td>Private slot called, when the the project browser context menu or a submenu is about to be shown.</td> | |
| 119 </tr><tr> | |
| 120 <td><a href="#RadonMetricsPlugin.__projectCyclomaticComplexity">__projectCyclomaticComplexity</a></td> | |
| 121 <td>Private slot used to calculate the cyclomatic complexity for the project.</td> | |
| 122 </tr><tr> | |
| 123 <td><a href="#RadonMetricsPlugin.__projectMaintainabilityIndex">__projectMaintainabilityIndex</a></td> | |
| 124 <td>Private slot used to calculate the maintainability indexes for the project.</td> | |
| 125 </tr><tr> | |
| 126 <td><a href="#RadonMetricsPlugin.__projectRawMetrics">__projectRawMetrics</a></td> | |
| 127 <td>Private slot used to calculate raw code metrics for the project.</td> | |
| 128 </tr><tr> | |
| 129 <td><a href="#RadonMetricsPlugin.__projectShowMenu">__projectShowMenu</a></td> | |
| 130 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> | |
| 131 </tr><tr> | |
| 132 <td><a href="#RadonMetricsPlugin.__serviceError">__serviceError</a></td> | |
| 133 <td>Private slot handling service errors.</td> | |
| 134 </tr><tr> | |
| 135 <td><a href="#RadonMetricsPlugin.__showRadonVersion">__showRadonVersion</a></td> | |
| 136 <td>Private slot to show the version number of the used radon library.</td> | |
| 137 </tr><tr> | |
| 138 <td><a href="#RadonMetricsPlugin.activate">activate</a></td> | |
| 139 <td>Public method to activate this plug-in.</td> | |
| 140 </tr><tr> | |
| 141 <td><a href="#RadonMetricsPlugin.batchJobDone">batchJobDone</a></td> | |
| 142 <td>Public slot handling the completion of a batch job.</td> | |
| 143 </tr><tr> | |
| 144 <td><a href="#RadonMetricsPlugin.cancelComplexityBatch">cancelComplexityBatch</a></td> | |
| 145 <td>Public method to cancel all batch jobs.</td> | |
| 146 </tr><tr> | |
| 147 <td><a href="#RadonMetricsPlugin.cancelMaintainabilityIndexBatch">cancelMaintainabilityIndexBatch</a></td> | |
| 148 <td>Public method to cancel all batch jobs.</td> | |
| 149 </tr><tr> | |
| 150 <td><a href="#RadonMetricsPlugin.cancelRawMetricsBatch">cancelRawMetricsBatch</a></td> | |
| 151 <td>Public method to cancel all batch jobs.</td> | |
| 152 </tr><tr> | |
| 153 <td><a href="#RadonMetricsPlugin.cyclomaticComplexity">cyclomaticComplexity</a></td> | |
| 154 <td>Public method to prepare cyclomatic complexity calculation on one Python source file.</td> | |
| 155 </tr><tr> | |
| 156 <td><a href="#RadonMetricsPlugin.cyclomaticComplexityBatch">cyclomaticComplexityBatch</a></td> | |
| 157 <td>Public method to prepare cyclomatic complexity calculation on multiple Python source files.</td> | |
| 158 </tr><tr> | |
| 159 <td><a href="#RadonMetricsPlugin.deactivate">deactivate</a></td> | |
| 160 <td>Public method to deactivate this plug-in.</td> | |
| 161 </tr><tr> | |
| 162 <td><a href="#RadonMetricsPlugin.maintainabilityIndex">maintainabilityIndex</a></td> | |
| 163 <td>Public method to prepare maintainability index calculation on one Python source file.</td> | |
| 164 </tr><tr> | |
| 165 <td><a href="#RadonMetricsPlugin.maintainabilityIndexBatch">maintainabilityIndexBatch</a></td> | |
| 166 <td>Public method to prepare maintainability index calculation on multiple Python source files.</td> | |
| 167 </tr><tr> | |
| 168 <td><a href="#RadonMetricsPlugin.metricsCalculationDone">metricsCalculationDone</a></td> | |
| 169 <td>Public slot to dispatch the result.</td> | |
| 170 </tr><tr> | |
| 171 <td><a href="#RadonMetricsPlugin.rawMetrics">rawMetrics</a></td> | |
| 172 <td>Public method to prepare raw code metrics calculation on one Python source file.</td> | |
| 173 </tr><tr> | |
| 174 <td><a href="#RadonMetricsPlugin.rawMetricsBatch">rawMetricsBatch</a></td> | |
| 175 <td>Public method to prepare raw code metrics calculation on multiple Python source files.</td> | |
| 176 </tr><tr> | |
| 177 <td><a href="#RadonMetricsPlugin.serviceErrorPy2">serviceErrorPy2</a></td> | |
| 178 <td>Public slot handling service errors for Python 2.</td> | |
| 179 </tr><tr> | |
| 180 <td><a href="#RadonMetricsPlugin.serviceErrorPy3">serviceErrorPy3</a></td> | |
| 181 <td>Public slot handling service errors for Python 3.</td> | |
| 182 </tr> | |
| 183 </table> | |
| 184 <h3>Static Methods</h3> | |
| 185 <table> | |
| 186 <tr><td>None</td></tr> | |
| 187 </table> | |
| 188 <a NAME="RadonMetricsPlugin.__init__" ID="RadonMetricsPlugin.__init__"></a> | |
| 189 <h4>RadonMetricsPlugin (Constructor)</h4> | |
| 190 <b>RadonMetricsPlugin</b>(<i>ui</i>) | |
| 191 <p> | |
| 192 Constructor | |
| 193 </p><dl> | |
| 194 <dt><i>ui</i> (UI.UserInterface)</dt> | |
| 195 <dd> | |
| 196 reference to the user interface object | |
| 197 </dd> | |
| 198 </dl><a NAME="RadonMetricsPlugin.__editorClosed" ID="RadonMetricsPlugin.__editorClosed"></a> | |
| 199 <h4>RadonMetricsPlugin.__editorClosed</h4> | |
| 200 <b>__editorClosed</b>(<i>editor</i>) | |
| 201 <p> | |
| 202 Private slot called, when an editor was closed. | |
| 203 </p><dl> | |
| 204 <dt><i>editor</i></dt> | |
| 205 <dd> | |
| 206 reference to the editor (QScintilla.Editor) | |
| 207 </dd> | |
| 208 </dl><a NAME="RadonMetricsPlugin.__editorCyclomaticComplexity" ID="RadonMetricsPlugin.__editorCyclomaticComplexity"></a> | |
| 209 <h4>RadonMetricsPlugin.__editorCyclomaticComplexity</h4> | |
| 210 <b>__editorCyclomaticComplexity</b>(<i></i>) | |
| 211 <p> | |
| 212 Private slot to handle the cyclomatic complexity action of the editor | |
| 213 show menu. | |
| 214 </p><a NAME="RadonMetricsPlugin.__editorMaintainabilityIndex" ID="RadonMetricsPlugin.__editorMaintainabilityIndex"></a> | |
| 215 <h4>RadonMetricsPlugin.__editorMaintainabilityIndex</h4> | |
| 216 <b>__editorMaintainabilityIndex</b>(<i></i>) | |
| 217 <p> | |
| 218 Private slot to handle the maintainability index action of the editor | |
| 219 show menu. | |
| 220 </p><a NAME="RadonMetricsPlugin.__editorOpened" ID="RadonMetricsPlugin.__editorOpened"></a> | |
| 221 <h4>RadonMetricsPlugin.__editorOpened</h4> | |
| 222 <b>__editorOpened</b>(<i>editor</i>) | |
| 223 <p> | |
| 224 Private slot called, when a new editor was opened. | |
| 225 </p><dl> | |
| 226 <dt><i>editor</i> (QScintilla.Editor)</dt> | |
| 227 <dd> | |
| 228 reference to the new editor | |
| 229 </dd> | |
| 230 </dl><a NAME="RadonMetricsPlugin.__editorRawMetrics" ID="RadonMetricsPlugin.__editorRawMetrics"></a> | |
| 231 <h4>RadonMetricsPlugin.__editorRawMetrics</h4> | |
| 232 <b>__editorRawMetrics</b>(<i></i>) | |
| 233 <p> | |
| 234 Private slot to handle the raw code metrics action of the editor show | |
| 235 menu. | |
| 236 </p><a NAME="RadonMetricsPlugin.__editorShowMenu" ID="RadonMetricsPlugin.__editorShowMenu"></a> | |
| 237 <h4>RadonMetricsPlugin.__editorShowMenu</h4> | |
| 238 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) | |
| 239 <p> | |
| 240 Private slot called, when the the editor context menu or a submenu is | |
| 241 about to be shown. | |
| 242 </p><dl> | |
| 243 <dt><i>menuName</i></dt> | |
| 244 <dd> | |
| 245 name of the menu to be shown (string) | |
| 246 </dd><dt><i>menu</i></dt> | |
| 247 <dd> | |
| 248 reference to the menu (QMenu) | |
| 249 </dd><dt><i>editor</i></dt> | |
| 250 <dd> | |
| 251 reference to the editor | |
| 252 </dd> | |
| 253 </dl><a NAME="RadonMetricsPlugin.__initialize" ID="RadonMetricsPlugin.__initialize"></a> | |
| 254 <h4>RadonMetricsPlugin.__initialize</h4> | |
| 255 <b>__initialize</b>(<i></i>) | |
| 256 <p> | |
| 257 Private slot to (re)initialize the plugin. | |
| 258 </p><a NAME="RadonMetricsPlugin.__loadTranslator" ID="RadonMetricsPlugin.__loadTranslator"></a> | |
| 259 <h4>RadonMetricsPlugin.__loadTranslator</h4> | |
| 260 <b>__loadTranslator</b>(<i></i>) | |
| 261 <p> | |
| 262 Private method to load the translation file. | |
| 263 </p><a NAME="RadonMetricsPlugin.__projectBrowserCyclomaticComplexity" ID="RadonMetricsPlugin.__projectBrowserCyclomaticComplexity"></a> | |
| 264 <h4>RadonMetricsPlugin.__projectBrowserCyclomaticComplexity</h4> | |
| 265 <b>__projectBrowserCyclomaticComplexity</b>(<i></i>) | |
| 266 <p> | |
| 267 Private method to handle the cyclomatic complexity context menu action | |
| 268 of the project sources browser. | |
| 269 </p><a NAME="RadonMetricsPlugin.__projectBrowserMaintainabilityIndex" ID="RadonMetricsPlugin.__projectBrowserMaintainabilityIndex"></a> | |
| 270 <h4>RadonMetricsPlugin.__projectBrowserMaintainabilityIndex</h4> | |
| 271 <b>__projectBrowserMaintainabilityIndex</b>(<i></i>) | |
| 272 <p> | |
| 273 Private method to handle the maintainability index context menu action | |
| 274 of the project sources browser. | |
| 275 </p><a NAME="RadonMetricsPlugin.__projectBrowserRawMetrics" ID="RadonMetricsPlugin.__projectBrowserRawMetrics"></a> | |
| 276 <h4>RadonMetricsPlugin.__projectBrowserRawMetrics</h4> | |
| 277 <b>__projectBrowserRawMetrics</b>(<i></i>) | |
| 278 <p> | |
| 279 Private method to handle the code metrics context menu action of the | |
| 280 project sources browser. | |
| 281 </p><a NAME="RadonMetricsPlugin.__projectBrowserShowMenu" ID="RadonMetricsPlugin.__projectBrowserShowMenu"></a> | |
| 282 <h4>RadonMetricsPlugin.__projectBrowserShowMenu</h4> | |
| 283 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>) | |
| 284 <p> | |
| 285 Private slot called, when the the project browser context menu or a | |
| 286 submenu is about to be shown. | |
| 287 </p><dl> | |
| 288 <dt><i>menuName</i></dt> | |
| 289 <dd> | |
| 290 name of the menu to be shown (string) | |
| 291 </dd><dt><i>menu</i></dt> | |
| 292 <dd> | |
| 293 reference to the menu (QMenu) | |
| 294 </dd> | |
| 295 </dl><a NAME="RadonMetricsPlugin.__projectCyclomaticComplexity" ID="RadonMetricsPlugin.__projectCyclomaticComplexity"></a> | |
| 296 <h4>RadonMetricsPlugin.__projectCyclomaticComplexity</h4> | |
| 297 <b>__projectCyclomaticComplexity</b>(<i></i>) | |
| 298 <p> | |
| 299 Private slot used to calculate the cyclomatic complexity for the | |
| 300 project. | |
| 301 </p><a NAME="RadonMetricsPlugin.__projectMaintainabilityIndex" ID="RadonMetricsPlugin.__projectMaintainabilityIndex"></a> | |
| 302 <h4>RadonMetricsPlugin.__projectMaintainabilityIndex</h4> | |
| 303 <b>__projectMaintainabilityIndex</b>(<i></i>) | |
| 304 <p> | |
| 305 Private slot used to calculate the maintainability indexes for the | |
| 306 project. | |
| 307 </p><a NAME="RadonMetricsPlugin.__projectRawMetrics" ID="RadonMetricsPlugin.__projectRawMetrics"></a> | |
| 308 <h4>RadonMetricsPlugin.__projectRawMetrics</h4> | |
| 309 <b>__projectRawMetrics</b>(<i></i>) | |
| 310 <p> | |
| 311 Private slot used to calculate raw code metrics for the project. | |
| 312 </p><a NAME="RadonMetricsPlugin.__projectShowMenu" ID="RadonMetricsPlugin.__projectShowMenu"></a> | |
| 313 <h4>RadonMetricsPlugin.__projectShowMenu</h4> | |
| 314 <b>__projectShowMenu</b>(<i>menuName, menu</i>) | |
| 315 <p> | |
| 316 Private slot called, when the the project menu or a submenu is | |
| 317 about to be shown. | |
| 318 </p><dl> | |
| 319 <dt><i>menuName</i> (str)</dt> | |
| 320 <dd> | |
| 321 name of the menu to be shown | |
| 322 </dd><dt><i>menu</i> (QMenu)</dt> | |
| 323 <dd> | |
| 324 reference to the menu | |
| 325 </dd> | |
| 326 </dl><a NAME="RadonMetricsPlugin.__serviceError" ID="RadonMetricsPlugin.__serviceError"></a> | |
| 327 <h4>RadonMetricsPlugin.__serviceError</h4> | |
| 328 <b>__serviceError</b>(<i>type_, fn, msg</i>) | |
| 329 <p> | |
| 330 Private slot handling service errors. | |
| 331 </p><dl> | |
| 332 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> | |
| 333 <dd> | |
| 334 type of the calculated metrics | |
| 335 </dd><dt><i>fn</i> (str)</dt> | |
| 336 <dd> | |
| 337 file name | |
| 338 </dd><dt><i>msg</i> (str)</dt> | |
| 339 <dd> | |
| 340 message text | |
| 341 </dd> | |
| 342 </dl><a NAME="RadonMetricsPlugin.__showRadonVersion" ID="RadonMetricsPlugin.__showRadonVersion"></a> | |
| 343 <h4>RadonMetricsPlugin.__showRadonVersion</h4> | |
| 344 <b>__showRadonVersion</b>(<i></i>) | |
| 345 <p> | |
| 346 Private slot to show the version number of the used radon library. | |
| 347 </p><a NAME="RadonMetricsPlugin.activate" ID="RadonMetricsPlugin.activate"></a> | |
| 348 <h4>RadonMetricsPlugin.activate</h4> | |
| 349 <b>activate</b>(<i></i>) | |
| 350 <p> | |
| 351 Public method to activate this plug-in. | |
| 352 </p><dl> | |
| 353 <dt>Returns:</dt> | |
| 354 <dd> | |
| 355 tuple of None and activation status | |
| 356 </dd> | |
| 357 </dl><dl> | |
| 358 <dt>Return Type:</dt> | |
| 359 <dd> | |
| 360 (None, bool) | |
| 361 </dd> | |
| 362 </dl><a NAME="RadonMetricsPlugin.batchJobDone" ID="RadonMetricsPlugin.batchJobDone"></a> | |
| 363 <h4>RadonMetricsPlugin.batchJobDone</h4> | |
| 364 <b>batchJobDone</b>(<i>type_, fx, lang</i>) | |
| 365 <p> | |
| 366 Public slot handling the completion of a batch job. | |
| 367 </p><dl> | |
| 368 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> | |
| 369 <dd> | |
| 370 type of the calculated metrics | |
| 371 </dd><dt><i>fx</i> (str)</dt> | |
| 372 <dd> | |
| 373 service name | |
| 374 </dd><dt><i>lang</i> (str)</dt> | |
| 375 <dd> | |
| 376 language | |
| 377 </dd> | |
| 378 </dl><a NAME="RadonMetricsPlugin.cancelComplexityBatch" ID="RadonMetricsPlugin.cancelComplexityBatch"></a> | |
| 379 <h4>RadonMetricsPlugin.cancelComplexityBatch</h4> | |
| 380 <b>cancelComplexityBatch</b>(<i></i>) | |
| 381 <p> | |
| 382 Public method to cancel all batch jobs. | |
| 383 </p><a NAME="RadonMetricsPlugin.cancelMaintainabilityIndexBatch" ID="RadonMetricsPlugin.cancelMaintainabilityIndexBatch"></a> | |
| 384 <h4>RadonMetricsPlugin.cancelMaintainabilityIndexBatch</h4> | |
| 385 <b>cancelMaintainabilityIndexBatch</b>(<i></i>) | |
| 386 <p> | |
| 387 Public method to cancel all batch jobs. | |
| 388 </p><a NAME="RadonMetricsPlugin.cancelRawMetricsBatch" ID="RadonMetricsPlugin.cancelRawMetricsBatch"></a> | |
| 389 <h4>RadonMetricsPlugin.cancelRawMetricsBatch</h4> | |
| 390 <b>cancelRawMetricsBatch</b>(<i></i>) | |
| 391 <p> | |
| 392 Public method to cancel all batch jobs. | |
| 393 </p><a NAME="RadonMetricsPlugin.cyclomaticComplexity" ID="RadonMetricsPlugin.cyclomaticComplexity"></a> | |
| 394 <h4>RadonMetricsPlugin.cyclomaticComplexity</h4> | |
| 395 <b>cyclomaticComplexity</b>(<i>lang, filename, source</i>) | |
| 396 <p> | |
| 397 Public method to prepare cyclomatic complexity calculation on one | |
| 398 Python source file. | |
| 399 </p><dl> | |
| 400 <dt><i>lang</i> (str or None)</dt> | |
| 401 <dd> | |
| 402 language of the file or None to determine by internal | |
| 403 algorithm | |
| 404 </dd><dt><i>filename</i> (str)</dt> | |
| 405 <dd> | |
| 406 source filename | |
| 407 </dd><dt><i>source</i> (str)</dt> | |
| 408 <dd> | |
| 409 string containing the code | |
| 410 </dd> | |
| 411 </dl><a NAME="RadonMetricsPlugin.cyclomaticComplexityBatch" ID="RadonMetricsPlugin.cyclomaticComplexityBatch"></a> | |
| 412 <h4>RadonMetricsPlugin.cyclomaticComplexityBatch</h4> | |
| 413 <b>cyclomaticComplexityBatch</b>(<i>argumentsList</i>) | |
| 414 <p> | |
| 415 Public method to prepare cyclomatic complexity calculation on multiple | |
| 416 Python source files. | |
| 417 </p><dl> | |
| 418 <dt><i>argumentsList</i> ((str, str))</dt> | |
| 419 <dd> | |
| 420 list of arguments tuples with each tuple | |
| 421 containing filename and source | |
| 422 </dd> | |
| 423 </dl><a NAME="RadonMetricsPlugin.deactivate" ID="RadonMetricsPlugin.deactivate"></a> | |
| 424 <h4>RadonMetricsPlugin.deactivate</h4> | |
| 425 <b>deactivate</b>(<i></i>) | |
| 426 <p> | |
| 427 Public method to deactivate this plug-in. | |
| 428 </p><a NAME="RadonMetricsPlugin.maintainabilityIndex" ID="RadonMetricsPlugin.maintainabilityIndex"></a> | |
| 429 <h4>RadonMetricsPlugin.maintainabilityIndex</h4> | |
| 430 <b>maintainabilityIndex</b>(<i>lang, filename, source</i>) | |
| 431 <p> | |
| 432 Public method to prepare maintainability index calculation on one | |
| 433 Python source file. | |
| 434 </p><dl> | |
| 435 <dt><i>lang</i> (str or None)</dt> | |
| 436 <dd> | |
| 437 language of the file or None to determine by internal | |
| 438 algorithm | |
| 439 </dd><dt><i>filename</i> (str)</dt> | |
| 440 <dd> | |
| 441 source filename | |
| 442 </dd><dt><i>source</i> (str)</dt> | |
| 443 <dd> | |
| 444 string containing the code | |
| 445 </dd> | |
| 446 </dl><a NAME="RadonMetricsPlugin.maintainabilityIndexBatch" ID="RadonMetricsPlugin.maintainabilityIndexBatch"></a> | |
| 447 <h4>RadonMetricsPlugin.maintainabilityIndexBatch</h4> | |
| 448 <b>maintainabilityIndexBatch</b>(<i>argumentsList</i>) | |
| 449 <p> | |
| 450 Public method to prepare maintainability index calculation on multiple | |
| 451 Python source files. | |
| 452 </p><dl> | |
| 453 <dt><i>argumentsList</i> ((str, str))</dt> | |
| 454 <dd> | |
| 455 list of arguments tuples with each tuple | |
| 456 containing filename and source | |
| 457 </dd> | |
| 458 </dl><a NAME="RadonMetricsPlugin.metricsCalculationDone" ID="RadonMetricsPlugin.metricsCalculationDone"></a> | |
| 459 <h4>RadonMetricsPlugin.metricsCalculationDone</h4> | |
| 460 <b>metricsCalculationDone</b>(<i>type_, filename, result</i>) | |
| 461 <p> | |
| 462 Public slot to dispatch the result. | |
| 463 </p><dl> | |
| 464 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> | |
| 465 <dd> | |
| 466 type of the calculated metrics | |
| 467 </dd><dt><i>filename</i> (str)</dt> | |
| 468 <dd> | |
| 469 name of the file the results belong to | |
| 470 </dd><dt><i>result</i> (dict)</dt> | |
| 471 <dd> | |
| 472 result dictionary | |
| 473 </dd> | |
| 474 </dl><a NAME="RadonMetricsPlugin.rawMetrics" ID="RadonMetricsPlugin.rawMetrics"></a> | |
| 475 <h4>RadonMetricsPlugin.rawMetrics</h4> | |
| 476 <b>rawMetrics</b>(<i>lang, filename, source</i>) | |
| 477 <p> | |
| 478 Public method to prepare raw code metrics calculation on one Python | |
| 479 source file. | |
| 480 </p><dl> | |
| 481 <dt><i>lang</i> (str or None)</dt> | |
| 482 <dd> | |
| 483 language of the file or None to determine by internal | |
| 484 algorithm | |
| 485 </dd><dt><i>filename</i> (str)</dt> | |
| 486 <dd> | |
| 487 source filename | |
| 488 </dd><dt><i>source</i> (str)</dt> | |
| 489 <dd> | |
| 490 string containing the code | |
| 491 </dd> | |
| 492 </dl><a NAME="RadonMetricsPlugin.rawMetricsBatch" ID="RadonMetricsPlugin.rawMetricsBatch"></a> | |
| 493 <h4>RadonMetricsPlugin.rawMetricsBatch</h4> | |
| 494 <b>rawMetricsBatch</b>(<i>argumentsList</i>) | |
| 495 <p> | |
| 496 Public method to prepare raw code metrics calculation on multiple | |
| 497 Python source files. | |
| 498 </p><dl> | |
| 499 <dt><i>argumentsList</i> ((str, str))</dt> | |
| 500 <dd> | |
| 501 list of arguments tuples with each tuple | |
| 502 containing filename and source | |
| 503 </dd> | |
| 504 </dl><a NAME="RadonMetricsPlugin.serviceErrorPy2" ID="RadonMetricsPlugin.serviceErrorPy2"></a> | |
| 505 <h4>RadonMetricsPlugin.serviceErrorPy2</h4> | |
| 506 <b>serviceErrorPy2</b>(<i>type_, fx, lang, fn, msg</i>) | |
| 507 <p> | |
| 508 Public slot handling service errors for Python 2. | |
| 509 </p><dl> | |
| 510 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> | |
| 511 <dd> | |
| 512 type of the calculated metrics | |
| 513 </dd><dt><i>fx</i> (str)</dt> | |
| 514 <dd> | |
| 515 service name | |
| 516 </dd><dt><i>lang</i> (str)</dt> | |
| 517 <dd> | |
| 518 language | |
| 519 </dd><dt><i>fn</i> (str)</dt> | |
| 520 <dd> | |
| 521 file name | |
| 522 </dd><dt><i>msg</i> (str)</dt> | |
| 523 <dd> | |
| 524 message text | |
| 525 </dd> | |
| 526 </dl><a NAME="RadonMetricsPlugin.serviceErrorPy3" ID="RadonMetricsPlugin.serviceErrorPy3"></a> | |
| 527 <h4>RadonMetricsPlugin.serviceErrorPy3</h4> | |
| 528 <b>serviceErrorPy3</b>(<i>type_, fx, lang, fn, msg</i>) | |
| 529 <p> | |
| 530 Public slot handling service errors for Python 3. | |
| 531 </p><dl> | |
| 532 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> | |
| 533 <dd> | |
| 534 type of the calculated metrics | |
| 535 </dd><dt><i>fx</i> (str)</dt> | |
| 536 <dd> | |
| 537 service name | |
| 538 </dd><dt><i>lang</i> (str)</dt> | |
| 539 <dd> | |
| 540 language | |
| 541 </dd><dt><i>fn</i> (str)</dt> | |
| 542 <dd> | |
| 543 file name | |
| 544 </dd><dt><i>msg</i> (str)</dt> | |
| 545 <dd> | |
| 546 message text | |
| 547 </dd> | |
| 548 </dl> | |
| 549 <div align="right"><a href="#top">Up</a></div> | |
| 550 <hr /> | |
| 551 </body></html> |
