showme 1.0.0

Painless Debugging and Inspection for Python

ShowMe – Quick and easy debugging for Python

ShowMe is a simple set of extremely useful function decorators for Python. It allows you to view trace information, execution time, cputime, and function documentation.

Installation

To use showme, simply:

pip install showme

or, if you must:

easy_install showme

Usage

Print passed-in arguments and function calls.

@showme.trace
def complex_function(a, b, c, **kwargs):


>>> complex_function('alpha', 'beta', False, debug=True)
calling haystack.submodule.complex_function() with
   args: ({'a': 'alpha', 'b': 'beta', 'c': False},)
   kwargs: {'debug': True}

Print function execution time.

 @showme.cputime
 def complex_function(a, b, c):

 >>> complex_function()
      3 function calls in 0.013 CPU seconds

ncalls  tottime  percall  cumtime  percall filename:lineno(function)
     1    0.013    0.013    0.013    0.013 test_time.py:6(test)
     1    0.000    0.000    0.000    0.000 {method 'disable' of '_lsprof.Profiler' objects}
     1    0.000    0.000    0.000    0.000 {range}

Pretty print function documentation.

@showme.docs
def complex_function():
        """Example Documentation for complex_function"""
        pass

>>> complex_function()
Example Documentation for complex_function

History

1.0.0 (2010-09-05)

• Featureset complete

• Public release of showme to PyPi

• Cleanup of project (removal of globals/locals)

0.0.5 (2010-09-05)

• @showme.time support (simple but big feature)

• Color output added (via vendorized Colorama)

0.0.4 (2010-09-04)

• Epic @showme.trace decorator written

• @showme.docs support

0.0.3 (2010-09-01)

• General configuration in place

• @showme.cputime support

• Vendorization of decorator decorator