Metadata-Version: 1.1
Name: profilestats
Version: 2.0
Summary: Decorator for profiling individual functions and converting profiling data to the kcachegrind/qcachegrind format.
Home-page: http://pypi.python.org/pypi/profilestats
Author: Hanno Schlichting
Author-email: hanno@hannosch.eu
License: BSD
Description: ============
        profilestats
        ============
        
        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):
                pass
        
        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.
        
        
        Changelog
        =========
        
        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::
        
              @profile(cumulative=False,
                       print_stats=10, dump_stats=True,
                       profile_filename='profilestats.prof',
                       callgrind_filename='cachegrind.out.profilestats')
              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.
        
Keywords: profile kcachegrind qcachegrind
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
