Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.DataViews.PyCoverageDialog.html
Documentation/Source/eric4.DataViews.PyCoverageDialog.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.DataViews.PyCoverageDialog</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.DataViews.PyCoverageDialog</h1> | |
| 24 <p> | |
| 25 Module implementing a Python code coverage dialog. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#PyCoverageDialog">PyCoverageDialog</a></td> | |
| 35 <td>Class implementing a dialog to display the collected code coverage data.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="PyCoverageDialog" ID="PyCoverageDialog"></a> | |
| 44 <h2>PyCoverageDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to display the collected code coverage data. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QDialog, Ui_PyCoverageDialog | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#PyCoverageDialog.__init__">PyCoverageDialog</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#PyCoverageDialog.__annotate">__annotate</a></td> | |
| 61 <td>Private slot to handle the annotate context menu action.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#PyCoverageDialog.__annotateAll">__annotateAll</a></td> | |
| 64 <td>Private slot to handle the annotate all context menu action.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#PyCoverageDialog.__createResultItem">__createResultItem</a></td> | |
| 67 <td>Private method to create an entry in the result list.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#PyCoverageDialog.__deleteAnnotated">__deleteAnnotated</a></td> | |
| 70 <td>Private slot to handle the delete annotated context menu action.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#PyCoverageDialog.__erase">__erase</a></td> | |
| 73 <td>Private slot to handle the erase context menu action.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#PyCoverageDialog.__finish">__finish</a></td> | |
| 76 <td>Private slot called when the action finished or the user pressed the button.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#PyCoverageDialog.__format_lines">__format_lines</a></td> | |
| 79 <td>Private method to format a list of integers into string by coalescing groups.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#PyCoverageDialog.__showContextMenu">__showContextMenu</a></td> | |
| 82 <td>Private slot to show the context menu of the listview.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#PyCoverageDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 85 <td>Private slot called by a button of the button box clicked.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#PyCoverageDialog.on_reloadButton_clicked">on_reloadButton_clicked</a></td> | |
| 88 <td>Private slot to reload the coverage info.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#PyCoverageDialog.start">start</a></td> | |
| 91 <td>Public slot to start the coverage data evaluation.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#PyCoverageDialog.stringify">stringify</a></td> | |
| 94 <td>Private helper function to generate a string representation of a pair</td> | |
| 95 </tr> | |
| 96 </table> | |
| 97 <a NAME="PyCoverageDialog.__init__" ID="PyCoverageDialog.__init__"></a> | |
| 98 <h4>PyCoverageDialog (Constructor)</h4> | |
| 99 <b>PyCoverageDialog</b>(<i>parent = None</i>) | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p><dl> | |
| 103 <dt><i>parent</i></dt> | |
| 104 <dd> | |
| 105 parent widget (QWidget) | |
| 106 </dd> | |
| 107 </dl><a NAME="PyCoverageDialog.__annotate" ID="PyCoverageDialog.__annotate"></a> | |
| 108 <h4>PyCoverageDialog.__annotate</h4> | |
| 109 <b>__annotate</b>(<i></i>) | |
| 110 <p> | |
| 111 Private slot to handle the annotate context menu action. | |
| 112 </p><p> | |
| 113 This method produce an annotated coverage file of the | |
| 114 selected file. | |
| 115 </p><a NAME="PyCoverageDialog.__annotateAll" ID="PyCoverageDialog.__annotateAll"></a> | |
| 116 <h4>PyCoverageDialog.__annotateAll</h4> | |
| 117 <b>__annotateAll</b>(<i></i>) | |
| 118 <p> | |
| 119 Private slot to handle the annotate all context menu action. | |
| 120 </p><p> | |
| 121 This method produce an annotated coverage file of every | |
| 122 file listed in the listview. | |
| 123 </p><a NAME="PyCoverageDialog.__createResultItem" ID="PyCoverageDialog.__createResultItem"></a> | |
| 124 <h4>PyCoverageDialog.__createResultItem</h4> | |
| 125 <b>__createResultItem</b>(<i>file, statements, executed, coverage, excluded, missing</i>) | |
| 126 <p> | |
| 127 Private method to create an entry in the result list. | |
| 128 </p><dl> | |
| 129 <dt><i>file</i></dt> | |
| 130 <dd> | |
| 131 filename of file (string) | |
| 132 </dd><dt><i>statements</i></dt> | |
| 133 <dd> | |
| 134 amount of statements (integer) | |
| 135 </dd><dt><i>executed</i></dt> | |
| 136 <dd> | |
| 137 amount of executed statements (integer) | |
| 138 </dd><dt><i>coverage</i></dt> | |
| 139 <dd> | |
| 140 percent of coverage (integer) | |
| 141 </dd><dt><i>excluded</i></dt> | |
| 142 <dd> | |
| 143 list of excluded lines (string) | |
| 144 </dd><dt><i>missing</i></dt> | |
| 145 <dd> | |
| 146 list of lines without coverage (string) | |
| 147 </dd> | |
| 148 </dl><a NAME="PyCoverageDialog.__deleteAnnotated" ID="PyCoverageDialog.__deleteAnnotated"></a> | |
| 149 <h4>PyCoverageDialog.__deleteAnnotated</h4> | |
| 150 <b>__deleteAnnotated</b>(<i></i>) | |
| 151 <p> | |
| 152 Private slot to handle the delete annotated context menu action. | |
| 153 </p><p> | |
| 154 This method deletes all annotated files. These are files | |
| 155 ending with ',cover'. | |
| 156 </p><a NAME="PyCoverageDialog.__erase" ID="PyCoverageDialog.__erase"></a> | |
| 157 <h4>PyCoverageDialog.__erase</h4> | |
| 158 <b>__erase</b>(<i></i>) | |
| 159 <p> | |
| 160 Private slot to handle the erase context menu action. | |
| 161 </p><p> | |
| 162 This method erases the collected coverage data that is | |
| 163 stored in the .coverage file. | |
| 164 </p><a NAME="PyCoverageDialog.__finish" ID="PyCoverageDialog.__finish"></a> | |
| 165 <h4>PyCoverageDialog.__finish</h4> | |
| 166 <b>__finish</b>(<i></i>) | |
| 167 <p> | |
| 168 Private slot called when the action finished or the user pressed the button. | |
| 169 </p><a NAME="PyCoverageDialog.__format_lines" ID="PyCoverageDialog.__format_lines"></a> | |
| 170 <h4>PyCoverageDialog.__format_lines</h4> | |
| 171 <b>__format_lines</b>(<i>lines</i>) | |
| 172 <p> | |
| 173 Private method to format a list of integers into string by coalescing groups. | |
| 174 </p><dl> | |
| 175 <dt><i>lines</i></dt> | |
| 176 <dd> | |
| 177 list of integers | |
| 178 </dd> | |
| 179 </dl><dl> | |
| 180 <dt>Returns:</dt> | |
| 181 <dd> | |
| 182 string representing the list | |
| 183 </dd> | |
| 184 </dl><a NAME="PyCoverageDialog.__showContextMenu" ID="PyCoverageDialog.__showContextMenu"></a> | |
| 185 <h4>PyCoverageDialog.__showContextMenu</h4> | |
| 186 <b>__showContextMenu</b>(<i>coord</i>) | |
| 187 <p> | |
| 188 Private slot to show the context menu of the listview. | |
| 189 </p><dl> | |
| 190 <dt><i>coord</i></dt> | |
| 191 <dd> | |
| 192 the position of the mouse pointer (QPoint) | |
| 193 </dd> | |
| 194 </dl><a NAME="PyCoverageDialog.on_buttonBox_clicked" ID="PyCoverageDialog.on_buttonBox_clicked"></a> | |
| 195 <h4>PyCoverageDialog.on_buttonBox_clicked</h4> | |
| 196 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 197 <p> | |
| 198 Private slot called by a button of the button box clicked. | |
| 199 </p><dl> | |
| 200 <dt><i>button</i></dt> | |
| 201 <dd> | |
| 202 button that was clicked (QAbstractButton) | |
| 203 </dd> | |
| 204 </dl><a NAME="PyCoverageDialog.on_reloadButton_clicked" ID="PyCoverageDialog.on_reloadButton_clicked"></a> | |
| 205 <h4>PyCoverageDialog.on_reloadButton_clicked</h4> | |
| 206 <b>on_reloadButton_clicked</b>(<i></i>) | |
| 207 <p> | |
| 208 Private slot to reload the coverage info. | |
| 209 </p><a NAME="PyCoverageDialog.start" ID="PyCoverageDialog.start"></a> | |
| 210 <h4>PyCoverageDialog.start</h4> | |
| 211 <b>start</b>(<i>cfn, fn</i>) | |
| 212 <p> | |
| 213 Public slot to start the coverage data evaluation. | |
| 214 </p><dl> | |
| 215 <dt><i>cfn</i></dt> | |
| 216 <dd> | |
| 217 basename of the coverage file (string) | |
| 218 </dd><dt><i>fn</i></dt> | |
| 219 <dd> | |
| 220 file or list of files or directory to be checked | |
| 221 (string or list of strings) | |
| 222 </dd> | |
| 223 </dl><a NAME="PyCoverageDialog.stringify" ID="PyCoverageDialog.stringify"></a> | |
| 224 <h4>PyCoverageDialog.stringify</h4> | |
| 225 <b>stringify</b>(<i></i>) | |
| 226 <p> | |
| 227 Private helper function to generate a string representation of a pair | |
| 228 </p><dl> | |
| 229 <dt><i>pair</i></dt> | |
| 230 <dd> | |
| 231 pair of integers | |
| 232 </dd> | |
| 233 </dl> | |
| 234 <div align="right"><a href="#top">Up</a></div> | |
| 235 <hr /> | |
| 236 </body></html> |
