Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.DataViews.PyCoverageDialog.html

Documentation/Source/eric6.DataViews.PyCoverageDialog.html

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.DataViews.PyCoverageDialog</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>eric6.DataViews.PyCoverageDialog</h1>
23 <p>
24 Module implementing a Python code coverage dialog.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#PyCoverageDialog">PyCoverageDialog</a></td>
34 <td>Class implementing a dialog to display the collected code coverage data.</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="PyCoverageDialog" ID="PyCoverageDialog"></a>
43 <h2>PyCoverageDialog</h2>
44 <p>
45 Class implementing a dialog to display the collected code coverage data.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_PyCoverageDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#PyCoverageDialog.__init__">PyCoverageDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#PyCoverageDialog.__annotate">__annotate</a></td>
64 <td>Private slot to handle the annotate context menu action.</td>
65 </tr><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><tr>
69 <td><a href="#PyCoverageDialog.__createResultItem">__createResultItem</a></td>
70 <td>Private method to create an entry in the result list.</td>
71 </tr><tr>
72 <td><a href="#PyCoverageDialog.__deleteAnnotated">__deleteAnnotated</a></td>
73 <td>Private slot to handle the delete annotated context menu action.</td>
74 </tr><tr>
75 <td><a href="#PyCoverageDialog.__erase">__erase</a></td>
76 <td>Private slot to handle the erase context menu action.</td>
77 </tr><tr>
78 <td><a href="#PyCoverageDialog.__finish">__finish</a></td>
79 <td>Private slot called when the action finished or the user pressed the button.</td>
80 </tr><tr>
81 <td><a href="#PyCoverageDialog.__format_lines">__format_lines</a></td>
82 <td>Private method to format a list of integers into string by coalescing groups.</td>
83 </tr><tr>
84 <td><a href="#PyCoverageDialog.__openFile">__openFile</a></td>
85 <td>Private slot to open the selected file.</td>
86 </tr><tr>
87 <td><a href="#PyCoverageDialog.__showContextMenu">__showContextMenu</a></td>
88 <td>Private slot to show the context menu of the listview.</td>
89 </tr><tr>
90 <td><a href="#PyCoverageDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
91 <td>Private slot called by a button of the button box clicked.</td>
92 </tr><tr>
93 <td><a href="#PyCoverageDialog.on_reloadButton_clicked">on_reloadButton_clicked</a></td>
94 <td>Private slot to reload the coverage info.</td>
95 </tr><tr>
96 <td><a href="#PyCoverageDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
97 <td>Private slot to handle the activation of an item.</td>
98 </tr><tr>
99 <td><a href="#PyCoverageDialog.start">start</a></td>
100 <td>Public slot to start the coverage data evaluation.</td>
101 </tr><tr>
102 <td><a href="#PyCoverageDialog.stringify">stringify</a></td>
103 <td>Private helper function to generate a string representation of a pair.</td>
104 </tr>
105 </table>
106 <h3>Static Methods</h3>
107 <table>
108 <tr><td>None</td></tr>
109 </table>
110 <a NAME="PyCoverageDialog.__init__" ID="PyCoverageDialog.__init__"></a>
111 <h4>PyCoverageDialog (Constructor)</h4>
112 <b>PyCoverageDialog</b>(<i>parent=None</i>)
113 <p>
114 Constructor
115 </p><dl>
116 <dt><i>parent</i></dt>
117 <dd>
118 parent widget (QWidget)
119 </dd>
120 </dl><a NAME="PyCoverageDialog.__annotate" ID="PyCoverageDialog.__annotate"></a>
121 <h4>PyCoverageDialog.__annotate</h4>
122 <b>__annotate</b>(<i></i>)
123 <p>
124 Private slot to handle the annotate context menu action.
125 </p><p>
126 This method produce an annotated coverage file of the
127 selected file.
128 </p><a NAME="PyCoverageDialog.__annotateAll" ID="PyCoverageDialog.__annotateAll"></a>
129 <h4>PyCoverageDialog.__annotateAll</h4>
130 <b>__annotateAll</b>(<i></i>)
131 <p>
132 Private slot to handle the annotate all context menu action.
133 </p><p>
134 This method produce an annotated coverage file of every
135 file listed in the listview.
136 </p><a NAME="PyCoverageDialog.__createResultItem" ID="PyCoverageDialog.__createResultItem"></a>
137 <h4>PyCoverageDialog.__createResultItem</h4>
138 <b>__createResultItem</b>(<i>file, statements, executed, coverage, excluded, missing</i>)
139 <p>
140 Private method to create an entry in the result list.
141 </p><dl>
142 <dt><i>file</i></dt>
143 <dd>
144 filename of file (string)
145 </dd><dt><i>statements</i></dt>
146 <dd>
147 amount of statements (integer)
148 </dd><dt><i>executed</i></dt>
149 <dd>
150 amount of executed statements (integer)
151 </dd><dt><i>coverage</i></dt>
152 <dd>
153 percent of coverage (integer)
154 </dd><dt><i>excluded</i></dt>
155 <dd>
156 list of excluded lines (string)
157 </dd><dt><i>missing</i></dt>
158 <dd>
159 list of lines without coverage (string)
160 </dd>
161 </dl><a NAME="PyCoverageDialog.__deleteAnnotated" ID="PyCoverageDialog.__deleteAnnotated"></a>
162 <h4>PyCoverageDialog.__deleteAnnotated</h4>
163 <b>__deleteAnnotated</b>(<i></i>)
164 <p>
165 Private slot to handle the delete annotated context menu action.
166 </p><p>
167 This method deletes all annotated files. These are files
168 ending with ',cover'.
169 </p><a NAME="PyCoverageDialog.__erase" ID="PyCoverageDialog.__erase"></a>
170 <h4>PyCoverageDialog.__erase</h4>
171 <b>__erase</b>(<i></i>)
172 <p>
173 Private slot to handle the erase context menu action.
174 </p><p>
175 This method erases the collected coverage data that is
176 stored in the .coverage file.
177 </p><a NAME="PyCoverageDialog.__finish" ID="PyCoverageDialog.__finish"></a>
178 <h4>PyCoverageDialog.__finish</h4>
179 <b>__finish</b>(<i></i>)
180 <p>
181 Private slot called when the action finished or the user pressed the
182 button.
183 </p><a NAME="PyCoverageDialog.__format_lines" ID="PyCoverageDialog.__format_lines"></a>
184 <h4>PyCoverageDialog.__format_lines</h4>
185 <b>__format_lines</b>(<i>lines</i>)
186 <p>
187 Private method to format a list of integers into string by coalescing
188 groups.
189 </p><dl>
190 <dt><i>lines</i></dt>
191 <dd>
192 list of integers
193 </dd>
194 </dl><dl>
195 <dt>Returns:</dt>
196 <dd>
197 string representing the list
198 </dd>
199 </dl><a NAME="PyCoverageDialog.__openFile" ID="PyCoverageDialog.__openFile"></a>
200 <h4>PyCoverageDialog.__openFile</h4>
201 <b>__openFile</b>(<i>itm=None</i>)
202 <p>
203 Private slot to open the selected file.
204 </p><dl>
205 <dt><i>itm</i></dt>
206 <dd>
207 reference to the item to be opened (QTreeWidgetItem)
208 </dd>
209 </dl><a NAME="PyCoverageDialog.__showContextMenu" ID="PyCoverageDialog.__showContextMenu"></a>
210 <h4>PyCoverageDialog.__showContextMenu</h4>
211 <b>__showContextMenu</b>(<i>coord</i>)
212 <p>
213 Private slot to show the context menu of the listview.
214 </p><dl>
215 <dt><i>coord</i></dt>
216 <dd>
217 the position of the mouse pointer (QPoint)
218 </dd>
219 </dl><a NAME="PyCoverageDialog.on_buttonBox_clicked" ID="PyCoverageDialog.on_buttonBox_clicked"></a>
220 <h4>PyCoverageDialog.on_buttonBox_clicked</h4>
221 <b>on_buttonBox_clicked</b>(<i>button</i>)
222 <p>
223 Private slot called by a button of the button box clicked.
224 </p><dl>
225 <dt><i>button</i></dt>
226 <dd>
227 button that was clicked (QAbstractButton)
228 </dd>
229 </dl><a NAME="PyCoverageDialog.on_reloadButton_clicked" ID="PyCoverageDialog.on_reloadButton_clicked"></a>
230 <h4>PyCoverageDialog.on_reloadButton_clicked</h4>
231 <b>on_reloadButton_clicked</b>(<i></i>)
232 <p>
233 Private slot to reload the coverage info.
234 </p><a NAME="PyCoverageDialog.on_resultList_itemActivated" ID="PyCoverageDialog.on_resultList_itemActivated"></a>
235 <h4>PyCoverageDialog.on_resultList_itemActivated</h4>
236 <b>on_resultList_itemActivated</b>(<i>item, column</i>)
237 <p>
238 Private slot to handle the activation of an item.
239 </p><dl>
240 <dt><i>item</i></dt>
241 <dd>
242 reference to the activated item (QTreeWidgetItem)
243 </dd><dt><i>column</i></dt>
244 <dd>
245 column the item was activated in (integer)
246 </dd>
247 </dl><a NAME="PyCoverageDialog.start" ID="PyCoverageDialog.start"></a>
248 <h4>PyCoverageDialog.start</h4>
249 <b>start</b>(<i>cfn, fn</i>)
250 <p>
251 Public slot to start the coverage data evaluation.
252 </p><dl>
253 <dt><i>cfn</i></dt>
254 <dd>
255 basename of the coverage file (string)
256 </dd><dt><i>fn</i></dt>
257 <dd>
258 file or list of files or directory to be checked
259 (string or list of strings)
260 </dd>
261 </dl><a NAME="PyCoverageDialog.stringify" ID="PyCoverageDialog.stringify"></a>
262 <h4>PyCoverageDialog.stringify</h4>
263 <b>stringify</b>(<i></i>)
264 <p>
265 Private helper function to generate a string representation of a
266 pair.
267 </p><dl>
268 <dt><i>pair</i></dt>
269 <dd>
270 pair of integers
271 </dd>
272 </dl>
273 <div align="right"><a href="#top">Up</a></div>
274 <hr />
275 </body></html>

Mercurial Repository: eric

eric ide

mercurial