Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DataViews.PyCoverageDialog.html
src/eric7/Documentation/Source/eric7.DataViews.PyCoverageDialog.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10423
- 299802979277
- child 10689
- 3ede487187f2
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.DataViews.PyCoverageDialog</h1> | 9 <h1>eric7.DataViews.PyCoverageDialog</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a Python code coverage dialog. | 11 Module implementing a Python code coverage dialog. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#PyCoverageDialog">PyCoverageDialog</a></td> | 22 <td><a href="#PyCoverageDialog">PyCoverageDialog</a></td> |
| 25 <td>Class implementing a dialog to display the collected code coverage data.</td> | 23 <td>Class implementing a dialog to display the collected code coverage data.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="PyCoverageDialog" ID="PyCoverageDialog"></a> | 34 <a NAME="PyCoverageDialog" ID="PyCoverageDialog"></a> |
| 36 <h2>PyCoverageDialog</h2> | 35 <h2>PyCoverageDialog</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a dialog to display the collected code coverage data. | 37 Class implementing a dialog to display the collected code coverage data. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Signals</h3> | 40 <h3>Signals</h3> |
| 42 <dl> | 41 <dl> |
| 43 | 42 |
| 44 <dt>openFile(str)</dt> | 43 <dt>openFile(str)</dt> |
| 45 <dd> | 44 <dd> |
| 47 </dd> | 46 </dd> |
| 48 </dl> | 47 </dl> |
| 49 <h3>Derived from</h3> | 48 <h3>Derived from</h3> |
| 50 QDialog, Ui_PyCoverageDialog | 49 QDialog, Ui_PyCoverageDialog |
| 51 <h3>Class Attributes</h3> | 50 <h3>Class Attributes</h3> |
| 52 | |
| 53 <table> | 51 <table> |
| 54 <tr><td>None</td></tr> | 52 <tr><td>None</td></tr> |
| 55 </table> | 53 </table> |
| 54 | |
| 56 <h3>Class Methods</h3> | 55 <h3>Class Methods</h3> |
| 57 | |
| 58 <table> | 56 <table> |
| 59 <tr><td>None</td></tr> | 57 <tr><td>None</td></tr> |
| 60 </table> | 58 </table> |
| 59 | |
| 61 <h3>Methods</h3> | 60 <h3>Methods</h3> |
| 62 | 61 <table> |
| 63 <table> | |
| 64 | |
| 65 <tr> | 62 <tr> |
| 66 <td><a href="#PyCoverageDialog.__init__">PyCoverageDialog</a></td> | 63 <td><a href="#PyCoverageDialog.__init__">PyCoverageDialog</a></td> |
| 67 <td>Constructor</td> | 64 <td>Constructor</td> |
| 68 </tr> | 65 </tr> |
| 69 <tr> | 66 <tr> |
| 129 <tr> | 126 <tr> |
| 130 <td><a href="#PyCoverageDialog.stringify">stringify</a></td> | 127 <td><a href="#PyCoverageDialog.stringify">stringify</a></td> |
| 131 <td>Private helper function to generate a string representation of a pair.</td> | 128 <td>Private helper function to generate a string representation of a pair.</td> |
| 132 </tr> | 129 </tr> |
| 133 </table> | 130 </table> |
| 131 | |
| 134 <h3>Static Methods</h3> | 132 <h3>Static Methods</h3> |
| 135 | |
| 136 <table> | 133 <table> |
| 137 <tr><td>None</td></tr> | 134 <tr><td>None</td></tr> |
| 138 </table> | 135 </table> |
| 136 | |
| 139 | 137 |
| 140 <a NAME="PyCoverageDialog.__init__" ID="PyCoverageDialog.__init__"></a> | 138 <a NAME="PyCoverageDialog.__init__" ID="PyCoverageDialog.__init__"></a> |
| 141 <h4>PyCoverageDialog (Constructor)</h4> | 139 <h4>PyCoverageDialog (Constructor)</h4> |
| 142 <b>PyCoverageDialog</b>(<i>parent=None</i>) | 140 <b>PyCoverageDialog</b>(<i>parent=None</i>) |
| 143 | |
| 144 <p> | 141 <p> |
| 145 Constructor | 142 Constructor |
| 146 </p> | 143 </p> |
| 144 | |
| 147 <dl> | 145 <dl> |
| 148 | 146 |
| 149 <dt><i>parent</i> (QWidget)</dt> | 147 <dt><i>parent</i> (QWidget)</dt> |
| 150 <dd> | 148 <dd> |
| 151 parent widget | 149 parent widget |
| 152 </dd> | 150 </dd> |
| 153 </dl> | 151 </dl> |
| 154 <a NAME="PyCoverageDialog.__createResultItem" ID="PyCoverageDialog.__createResultItem"></a> | 152 <a NAME="PyCoverageDialog.__createResultItem" ID="PyCoverageDialog.__createResultItem"></a> |
| 155 <h4>PyCoverageDialog.__createResultItem</h4> | 153 <h4>PyCoverageDialog.__createResultItem</h4> |
| 156 <b>__createResultItem</b>(<i>file, statements, executed, coverage, excluded, missing</i>) | 154 <b>__createResultItem</b>(<i>file, statements, executed, coverage, excluded, missing</i>) |
| 157 | |
| 158 <p> | 155 <p> |
| 159 Private method to create an entry in the result list. | 156 Private method to create an entry in the result list. |
| 160 </p> | 157 </p> |
| 158 | |
| 161 <dl> | 159 <dl> |
| 162 | 160 |
| 163 <dt><i>file</i> (str)</dt> | 161 <dt><i>file</i> (str)</dt> |
| 164 <dd> | 162 <dd> |
| 165 filename of file | 163 filename of file |
| 186 </dd> | 184 </dd> |
| 187 </dl> | 185 </dl> |
| 188 <a NAME="PyCoverageDialog.__erase" ID="PyCoverageDialog.__erase"></a> | 186 <a NAME="PyCoverageDialog.__erase" ID="PyCoverageDialog.__erase"></a> |
| 189 <h4>PyCoverageDialog.__erase</h4> | 187 <h4>PyCoverageDialog.__erase</h4> |
| 190 <b>__erase</b>(<i></i>) | 188 <b>__erase</b>(<i></i>) |
| 191 | |
| 192 <p> | 189 <p> |
| 193 Private slot to handle the erase context menu action. | 190 Private slot to handle the erase context menu action. |
| 194 </p> | 191 </p> |
| 195 <p> | 192 <p> |
| 196 This method erases the collected coverage data that is | 193 This method erases the collected coverage data that is |
| 197 stored in the .coverage file. | 194 stored in the .coverage file. |
| 198 </p> | 195 </p> |
| 196 | |
| 199 <a NAME="PyCoverageDialog.__finish" ID="PyCoverageDialog.__finish"></a> | 197 <a NAME="PyCoverageDialog.__finish" ID="PyCoverageDialog.__finish"></a> |
| 200 <h4>PyCoverageDialog.__finish</h4> | 198 <h4>PyCoverageDialog.__finish</h4> |
| 201 <b>__finish</b>(<i></i>) | 199 <b>__finish</b>(<i></i>) |
| 202 | |
| 203 <p> | 200 <p> |
| 204 Private slot called when the action finished or the user pressed the | 201 Private slot called when the action finished or the user pressed the |
| 205 button. | 202 button. |
| 206 </p> | 203 </p> |
| 204 | |
| 207 <a NAME="PyCoverageDialog.__format_lines" ID="PyCoverageDialog.__format_lines"></a> | 205 <a NAME="PyCoverageDialog.__format_lines" ID="PyCoverageDialog.__format_lines"></a> |
| 208 <h4>PyCoverageDialog.__format_lines</h4> | 206 <h4>PyCoverageDialog.__format_lines</h4> |
| 209 <b>__format_lines</b>(<i>lines</i>) | 207 <b>__format_lines</b>(<i>lines</i>) |
| 210 | |
| 211 <p> | 208 <p> |
| 212 Private method to format a list of integers into string by coalescing | 209 Private method to format a list of integers into string by coalescing |
| 213 groups. | 210 groups. |
| 214 </p> | 211 </p> |
| 212 | |
| 215 <dl> | 213 <dl> |
| 216 | 214 |
| 217 <dt><i>lines</i> (list of int)</dt> | 215 <dt><i>lines</i> (list of int)</dt> |
| 218 <dd> | 216 <dd> |
| 219 list of integers | 217 list of integers |
| 232 </dd> | 230 </dd> |
| 233 </dl> | 231 </dl> |
| 234 <a NAME="PyCoverageDialog.__htmlReport" ID="PyCoverageDialog.__htmlReport"></a> | 232 <a NAME="PyCoverageDialog.__htmlReport" ID="PyCoverageDialog.__htmlReport"></a> |
| 235 <h4>PyCoverageDialog.__htmlReport</h4> | 233 <h4>PyCoverageDialog.__htmlReport</h4> |
| 236 <b>__htmlReport</b>(<i></i>) | 234 <b>__htmlReport</b>(<i></i>) |
| 237 | |
| 238 <p> | 235 <p> |
| 239 Private slot to generate a HTML report of the shown data. | 236 Private slot to generate a HTML report of the shown data. |
| 240 </p> | 237 </p> |
| 238 | |
| 241 <a NAME="PyCoverageDialog.__jsonReport" ID="PyCoverageDialog.__jsonReport"></a> | 239 <a NAME="PyCoverageDialog.__jsonReport" ID="PyCoverageDialog.__jsonReport"></a> |
| 242 <h4>PyCoverageDialog.__jsonReport</h4> | 240 <h4>PyCoverageDialog.__jsonReport</h4> |
| 243 <b>__jsonReport</b>(<i></i>) | 241 <b>__jsonReport</b>(<i></i>) |
| 244 | |
| 245 <p> | 242 <p> |
| 246 Private slot to generate a JSON report of the shown data. | 243 Private slot to generate a JSON report of the shown data. |
| 247 </p> | 244 </p> |
| 245 | |
| 248 <a NAME="PyCoverageDialog.__lcovReport" ID="PyCoverageDialog.__lcovReport"></a> | 246 <a NAME="PyCoverageDialog.__lcovReport" ID="PyCoverageDialog.__lcovReport"></a> |
| 249 <h4>PyCoverageDialog.__lcovReport</h4> | 247 <h4>PyCoverageDialog.__lcovReport</h4> |
| 250 <b>__lcovReport</b>(<i></i>) | 248 <b>__lcovReport</b>(<i></i>) |
| 251 | |
| 252 <p> | 249 <p> |
| 253 Private slot to generate a LCOV report of the shown data. | 250 Private slot to generate a LCOV report of the shown data. |
| 254 </p> | 251 </p> |
| 252 | |
| 255 <a NAME="PyCoverageDialog.__openFile" ID="PyCoverageDialog.__openFile"></a> | 253 <a NAME="PyCoverageDialog.__openFile" ID="PyCoverageDialog.__openFile"></a> |
| 256 <h4>PyCoverageDialog.__openFile</h4> | 254 <h4>PyCoverageDialog.__openFile</h4> |
| 257 <b>__openFile</b>(<i>itm=None</i>) | 255 <b>__openFile</b>(<i>itm=None</i>) |
| 258 | |
| 259 <p> | 256 <p> |
| 260 Private slot to open the selected file. | 257 Private slot to open the selected file. |
| 261 </p> | 258 </p> |
| 259 | |
| 262 <dl> | 260 <dl> |
| 263 | 261 |
| 264 <dt><i>itm</i> (QTreeWidgetItem)</dt> | 262 <dt><i>itm</i> (QTreeWidgetItem)</dt> |
| 265 <dd> | 263 <dd> |
| 266 reference to the item to be opened | 264 reference to the item to be opened |
| 267 </dd> | 265 </dd> |
| 268 </dl> | 266 </dl> |
| 269 <a NAME="PyCoverageDialog.__prepareReportGeneration" ID="PyCoverageDialog.__prepareReportGeneration"></a> | 267 <a NAME="PyCoverageDialog.__prepareReportGeneration" ID="PyCoverageDialog.__prepareReportGeneration"></a> |
| 270 <h4>PyCoverageDialog.__prepareReportGeneration</h4> | 268 <h4>PyCoverageDialog.__prepareReportGeneration</h4> |
| 271 <b>__prepareReportGeneration</b>(<i></i>) | 269 <b>__prepareReportGeneration</b>(<i></i>) |
| 272 | |
| 273 <p> | 270 <p> |
| 274 Private method to prepare a report generation. | 271 Private method to prepare a report generation. |
| 275 </p> | 272 </p> |
| 273 | |
| 276 <dl> | 274 <dl> |
| 277 <dt>Return:</dt> | 275 <dt>Return:</dt> |
| 278 <dd> | 276 <dd> |
| 279 tuple containing a reference to the Coverage object and the | 277 tuple containing a reference to the Coverage object and the |
| 280 list of files to report | 278 list of files to report |
| 287 </dd> | 285 </dd> |
| 288 </dl> | 286 </dl> |
| 289 <a NAME="PyCoverageDialog.__showContextMenu" ID="PyCoverageDialog.__showContextMenu"></a> | 287 <a NAME="PyCoverageDialog.__showContextMenu" ID="PyCoverageDialog.__showContextMenu"></a> |
| 290 <h4>PyCoverageDialog.__showContextMenu</h4> | 288 <h4>PyCoverageDialog.__showContextMenu</h4> |
| 291 <b>__showContextMenu</b>(<i>coord</i>) | 289 <b>__showContextMenu</b>(<i>coord</i>) |
| 292 | |
| 293 <p> | 290 <p> |
| 294 Private slot to show the context menu of the listview. | 291 Private slot to show the context menu of the listview. |
| 295 </p> | 292 </p> |
| 293 | |
| 296 <dl> | 294 <dl> |
| 297 | 295 |
| 298 <dt><i>coord</i> (QPoint)</dt> | 296 <dt><i>coord</i> (QPoint)</dt> |
| 299 <dd> | 297 <dd> |
| 300 position of the mouse pointer | 298 position of the mouse pointer |
| 301 </dd> | 299 </dd> |
| 302 </dl> | 300 </dl> |
| 303 <a NAME="PyCoverageDialog.closeEvent" ID="PyCoverageDialog.closeEvent"></a> | 301 <a NAME="PyCoverageDialog.closeEvent" ID="PyCoverageDialog.closeEvent"></a> |
| 304 <h4>PyCoverageDialog.closeEvent</h4> | 302 <h4>PyCoverageDialog.closeEvent</h4> |
| 305 <b>closeEvent</b>(<i>evt</i>) | 303 <b>closeEvent</b>(<i>evt</i>) |
| 306 | |
| 307 <p> | 304 <p> |
| 308 Protected method to handle the close event. | 305 Protected method to handle the close event. |
| 309 </p> | 306 </p> |
| 307 | |
| 310 <dl> | 308 <dl> |
| 311 | 309 |
| 312 <dt><i>evt</i> (QCloseEvent)</dt> | 310 <dt><i>evt</i> (QCloseEvent)</dt> |
| 313 <dd> | 311 <dd> |
| 314 reference to the close event | 312 reference to the close event |
| 315 </dd> | 313 </dd> |
| 316 </dl> | 314 </dl> |
| 317 <a NAME="PyCoverageDialog.on_buttonBox_clicked" ID="PyCoverageDialog.on_buttonBox_clicked"></a> | 315 <a NAME="PyCoverageDialog.on_buttonBox_clicked" ID="PyCoverageDialog.on_buttonBox_clicked"></a> |
| 318 <h4>PyCoverageDialog.on_buttonBox_clicked</h4> | 316 <h4>PyCoverageDialog.on_buttonBox_clicked</h4> |
| 319 <b>on_buttonBox_clicked</b>(<i>button</i>) | 317 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 320 | |
| 321 <p> | 318 <p> |
| 322 Private slot called by a button of the button box clicked. | 319 Private slot called by a button of the button box clicked. |
| 323 </p> | 320 </p> |
| 321 | |
| 324 <dl> | 322 <dl> |
| 325 | 323 |
| 326 <dt><i>button</i> (QAbstractButton)</dt> | 324 <dt><i>button</i> (QAbstractButton)</dt> |
| 327 <dd> | 325 <dd> |
| 328 button that was clicked | 326 button that was clicked |
| 329 </dd> | 327 </dd> |
| 330 </dl> | 328 </dl> |
| 331 <a NAME="PyCoverageDialog.on_reloadButton_clicked" ID="PyCoverageDialog.on_reloadButton_clicked"></a> | 329 <a NAME="PyCoverageDialog.on_reloadButton_clicked" ID="PyCoverageDialog.on_reloadButton_clicked"></a> |
| 332 <h4>PyCoverageDialog.on_reloadButton_clicked</h4> | 330 <h4>PyCoverageDialog.on_reloadButton_clicked</h4> |
| 333 <b>on_reloadButton_clicked</b>(<i></i>) | 331 <b>on_reloadButton_clicked</b>(<i></i>) |
| 334 | |
| 335 <p> | 332 <p> |
| 336 Private slot to reload the coverage info. | 333 Private slot to reload the coverage info. |
| 337 </p> | 334 </p> |
| 335 | |
| 338 <a NAME="PyCoverageDialog.on_resultList_itemActivated" ID="PyCoverageDialog.on_resultList_itemActivated"></a> | 336 <a NAME="PyCoverageDialog.on_resultList_itemActivated" ID="PyCoverageDialog.on_resultList_itemActivated"></a> |
| 339 <h4>PyCoverageDialog.on_resultList_itemActivated</h4> | 337 <h4>PyCoverageDialog.on_resultList_itemActivated</h4> |
| 340 <b>on_resultList_itemActivated</b>(<i>item, column</i>) | 338 <b>on_resultList_itemActivated</b>(<i>item, column</i>) |
| 341 | |
| 342 <p> | 339 <p> |
| 343 Private slot to handle the activation of an item. | 340 Private slot to handle the activation of an item. |
| 344 </p> | 341 </p> |
| 342 | |
| 345 <dl> | 343 <dl> |
| 346 | 344 |
| 347 <dt><i>item</i> (QTreeWidgetItem)</dt> | 345 <dt><i>item</i> (QTreeWidgetItem)</dt> |
| 348 <dd> | 346 <dd> |
| 349 reference to the activated item | 347 reference to the activated item |
| 354 </dd> | 352 </dd> |
| 355 </dl> | 353 </dl> |
| 356 <a NAME="PyCoverageDialog.start" ID="PyCoverageDialog.start"></a> | 354 <a NAME="PyCoverageDialog.start" ID="PyCoverageDialog.start"></a> |
| 357 <h4>PyCoverageDialog.start</h4> | 355 <h4>PyCoverageDialog.start</h4> |
| 358 <b>start</b>(<i>cfn, fn</i>) | 356 <b>start</b>(<i>cfn, fn</i>) |
| 359 | |
| 360 <p> | 357 <p> |
| 361 Public slot to start the coverage data evaluation. | 358 Public slot to start the coverage data evaluation. |
| 362 </p> | 359 </p> |
| 360 | |
| 363 <dl> | 361 <dl> |
| 364 | 362 |
| 365 <dt><i>cfn</i> (str)</dt> | 363 <dt><i>cfn</i> (str)</dt> |
| 366 <dd> | 364 <dd> |
| 367 basename of the coverage file | 365 basename of the coverage file |
| 372 </dd> | 370 </dd> |
| 373 </dl> | 371 </dl> |
| 374 <a NAME="PyCoverageDialog.stringify" ID="PyCoverageDialog.stringify"></a> | 372 <a NAME="PyCoverageDialog.stringify" ID="PyCoverageDialog.stringify"></a> |
| 375 <h4>PyCoverageDialog.stringify</h4> | 373 <h4>PyCoverageDialog.stringify</h4> |
| 376 <b>stringify</b>(<i></i>) | 374 <b>stringify</b>(<i></i>) |
| 377 | |
| 378 <p> | 375 <p> |
| 379 Private helper function to generate a string representation of a | 376 Private helper function to generate a string representation of a |
| 380 pair. | 377 pair. |
| 381 </p> | 378 </p> |
| 379 | |
| 382 <dl> | 380 <dl> |
| 383 | 381 |
| 384 <dt><i>pair</i> (tuple of (int, int)</dt> | 382 <dt><i>pair</i> (tuple of (int, int)</dt> |
| 385 <dd> | 383 <dd> |
| 386 pair of integers | 384 pair of integers |
