Mercurial Repositories > Radon Code Metrics / file comparison

comparison: RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.RawMetricsDialog.html

RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.RawMetricsDialog.html

changeset 69
cdf51e6abaee
parent 31
fe59ed68bd19
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.RawMetricsDialog</h1> 23 <h1>Plugin_Metrics_Radon.RadonMetrics.RawMetricsDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to show raw code metrics. 26 Module implementing a dialog to show raw code metrics.
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>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#RawMetricsDialog">RawMetricsDialog</a></td> 38 <td><a href="#RawMetricsDialog">RawMetricsDialog</a></td>
34 <td>Class implementing a dialog to show raw code metrics.</td> 39 <td>Class implementing a dialog to show raw code metrics.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="RawMetricsDialog" ID="RawMetricsDialog"></a> 49 <a NAME="RawMetricsDialog" ID="RawMetricsDialog"></a>
43 <h2>RawMetricsDialog</h2> 50 <h2>RawMetricsDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to show raw code metrics. 53 Class implementing a dialog to show raw code metrics.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_RawMetricsDialog 56 QDialog, Ui_RawMetricsDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>FilePathRole</td></tr> 60 <tr><td>FilePathRole</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#RawMetricsDialog.__init__">RawMetricsDialog</a></td> 72 <td><a href="#RawMetricsDialog.__init__">RawMetricsDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#RawMetricsDialog.__batchFinished">__batchFinished</a></td> 76 <td><a href="#RawMetricsDialog.__batchFinished">__batchFinished</a></td>
64 <td>Private slot handling the completion of a batch job.</td> 77 <td>Private slot handling the completion of a batch job.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#RawMetricsDialog.__createErrorItem">__createErrorItem</a></td> 80 <td><a href="#RawMetricsDialog.__createErrorItem">__createErrorItem</a></td>
67 <td>Private slot to create a new error item in the result list.</td> 81 <td>Private slot to create a new error item in the result list.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#RawMetricsDialog.__createResultItem">__createResultItem</a></td> 84 <td><a href="#RawMetricsDialog.__createResultItem">__createResultItem</a></td>
70 <td>Private slot to create a new item in the result list.</td> 85 <td>Private slot to create a new item in the result list.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#RawMetricsDialog.__createSummary">__createSummary</a></td> 88 <td><a href="#RawMetricsDialog.__createSummary">__createSummary</a></td>
73 <td>Private method to create the code metrics summary.</td> 89 <td>Private method to create the code metrics summary.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#RawMetricsDialog.__createSummaryItem">__createSummaryItem</a></td> 92 <td><a href="#RawMetricsDialog.__createSummaryItem">__createSummaryItem</a></td>
76 <td>Private slot to create a new item in the summary list.</td> 93 <td>Private slot to create a new item in the summary list.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#RawMetricsDialog.__finish">__finish</a></td> 96 <td><a href="#RawMetricsDialog.__finish">__finish</a></td>
79 <td>Private slot called when the action or the user pressed the button.</td> 97 <td>Private slot called when the action or the user pressed the button.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#RawMetricsDialog.__getValues">__getValues</a></td> 100 <td><a href="#RawMetricsDialog.__getValues">__getValues</a></td>
82 <td>Private method to extract the code metric values.</td> 101 <td>Private method to extract the code metric values.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#RawMetricsDialog.__processError">__processError</a></td> 104 <td><a href="#RawMetricsDialog.__processError">__processError</a></td>
85 <td>Private slot to process an error indication from the service.</td> 105 <td>Private slot to process an error indication from the service.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#RawMetricsDialog.__processResult">__processResult</a></td> 108 <td><a href="#RawMetricsDialog.__processResult">__processResult</a></td>
88 <td>Private slot called after perfoming a code metrics calculation on one file.</td> 109 <td>Private slot called after perfoming a code metrics calculation on one file.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#RawMetricsDialog.__resizeResultColumns">__resizeResultColumns</a></td> 112 <td><a href="#RawMetricsDialog.__resizeResultColumns">__resizeResultColumns</a></td>
91 <td>Private method to resize the list columns.</td> 113 <td>Private method to resize the list columns.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#RawMetricsDialog.clear">clear</a></td> 116 <td><a href="#RawMetricsDialog.clear">clear</a></td>
94 <td>Public method to clear all results.</td> 117 <td>Public method to clear all results.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#RawMetricsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 120 <td><a href="#RawMetricsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
97 <td>Private slot called by a button of the button box clicked.</td> 121 <td>Private slot called by a button of the button box clicked.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#RawMetricsDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> 124 <td><a href="#RawMetricsDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
100 <td>Private slot to handle the activation of a result item.</td> 125 <td>Private slot to handle the activation of a result item.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#RawMetricsDialog.on_startButton_clicked">on_startButton_clicked</a></td> 128 <td><a href="#RawMetricsDialog.on_startButton_clicked">on_startButton_clicked</a></td>
103 <td>Private slot to start a code metrics run.</td> 129 <td>Private slot to start a code metrics run.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#RawMetricsDialog.prepare">prepare</a></td> 132 <td><a href="#RawMetricsDialog.prepare">prepare</a></td>
106 <td>Public method to prepare the dialog with a list of filenames.</td> 133 <td>Public method to prepare the dialog with a list of filenames.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#RawMetricsDialog.rawMetrics">rawMetrics</a></td> 136 <td><a href="#RawMetricsDialog.rawMetrics">rawMetrics</a></td>
109 <td>Public method to start a code metrics calculation for one Python file.</td> 137 <td>Public method to start a code metrics calculation for one Python file.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#RawMetricsDialog.rawMetricsBatch">rawMetricsBatch</a></td> 140 <td><a href="#RawMetricsDialog.rawMetricsBatch">rawMetricsBatch</a></td>
112 <td>Public method to start a code metrics calculation batch job.</td> 141 <td>Public method to start a code metrics calculation batch job.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#RawMetricsDialog.start">start</a></td> 144 <td><a href="#RawMetricsDialog.start">start</a></td>
115 <td>Public slot to start the code metrics determination.</td> 145 <td>Public slot to start the code metrics determination.</td>
116 </tr> 146 </tr>
117 </table> 147 </table>
118 <h3>Static Methods</h3> 148 <h3>Static Methods</h3>
149
119 <table> 150 <table>
120 <tr><td>None</td></tr> 151 <tr><td>None</td></tr>
121 </table> 152 </table>
153
122 <a NAME="RawMetricsDialog.__init__" ID="RawMetricsDialog.__init__"></a> 154 <a NAME="RawMetricsDialog.__init__" ID="RawMetricsDialog.__init__"></a>
123 <h4>RawMetricsDialog (Constructor)</h4> 155 <h4>RawMetricsDialog (Constructor)</h4>
124 <b>RawMetricsDialog</b>(<i>radonService, parent=None</i>) 156 <b>RawMetricsDialog</b>(<i>radonService, parent=None</i>)
157
125 <p> 158 <p>
126 Constructor 159 Constructor
127 </p><dl> 160 </p>
161 <dl>
162
128 <dt><i>radonService</i> (RadonMetricsPlugin)</dt> 163 <dt><i>radonService</i> (RadonMetricsPlugin)</dt>
129 <dd> 164 <dd>
130 reference to the service 165 reference to the service
131 </dd><dt><i>parent</i> (QWidget)</dt> 166 </dd>
167 <dt><i>parent</i> (QWidget)</dt>
132 <dd> 168 <dd>
133 reference to the parent widget 169 reference to the parent widget
134 </dd> 170 </dd>
135 </dl><a NAME="RawMetricsDialog.__batchFinished" ID="RawMetricsDialog.__batchFinished"></a> 171 </dl>
172 <a NAME="RawMetricsDialog.__batchFinished" ID="RawMetricsDialog.__batchFinished"></a>
136 <h4>RawMetricsDialog.__batchFinished</h4> 173 <h4>RawMetricsDialog.__batchFinished</h4>
137 <b>__batchFinished</b>(<i>type_</i>) 174 <b>__batchFinished</b>(<i>type_</i>)
175
138 <p> 176 <p>
139 Private slot handling the completion of a batch job. 177 Private slot handling the completion of a batch job.
140 </p><dl> 178 </p>
179 <dl>
180
141 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> 181 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt>
142 <dd> 182 <dd>
143 type of the calculated metrics 183 type of the calculated metrics
144 </dd> 184 </dd>
145 </dl><a NAME="RawMetricsDialog.__createErrorItem" ID="RawMetricsDialog.__createErrorItem"></a> 185 </dl>
186 <a NAME="RawMetricsDialog.__createErrorItem" ID="RawMetricsDialog.__createErrorItem"></a>
146 <h4>RawMetricsDialog.__createErrorItem</h4> 187 <h4>RawMetricsDialog.__createErrorItem</h4>
147 <b>__createErrorItem</b>(<i>filename, message</i>) 188 <b>__createErrorItem</b>(<i>filename, message</i>)
189
148 <p> 190 <p>
149 Private slot to create a new error item in the result list. 191 Private slot to create a new error item in the result list.
150 </p><dl> 192 </p>
193 <dl>
194
151 <dt><i>filename</i> (str)</dt> 195 <dt><i>filename</i> (str)</dt>
152 <dd> 196 <dd>
153 name of the file 197 name of the file
154 </dd><dt><i>message</i> (str)</dt> 198 </dd>
199 <dt><i>message</i> (str)</dt>
155 <dd> 200 <dd>
156 error message 201 error message
157 </dd> 202 </dd>
158 </dl><a NAME="RawMetricsDialog.__createResultItem" ID="RawMetricsDialog.__createResultItem"></a> 203 </dl>
204 <a NAME="RawMetricsDialog.__createResultItem" ID="RawMetricsDialog.__createResultItem"></a>
159 <h4>RawMetricsDialog.__createResultItem</h4> 205 <h4>RawMetricsDialog.__createResultItem</h4>
160 <b>__createResultItem</b>(<i>filename, values</i>) 206 <b>__createResultItem</b>(<i>filename, values</i>)
207
161 <p> 208 <p>
162 Private slot to create a new item in the result list. 209 Private slot to create a new item in the result list.
163 </p><dl> 210 </p>
211 <dl>
212
164 <dt><i>filename</i> (str)</dt> 213 <dt><i>filename</i> (str)</dt>
165 <dd> 214 <dd>
166 name of the file 215 name of the file
167 </dd><dt><i>values</i> (dict)</dt> 216 </dd>
217 <dt><i>values</i> (dict)</dt>
168 <dd> 218 <dd>
169 values to be displayed 219 values to be displayed
170 </dd> 220 </dd>
171 </dl><a NAME="RawMetricsDialog.__createSummary" ID="RawMetricsDialog.__createSummary"></a> 221 </dl>
222 <a NAME="RawMetricsDialog.__createSummary" ID="RawMetricsDialog.__createSummary"></a>
172 <h4>RawMetricsDialog.__createSummary</h4> 223 <h4>RawMetricsDialog.__createSummary</h4>
173 <b>__createSummary</b>(<i></i>) 224 <b>__createSummary</b>(<i></i>)
225
174 <p> 226 <p>
175 Private method to create the code metrics summary. 227 Private method to create the code metrics summary.
176 </p><a NAME="RawMetricsDialog.__createSummaryItem" ID="RawMetricsDialog.__createSummaryItem"></a> 228 </p>
229 <a NAME="RawMetricsDialog.__createSummaryItem" ID="RawMetricsDialog.__createSummaryItem"></a>
177 <h4>RawMetricsDialog.__createSummaryItem</h4> 230 <h4>RawMetricsDialog.__createSummaryItem</h4>
178 <b>__createSummaryItem</b>(<i>col0, col1</i>) 231 <b>__createSummaryItem</b>(<i>col0, col1</i>)
232
179 <p> 233 <p>
180 Private slot to create a new item in the summary list. 234 Private slot to create a new item in the summary list.
181 </p><dl> 235 </p>
236 <dl>
237
182 <dt><i>col0</i></dt> 238 <dt><i>col0</i></dt>
183 <dd> 239 <dd>
184 string for column 0 (string) 240 string for column 0 (string)
185 </dd><dt><i>col1</i></dt> 241 </dd>
242 <dt><i>col1</i></dt>
186 <dd> 243 <dd>
187 string for column 1 (string) 244 string for column 1 (string)
188 </dd> 245 </dd>
189 </dl><a NAME="RawMetricsDialog.__finish" ID="RawMetricsDialog.__finish"></a> 246 </dl>
247 <a NAME="RawMetricsDialog.__finish" ID="RawMetricsDialog.__finish"></a>
190 <h4>RawMetricsDialog.__finish</h4> 248 <h4>RawMetricsDialog.__finish</h4>
191 <b>__finish</b>(<i></i>) 249 <b>__finish</b>(<i></i>)
250
192 <p> 251 <p>
193 Private slot called when the action or the user pressed the button. 252 Private slot called when the action or the user pressed the button.
194 </p><a NAME="RawMetricsDialog.__getValues" ID="RawMetricsDialog.__getValues"></a> 253 </p>
254 <a NAME="RawMetricsDialog.__getValues" ID="RawMetricsDialog.__getValues"></a>
195 <h4>RawMetricsDialog.__getValues</h4> 255 <h4>RawMetricsDialog.__getValues</h4>
196 <b>__getValues</b>(<i>result</i>) 256 <b>__getValues</b>(<i>result</i>)
257
197 <p> 258 <p>
198 Private method to extract the code metric values. 259 Private method to extract the code metric values.
199 </p><dl> 260 </p>
261 <dl>
262
200 <dt><i>result</i> (dict)</dt> 263 <dt><i>result</i> (dict)</dt>
201 <dd> 264 <dd>
202 result dict 265 result dict
203 </dd> 266 </dd>
204 </dl><dl> 267 </dl>
268 <dl>
205 <dt>Returns:</dt> 269 <dt>Returns:</dt>
206 <dd> 270 <dd>
207 list of values suitable for display 271 list of values suitable for display
208 </dd> 272 </dd>
209 </dl><dl> 273 </dl>
274 <dl>
210 <dt>Return Type:</dt> 275 <dt>Return Type:</dt>
211 <dd> 276 <dd>
212 list of str 277 list of str
213 </dd> 278 </dd>
214 </dl><a NAME="RawMetricsDialog.__processError" ID="RawMetricsDialog.__processError"></a> 279 </dl>
280 <a NAME="RawMetricsDialog.__processError" ID="RawMetricsDialog.__processError"></a>
215 <h4>RawMetricsDialog.__processError</h4> 281 <h4>RawMetricsDialog.__processError</h4>
216 <b>__processError</b>(<i>type_, fn, msg</i>) 282 <b>__processError</b>(<i>type_, fn, msg</i>)
283
217 <p> 284 <p>
218 Private slot to process an error indication from the service. 285 Private slot to process an error indication from the service.
219 </p><dl> 286 </p>
287 <dl>
288
220 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> 289 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt>
221 <dd> 290 <dd>
222 type of the calculated metrics 291 type of the calculated metrics
223 </dd><dt><i>fn</i> (str)</dt> 292 </dd>
293 <dt><i>fn</i> (str)</dt>
224 <dd> 294 <dd>
225 filename of the file 295 filename of the file
226 </dd><dt><i>msg</i> (str)</dt> 296 </dd>
297 <dt><i>msg</i> (str)</dt>
227 <dd> 298 <dd>
228 error message 299 error message
229 </dd> 300 </dd>
230 </dl><a NAME="RawMetricsDialog.__processResult" ID="RawMetricsDialog.__processResult"></a> 301 </dl>
302 <a NAME="RawMetricsDialog.__processResult" ID="RawMetricsDialog.__processResult"></a>
231 <h4>RawMetricsDialog.__processResult</h4> 303 <h4>RawMetricsDialog.__processResult</h4>
232 <b>__processResult</b>(<i>fn, result</i>) 304 <b>__processResult</b>(<i>fn, result</i>)
305
233 <p> 306 <p>
234 Private slot called after perfoming a code metrics calculation on one 307 Private slot called after perfoming a code metrics calculation on one
235 file. 308 file.
236 </p><dl> 309 </p>
310 <dl>
311
237 <dt><i>fn</i> (str)</dt> 312 <dt><i>fn</i> (str)</dt>
238 <dd> 313 <dd>
239 filename of the file 314 filename of the file
240 </dd><dt><i>result</i> (dict)</dt> 315 </dd>
316 <dt><i>result</i> (dict)</dt>
241 <dd> 317 <dd>
242 result dict 318 result dict
243 </dd> 319 </dd>
244 </dl><a NAME="RawMetricsDialog.__resizeResultColumns" ID="RawMetricsDialog.__resizeResultColumns"></a> 320 </dl>
321 <a NAME="RawMetricsDialog.__resizeResultColumns" ID="RawMetricsDialog.__resizeResultColumns"></a>
245 <h4>RawMetricsDialog.__resizeResultColumns</h4> 322 <h4>RawMetricsDialog.__resizeResultColumns</h4>
246 <b>__resizeResultColumns</b>(<i></i>) 323 <b>__resizeResultColumns</b>(<i></i>)
324
247 <p> 325 <p>
248 Private method to resize the list columns. 326 Private method to resize the list columns.
249 </p><a NAME="RawMetricsDialog.clear" ID="RawMetricsDialog.clear"></a> 327 </p>
328 <a NAME="RawMetricsDialog.clear" ID="RawMetricsDialog.clear"></a>
250 <h4>RawMetricsDialog.clear</h4> 329 <h4>RawMetricsDialog.clear</h4>
251 <b>clear</b>(<i></i>) 330 <b>clear</b>(<i></i>)
331
252 <p> 332 <p>
253 Public method to clear all results. 333 Public method to clear all results.
254 </p><a NAME="RawMetricsDialog.on_buttonBox_clicked" ID="RawMetricsDialog.on_buttonBox_clicked"></a> 334 </p>
335 <a NAME="RawMetricsDialog.on_buttonBox_clicked" ID="RawMetricsDialog.on_buttonBox_clicked"></a>
255 <h4>RawMetricsDialog.on_buttonBox_clicked</h4> 336 <h4>RawMetricsDialog.on_buttonBox_clicked</h4>
256 <b>on_buttonBox_clicked</b>(<i>button</i>) 337 <b>on_buttonBox_clicked</b>(<i>button</i>)
338
257 <p> 339 <p>
258 Private slot called by a button of the button box clicked. 340 Private slot called by a button of the button box clicked.
259 </p><dl> 341 </p>
342 <dl>
343
260 <dt><i>button</i> (QAbstractButton)</dt> 344 <dt><i>button</i> (QAbstractButton)</dt>
261 <dd> 345 <dd>
262 button that was clicked 346 button that was clicked
263 </dd> 347 </dd>
264 </dl><a NAME="RawMetricsDialog.on_resultList_itemActivated" ID="RawMetricsDialog.on_resultList_itemActivated"></a> 348 </dl>
349 <a NAME="RawMetricsDialog.on_resultList_itemActivated" ID="RawMetricsDialog.on_resultList_itemActivated"></a>
265 <h4>RawMetricsDialog.on_resultList_itemActivated</h4> 350 <h4>RawMetricsDialog.on_resultList_itemActivated</h4>
266 <b>on_resultList_itemActivated</b>(<i>item, column</i>) 351 <b>on_resultList_itemActivated</b>(<i>item, column</i>)
352
267 <p> 353 <p>
268 Private slot to handle the activation of a result item. 354 Private slot to handle the activation of a result item.
269 </p><dl> 355 </p>
356 <dl>
357
270 <dt><i>item</i> (QTreeWidgetItem)</dt> 358 <dt><i>item</i> (QTreeWidgetItem)</dt>
271 <dd> 359 <dd>
272 reference to the activated item 360 reference to the activated item
273 </dd><dt><i>column</i> (int)</dt> 361 </dd>
362 <dt><i>column</i> (int)</dt>
274 <dd> 363 <dd>
275 activated column 364 activated column
276 </dd> 365 </dd>
277 </dl><a NAME="RawMetricsDialog.on_startButton_clicked" ID="RawMetricsDialog.on_startButton_clicked"></a> 366 </dl>
367 <a NAME="RawMetricsDialog.on_startButton_clicked" ID="RawMetricsDialog.on_startButton_clicked"></a>
278 <h4>RawMetricsDialog.on_startButton_clicked</h4> 368 <h4>RawMetricsDialog.on_startButton_clicked</h4>
279 <b>on_startButton_clicked</b>(<i></i>) 369 <b>on_startButton_clicked</b>(<i></i>)
370
280 <p> 371 <p>
281 Private slot to start a code metrics run. 372 Private slot to start a code metrics run.
282 </p><a NAME="RawMetricsDialog.prepare" ID="RawMetricsDialog.prepare"></a> 373 </p>
374 <a NAME="RawMetricsDialog.prepare" ID="RawMetricsDialog.prepare"></a>
283 <h4>RawMetricsDialog.prepare</h4> 375 <h4>RawMetricsDialog.prepare</h4>
284 <b>prepare</b>(<i>fileList, project</i>) 376 <b>prepare</b>(<i>fileList, project</i>)
377
285 <p> 378 <p>
286 Public method to prepare the dialog with a list of filenames. 379 Public method to prepare the dialog with a list of filenames.
287 </p><dl> 380 </p>
381 <dl>
382
288 <dt><i>fileList</i> (list of str)</dt> 383 <dt><i>fileList</i> (list of str)</dt>
289 <dd> 384 <dd>
290 list of filenames 385 list of filenames
291 </dd><dt><i>project</i> (Project)</dt> 386 </dd>
387 <dt><i>project</i> (Project)</dt>
292 <dd> 388 <dd>
293 reference to the project object 389 reference to the project object
294 </dd> 390 </dd>
295 </dl><a NAME="RawMetricsDialog.rawMetrics" ID="RawMetricsDialog.rawMetrics"></a> 391 </dl>
392 <a NAME="RawMetricsDialog.rawMetrics" ID="RawMetricsDialog.rawMetrics"></a>
296 <h4>RawMetricsDialog.rawMetrics</h4> 393 <h4>RawMetricsDialog.rawMetrics</h4>
297 <b>rawMetrics</b>(<i>codestring=''</i>) 394 <b>rawMetrics</b>(<i>codestring=''</i>)
395
298 <p> 396 <p>
299 Public method to start a code metrics calculation for one Python file. 397 Public method to start a code metrics calculation for one Python file.
300 </p><p> 398 </p>
399 <p>
301 The results are reported to the __processResult slot. 400 The results are reported to the __processResult slot.
302 </p><dl> 401 </p>
402 <dl>
403
303 <dt><i>codestring=</i> (str)</dt> 404 <dt><i>codestring=</i> (str)</dt>
304 <dd> 405 <dd>
305 optional sourcestring 406 optional sourcestring
306 </dd> 407 </dd>
307 </dl><a NAME="RawMetricsDialog.rawMetricsBatch" ID="RawMetricsDialog.rawMetricsBatch"></a> 408 </dl>
409 <a NAME="RawMetricsDialog.rawMetricsBatch" ID="RawMetricsDialog.rawMetricsBatch"></a>
308 <h4>RawMetricsDialog.rawMetricsBatch</h4> 410 <h4>RawMetricsDialog.rawMetricsBatch</h4>
309 <b>rawMetricsBatch</b>(<i></i>) 411 <b>rawMetricsBatch</b>(<i></i>)
412
310 <p> 413 <p>
311 Public method to start a code metrics calculation batch job. 414 Public method to start a code metrics calculation batch job.
312 </p><p> 415 </p>
416 <p>
313 The results are reported to the __processResult slot. 417 The results are reported to the __processResult slot.
314 </p><a NAME="RawMetricsDialog.start" ID="RawMetricsDialog.start"></a> 418 </p>
419 <a NAME="RawMetricsDialog.start" ID="RawMetricsDialog.start"></a>
315 <h4>RawMetricsDialog.start</h4> 420 <h4>RawMetricsDialog.start</h4>
316 <b>start</b>(<i>fn</i>) 421 <b>start</b>(<i>fn</i>)
422
317 <p> 423 <p>
318 Public slot to start the code metrics determination. 424 Public slot to start the code metrics determination.
319 </p><dl> 425 </p>
426 <dl>
427
320 <dt><i>fn</i> (str or list of str)</dt> 428 <dt><i>fn</i> (str or list of str)</dt>
321 <dd> 429 <dd>
322 file or list of files or directory to show 430 file or list of files or directory to show
323 the code metrics for 431 the code metrics for
324 </dd> 432 </dd>

Mercurial Repository: Radon Code Metrics

eric ide

mercurial