Skip to main content

Decorators for profiling/timing/tracing individual functions

Project description


It’s a collection of decorators for profiling functions. E.g. to profile a single function:

from profilehooks import profile

def my_function(args, etc):

The results will be printed when the program exits (or you can use @profile(immediate=True)).

If you’re interested in coarse timings and don’t want to pay for the overhead of profiling, use

from profilehooks import timecall

@timecall       # or @timecall(immediate=True)
def my_function(args, etc):

Finally, you may be interested in seeing line coverage for a single function

from profilehooks import coverage

def my_function(args, etc):

Also functions can be available in Python console or module if run it with -m arg

$ python -m profilehooks
>>> profile
<function profile at 0x1005c6488>

$ python -m profilehooks yourmodule

Full documentation is available through pydoc profilehooks after installation.

The home page for this module is It has screensho, uh, that is, more examples.


1.10.0 (2017-12-09)

1.9.0 (2017-01-02)

  • Drop claim of Python 3.2 compatibility. Everything still works, except I’m no longer running automated tests on 3.2, so things might regress.

  • Drop Python 2.6 compatibility.

  • Add Python 3.6 compatibility.

1.8.1 (2015-11-21)

1.8.0 (2015-03-25)

  • New option: @profile(stdout=False) to suppress output to sys.stdout.

1.7.1 (2014-12-02)

  • Make @profile(profiler='hotshot') work again. This was probably broken in 1.0 or 1.1, but nobody complained.

  • Fix missing space in the output of @profile(skip=N).

  • Make @coverage_with_hotshot output match @coverage output precisely.

  • 100% test coverage.

  • Claim Python 3.4 and PyPy compatibility.

1.7 (2013-10-16)

1.6 (2012-06-05)

1.5 (2010-08-13)

  • New argument to @timecall: timer (defaults to time.time). Example: @timecall(timer=time.clock)

  • Better documentation.

1.4 (2009-03-31)

  • Added support for cProfile, make it the default profiler when available. Previously profilehooks supported profile and hotshot only.

1.3 (2008-06-10)

  • Store profile results (when you pass filename to @profile) in pstats format instead of pickles. Contributed by Florian Schulze.

1.2 (2008-03-07)

  • New argument to: @timecall: immediate (defaults to False).

  • Added a test suite.

1.1 (2007-11-07)

  • First release to PyPI, with a and everything.

  • New arguments to @profile: dirs, sort, entries. Contributed by Hanno Schlichting.

  • Preserve function attributes such as __doc__ and __module__ when decorating them.

  • Pydoc-friendly docstring wrapping and other docstring improvements.

1.0 (2006-12-06)

  • Changed licence from GPL to MIT.

  • New decorator: @timecall

  • New arguments to @profile: skip, filename, immediate.

  • Added support for profile, after becoming convinced hotshot was unreliable. Made it the default profiler.

0.1 (2004-12-30)

  • First public release (it didn’t actually have a version number), announced on my blog:

  • @profile and @coverage decorators that didn’t accept any arguments.

  • hotshot was the only profiler supported for @profile, while @coverage used

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

profilehooks-1.10.0.tar.gz (15.5 kB view hashes)

Uploaded Source

Built Distribution

profilehooks-1.10.0-py2.py3-none-any.whl (13.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page