src/eric7/Documentation/Source/eric7.DataViews.PyProfileDialog.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.PyProfileDialog</h1> 9 <h1>eric7.DataViews.PyProfileDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to display profile data. 11 Module implementing a dialog to display profile data.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#ProfileTreeWidgetItem">ProfileTreeWidgetItem</a></td> 22 <td><a href="#ProfileTreeWidgetItem">ProfileTreeWidgetItem</a></td>
25 <td>Class implementing a custom QTreeWidgetItem to allow sorting on numeric values.</td> 23 <td>Class implementing a custom QTreeWidgetItem to allow sorting on numeric values.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
28 <td><a href="#PyProfileDialog">PyProfileDialog</a></td> 26 <td><a href="#PyProfileDialog">PyProfileDialog</a></td>
29 <td>Class implementing a dialog to display the results of a profiling run.</td> 27 <td>Class implementing a dialog to display the results of a profiling run.</td>
30 </tr> 28 </tr>
31 </table> 29 </table>
30
32 <h3>Functions</h3> 31 <h3>Functions</h3>
33 32 <table>
34 <table> 33 <tr><td>None</td></tr>
35 <tr><td>None</td></tr> 34 </table>
36 </table> 35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="ProfileTreeWidgetItem" ID="ProfileTreeWidgetItem"></a> 38 <a NAME="ProfileTreeWidgetItem" ID="ProfileTreeWidgetItem"></a>
40 <h2>ProfileTreeWidgetItem</h2> 39 <h2>ProfileTreeWidgetItem</h2>
41
42 <p> 40 <p>
43 Class implementing a custom QTreeWidgetItem to allow sorting on numeric 41 Class implementing a custom QTreeWidgetItem to allow sorting on numeric
44 values. 42 values.
45 </p> 43 </p>
44
46 <h3>Derived from</h3> 45 <h3>Derived from</h3>
47 QTreeWidgetItem 46 QTreeWidgetItem
48 <h3>Class Attributes</h3> 47 <h3>Class Attributes</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Class Methods</h3> 52 <h3>Class Methods</h3>
54 53 <table>
55 <table> 54 <tr><td>None</td></tr>
56 <tr><td>None</td></tr> 55 </table>
57 </table> 56
58 <h3>Methods</h3> 57 <h3>Methods</h3>
59 58 <table>
60 <table>
61
62 <tr> 59 <tr>
63 <td><a href="#ProfileTreeWidgetItem.__getNC">__getNC</a></td> 60 <td><a href="#ProfileTreeWidgetItem.__getNC">__getNC</a></td>
64 <td>Private method to get the value to compare on for the first column.</td> 61 <td>Private method to get the value to compare on for the first column.</td>
65 </tr> 62 </tr>
66 <tr> 63 <tr>
67 <td><a href="#ProfileTreeWidgetItem.__lt__">__lt__</a></td> 64 <td><a href="#ProfileTreeWidgetItem.__lt__">__lt__</a></td>
68 <td>Special method to check, if the item is less than the other one.</td> 65 <td>Special method to check, if the item is less than the other one.</td>
69 </tr> 66 </tr>
70 </table> 67 </table>
68
71 <h3>Static Methods</h3> 69 <h3>Static Methods</h3>
72 70 <table>
73 <table> 71 <tr><td>None</td></tr>
74 <tr><td>None</td></tr> 72 </table>
75 </table> 73
76 74
77 <a NAME="ProfileTreeWidgetItem.__getNC" ID="ProfileTreeWidgetItem.__getNC"></a> 75 <a NAME="ProfileTreeWidgetItem.__getNC" ID="ProfileTreeWidgetItem.__getNC"></a>
78 <h4>ProfileTreeWidgetItem.__getNC</h4> 76 <h4>ProfileTreeWidgetItem.__getNC</h4>
79 <b>__getNC</b>(<i>itm</i>) 77 <b>__getNC</b>(<i>itm</i>)
80
81 <p> 78 <p>
82 Private method to get the value to compare on for the first column. 79 Private method to get the value to compare on for the first column.
83 </p> 80 </p>
81
84 <dl> 82 <dl>
85 83
86 <dt><i>itm</i> (ProfileTreeWidgetItem)</dt> 84 <dt><i>itm</i> (ProfileTreeWidgetItem)</dt>
87 <dd> 85 <dd>
88 item to operate on 86 item to operate on
101 </dd> 99 </dd>
102 </dl> 100 </dl>
103 <a NAME="ProfileTreeWidgetItem.__lt__" ID="ProfileTreeWidgetItem.__lt__"></a> 101 <a NAME="ProfileTreeWidgetItem.__lt__" ID="ProfileTreeWidgetItem.__lt__"></a>
104 <h4>ProfileTreeWidgetItem.__lt__</h4> 102 <h4>ProfileTreeWidgetItem.__lt__</h4>
105 <b>__lt__</b>(<i>other</i>) 103 <b>__lt__</b>(<i>other</i>)
106
107 <p> 104 <p>
108 Special method to check, if the item is less than the other one. 105 Special method to check, if the item is less than the other one.
109 </p> 106 </p>
107
110 <dl> 108 <dl>
111 109
112 <dt><i>other</i> (ProfileTreeWidgetItem)</dt> 110 <dt><i>other</i> (ProfileTreeWidgetItem)</dt>
113 <dd> 111 <dd>
114 reference to item to compare against 112 reference to item to compare against
129 <div align="right"><a href="#top">Up</a></div> 127 <div align="right"><a href="#top">Up</a></div>
130 <hr /> 128 <hr />
131 <hr /> 129 <hr />
132 <a NAME="PyProfileDialog" ID="PyProfileDialog"></a> 130 <a NAME="PyProfileDialog" ID="PyProfileDialog"></a>
133 <h2>PyProfileDialog</h2> 131 <h2>PyProfileDialog</h2>
134
135 <p> 132 <p>
136 Class implementing a dialog to display the results of a profiling run. 133 Class implementing a dialog to display the results of a profiling run.
137 </p> 134 </p>
135
138 <h3>Derived from</h3> 136 <h3>Derived from</h3>
139 QDialog, Ui_PyProfileDialog 137 QDialog, Ui_PyProfileDialog
140 <h3>Class Attributes</h3> 138 <h3>Class Attributes</h3>
141 139 <table>
142 <table> 140 <tr><td>None</td></tr>
143 <tr><td>None</td></tr> 141 </table>
144 </table> 142
145 <h3>Class Methods</h3> 143 <h3>Class Methods</h3>
146 144 <table>
147 <table> 145 <tr><td>None</td></tr>
148 <tr><td>None</td></tr> 146 </table>
149 </table> 147
150 <h3>Methods</h3> 148 <h3>Methods</h3>
151 149 <table>
152 <table>
153
154 <tr> 150 <tr>
155 <td><a href="#PyProfileDialog.__init__">PyProfileDialog</a></td> 151 <td><a href="#PyProfileDialog.__init__">PyProfileDialog</a></td>
156 <td>Constructor</td> 152 <td>Constructor</td>
157 </tr> 153 </tr>
158 <tr> 154 <tr>
210 <tr> 206 <tr>
211 <td><a href="#PyProfileDialog.start">start</a></td> 207 <td><a href="#PyProfileDialog.start">start</a></td>
212 <td>Public slot to start the calculation of the profile data.</td> 208 <td>Public slot to start the calculation of the profile data.</td>
213 </tr> 209 </tr>
214 </table> 210 </table>
211
215 <h3>Static Methods</h3> 212 <h3>Static Methods</h3>
216 213 <table>
217 <table> 214 <tr><td>None</td></tr>
218 <tr><td>None</td></tr> 215 </table>
219 </table> 216
220 217
221 <a NAME="PyProfileDialog.__init__" ID="PyProfileDialog.__init__"></a> 218 <a NAME="PyProfileDialog.__init__" ID="PyProfileDialog.__init__"></a>
222 <h4>PyProfileDialog (Constructor)</h4> 219 <h4>PyProfileDialog (Constructor)</h4>
223 <b>PyProfileDialog</b>(<i>parent=None</i>) 220 <b>PyProfileDialog</b>(<i>parent=None</i>)
224
225 <p> 221 <p>
226 Constructor 222 Constructor
227 </p> 223 </p>
224
228 <dl> 225 <dl>
229 226
230 <dt><i>parent</i> (QWidget)</dt> 227 <dt><i>parent</i> (QWidget)</dt>
231 <dd> 228 <dd>
232 parent widget 229 parent widget
233 </dd> 230 </dd>
234 </dl> 231 </dl>
235 <a NAME="PyProfileDialog.__createResultItem" ID="PyProfileDialog.__createResultItem"></a> 232 <a NAME="PyProfileDialog.__createResultItem" ID="PyProfileDialog.__createResultItem"></a>
236 <h4>PyProfileDialog.__createResultItem</h4> 233 <h4>PyProfileDialog.__createResultItem</h4>
237 <b>__createResultItem</b>(<i>calls, totalTime, totalTimePerCall, cumulativeTime, cumulativeTimePerCall, file, line, functionName, </i>) 234 <b>__createResultItem</b>(<i>calls, totalTime, totalTimePerCall, cumulativeTime, cumulativeTimePerCall, file, line, functionName, </i>)
238
239 <p> 235 <p>
240 Private method to create an entry in the result list. 236 Private method to create an entry in the result list.
241 </p> 237 </p>
238
242 <dl> 239 <dl>
243 240
244 <dt><i>calls</i> (int)</dt> 241 <dt><i>calls</i> (int)</dt>
245 <dd> 242 <dd>
246 number of calls 243 number of calls
275 </dd> 272 </dd>
276 </dl> 273 </dl>
277 <a NAME="PyProfileDialog.__createSummaryItem" ID="PyProfileDialog.__createSummaryItem"></a> 274 <a NAME="PyProfileDialog.__createSummaryItem" ID="PyProfileDialog.__createSummaryItem"></a>
278 <h4>PyProfileDialog.__createSummaryItem</h4> 275 <h4>PyProfileDialog.__createSummaryItem</h4>
279 <b>__createSummaryItem</b>(<i>label, contents</i>) 276 <b>__createSummaryItem</b>(<i>label, contents</i>)
280
281 <p> 277 <p>
282 Private method to create an entry in the summary list. 278 Private method to create an entry in the summary list.
283 </p> 279 </p>
280
284 <dl> 281 <dl>
285 282
286 <dt><i>label</i> (str)</dt> 283 <dt><i>label</i> (str)</dt>
287 <dd> 284 <dd>
288 text of the first column 285 text of the first column
293 </dd> 290 </dd>
294 </dl> 291 </dl>
295 <a NAME="PyProfileDialog.__eraseAll" ID="PyProfileDialog.__eraseAll"></a> 292 <a NAME="PyProfileDialog.__eraseAll" ID="PyProfileDialog.__eraseAll"></a>
296 <h4>PyProfileDialog.__eraseAll</h4> 293 <h4>PyProfileDialog.__eraseAll</h4>
297 <b>__eraseAll</b>(<i></i>) 294 <b>__eraseAll</b>(<i></i>)
298
299 <p> 295 <p>
300 Private slot to handle the Erase All context menu action. 296 Private slot to handle the Erase All context menu action.
301 </p> 297 </p>
298
302 <a NAME="PyProfileDialog.__eraseProfile" ID="PyProfileDialog.__eraseProfile"></a> 299 <a NAME="PyProfileDialog.__eraseProfile" ID="PyProfileDialog.__eraseProfile"></a>
303 <h4>PyProfileDialog.__eraseProfile</h4> 300 <h4>PyProfileDialog.__eraseProfile</h4>
304 <b>__eraseProfile</b>(<i></i>) 301 <b>__eraseProfile</b>(<i></i>)
305
306 <p> 302 <p>
307 Private slot to handle the Erase Profile context menu action. 303 Private slot to handle the Erase Profile context menu action.
308 </p> 304 </p>
305
309 <a NAME="PyProfileDialog.__eraseTiming" ID="PyProfileDialog.__eraseTiming"></a> 306 <a NAME="PyProfileDialog.__eraseTiming" ID="PyProfileDialog.__eraseTiming"></a>
310 <h4>PyProfileDialog.__eraseTiming</h4> 307 <h4>PyProfileDialog.__eraseTiming</h4>
311 <b>__eraseTiming</b>(<i></i>) 308 <b>__eraseTiming</b>(<i></i>)
312
313 <p> 309 <p>
314 Private slot to handle the Erase Timing context menu action. 310 Private slot to handle the Erase Timing context menu action.
315 </p> 311 </p>
312
316 <a NAME="PyProfileDialog.__filter" ID="PyProfileDialog.__filter"></a> 313 <a NAME="PyProfileDialog.__filter" ID="PyProfileDialog.__filter"></a>
317 <h4>PyProfileDialog.__filter</h4> 314 <h4>PyProfileDialog.__filter</h4>
318 <b>__filter</b>(<i></i>) 315 <b>__filter</b>(<i></i>)
319
320 <p> 316 <p>
321 Private slot to handle the Exclude/Include Python Library context menu 317 Private slot to handle the Exclude/Include Python Library context menu
322 action. 318 action.
323 </p> 319 </p>
320
324 <a NAME="PyProfileDialog.__finish" ID="PyProfileDialog.__finish"></a> 321 <a NAME="PyProfileDialog.__finish" ID="PyProfileDialog.__finish"></a>
325 <h4>PyProfileDialog.__finish</h4> 322 <h4>PyProfileDialog.__finish</h4>
326 <b>__finish</b>(<i></i>) 323 <b>__finish</b>(<i></i>)
327
328 <p> 324 <p>
329 Private slot called when the action finished or the user pressed the 325 Private slot called when the action finished or the user pressed the
330 button. 326 button.
331 </p> 327 </p>
328
332 <a NAME="PyProfileDialog.__populateLists" ID="PyProfileDialog.__populateLists"></a> 329 <a NAME="PyProfileDialog.__populateLists" ID="PyProfileDialog.__populateLists"></a>
333 <h4>PyProfileDialog.__populateLists</h4> 330 <h4>PyProfileDialog.__populateLists</h4>
334 <b>__populateLists</b>(<i>exclude=False</i>) 331 <b>__populateLists</b>(<i>exclude=False</i>)
335
336 <p> 332 <p>
337 Private method used to populate the listviews. 333 Private method used to populate the listviews.
338 </p> 334 </p>
335
339 <dl> 336 <dl>
340 337
341 <dt><i>exclude</i> (bool)</dt> 338 <dt><i>exclude</i> (bool)</dt>
342 <dd> 339 <dd>
343 flag indicating whether files residing in the 340 flag indicating whether files residing in the
345 </dd> 342 </dd>
346 </dl> 343 </dl>
347 <a NAME="PyProfileDialog.__resortResultList" ID="PyProfileDialog.__resortResultList"></a> 344 <a NAME="PyProfileDialog.__resortResultList" ID="PyProfileDialog.__resortResultList"></a>
348 <h4>PyProfileDialog.__resortResultList</h4> 345 <h4>PyProfileDialog.__resortResultList</h4>
349 <b>__resortResultList</b>(<i></i>) 346 <b>__resortResultList</b>(<i></i>)
350
351 <p> 347 <p>
352 Private method to resort the tree. 348 Private method to resort the tree.
353 </p> 349 </p>
350
354 <a NAME="PyProfileDialog.__showContextMenu" ID="PyProfileDialog.__showContextMenu"></a> 351 <a NAME="PyProfileDialog.__showContextMenu" ID="PyProfileDialog.__showContextMenu"></a>
355 <h4>PyProfileDialog.__showContextMenu</h4> 352 <h4>PyProfileDialog.__showContextMenu</h4>
356 <b>__showContextMenu</b>(<i>coord</i>) 353 <b>__showContextMenu</b>(<i>coord</i>)
357
358 <p> 354 <p>
359 Private slot to show the context menu of the listview. 355 Private slot to show the context menu of the listview.
360 </p> 356 </p>
357
361 <dl> 358 <dl>
362 359
363 <dt><i>coord</i> (QPoint)</dt> 360 <dt><i>coord</i> (QPoint)</dt>
364 <dd> 361 <dd>
365 the position of the mouse pointer 362 the position of the mouse pointer
366 </dd> 363 </dd>
367 </dl> 364 </dl>
368 <a NAME="PyProfileDialog.__unfinish" ID="PyProfileDialog.__unfinish"></a> 365 <a NAME="PyProfileDialog.__unfinish" ID="PyProfileDialog.__unfinish"></a>
369 <h4>PyProfileDialog.__unfinish</h4> 366 <h4>PyProfileDialog.__unfinish</h4>
370 <b>__unfinish</b>(<i></i>) 367 <b>__unfinish</b>(<i></i>)
371
372 <p> 368 <p>
373 Private slot called to revert the effects of the __finish slot. 369 Private slot called to revert the effects of the __finish slot.
374 </p> 370 </p>
371
375 <a NAME="PyProfileDialog.closeEvent" ID="PyProfileDialog.closeEvent"></a> 372 <a NAME="PyProfileDialog.closeEvent" ID="PyProfileDialog.closeEvent"></a>
376 <h4>PyProfileDialog.closeEvent</h4> 373 <h4>PyProfileDialog.closeEvent</h4>
377 <b>closeEvent</b>(<i>evt</i>) 374 <b>closeEvent</b>(<i>evt</i>)
378
379 <p> 375 <p>
380 Protected method to handle the close event. 376 Protected method to handle the close event.
381 </p> 377 </p>
378
382 <dl> 379 <dl>
383 380
384 <dt><i>evt</i> (QCloseEvent)</dt> 381 <dt><i>evt</i> (QCloseEvent)</dt>
385 <dd> 382 <dd>
386 reference to the close event 383 reference to the close event
387 </dd> 384 </dd>
388 </dl> 385 </dl>
389 <a NAME="PyProfileDialog.on_buttonBox_clicked" ID="PyProfileDialog.on_buttonBox_clicked"></a> 386 <a NAME="PyProfileDialog.on_buttonBox_clicked" ID="PyProfileDialog.on_buttonBox_clicked"></a>
390 <h4>PyProfileDialog.on_buttonBox_clicked</h4> 387 <h4>PyProfileDialog.on_buttonBox_clicked</h4>
391 <b>on_buttonBox_clicked</b>(<i>button</i>) 388 <b>on_buttonBox_clicked</b>(<i>button</i>)
392
393 <p> 389 <p>
394 Private slot called by a button of the button box clicked. 390 Private slot called by a button of the button box clicked.
395 </p> 391 </p>
392
396 <dl> 393 <dl>
397 394
398 <dt><i>button</i> (QAbstractButton)</dt> 395 <dt><i>button</i> (QAbstractButton)</dt>
399 <dd> 396 <dd>
400 button that was clicked 397 button that was clicked
401 </dd> 398 </dd>
402 </dl> 399 </dl>
403 <a NAME="PyProfileDialog.start" ID="PyProfileDialog.start"></a> 400 <a NAME="PyProfileDialog.start" ID="PyProfileDialog.start"></a>
404 <h4>PyProfileDialog.start</h4> 401 <h4>PyProfileDialog.start</h4>
405 <b>start</b>(<i>pfn, fn=None</i>) 402 <b>start</b>(<i>pfn, fn=None</i>)
406
407 <p> 403 <p>
408 Public slot to start the calculation of the profile data. 404 Public slot to start the calculation of the profile data.
409 </p> 405 </p>
406
410 <dl> 407 <dl>
411 408
412 <dt><i>pfn</i> (str)</dt> 409 <dt><i>pfn</i> (str)</dt>
413 <dd> 410 <dd>
414 basename of the profiling file 411 basename of the profiling file

eric ide

mercurial