Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.DataViews.PyCoverageDialog.html
eric7/Documentation/Source/eric7.DataViews.PyCoverageDialog.html
- branch
- eric7
- changeset 9097
- 213951c41dcd
- parent 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 9096:f6f7d8f364c3 | 9097:213951c41dcd |
|---|---|
| 36 <h2>PyCoverageDialog</h2> | 36 <h2>PyCoverageDialog</h2> |
| 37 | 37 |
| 38 <p> | 38 <p> |
| 39 Class implementing a dialog to display the collected code coverage data. | 39 Class implementing a dialog to display the collected code coverage data. |
| 40 </p> | 40 </p> |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>openFile(str)</dt> | |
| 45 <dd> | |
| 46 emitted to open the given file in an editor | |
| 47 </dd> | |
| 48 </dl> | |
| 41 <h3>Derived from</h3> | 49 <h3>Derived from</h3> |
| 42 QDialog, Ui_PyCoverageDialog | 50 QDialog, Ui_PyCoverageDialog |
| 43 <h3>Class Attributes</h3> | 51 <h3>Class Attributes</h3> |
| 44 | 52 |
| 45 <table> | 53 <table> |
| 57 <tr> | 65 <tr> |
| 58 <td><a href="#PyCoverageDialog.__init__">PyCoverageDialog</a></td> | 66 <td><a href="#PyCoverageDialog.__init__">PyCoverageDialog</a></td> |
| 59 <td>Constructor</td> | 67 <td>Constructor</td> |
| 60 </tr> | 68 </tr> |
| 61 <tr> | 69 <tr> |
| 62 <td><a href="#PyCoverageDialog.__annotate">__annotate</a></td> | |
| 63 <td>Private slot to handle the annotate context menu action.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#PyCoverageDialog.__annotateAll">__annotateAll</a></td> | |
| 67 <td>Private slot to handle the annotate all context menu action.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#PyCoverageDialog.__createResultItem">__createResultItem</a></td> | 70 <td><a href="#PyCoverageDialog.__createResultItem">__createResultItem</a></td> |
| 71 <td>Private method to create an entry in the result list.</td> | 71 <td>Private method to create an entry in the result list.</td> |
| 72 </tr> | 72 </tr> |
| 73 <tr> | 73 <tr> |
| 74 <td><a href="#PyCoverageDialog.__deleteAnnotated">__deleteAnnotated</a></td> | |
| 75 <td>Private slot to handle the delete annotated context menu action.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#PyCoverageDialog.__erase">__erase</a></td> | 74 <td><a href="#PyCoverageDialog.__erase">__erase</a></td> |
| 79 <td>Private slot to handle the erase context menu action.</td> | 75 <td>Private slot to handle the erase context menu action.</td> |
| 80 </tr> | 76 </tr> |
| 81 <tr> | 77 <tr> |
| 82 <td><a href="#PyCoverageDialog.__finish">__finish</a></td> | 78 <td><a href="#PyCoverageDialog.__finish">__finish</a></td> |
| 85 <tr> | 81 <tr> |
| 86 <td><a href="#PyCoverageDialog.__format_lines">__format_lines</a></td> | 82 <td><a href="#PyCoverageDialog.__format_lines">__format_lines</a></td> |
| 87 <td>Private method to format a list of integers into string by coalescing groups.</td> | 83 <td>Private method to format a list of integers into string by coalescing groups.</td> |
| 88 </tr> | 84 </tr> |
| 89 <tr> | 85 <tr> |
| 86 <td><a href="#PyCoverageDialog.__htmlReport">__htmlReport</a></td> | |
| 87 <td>Private slot to generate a HTML report of the shown data.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#PyCoverageDialog.__jsonReport">__jsonReport</a></td> | |
| 91 <td>Private slot to generate a JSON report of the shown data.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#PyCoverageDialog.__lcovReport">__lcovReport</a></td> | |
| 95 <td>Private slot to generate a LCOV report of the shown data.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 90 <td><a href="#PyCoverageDialog.__openFile">__openFile</a></td> | 98 <td><a href="#PyCoverageDialog.__openFile">__openFile</a></td> |
| 91 <td>Private slot to open the selected file.</td> | 99 <td>Private slot to open the selected file.</td> |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#PyCoverageDialog.__prepareReportGeneration">__prepareReportGeneration</a></td> | |
| 103 <td>Private method to prepare a report generation.</td> | |
| 92 </tr> | 104 </tr> |
| 93 <tr> | 105 <tr> |
| 94 <td><a href="#PyCoverageDialog.__showContextMenu">__showContextMenu</a></td> | 106 <td><a href="#PyCoverageDialog.__showContextMenu">__showContextMenu</a></td> |
| 95 <td>Private slot to show the context menu of the listview.</td> | 107 <td>Private slot to show the context menu of the listview.</td> |
| 96 </tr> | 108 </tr> |
| 128 <p> | 140 <p> |
| 129 Constructor | 141 Constructor |
| 130 </p> | 142 </p> |
| 131 <dl> | 143 <dl> |
| 132 | 144 |
| 133 <dt><i>parent</i></dt> | 145 <dt><i>parent</i> (QWidget)</dt> |
| 134 <dd> | 146 <dd> |
| 135 parent widget (QWidget) | 147 parent widget |
| 136 </dd> | 148 </dd> |
| 137 </dl> | 149 </dl> |
| 138 <a NAME="PyCoverageDialog.__annotate" ID="PyCoverageDialog.__annotate"></a> | |
| 139 <h4>PyCoverageDialog.__annotate</h4> | |
| 140 <b>__annotate</b>(<i></i>) | |
| 141 | |
| 142 <p> | |
| 143 Private slot to handle the annotate context menu action. | |
| 144 </p> | |
| 145 <p> | |
| 146 This method produce an annotated coverage file of the | |
| 147 selected file. | |
| 148 </p> | |
| 149 <a NAME="PyCoverageDialog.__annotateAll" ID="PyCoverageDialog.__annotateAll"></a> | |
| 150 <h4>PyCoverageDialog.__annotateAll</h4> | |
| 151 <b>__annotateAll</b>(<i></i>) | |
| 152 | |
| 153 <p> | |
| 154 Private slot to handle the annotate all context menu action. | |
| 155 </p> | |
| 156 <p> | |
| 157 This method produce an annotated coverage file of every | |
| 158 file listed in the listview. | |
| 159 </p> | |
| 160 <a NAME="PyCoverageDialog.__createResultItem" ID="PyCoverageDialog.__createResultItem"></a> | 150 <a NAME="PyCoverageDialog.__createResultItem" ID="PyCoverageDialog.__createResultItem"></a> |
| 161 <h4>PyCoverageDialog.__createResultItem</h4> | 151 <h4>PyCoverageDialog.__createResultItem</h4> |
| 162 <b>__createResultItem</b>(<i>file, statements, executed, coverage, excluded, missing</i>) | 152 <b>__createResultItem</b>(<i>file, statements, executed, coverage, excluded, missing</i>) |
| 163 | 153 |
| 164 <p> | 154 <p> |
| 165 Private method to create an entry in the result list. | 155 Private method to create an entry in the result list. |
| 166 </p> | 156 </p> |
| 167 <dl> | 157 <dl> |
| 168 | 158 |
| 169 <dt><i>file</i></dt> | 159 <dt><i>file</i> (str)</dt> |
| 170 <dd> | 160 <dd> |
| 171 filename of file (string) | 161 filename of file |
| 172 </dd> | 162 </dd> |
| 173 <dt><i>statements</i></dt> | 163 <dt><i>statements</i> (int)</dt> |
| 174 <dd> | 164 <dd> |
| 175 amount of statements (integer) | 165 number of statements |
| 176 </dd> | 166 </dd> |
| 177 <dt><i>executed</i></dt> | 167 <dt><i>executed</i> (int)</dt> |
| 178 <dd> | 168 <dd> |
| 179 amount of executed statements (integer) | 169 number of executed statements |
| 180 </dd> | 170 </dd> |
| 181 <dt><i>coverage</i></dt> | 171 <dt><i>coverage</i> (int)</dt> |
| 182 <dd> | 172 <dd> |
| 183 percent of coverage (integer) | 173 percent of coverage |
| 184 </dd> | 174 </dd> |
| 185 <dt><i>excluded</i></dt> | 175 <dt><i>excluded</i> (str)</dt> |
| 186 <dd> | 176 <dd> |
| 187 list of excluded lines (string) | 177 list of excluded lines |
| 188 </dd> | 178 </dd> |
| 189 <dt><i>missing</i></dt> | 179 <dt><i>missing</i> (str)</dt> |
| 190 <dd> | 180 <dd> |
| 191 list of lines without coverage (string) | 181 list of lines without coverage |
| 192 </dd> | 182 </dd> |
| 193 </dl> | 183 </dl> |
| 194 <a NAME="PyCoverageDialog.__deleteAnnotated" ID="PyCoverageDialog.__deleteAnnotated"></a> | |
| 195 <h4>PyCoverageDialog.__deleteAnnotated</h4> | |
| 196 <b>__deleteAnnotated</b>(<i></i>) | |
| 197 | |
| 198 <p> | |
| 199 Private slot to handle the delete annotated context menu action. | |
| 200 </p> | |
| 201 <p> | |
| 202 This method deletes all annotated files. These are files | |
| 203 ending with ',cover'. | |
| 204 </p> | |
| 205 <a NAME="PyCoverageDialog.__erase" ID="PyCoverageDialog.__erase"></a> | 184 <a NAME="PyCoverageDialog.__erase" ID="PyCoverageDialog.__erase"></a> |
| 206 <h4>PyCoverageDialog.__erase</h4> | 185 <h4>PyCoverageDialog.__erase</h4> |
| 207 <b>__erase</b>(<i></i>) | 186 <b>__erase</b>(<i></i>) |
| 208 | 187 |
| 209 <p> | 188 <p> |
| 229 Private method to format a list of integers into string by coalescing | 208 Private method to format a list of integers into string by coalescing |
| 230 groups. | 209 groups. |
| 231 </p> | 210 </p> |
| 232 <dl> | 211 <dl> |
| 233 | 212 |
| 234 <dt><i>lines</i></dt> | 213 <dt><i>lines</i> (list of int)</dt> |
| 235 <dd> | 214 <dd> |
| 236 list of integers | 215 list of integers |
| 237 </dd> | 216 </dd> |
| 238 </dl> | 217 </dl> |
| 239 <dl> | 218 <dl> |
| 240 <dt>Return:</dt> | 219 <dt>Return:</dt> |
| 241 <dd> | 220 <dd> |
| 242 string representing the list | 221 string representing the list |
| 243 </dd> | 222 </dd> |
| 244 </dl> | 223 </dl> |
| 224 <dl> | |
| 225 <dt>Return Type:</dt> | |
| 226 <dd> | |
| 227 str | |
| 228 </dd> | |
| 229 </dl> | |
| 230 <a NAME="PyCoverageDialog.__htmlReport" ID="PyCoverageDialog.__htmlReport"></a> | |
| 231 <h4>PyCoverageDialog.__htmlReport</h4> | |
| 232 <b>__htmlReport</b>(<i></i>) | |
| 233 | |
| 234 <p> | |
| 235 Private slot to generate a HTML report of the shown data. | |
| 236 </p> | |
| 237 <a NAME="PyCoverageDialog.__jsonReport" ID="PyCoverageDialog.__jsonReport"></a> | |
| 238 <h4>PyCoverageDialog.__jsonReport</h4> | |
| 239 <b>__jsonReport</b>(<i></i>) | |
| 240 | |
| 241 <p> | |
| 242 Private slot to generate a JSON report of the shown data. | |
| 243 </p> | |
| 244 <a NAME="PyCoverageDialog.__lcovReport" ID="PyCoverageDialog.__lcovReport"></a> | |
| 245 <h4>PyCoverageDialog.__lcovReport</h4> | |
| 246 <b>__lcovReport</b>(<i></i>) | |
| 247 | |
| 248 <p> | |
| 249 Private slot to generate a LCOV report of the shown data. | |
| 250 </p> | |
| 245 <a NAME="PyCoverageDialog.__openFile" ID="PyCoverageDialog.__openFile"></a> | 251 <a NAME="PyCoverageDialog.__openFile" ID="PyCoverageDialog.__openFile"></a> |
| 246 <h4>PyCoverageDialog.__openFile</h4> | 252 <h4>PyCoverageDialog.__openFile</h4> |
| 247 <b>__openFile</b>(<i>itm=None</i>) | 253 <b>__openFile</b>(<i>itm=None</i>) |
| 248 | 254 |
| 249 <p> | 255 <p> |
| 250 Private slot to open the selected file. | 256 Private slot to open the selected file. |
| 251 </p> | 257 </p> |
| 252 <dl> | 258 <dl> |
| 253 | 259 |
| 254 <dt><i>itm</i></dt> | 260 <dt><i>itm</i> (QTreeWidgetItem)</dt> |
| 255 <dd> | 261 <dd> |
| 256 reference to the item to be opened (QTreeWidgetItem) | 262 reference to the item to be opened |
| 263 </dd> | |
| 264 </dl> | |
| 265 <a NAME="PyCoverageDialog.__prepareReportGeneration" ID="PyCoverageDialog.__prepareReportGeneration"></a> | |
| 266 <h4>PyCoverageDialog.__prepareReportGeneration</h4> | |
| 267 <b>__prepareReportGeneration</b>(<i></i>) | |
| 268 | |
| 269 <p> | |
| 270 Private method to prepare a report generation. | |
| 271 </p> | |
| 272 <dl> | |
| 273 <dt>Return:</dt> | |
| 274 <dd> | |
| 275 tuple containing a reference to the Coverage object and the | |
| 276 list of files to report | |
| 277 </dd> | |
| 278 </dl> | |
| 279 <dl> | |
| 280 <dt>Return Type:</dt> | |
| 281 <dd> | |
| 282 tuple of (Coverage, list of str) | |
| 257 </dd> | 283 </dd> |
| 258 </dl> | 284 </dl> |
| 259 <a NAME="PyCoverageDialog.__showContextMenu" ID="PyCoverageDialog.__showContextMenu"></a> | 285 <a NAME="PyCoverageDialog.__showContextMenu" ID="PyCoverageDialog.__showContextMenu"></a> |
| 260 <h4>PyCoverageDialog.__showContextMenu</h4> | 286 <h4>PyCoverageDialog.__showContextMenu</h4> |
| 261 <b>__showContextMenu</b>(<i>coord</i>) | 287 <b>__showContextMenu</b>(<i>coord</i>) |
| 263 <p> | 289 <p> |
| 264 Private slot to show the context menu of the listview. | 290 Private slot to show the context menu of the listview. |
| 265 </p> | 291 </p> |
| 266 <dl> | 292 <dl> |
| 267 | 293 |
| 268 <dt><i>coord</i></dt> | 294 <dt><i>coord</i> (QPoint)</dt> |
| 269 <dd> | 295 <dd> |
| 270 the position of the mouse pointer (QPoint) | 296 position of the mouse pointer |
| 271 </dd> | 297 </dd> |
| 272 </dl> | 298 </dl> |
| 273 <a NAME="PyCoverageDialog.on_buttonBox_clicked" ID="PyCoverageDialog.on_buttonBox_clicked"></a> | 299 <a NAME="PyCoverageDialog.on_buttonBox_clicked" ID="PyCoverageDialog.on_buttonBox_clicked"></a> |
| 274 <h4>PyCoverageDialog.on_buttonBox_clicked</h4> | 300 <h4>PyCoverageDialog.on_buttonBox_clicked</h4> |
| 275 <b>on_buttonBox_clicked</b>(<i>button</i>) | 301 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 277 <p> | 303 <p> |
| 278 Private slot called by a button of the button box clicked. | 304 Private slot called by a button of the button box clicked. |
| 279 </p> | 305 </p> |
| 280 <dl> | 306 <dl> |
| 281 | 307 |
| 282 <dt><i>button</i></dt> | 308 <dt><i>button</i> (QAbstractButton)</dt> |
| 283 <dd> | 309 <dd> |
| 284 button that was clicked (QAbstractButton) | 310 button that was clicked |
| 285 </dd> | 311 </dd> |
| 286 </dl> | 312 </dl> |
| 287 <a NAME="PyCoverageDialog.on_reloadButton_clicked" ID="PyCoverageDialog.on_reloadButton_clicked"></a> | 313 <a NAME="PyCoverageDialog.on_reloadButton_clicked" ID="PyCoverageDialog.on_reloadButton_clicked"></a> |
| 288 <h4>PyCoverageDialog.on_reloadButton_clicked</h4> | 314 <h4>PyCoverageDialog.on_reloadButton_clicked</h4> |
| 289 <b>on_reloadButton_clicked</b>(<i></i>) | 315 <b>on_reloadButton_clicked</b>(<i></i>) |
| 316 <p> | 342 <p> |
| 317 Public slot to start the coverage data evaluation. | 343 Public slot to start the coverage data evaluation. |
| 318 </p> | 344 </p> |
| 319 <dl> | 345 <dl> |
| 320 | 346 |
| 321 <dt><i>cfn</i></dt> | 347 <dt><i>cfn</i> (str)</dt> |
| 322 <dd> | 348 <dd> |
| 323 basename of the coverage file (string) | 349 basename of the coverage file |
| 324 </dd> | 350 </dd> |
| 325 <dt><i>fn</i></dt> | 351 <dt><i>fn</i> (str or list of str)</dt> |
| 326 <dd> | 352 <dd> |
| 327 file or list of files or directory to be checked | 353 file or list of files or directory to be checked |
| 328 (string or list of strings) | |
| 329 </dd> | 354 </dd> |
| 330 </dl> | 355 </dl> |
| 331 <a NAME="PyCoverageDialog.stringify" ID="PyCoverageDialog.stringify"></a> | 356 <a NAME="PyCoverageDialog.stringify" ID="PyCoverageDialog.stringify"></a> |
| 332 <h4>PyCoverageDialog.stringify</h4> | 357 <h4>PyCoverageDialog.stringify</h4> |
| 333 <b>stringify</b>(<i></i>) | 358 <b>stringify</b>(<i></i>) |
| 336 Private helper function to generate a string representation of a | 361 Private helper function to generate a string representation of a |
| 337 pair. | 362 pair. |
| 338 </p> | 363 </p> |
| 339 <dl> | 364 <dl> |
| 340 | 365 |
| 341 <dt><i>pair</i></dt> | 366 <dt><i>pair</i> (tuple of (int, int)</dt> |
| 342 <dd> | 367 <dd> |
| 343 pair of integers | 368 pair of integers |
| 369 </dd> | |
| 370 </dl> | |
| 371 <dl> | |
| 372 <dt>Return:</dt> | |
| 373 <dd> | |
| 374 representation of the pair | |
| 375 </dd> | |
| 376 </dl> | |
| 377 <dl> | |
| 378 <dt>Return Type:</dt> | |
| 379 <dd> | |
| 380 str | |
| 344 </dd> | 381 </dd> |
| 345 </dl> | 382 </dl> |
| 346 <div align="right"><a href="#top">Up</a></div> | 383 <div align="right"><a href="#top">Up</a></div> |
| 347 <hr /> | 384 <hr /> |
| 348 </body></html> | 385 </body></html> |
