Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.DataViews.PyProfileDialog.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.DataViews.PyProfileDialog</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.PyProfileDialog</h1>
23 <p>
24 Module implementing a dialog to display profile data.
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="#ProfileTreeWidgetItem">ProfileTreeWidgetItem</a></td>
34 <td>Class implementing a custom QTreeWidgetItem to allow sorting on numeric values.</td>
35 </tr><tr>
36 <td><a href="#PyProfileDialog">PyProfileDialog</a></td>
37 <td>Class implementing a dialog to display the results of a profiling run.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="ProfileTreeWidgetItem" ID="ProfileTreeWidgetItem"></a>
46 <h2>ProfileTreeWidgetItem</h2>
47 <p>
48 Class implementing a custom QTreeWidgetItem to allow sorting on numeric
49 values.
50 </p>
51 <h3>Derived from</h3>
52 QTreeWidgetItem
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Class Methods</h3>
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62 <table>
63 <tr>
64 <td><a href="#ProfileTreeWidgetItem.__getNC">__getNC</a></td>
65 <td>Private method to get the value to compare on for the first column.</td>
66 </tr><tr>
67 <td><a href="#ProfileTreeWidgetItem.__lt__">__lt__</a></td>
68 <td>Special method to check, if the item is less than the other one.</td>
69 </tr>
70 </table>
71 <h3>Static Methods</h3>
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <a NAME="ProfileTreeWidgetItem.__getNC" ID="ProfileTreeWidgetItem.__getNC"></a>
76 <h4>ProfileTreeWidgetItem.__getNC</h4>
77 <b>__getNC</b>(<i>itm</i>)
78 <p>
79 Private method to get the value to compare on for the first column.
80 </p><dl>
81 <dt><i>itm</i></dt>
82 <dd>
83 item to operate on (ProfileTreeWidgetItem)
84 </dd>
85 </dl><dl>
86 <dt>Returns:</dt>
87 <dd>
88 comparison value for the first column (integer)
89 </dd>
90 </dl><a NAME="ProfileTreeWidgetItem.__lt__" ID="ProfileTreeWidgetItem.__lt__"></a>
91 <h4>ProfileTreeWidgetItem.__lt__</h4>
92 <b>__lt__</b>(<i>other</i>)
93 <p>
94 Special method to check, if the item is less than the other one.
95 </p><dl>
96 <dt><i>other</i></dt>
97 <dd>
98 reference to item to compare against
99 (ProfileTreeWidgetItem)
100 </dd>
101 </dl><dl>
102 <dt>Returns:</dt>
103 <dd>
104 true, if this item is less than other (boolean)
105 </dd>
106 </dl>
107 <div align="right"><a href="#top">Up</a></div>
108 <hr /><hr />
109 <a NAME="PyProfileDialog" ID="PyProfileDialog"></a>
110 <h2>PyProfileDialog</h2>
111 <p>
112 Class implementing a dialog to display the results of a profiling run.
113 </p>
114 <h3>Derived from</h3>
115 QDialog, Ui_PyProfileDialog
116 <h3>Class Attributes</h3>
117 <table>
118 <tr><td>None</td></tr>
119 </table>
120 <h3>Class Methods</h3>
121 <table>
122 <tr><td>None</td></tr>
123 </table>
124 <h3>Methods</h3>
125 <table>
126 <tr>
127 <td><a href="#PyProfileDialog.__init__">PyProfileDialog</a></td>
128 <td>Constructor</td>
129 </tr><tr>
130 <td><a href="#PyProfileDialog.__createResultItem">__createResultItem</a></td>
131 <td>Private method to create an entry in the result list.</td>
132 </tr><tr>
133 <td><a href="#PyProfileDialog.__createSummaryItem">__createSummaryItem</a></td>
134 <td>Private method to create an entry in the summary list.</td>
135 </tr><tr>
136 <td><a href="#PyProfileDialog.__eraseAll">__eraseAll</a></td>
137 <td>Private slot to handle the Erase All context menu action.</td>
138 </tr><tr>
139 <td><a href="#PyProfileDialog.__eraseProfile">__eraseProfile</a></td>
140 <td>Private slot to handle the Erase Profile context menu action.</td>
141 </tr><tr>
142 <td><a href="#PyProfileDialog.__eraseTiming">__eraseTiming</a></td>
143 <td>Private slot to handle the Erase Timing context menu action.</td>
144 </tr><tr>
145 <td><a href="#PyProfileDialog.__filter">__filter</a></td>
146 <td>Private slot to handle the Exclude/Include Python Library context menu action.</td>
147 </tr><tr>
148 <td><a href="#PyProfileDialog.__finish">__finish</a></td>
149 <td>Private slot called when the action finished or the user pressed the button.</td>
150 </tr><tr>
151 <td><a href="#PyProfileDialog.__populateLists">__populateLists</a></td>
152 <td>Private method used to populate the listviews.</td>
153 </tr><tr>
154 <td><a href="#PyProfileDialog.__resortResultList">__resortResultList</a></td>
155 <td>Private method to resort the tree.</td>
156 </tr><tr>
157 <td><a href="#PyProfileDialog.__showContextMenu">__showContextMenu</a></td>
158 <td>Private slot to show the context menu of the listview.</td>
159 </tr><tr>
160 <td><a href="#PyProfileDialog.__unfinish">__unfinish</a></td>
161 <td>Private slot called to revert the effects of the __finish slot.</td>
162 </tr><tr>
163 <td><a href="#PyProfileDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
164 <td>Private slot called by a button of the button box clicked.</td>
165 </tr><tr>
166 <td><a href="#PyProfileDialog.start">start</a></td>
167 <td>Public slot to start the calculation of the profile data.</td>
168 </tr>
169 </table>
170 <h3>Static Methods</h3>
171 <table>
172 <tr><td>None</td></tr>
173 </table>
174 <a NAME="PyProfileDialog.__init__" ID="PyProfileDialog.__init__"></a>
175 <h4>PyProfileDialog (Constructor)</h4>
176 <b>PyProfileDialog</b>(<i>parent=None</i>)
177 <p>
178 Constructor
179 </p><dl>
180 <dt><i>parent</i></dt>
181 <dd>
182 parent widget (QWidget)
183 </dd>
184 </dl><a NAME="PyProfileDialog.__createResultItem" ID="PyProfileDialog.__createResultItem"></a>
185 <h4>PyProfileDialog.__createResultItem</h4>
186 <b>__createResultItem</b>(<i>calls, totalTime, totalTimePerCall, cumulativeTime, cumulativeTimePerCall, file, line, functionName</i>)
187 <p>
188 Private method to create an entry in the result list.
189 </p><dl>
190 <dt><i>calls</i></dt>
191 <dd>
192 number of calls (integer)
193 </dd><dt><i>totalTime</i></dt>
194 <dd>
195 total time (double)
196 </dd><dt><i>totalTimePerCall</i></dt>
197 <dd>
198 total time per call (double)
199 </dd><dt><i>cumulativeTime</i></dt>
200 <dd>
201 cumulative time (double)
202 </dd><dt><i>cumulativeTimePerCall</i></dt>
203 <dd>
204 cumulative time per call (double)
205 </dd><dt><i>file</i></dt>
206 <dd>
207 filename of file (string)
208 </dd><dt><i>line</i></dt>
209 <dd>
210 linenumber (integer)
211 </dd><dt><i>functionName</i></dt>
212 <dd>
213 function name (string)
214 </dd>
215 </dl><a NAME="PyProfileDialog.__createSummaryItem" ID="PyProfileDialog.__createSummaryItem"></a>
216 <h4>PyProfileDialog.__createSummaryItem</h4>
217 <b>__createSummaryItem</b>(<i>label, contents</i>)
218 <p>
219 Private method to create an entry in the summary list.
220 </p><dl>
221 <dt><i>label</i></dt>
222 <dd>
223 text of the first column (string)
224 </dd><dt><i>contents</i></dt>
225 <dd>
226 text of the second column (string)
227 </dd>
228 </dl><a NAME="PyProfileDialog.__eraseAll" ID="PyProfileDialog.__eraseAll"></a>
229 <h4>PyProfileDialog.__eraseAll</h4>
230 <b>__eraseAll</b>(<i></i>)
231 <p>
232 Private slot to handle the Erase All context menu action.
233 </p><a NAME="PyProfileDialog.__eraseProfile" ID="PyProfileDialog.__eraseProfile"></a>
234 <h4>PyProfileDialog.__eraseProfile</h4>
235 <b>__eraseProfile</b>(<i></i>)
236 <p>
237 Private slot to handle the Erase Profile context menu action.
238 </p><a NAME="PyProfileDialog.__eraseTiming" ID="PyProfileDialog.__eraseTiming"></a>
239 <h4>PyProfileDialog.__eraseTiming</h4>
240 <b>__eraseTiming</b>(<i></i>)
241 <p>
242 Private slot to handle the Erase Timing context menu action.
243 </p><a NAME="PyProfileDialog.__filter" ID="PyProfileDialog.__filter"></a>
244 <h4>PyProfileDialog.__filter</h4>
245 <b>__filter</b>(<i></i>)
246 <p>
247 Private slot to handle the Exclude/Include Python Library context menu
248 action.
249 </p><a NAME="PyProfileDialog.__finish" ID="PyProfileDialog.__finish"></a>
250 <h4>PyProfileDialog.__finish</h4>
251 <b>__finish</b>(<i></i>)
252 <p>
253 Private slot called when the action finished or the user pressed the
254 button.
255 </p><a NAME="PyProfileDialog.__populateLists" ID="PyProfileDialog.__populateLists"></a>
256 <h4>PyProfileDialog.__populateLists</h4>
257 <b>__populateLists</b>(<i>exclude=False</i>)
258 <p>
259 Private method used to populate the listviews.
260 </p><dl>
261 <dt><i>exclude</i></dt>
262 <dd>
263 flag indicating whether files residing in the
264 Python library should be excluded
265 </dd>
266 </dl><a NAME="PyProfileDialog.__resortResultList" ID="PyProfileDialog.__resortResultList"></a>
267 <h4>PyProfileDialog.__resortResultList</h4>
268 <b>__resortResultList</b>(<i></i>)
269 <p>
270 Private method to resort the tree.
271 </p><a NAME="PyProfileDialog.__showContextMenu" ID="PyProfileDialog.__showContextMenu"></a>
272 <h4>PyProfileDialog.__showContextMenu</h4>
273 <b>__showContextMenu</b>(<i>coord</i>)
274 <p>
275 Private slot to show the context menu of the listview.
276 </p><dl>
277 <dt><i>coord</i></dt>
278 <dd>
279 the position of the mouse pointer (QPoint)
280 </dd>
281 </dl><a NAME="PyProfileDialog.__unfinish" ID="PyProfileDialog.__unfinish"></a>
282 <h4>PyProfileDialog.__unfinish</h4>
283 <b>__unfinish</b>(<i></i>)
284 <p>
285 Private slot called to revert the effects of the __finish slot.
286 </p><a NAME="PyProfileDialog.on_buttonBox_clicked" ID="PyProfileDialog.on_buttonBox_clicked"></a>
287 <h4>PyProfileDialog.on_buttonBox_clicked</h4>
288 <b>on_buttonBox_clicked</b>(<i>button</i>)
289 <p>
290 Private slot called by a button of the button box clicked.
291 </p><dl>
292 <dt><i>button</i></dt>
293 <dd>
294 button that was clicked (QAbstractButton)
295 </dd>
296 </dl><a NAME="PyProfileDialog.start" ID="PyProfileDialog.start"></a>
297 <h4>PyProfileDialog.start</h4>
298 <b>start</b>(<i>pfn, fn=None</i>)
299 <p>
300 Public slot to start the calculation of the profile data.
301 </p><dl>
302 <dt><i>pfn</i></dt>
303 <dd>
304 basename of the profiling file (string)
305 </dd><dt><i>fn</i></dt>
306 <dd>
307 file to display the profiling data for (string)
308 </dd>
309 </dl>
310 <div align="right"><a href="#top">Up</a></div>
311 <hr />
312 </body></html>

Mercurial Repository: eric

eric ide

mercurial