Skip to main content

Painless Debugging and Inspection for Python

Project description

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

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

showme-1.0.0.tar.gz (4.4 kB view details)

Uploaded Source

File details

Details for the file showme-1.0.0.tar.gz.

File metadata

  • Download URL: showme-1.0.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for showme-1.0.0.tar.gz
Algorithm Hash digest
SHA256 4be451b7dce25d28a689e9bfb8d7e72fe8872704a8ec79ac39a8030256c5316d
MD5 79c6a267945bd623dc1d2fb218fc4d22
BLAKE2b-256 eac7bcfc6d0c9ee53fd8937c295ab6ab43f6ae1d24982851f6e08398eac6cc0a

See more details on using hashes here.

Provenance

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