Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DataViews.PyProfileDialog.html
Documentation/Source/eric5.DataViews.PyProfileDialog.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 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>eric5.DataViews.PyProfileDialog</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.DataViews.PyProfileDialog</h1> | |
| 12 <p> | |
| 13 Module implementing a dialog to display profile data. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#ProfileTreeWidgetItem">ProfileTreeWidgetItem</a></td> | |
| 23 <td>Class implementing a custom QTreeWidgetItem to allow sorting on numeric values.</td> | |
| 24 </tr><tr> | |
| 25 <td><a href="#PyProfileDialog">PyProfileDialog</a></td> | |
| 26 <td>Class implementing a dialog to display the results of a syntax check run.</td> | |
| 27 </tr> | |
| 28 </table> | |
| 29 <h3>Functions</h3> | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /><hr /> | |
| 34 <a NAME="ProfileTreeWidgetItem" ID="ProfileTreeWidgetItem"></a> | |
| 35 <h2>ProfileTreeWidgetItem</h2> | |
| 36 <p> | |
| 37 Class implementing a custom QTreeWidgetItem to allow sorting on numeric values. | |
| 38 </p> | |
| 39 <h3>Derived from</h3> | |
| 40 QTreeWidgetItem | |
| 41 <h3>Class Attributes</h3> | |
| 42 <table> | |
| 43 <tr><td>None</td></tr> | |
| 44 </table> | |
| 45 <h3>Methods</h3> | |
| 46 <table> | |
| 47 <tr> | |
| 48 <td><a href="#ProfileTreeWidgetItem.__getNC">__getNC</a></td> | |
| 49 <td>Private method to get the value to compare on for the first column.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#ProfileTreeWidgetItem.__lt__">__lt__</a></td> | |
| 52 <td>Public method to check, if the item is less than the other one.</td> | |
| 53 </tr> | |
| 54 </table> | |
| 55 <a NAME="ProfileTreeWidgetItem.__getNC" ID="ProfileTreeWidgetItem.__getNC"></a> | |
| 56 <h4>ProfileTreeWidgetItem.__getNC</h4> | |
| 57 <b>__getNC</b>(<i>itm</i>) | |
| 58 <p> | |
| 59 Private method to get the value to compare on for the first column. | |
| 60 </p><dl> | |
| 61 <dt><i>itm</i></dt> | |
| 62 <dd> | |
| 63 item to operate on (ProfileTreeWidgetItem) | |
| 64 </dd> | |
| 65 </dl><a NAME="ProfileTreeWidgetItem.__lt__" ID="ProfileTreeWidgetItem.__lt__"></a> | |
| 66 <h4>ProfileTreeWidgetItem.__lt__</h4> | |
| 67 <b>__lt__</b>(<i>other</i>) | |
| 68 <p> | |
| 69 Public method to check, if the item is less than the other one. | |
| 70 </p><dl> | |
| 71 <dt><i>other</i></dt> | |
| 72 <dd> | |
| 73 reference to item to compare against (ProfileTreeWidgetItem) | |
| 74 </dd> | |
| 75 </dl><dl> | |
| 76 <dt>Returns:</dt> | |
| 77 <dd> | |
| 78 true, if this item is less than other (boolean) | |
| 79 </dd> | |
| 80 </dl> | |
| 81 <div align="right"><a href="#top">Up</a></div> | |
| 82 <hr /><hr /> | |
| 83 <a NAME="PyProfileDialog" ID="PyProfileDialog"></a> | |
| 84 <h2>PyProfileDialog</h2> | |
| 85 <p> | |
| 86 Class implementing a dialog to display the results of a syntax check run. | |
| 87 </p> | |
| 88 <h3>Derived from</h3> | |
| 89 QDialog, Ui_PyProfileDialog | |
| 90 <h3>Class Attributes</h3> | |
| 91 <table> | |
| 92 <tr><td>None</td></tr> | |
| 93 </table> | |
| 94 <h3>Methods</h3> | |
| 95 <table> | |
| 96 <tr> | |
| 97 <td><a href="#PyProfileDialog.__init__">PyProfileDialog</a></td> | |
| 98 <td>Constructor</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#PyProfileDialog.__createResultItem">__createResultItem</a></td> | |
| 101 <td>Private method to create an entry in the result list.</td> | |
| 102 </tr><tr> | |
| 103 <td><a href="#PyProfileDialog.__createSummaryItem">__createSummaryItem</a></td> | |
| 104 <td>Private method to create an entry in the summary list.</td> | |
| 105 </tr><tr> | |
| 106 <td><a href="#PyProfileDialog.__eraseAll">__eraseAll</a></td> | |
| 107 <td>Private slot to handle the Erase All context menu action.</td> | |
| 108 </tr><tr> | |
| 109 <td><a href="#PyProfileDialog.__eraseProfile">__eraseProfile</a></td> | |
| 110 <td>Private slot to handle the Erase Profile context menu action.</td> | |
| 111 </tr><tr> | |
| 112 <td><a href="#PyProfileDialog.__eraseTiming">__eraseTiming</a></td> | |
| 113 <td>Private slot to handle the Erase Timing context menu action.</td> | |
| 114 </tr><tr> | |
| 115 <td><a href="#PyProfileDialog.__filter">__filter</a></td> | |
| 116 <td>Private slot to handle the Exclude/Include Python Library context menu action.</td> | |
| 117 </tr><tr> | |
| 118 <td><a href="#PyProfileDialog.__finish">__finish</a></td> | |
| 119 <td>Private slot called when the action finished or the user pressed the button.</td> | |
| 120 </tr><tr> | |
| 121 <td><a href="#PyProfileDialog.__populateLists">__populateLists</a></td> | |
| 122 <td>Private method used to populate the listviews.</td> | |
| 123 </tr><tr> | |
| 124 <td><a href="#PyProfileDialog.__resortResultList">__resortResultList</a></td> | |
| 125 <td>Private method to resort the tree.</td> | |
| 126 </tr><tr> | |
| 127 <td><a href="#PyProfileDialog.__showContextMenu">__showContextMenu</a></td> | |
| 128 <td>Private slot to show the context menu of the listview.</td> | |
| 129 </tr><tr> | |
| 130 <td><a href="#PyProfileDialog.__unfinish">__unfinish</a></td> | |
| 131 <td>Private slot called to revert the effects of the __finish slot.</td> | |
| 132 </tr><tr> | |
| 133 <td><a href="#PyProfileDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 134 <td>Private slot called by a button of the button box clicked.</td> | |
| 135 </tr><tr> | |
| 136 <td><a href="#PyProfileDialog.start">start</a></td> | |
| 137 <td>Public slot to start the calculation of the profile data.</td> | |
| 138 </tr> | |
| 139 </table> | |
| 140 <a NAME="PyProfileDialog.__init__" ID="PyProfileDialog.__init__"></a> | |
| 141 <h4>PyProfileDialog (Constructor)</h4> | |
| 142 <b>PyProfileDialog</b>(<i>parent = None</i>) | |
| 143 <p> | |
| 144 Constructor | |
| 145 </p><dl> | |
| 146 <dt><i>parent</i></dt> | |
| 147 <dd> | |
| 148 parent widget (QWidget) | |
| 149 </dd> | |
| 150 </dl><a NAME="PyProfileDialog.__createResultItem" ID="PyProfileDialog.__createResultItem"></a> | |
| 151 <h4>PyProfileDialog.__createResultItem</h4> | |
| 152 <b>__createResultItem</b>(<i>calls, totalTime, totalTimePerCall, cumulativeTime, cumulativeTimePerCall, file, line, functionName</i>) | |
| 153 <p> | |
| 154 Private method to create an entry in the result list. | |
| 155 </p><dl> | |
| 156 <dt><i>calls</i></dt> | |
| 157 <dd> | |
| 158 number of calls (integer) | |
| 159 </dd><dt><i>totalTime</i></dt> | |
| 160 <dd> | |
| 161 total time (double) | |
| 162 </dd><dt><i>totalTimePerCall</i></dt> | |
| 163 <dd> | |
| 164 total time per call (double) | |
| 165 </dd><dt><i>cumulativeTime</i></dt> | |
| 166 <dd> | |
| 167 cumulative time (double) | |
| 168 </dd><dt><i>cumulativeTimePerCall</i></dt> | |
| 169 <dd> | |
| 170 cumulative time per call (double) | |
| 171 </dd><dt><i>file</i></dt> | |
| 172 <dd> | |
| 173 filename of file (string) | |
| 174 </dd><dt><i>line</i></dt> | |
| 175 <dd> | |
| 176 linenumber (integer) | |
| 177 </dd><dt><i>functionName</i></dt> | |
| 178 <dd> | |
| 179 function name (string) | |
| 180 </dd> | |
| 181 </dl><a NAME="PyProfileDialog.__createSummaryItem" ID="PyProfileDialog.__createSummaryItem"></a> | |
| 182 <h4>PyProfileDialog.__createSummaryItem</h4> | |
| 183 <b>__createSummaryItem</b>(<i>label, contents</i>) | |
| 184 <p> | |
| 185 Private method to create an entry in the summary list. | |
| 186 </p><dl> | |
| 187 <dt><i>label</i></dt> | |
| 188 <dd> | |
| 189 text of the first column (string) | |
| 190 </dd><dt><i>contents</i></dt> | |
| 191 <dd> | |
| 192 text of the second column (string) | |
| 193 </dd> | |
| 194 </dl><a NAME="PyProfileDialog.__eraseAll" ID="PyProfileDialog.__eraseAll"></a> | |
| 195 <h4>PyProfileDialog.__eraseAll</h4> | |
| 196 <b>__eraseAll</b>(<i></i>) | |
| 197 <p> | |
| 198 Private slot to handle the Erase All context menu action. | |
| 199 </p><a NAME="PyProfileDialog.__eraseProfile" ID="PyProfileDialog.__eraseProfile"></a> | |
| 200 <h4>PyProfileDialog.__eraseProfile</h4> | |
| 201 <b>__eraseProfile</b>(<i></i>) | |
| 202 <p> | |
| 203 Private slot to handle the Erase Profile context menu action. | |
| 204 </p><a NAME="PyProfileDialog.__eraseTiming" ID="PyProfileDialog.__eraseTiming"></a> | |
| 205 <h4>PyProfileDialog.__eraseTiming</h4> | |
| 206 <b>__eraseTiming</b>(<i></i>) | |
| 207 <p> | |
| 208 Private slot to handle the Erase Timing context menu action. | |
| 209 </p><a NAME="PyProfileDialog.__filter" ID="PyProfileDialog.__filter"></a> | |
| 210 <h4>PyProfileDialog.__filter</h4> | |
| 211 <b>__filter</b>(<i></i>) | |
| 212 <p> | |
| 213 Private slot to handle the Exclude/Include Python Library context menu action. | |
| 214 </p><a NAME="PyProfileDialog.__finish" ID="PyProfileDialog.__finish"></a> | |
| 215 <h4>PyProfileDialog.__finish</h4> | |
| 216 <b>__finish</b>(<i></i>) | |
| 217 <p> | |
| 218 Private slot called when the action finished or the user pressed the button. | |
| 219 </p><a NAME="PyProfileDialog.__populateLists" ID="PyProfileDialog.__populateLists"></a> | |
| 220 <h4>PyProfileDialog.__populateLists</h4> | |
| 221 <b>__populateLists</b>(<i>exclude = False</i>) | |
| 222 <p> | |
| 223 Private method used to populate the listviews. | |
| 224 </p><dl> | |
| 225 <dt><i>exclude</i></dt> | |
| 226 <dd> | |
| 227 flag indicating whether files residing in the | |
| 228 Python library should be excluded | |
| 229 </dd> | |
| 230 </dl><a NAME="PyProfileDialog.__resortResultList" ID="PyProfileDialog.__resortResultList"></a> | |
| 231 <h4>PyProfileDialog.__resortResultList</h4> | |
| 232 <b>__resortResultList</b>(<i></i>) | |
| 233 <p> | |
| 234 Private method to resort the tree. | |
| 235 </p><a NAME="PyProfileDialog.__showContextMenu" ID="PyProfileDialog.__showContextMenu"></a> | |
| 236 <h4>PyProfileDialog.__showContextMenu</h4> | |
| 237 <b>__showContextMenu</b>(<i>coord</i>) | |
| 238 <p> | |
| 239 Private slot to show the context menu of the listview. | |
| 240 </p><dl> | |
| 241 <dt><i>coord</i></dt> | |
| 242 <dd> | |
| 243 the position of the mouse pointer (QPoint) | |
| 244 </dd> | |
| 245 </dl><a NAME="PyProfileDialog.__unfinish" ID="PyProfileDialog.__unfinish"></a> | |
| 246 <h4>PyProfileDialog.__unfinish</h4> | |
| 247 <b>__unfinish</b>(<i></i>) | |
| 248 <p> | |
| 249 Private slot called to revert the effects of the __finish slot. | |
| 250 </p><a NAME="PyProfileDialog.on_buttonBox_clicked" ID="PyProfileDialog.on_buttonBox_clicked"></a> | |
| 251 <h4>PyProfileDialog.on_buttonBox_clicked</h4> | |
| 252 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 253 <p> | |
| 254 Private slot called by a button of the button box clicked. | |
| 255 </p><dl> | |
| 256 <dt><i>button</i></dt> | |
| 257 <dd> | |
| 258 button that was clicked (QAbstractButton) | |
| 259 </dd> | |
| 260 </dl><a NAME="PyProfileDialog.start" ID="PyProfileDialog.start"></a> | |
| 261 <h4>PyProfileDialog.start</h4> | |
| 262 <b>start</b>(<i>pfn, fn=None</i>) | |
| 263 <p> | |
| 264 Public slot to start the calculation of the profile data. | |
| 265 </p><dl> | |
| 266 <dt><i>pfn</i></dt> | |
| 267 <dd> | |
| 268 basename of the profiling file (string) | |
| 269 </dd><dt><i>fn</i></dt> | |
| 270 <dd> | |
| 271 file to display the profiling data for (string) | |
| 272 </dd> | |
| 273 </dl> | |
| 274 <div align="right"><a href="#top">Up</a></div> | |
| 275 <hr /> | |
| 276 </body></html> |
