Metadata-Version: 1.0
Name: print-considered-harmful
Version: 1.2.0
Summary: Switch from print to debugger() and never look back!
Home-page: https://github.com/akuhn/print-considered-harmful
Author: Adrian Kuhn
Author-email: akuhnplus@gmail.com
License: UNKNOWN
Description: Print statement considered harmful
        ==================================
        
        Switch from ``print`` to ``debugger()`` and never look back.
        
        Import this module in your main file to add ``debugger`` as a builtin
        command.
        
        Calling ``debugger`` opens the ``ipdb`` debugger,
        
        ::
        
            import debug
        
            debugger() # <-- breaks here
        
        Calling ``debugger.disable`` from the ipdb prompt disables all
        breakpoints,
        
        ::
        
            import debug
        
            debugger() # <-- breaks here
        
            # >> debugger.disable()
            # >> continue
        
            debugger() # <-- does not break here
        
        Using ``debug.wrap`` sets a function breakpoint,
        
        ::
        
            def fun():
                pass
        
            def example():
                fun()
        
            fun = debug.wrap(fun)
            example() # <-- breaks above at definition of fun
        
        Using ``debug.sample`` collects arguments and return values,
        
        ::
        
            def fun(a, b=None):
                return
        
            fun(42, 'hello worlds')
        
            debugger() # <-- breaks here
        
            >> len(fun.samples)
            1
            >> fun.samples
            [{0: 42, 'b': 'hello worlds', '$': 1764}]
        
        Installation
        ------------
        
        To install this package, run
        
        ::
        
            pip install print-considered-harmful
        
        Contributing
        ------------
        
        Bug reports and pull requests are welcome on github at,
        https://github.com/akuhn/print-considered-harmful
        
Platform: UNKNOWN
