Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Decorator for profiling individual functions and converting profiling data to the kcachegrind/qcachegrind format.

Project description

This module contains a simple helper decorator, which allows you to profile a function and write the profiling data to the file system in both the pstats and the k/qcachegrind format.

The decorator can be used as:

from profilestats import profile

@profile(print_stats=10, dump_stats=True)
def my_function(args, etc):

You can pass the following arguments to the decorator:

  • cumulative (default: True) - Accumulate profile data over multiple function calls (True) or use a new profile for each function call (False). Only the data from the last profile is saved to disk.
  • print_stats (default: 0) - How many lines of profile output to show on stdout after each function call. If set to 0, do not print out anything.
  • sort_stats (default: ‘cumulative’) - How to sort the print output. Other options include ‘time’ and ‘ncalls’.
  • dump_stats (default: False) - Save the profile data in the Python profile format to a file.
  • profile_filename (default: ‘profilestats.out’) - The filename for the profile data in Python’s own format.
  • callgrind_filename (default: ‘callgrind.out’) - The filename for the profile data in k/qcachegrind’s format.


2.0 (2015-01-30)

  • Changed default behavior. Profile data is now accumulated over multiple function calls, no data is printed out and the profile data is only stored in the callgrind.out file.

    To get the old behavior use:

             print_stats=10, dump_stats=True,
    def foo(): pass
  • Added arguments to profile decorator to influence it’s behavior.

  • Python 3 compatibility, thanks to lukasgraf.

1.0.2 (2011-02-13)

  • Fixed profiling for functions which have a return value.

Project details

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date (6.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page