Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | .. _profile: |
| 2 | |
| 3 | ******************** |
| 4 | The Python Profilers |
| 5 | ******************** |
| 6 | |
| 7 | .. sectionauthor:: James Roskind |
| 8 | |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 9 | .. module:: profile |
| 10 | :synopsis: Python source profiler. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 11 | |
Raymond Hettinger | 469271d | 2011-01-27 20:38:46 +0000 | [diff] [blame] | 12 | **Source code:** :source:`Lib/profile.py` and :source:`Lib/pstats.py` |
| 13 | |
| 14 | -------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 15 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 16 | .. _profiler-introduction: |
| 17 | |
| 18 | Introduction to the profilers |
| 19 | ============================= |
| 20 | |
| 21 | .. index:: |
| 22 | single: deterministic profiling |
| 23 | single: profiling, deterministic |
| 24 | |
Georg Brandl | 4eb6597 | 2010-10-14 06:41:42 +0000 | [diff] [blame] | 25 | A :dfn:`profiler` is a program that describes the run time performance of a |
| 26 | program, providing a variety of statistics. This documentation describes the |
| 27 | profiler functionality provided in the modules :mod:`cProfile`, :mod:`profile` |
| 28 | and :mod:`pstats`. This profiler provides :dfn:`deterministic profiling` of |
| 29 | Python programs. It also provides a series of report generation tools to allow |
| 30 | users to rapidly examine the results of a profile operation. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 31 | |
Fred Drake | 0e474a8 | 2007-10-11 18:01:43 +0000 | [diff] [blame] | 32 | The Python standard library provides two different profilers: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 33 | |
Georg Brandl | 4eb6597 | 2010-10-14 06:41:42 +0000 | [diff] [blame] | 34 | 1. :mod:`cProfile` is recommended for most users; it's a C extension with |
| 35 | reasonable overhead that makes it suitable for profiling long-running |
| 36 | programs. Based on :mod:`lsprof`, contributed by Brett Rosen and Ted |
| 37 | Czotter. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 38 | |
Georg Brandl | 4eb6597 | 2010-10-14 06:41:42 +0000 | [diff] [blame] | 39 | 2. :mod:`profile`, a pure Python module whose interface is imitated by |
| 40 | :mod:`cProfile`. Adds significant overhead to profiled programs. If you're |
| 41 | trying to extend the profiler in some way, the task might be easier with this |
Éric Araujo | ee19c77 | 2011-07-28 22:56:24 +0200 | [diff] [blame] | 42 | module. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 43 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 44 | The :mod:`profile` and :mod:`cProfile` modules export the same interface, so |
Christian Heimes | dae2a89 | 2008-04-19 00:55:37 +0000 | [diff] [blame] | 45 | they are mostly interchangeable; :mod:`cProfile` has a much lower overhead but |
Georg Brandl | 4eb6597 | 2010-10-14 06:41:42 +0000 | [diff] [blame] | 46 | is newer and might not be available on all systems. :mod:`cProfile` is really a |
| 47 | compatibility layer on top of the internal :mod:`_lsprof` module. |
| 48 | |
| 49 | .. note:: |
| 50 | |
| 51 | The profiler modules are designed to provide an execution profile for a given |
| 52 | program, not for benchmarking purposes (for that, there is :mod:`timeit` for |
Ezio Melotti | b5ff3e4 | 2011-04-03 16:20:21 +0300 | [diff] [blame] | 53 | reasonably accurate results). This particularly applies to benchmarking |
Georg Brandl | 4eb6597 | 2010-10-14 06:41:42 +0000 | [diff] [blame] | 54 | Python code against C code: the profilers introduce overhead for Python code, |
| 55 | but not for C-level functions, and so the C code would seem faster than any |
| 56 | Python one. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 57 | |
| 58 | |
| 59 | .. _profile-instant: |
| 60 | |
| 61 | Instant User's Manual |
| 62 | ===================== |
| 63 | |
| 64 | This section is provided for users that "don't want to read the manual." It |
| 65 | provides a very brief overview, and allows a user to rapidly perform profiling |
| 66 | on an existing application. |
| 67 | |
| 68 | To profile an application with a main entry point of :func:`foo`, you would add |
| 69 | the following to your module:: |
| 70 | |
| 71 | import cProfile |
| 72 | cProfile.run('foo()') |
| 73 | |
| 74 | (Use :mod:`profile` instead of :mod:`cProfile` if the latter is not available on |
| 75 | your system.) |
| 76 | |
| 77 | The above action would cause :func:`foo` to be run, and a series of informative |
| 78 | lines (the profile) to be printed. The above approach is most useful when |
| 79 | working with the interpreter. If you would like to save the results of a |
| 80 | profile into a file for later examination, you can supply a file name as the |
| 81 | second argument to the :func:`run` function:: |
| 82 | |
| 83 | import cProfile |
| 84 | cProfile.run('foo()', 'fooprof') |
| 85 | |
| 86 | The file :file:`cProfile.py` can also be invoked as a script to profile another |
| 87 | script. For example:: |
| 88 | |
| 89 | python -m cProfile myscript.py |
| 90 | |
| 91 | :file:`cProfile.py` accepts two optional arguments on the command line:: |
| 92 | |
| 93 | cProfile.py [-o output_file] [-s sort_order] |
| 94 | |
Benjamin Peterson | 5e55b3e | 2010-02-03 02:35:45 +0000 | [diff] [blame] | 95 | ``-s`` only applies to standard output (``-o`` is not supplied). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 96 | Look in the :class:`Stats` documentation for valid sort values. |
| 97 | |
| 98 | When you wish to review the profile, you should use the methods in the |
| 99 | :mod:`pstats` module. Typically you would load the statistics data as follows:: |
| 100 | |
| 101 | import pstats |
| 102 | p = pstats.Stats('fooprof') |
| 103 | |
| 104 | The class :class:`Stats` (the above code just created an instance of this class) |
| 105 | has a variety of methods for manipulating and printing the data that was just |
| 106 | read into ``p``. When you ran :func:`cProfile.run` above, what was printed was |
| 107 | the result of three method calls:: |
| 108 | |
| 109 | p.strip_dirs().sort_stats(-1).print_stats() |
| 110 | |
| 111 | The first method removed the extraneous path from all the module names. The |
| 112 | second method sorted all the entries according to the standard module/line/name |
| 113 | string that is printed. The third method printed out all the statistics. You |
| 114 | might try the following sort calls: |
| 115 | |
Christian Heimes | 5b5e81c | 2007-12-31 16:14:33 +0000 | [diff] [blame] | 116 | .. (this is to comply with the semantics of the old profiler). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 117 | |
| 118 | :: |
| 119 | |
| 120 | p.sort_stats('name') |
| 121 | p.print_stats() |
| 122 | |
| 123 | The first call will actually sort the list by function name, and the second call |
| 124 | will print out the statistics. The following are some interesting calls to |
| 125 | experiment with:: |
| 126 | |
| 127 | p.sort_stats('cumulative').print_stats(10) |
| 128 | |
| 129 | This sorts the profile by cumulative time in a function, and then only prints |
| 130 | the ten most significant lines. If you want to understand what algorithms are |
| 131 | taking time, the above line is what you would use. |
| 132 | |
| 133 | If you were looking to see what functions were looping a lot, and taking a lot |
| 134 | of time, you would do:: |
| 135 | |
| 136 | p.sort_stats('time').print_stats(10) |
| 137 | |
| 138 | to sort according to time spent within each function, and then print the |
| 139 | statistics for the top ten functions. |
| 140 | |
| 141 | You might also try:: |
| 142 | |
| 143 | p.sort_stats('file').print_stats('__init__') |
| 144 | |
| 145 | This will sort all the statistics by file name, and then print out statistics |
| 146 | for only the class init methods (since they are spelled with ``__init__`` in |
| 147 | them). As one final example, you could try:: |
| 148 | |
| 149 | p.sort_stats('time', 'cum').print_stats(.5, 'init') |
| 150 | |
| 151 | This line sorts statistics with a primary key of time, and a secondary key of |
| 152 | cumulative time, and then prints out some of the statistics. To be specific, the |
| 153 | list is first culled down to 50% (re: ``.5``) of its original size, then only |
| 154 | lines containing ``init`` are maintained, and that sub-sub-list is printed. |
| 155 | |
| 156 | If you wondered what functions called the above functions, you could now (``p`` |
| 157 | is still sorted according to the last criteria) do:: |
| 158 | |
| 159 | p.print_callers(.5, 'init') |
| 160 | |
| 161 | and you would get a list of callers for each of the listed functions. |
| 162 | |
| 163 | If you want more functionality, you're going to have to read the manual, or |
| 164 | guess what the following functions do:: |
| 165 | |
| 166 | p.print_callees() |
| 167 | p.add('fooprof') |
| 168 | |
| 169 | Invoked as a script, the :mod:`pstats` module is a statistics browser for |
| 170 | reading and examining profile dumps. It has a simple line-oriented interface |
| 171 | (implemented using :mod:`cmd`) and interactive help. |
| 172 | |
| 173 | |
| 174 | .. _deterministic-profiling: |
| 175 | |
| 176 | What Is Deterministic Profiling? |
| 177 | ================================ |
| 178 | |
| 179 | :dfn:`Deterministic profiling` is meant to reflect the fact that all *function |
| 180 | call*, *function return*, and *exception* events are monitored, and precise |
| 181 | timings are made for the intervals between these events (during which time the |
| 182 | user's code is executing). In contrast, :dfn:`statistical profiling` (which is |
| 183 | not done by this module) randomly samples the effective instruction pointer, and |
| 184 | deduces where time is being spent. The latter technique traditionally involves |
| 185 | less overhead (as the code does not need to be instrumented), but provides only |
| 186 | relative indications of where time is being spent. |
| 187 | |
| 188 | In Python, since there is an interpreter active during execution, the presence |
| 189 | of instrumented code is not required to do deterministic profiling. Python |
| 190 | automatically provides a :dfn:`hook` (optional callback) for each event. In |
| 191 | addition, the interpreted nature of Python tends to add so much overhead to |
| 192 | execution, that deterministic profiling tends to only add small processing |
| 193 | overhead in typical applications. The result is that deterministic profiling is |
| 194 | not that expensive, yet provides extensive run time statistics about the |
| 195 | execution of a Python program. |
| 196 | |
| 197 | Call count statistics can be used to identify bugs in code (surprising counts), |
| 198 | and to identify possible inline-expansion points (high call counts). Internal |
| 199 | time statistics can be used to identify "hot loops" that should be carefully |
| 200 | optimized. Cumulative time statistics should be used to identify high level |
| 201 | errors in the selection of algorithms. Note that the unusual handling of |
| 202 | cumulative times in this profiler allows statistics for recursive |
| 203 | implementations of algorithms to be directly compared to iterative |
| 204 | implementations. |
| 205 | |
| 206 | |
| 207 | Reference Manual -- :mod:`profile` and :mod:`cProfile` |
| 208 | ====================================================== |
| 209 | |
| 210 | .. module:: cProfile |
| 211 | :synopsis: Python profiler |
| 212 | |
| 213 | |
| 214 | The primary entry point for the profiler is the global function |
| 215 | :func:`profile.run` (resp. :func:`cProfile.run`). It is typically used to create |
| 216 | any profile information. The reports are formatted and printed using methods of |
| 217 | the class :class:`pstats.Stats`. The following is a description of all of these |
| 218 | standard entry points and functions. For a more in-depth view of some of the |
| 219 | code, consider reading the later section on Profiler Extensions, which includes |
| 220 | discussion of how to derive "better" profilers from the classes presented, or |
| 221 | reading the source code for these modules. |
| 222 | |
| 223 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 224 | .. function:: run(command, filename=None, sort=-1) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 225 | |
| 226 | This function takes a single argument that can be passed to the :func:`exec` |
| 227 | function, and an optional file name. In all cases this routine attempts to |
| 228 | :func:`exec` its first argument, and gather profiling statistics from the |
| 229 | execution. If no file name is present, then this function automatically |
| 230 | prints a simple profiling report, sorted by the standard name string |
| 231 | (file/line/function-name) that is presented in each line. The following is a |
| 232 | typical output from such a call:: |
| 233 | |
| 234 | 2706 function calls (2004 primitive calls) in 4.504 CPU seconds |
| 235 | |
| 236 | Ordered by: standard name |
| 237 | |
| 238 | ncalls tottime percall cumtime percall filename:lineno(function) |
| 239 | 2 0.006 0.003 0.953 0.477 pobject.py:75(save_objects) |
| 240 | 43/3 0.533 0.012 0.749 0.250 pobject.py:99(evaluate) |
| 241 | ... |
| 242 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 243 | The first line indicates that 2706 calls were monitored. Of those |
| 244 | calls, 2004 were :dfn:`primitive`. We define :dfn:`primitive` to |
| 245 | mean that the call was not induced via recursion. The next line: |
| 246 | ``Ordered by: standard name``, indicates that the text string in |
| 247 | the far right column was used to sort the output. The column |
| 248 | headings include: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 249 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 250 | ncalls |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 251 | for the number of calls, |
| 252 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 253 | tottime |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 254 | for the total time spent in the given function (and excluding time made in |
| 255 | calls to sub-functions), |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 256 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 257 | percall |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 258 | is the quotient of ``tottime`` divided by ``ncalls`` |
| 259 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 260 | cumtime |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 261 | is the total time spent in this and all subfunctions (from invocation till |
| 262 | exit). This figure is accurate *even* for recursive functions. |
| 263 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 264 | percall |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 265 | is the quotient of ``cumtime`` divided by primitive calls |
| 266 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 267 | filename:lineno(function) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 268 | provides the respective data of each function |
| 269 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 270 | When there are two numbers in the first column (for example, |
| 271 | ``43/3``), then the latter is the number of primitive calls, and |
| 272 | the former is the actual number of calls. Note that when the |
| 273 | function does not recurse, these two values are the same, and only |
| 274 | the single figure is printed. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 275 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 276 | If *sort* is given, it can be one of values allowed for *key* |
| 277 | parameter from :meth:`pstats.Stats.sort_stats`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 278 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 279 | |
| 280 | .. function:: runctx(command, globals, locals, filename=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 281 | |
| 282 | This function is similar to :func:`run`, with added arguments to supply the |
| 283 | globals and locals dictionaries for the *command* string. |
| 284 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 285 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 286 | Analysis of the profiler data is done using the :class:`pstats.Stats` class. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 287 | |
| 288 | |
| 289 | .. module:: pstats |
| 290 | :synopsis: Statistics object for use with the profiler. |
| 291 | |
| 292 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 293 | .. class:: Stats(*filenames, stream=sys.stdout) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 294 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 295 | This class constructor creates an instance of a "statistics object" |
| 296 | from a *filename* (or set of filenames). :class:`Stats` objects |
| 297 | are manipulated by methods, in order to print useful reports. You |
| 298 | may specify an alternate output stream by giving the keyword |
| 299 | argument, ``stream``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 300 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 301 | The file selected by the above constructor must have been created |
| 302 | by the corresponding version of :mod:`profile` or :mod:`cProfile`. |
| 303 | To be specific, there is *no* file compatibility guaranteed with |
| 304 | future versions of this profiler, and there is no compatibility |
| 305 | with files produced by other profilers. If several files are |
| 306 | provided, all the statistics for identical functions will be |
| 307 | coalesced, so that an overall view of several processes can be |
| 308 | considered in a single report. If additional files need to be |
| 309 | combined with data in an existing :class:`Stats` object, the |
| 310 | :meth:`add` method can be used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 311 | |
Christian Heimes | 5b5e81c | 2007-12-31 16:14:33 +0000 | [diff] [blame] | 312 | .. (such as the old system profiler). |
| 313 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 314 | |
| 315 | .. _profile-stats: |
| 316 | |
| 317 | The :class:`Stats` Class |
| 318 | ------------------------ |
| 319 | |
| 320 | :class:`Stats` objects have the following methods: |
| 321 | |
| 322 | |
| 323 | .. method:: Stats.strip_dirs() |
| 324 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 325 | This method for the :class:`Stats` class removes all leading path |
| 326 | information from file names. It is very useful in reducing the |
| 327 | size of the printout to fit within (close to) 80 columns. This |
| 328 | method modifies the object, and the stripped information is lost. |
| 329 | After performing a strip operation, the object is considered to |
| 330 | have its entries in a "random" order, as it was just after object |
| 331 | initialization and loading. If :meth:`strip_dirs` causes two |
| 332 | function names to be indistinguishable (they are on the same line |
| 333 | of the same filename, and have the same function name), then the |
| 334 | statistics for these two entries are accumulated into a single |
| 335 | entry. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 336 | |
| 337 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 338 | .. method:: Stats.add(*filenames) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 339 | |
| 340 | This method of the :class:`Stats` class accumulates additional profiling |
| 341 | information into the current profiling object. Its arguments should refer to |
| 342 | filenames created by the corresponding version of :func:`profile.run` or |
| 343 | :func:`cProfile.run`. Statistics for identically named (re: file, line, name) |
| 344 | functions are automatically accumulated into single function statistics. |
| 345 | |
| 346 | |
| 347 | .. method:: Stats.dump_stats(filename) |
| 348 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 349 | Save the data loaded into the :class:`Stats` object to a file named |
| 350 | *filename*. The file is created if it does not exist, and is |
| 351 | overwritten if it already exists. This is equivalent to the method |
| 352 | of the same name on the :class:`profile.Profile` and |
| 353 | :class:`cProfile.Profile` classes. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 354 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 355 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 356 | .. method:: Stats.sort_stats(*keys) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 357 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 358 | This method modifies the :class:`Stats` object by sorting it |
| 359 | according to the supplied criteria. The argument is typically a |
| 360 | string identifying the basis of a sort (example: ``'time'`` or |
| 361 | ``'name'``). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 362 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 363 | When more than one key is provided, then additional keys are used |
| 364 | as secondary criteria when there is equality in all keys selected |
| 365 | before them. For example, ``sort_stats('name', 'file')`` will sort |
| 366 | all the entries according to their function name, and resolve all |
| 367 | ties (identical function names) by sorting by file name. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 368 | |
| 369 | Abbreviations can be used for any key names, as long as the abbreviation is |
| 370 | unambiguous. The following are the keys currently defined: |
| 371 | |
| 372 | +------------------+----------------------+ |
| 373 | | Valid Arg | Meaning | |
| 374 | +==================+======================+ |
| 375 | | ``'calls'`` | call count | |
| 376 | +------------------+----------------------+ |
| 377 | | ``'cumulative'`` | cumulative time | |
| 378 | +------------------+----------------------+ |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 379 | | ``'cumtime'`` | cumulative time | |
| 380 | +------------------+----------------------+ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 381 | | ``'file'`` | file name | |
| 382 | +------------------+----------------------+ |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 383 | | ``'filename'`` | file name | |
| 384 | +------------------+----------------------+ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 385 | | ``'module'`` | file name | |
| 386 | +------------------+----------------------+ |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 387 | | ``'ncalls'`` | call count | |
| 388 | +------------------+----------------------+ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 389 | | ``'pcalls'`` | primitive call count | |
| 390 | +------------------+----------------------+ |
| 391 | | ``'line'`` | line number | |
| 392 | +------------------+----------------------+ |
| 393 | | ``'name'`` | function name | |
| 394 | +------------------+----------------------+ |
| 395 | | ``'nfl'`` | name/file/line | |
| 396 | +------------------+----------------------+ |
| 397 | | ``'stdname'`` | standard name | |
| 398 | +------------------+----------------------+ |
| 399 | | ``'time'`` | internal time | |
| 400 | +------------------+----------------------+ |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 401 | | ``'tottime'`` | internal time | |
| 402 | +------------------+----------------------+ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 403 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 404 | Note that all sorts on statistics are in descending order (placing |
| 405 | most time consuming items first), where as name, file, and line |
| 406 | number searches are in ascending order (alphabetical). The subtle |
| 407 | distinction between ``'nfl'`` and ``'stdname'`` is that the |
| 408 | standard name is a sort of the name as printed, which means that |
| 409 | the embedded line numbers get compared in an odd way. For example, |
| 410 | lines 3, 20, and 40 would (if the file names were the same) appear |
| 411 | in the string order 20, 3 and 40. In contrast, ``'nfl'`` does a |
| 412 | numeric compare of the line numbers. In fact, |
| 413 | ``sort_stats('nfl')`` is the same as ``sort_stats('name', 'file', |
| 414 | 'line')``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 415 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 416 | For backward-compatibility reasons, the numeric arguments ``-1``, |
| 417 | ``0``, ``1``, and ``2`` are permitted. They are interpreted as |
| 418 | ``'stdname'``, ``'calls'``, ``'time'``, and ``'cumulative'`` |
| 419 | respectively. If this old style format (numeric) is used, only one |
| 420 | sort key (the numeric key) will be used, and additional arguments |
| 421 | will be silently ignored. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 422 | |
Christian Heimes | 5b5e81c | 2007-12-31 16:14:33 +0000 | [diff] [blame] | 423 | .. For compatibility with the old profiler, |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 424 | |
| 425 | |
| 426 | .. method:: Stats.reverse_order() |
| 427 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 428 | This method for the :class:`Stats` class reverses the ordering of |
| 429 | the basic list within the object. Note that by default ascending |
| 430 | vs descending order is properly selected based on the sort key of |
| 431 | choice. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 432 | |
Christian Heimes | 5b5e81c | 2007-12-31 16:14:33 +0000 | [diff] [blame] | 433 | .. This method is provided primarily for compatibility with the old profiler. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 434 | |
| 435 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 436 | .. method:: Stats.print_stats(*restrictions) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 437 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 438 | This method for the :class:`Stats` class prints out a report as |
| 439 | described in the :func:`profile.run` definition. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 440 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 441 | The order of the printing is based on the last :meth:`sort_stats` |
| 442 | operation done on the object (subject to caveats in :meth:`add` and |
| 443 | :meth:`strip_dirs`). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 444 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 445 | The arguments provided (if any) can be used to limit the list down |
| 446 | to the significant entries. Initially, the list is taken to be the |
| 447 | complete set of profiled functions. Each restriction is either an |
| 448 | integer (to select a count of lines), or a decimal fraction between |
| 449 | 0.0 and 1.0 inclusive (to select a percentage of lines), or a |
| 450 | regular expression (to pattern match the standard name that is |
| 451 | printed; as of Python 1.5b1, this uses the Perl-style regular |
| 452 | expression syntax defined by the :mod:`re` module). If several |
| 453 | restrictions are provided, then they are applied sequentially. For |
| 454 | example:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 455 | |
| 456 | print_stats(.1, 'foo:') |
| 457 | |
| 458 | would first limit the printing to first 10% of list, and then only print |
| 459 | functions that were part of filename :file:`.\*foo:`. In contrast, the |
| 460 | command:: |
| 461 | |
| 462 | print_stats('foo:', .1) |
| 463 | |
| 464 | would limit the list to all functions having file names :file:`.\*foo:`, and |
| 465 | then proceed to only print the first 10% of them. |
| 466 | |
| 467 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 468 | .. method:: Stats.print_callers(*restrictions) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 469 | |
| 470 | This method for the :class:`Stats` class prints a list of all functions that |
| 471 | called each function in the profiled database. The ordering is identical to |
| 472 | that provided by :meth:`print_stats`, and the definition of the restricting |
| 473 | argument is also identical. Each caller is reported on its own line. The |
| 474 | format differs slightly depending on the profiler that produced the stats: |
| 475 | |
| 476 | * With :mod:`profile`, a number is shown in parentheses after each caller to |
| 477 | show how many times this specific call was made. For convenience, a second |
| 478 | non-parenthesized number repeats the cumulative time spent in the function |
| 479 | at the right. |
| 480 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 481 | * With :mod:`cProfile`, each caller is preceded by three numbers: |
| 482 | the number of times this specific call was made, and the total |
| 483 | and cumulative times spent in the current function while it was |
| 484 | invoked by this specific caller. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 485 | |
| 486 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 487 | .. method:: Stats.print_callees(*restrictions) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 488 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 489 | This method for the :class:`Stats` class prints a list of all |
| 490 | function that were called by the indicated function. Aside from |
| 491 | this reversal of direction of calls (re: called vs was called by), |
| 492 | the arguments and ordering are identical to the |
| 493 | :meth:`print_callers` method. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 494 | |
| 495 | |
| 496 | .. _profile-limits: |
| 497 | |
| 498 | Limitations |
| 499 | =========== |
| 500 | |
| 501 | One limitation has to do with accuracy of timing information. There is a |
| 502 | fundamental problem with deterministic profilers involving accuracy. The most |
| 503 | obvious restriction is that the underlying "clock" is only ticking at a rate |
| 504 | (typically) of about .001 seconds. Hence no measurements will be more accurate |
| 505 | than the underlying clock. If enough measurements are taken, then the "error" |
| 506 | will tend to average out. Unfortunately, removing this first error induces a |
| 507 | second source of error. |
| 508 | |
| 509 | The second problem is that it "takes a while" from when an event is dispatched |
| 510 | until the profiler's call to get the time actually *gets* the state of the |
| 511 | clock. Similarly, there is a certain lag when exiting the profiler event |
| 512 | handler from the time that the clock's value was obtained (and then squirreled |
| 513 | away), until the user's code is once again executing. As a result, functions |
| 514 | that are called many times, or call many functions, will typically accumulate |
| 515 | this error. The error that accumulates in this fashion is typically less than |
| 516 | the accuracy of the clock (less than one clock tick), but it *can* accumulate |
| 517 | and become very significant. |
| 518 | |
| 519 | The problem is more important with :mod:`profile` than with the lower-overhead |
| 520 | :mod:`cProfile`. For this reason, :mod:`profile` provides a means of |
| 521 | calibrating itself for a given platform so that this error can be |
| 522 | probabilistically (on the average) removed. After the profiler is calibrated, it |
| 523 | will be more accurate (in a least square sense), but it will sometimes produce |
| 524 | negative numbers (when call counts are exceptionally low, and the gods of |
| 525 | probability work against you :-). ) Do *not* be alarmed by negative numbers in |
| 526 | the profile. They should *only* appear if you have calibrated your profiler, |
| 527 | and the results are actually better than without calibration. |
| 528 | |
| 529 | |
| 530 | .. _profile-calibration: |
| 531 | |
| 532 | Calibration |
| 533 | =========== |
| 534 | |
| 535 | The profiler of the :mod:`profile` module subtracts a constant from each event |
| 536 | handling time to compensate for the overhead of calling the time function, and |
| 537 | socking away the results. By default, the constant is 0. The following |
| 538 | procedure can be used to obtain a better constant for a given platform (see |
| 539 | discussion in section Limitations above). :: |
| 540 | |
| 541 | import profile |
| 542 | pr = profile.Profile() |
| 543 | for i in range(5): |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 544 | print(pr.calibrate(10000)) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 545 | |
| 546 | The method executes the number of Python calls given by the argument, directly |
| 547 | and again under the profiler, measuring the time for both. It then computes the |
| 548 | hidden overhead per profiler event, and returns that as a float. For example, |
| 549 | on an 800 MHz Pentium running Windows 2000, and using Python's time.clock() as |
| 550 | the timer, the magical number is about 12.5e-6. |
| 551 | |
| 552 | The object of this exercise is to get a fairly consistent result. If your |
| 553 | computer is *very* fast, or your timer function has poor resolution, you might |
| 554 | have to pass 100000, or even 1000000, to get consistent results. |
| 555 | |
Georg Brandl | e6bcc91 | 2008-05-12 18:05:20 +0000 | [diff] [blame] | 556 | When you have a consistent answer, there are three ways you can use it:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 557 | |
| 558 | import profile |
| 559 | |
| 560 | # 1. Apply computed bias to all Profile instances created hereafter. |
| 561 | profile.Profile.bias = your_computed_bias |
| 562 | |
| 563 | # 2. Apply computed bias to a specific Profile instance. |
| 564 | pr = profile.Profile() |
| 565 | pr.bias = your_computed_bias |
| 566 | |
| 567 | # 3. Specify computed bias in instance constructor. |
| 568 | pr = profile.Profile(bias=your_computed_bias) |
| 569 | |
| 570 | If you have a choice, you are better off choosing a smaller constant, and then |
| 571 | your results will "less often" show up as negative in profile statistics. |
| 572 | |
| 573 | |
| 574 | .. _profiler-extensions: |
| 575 | |
| 576 | Extensions --- Deriving Better Profilers |
| 577 | ======================================== |
| 578 | |
| 579 | The :class:`Profile` class of both modules, :mod:`profile` and :mod:`cProfile`, |
| 580 | were written so that derived classes could be developed to extend the profiler. |
| 581 | The details are not described here, as doing this successfully requires an |
| 582 | expert understanding of how the :class:`Profile` class works internally. Study |
| 583 | the source code of the module carefully if you want to pursue this. |
| 584 | |
| 585 | If all you want to do is change how current time is determined (for example, to |
| 586 | force use of wall-clock time or elapsed process time), pass the timing function |
| 587 | you want to the :class:`Profile` class constructor:: |
| 588 | |
| 589 | pr = profile.Profile(your_time_func) |
| 590 | |
| 591 | The resulting profiler will then call :func:`your_time_func`. |
| 592 | |
| 593 | :class:`profile.Profile` |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 594 | :func:`your_time_func` should return a single number, or a list of |
| 595 | numbers whose sum is the current time (like what :func:`os.times` |
| 596 | returns). If the function returns a single time number, or the |
| 597 | list of returned numbers has length 2, then you will get an |
| 598 | especially fast version of the dispatch routine. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 599 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 600 | Be warned that you should calibrate the profiler class for the |
| 601 | timer function that you choose. For most machines, a timer that |
| 602 | returns a lone integer value will provide the best results in terms |
| 603 | of low overhead during profiling. (:func:`os.times` is *pretty* |
| 604 | bad, as it returns a tuple of floating point values). If you want |
| 605 | to substitute a better timer in the cleanest fashion, derive a |
| 606 | class and hardwire a replacement dispatch method that best handles |
| 607 | your timer call, along with the appropriate calibration constant. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 608 | |
| 609 | :class:`cProfile.Profile` |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 610 | :func:`your_time_func` should return a single number. If it |
| 611 | returns integers, you can also invoke the class constructor with a |
| 612 | second argument specifying the real duration of one unit of time. |
| 613 | For example, if :func:`your_integer_time_func` returns times |
| 614 | measured in thousands of seconds, you would construct the |
| 615 | :class:`Profile` instance as follows:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 616 | |
| 617 | pr = profile.Profile(your_integer_time_func, 0.001) |
| 618 | |
Andrew Svetlov | 5f91ad3 | 2012-10-31 22:03:28 +0200 | [diff] [blame] | 619 | As the :mod:`cProfile.Profile` class cannot be calibrated, custom |
| 620 | timer functions should be used with care and should be as fast as |
| 621 | possible. For the best results with a custom timer, it might be |
| 622 | necessary to hard-code it in the C source of the internal |
| 623 | :mod:`_lsprof` module. |