PDB Tricks

all_in_one_break.py

"""
I have F8 in Vim (see pdb.vim) bound to insert this statement.

It will:
- Still work if running tests under nosetests
- Can be disabled if it's accidentally added in a loop by setting "st.off = True"
- The XXX is highlighted in Vim, and BREAK is easy to grep for
"""

from nose.tools import set_trace as st; st.__dict__.get("off") or st() #XXX: BREAK

pdb.vim

" Binds F8 to insert a debug statement
" Add to ~/.vim/ftplugin/python.vim or ~/.vim/ftplugin/python/pdb.vim
map <buffer> <leader>d Ofrom nose.tools import set_trace as st; st.__dict__.get("off") or st() #BREAK XXX<esc>

pdb_in_production.py

"""
Make sure that an accidentally pdb.set_trace() doesn't bring production to a halt
"""

if not DEBUG:
    def whoops_set_trace(*a, **kw):
        if whoops_set_trace.did_log:
            return
        import logging
        logger = logging.getLogger("debugger_in_prod")
        logger.error("whoopsie a debugger was left in prod (use AK_DEBUG=1 to allow it)")
        whoops_set_trace.did_log = True
    whoops_set_trace.did_log = False
    import pdb
    pdb.set_trace = whoops_set_trace
    try:
        from nose import tools
        tools.set_trace = whoops_set_trace
    except ImportError:
        pass