https://github.com/navdeep-G/showme

Quick application debugging and analysis for Python
https://github.com/navdeep-G/showme

debugging python

Last synced: 3 months ago
JSON representation

Quick application debugging and analysis for Python

• Host: GitHub
• URL: https://github.com/navdeep-G/showme
• Owner: navdeep-G
• License: mit
• Created: 2010-07-14T14:11:36.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2023-01-31T18:34:09.000Z (almost 2 years ago)
• Last Synced: 2024-05-18T22:13:50.328Z (6 months ago)
• Topics: debugging, python
• Language: Python
• Homepage: https://github.com/navdeep-G/showme
• Size: 32.2 KB
• Stars: 188
• Watchers: 18
• Forks: 17
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-python-decorator - showme

README

        
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.time

    def some_function(a):

        ...

    

    >>> some_function()

    Execution speed of __main__.some_function:

    0.000688076019287 seconds

    

Print function cpu-execution time. ::

    @showme.cputime

    def complex_function(a, b, c):

        ...

    >>> complex_function()

    CPU time for __main__.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}

.. Print local variables available at runtime. ::

..  

..  @showme.locals

..  def complex_function(a, b, c):

..      ...

Pretty print function documentation. ::

    

    @showme.docs

    def complex_function():

        """Example Documentation for complex_function."""

        ...

        

    >>> complex_function()

    Documentation for __main__.complex_function:

    Example Documentation for complex_function.