datatracker/debug.py
Henrik Levkowetz e896ead272 Merged [5001] from jmh@joelhalpern.com:
Make comments optional on WG adoption and WG state changes.
 - Legacy-Id: 5016
Note: SVN reference [5001] has been migrated to Git commit 1057dbf631c22669cf35d0d52769945b9836f516
2012-11-07 13:04:05 +00:00

150 lines
4 KiB
Python

import sys
import time as timeutils
import inspect
try:
import syslog
write = syslog.syslog
except ImportError: # import syslog will fail on Windows boxes
import sys
write = lambda x: sys.stderr.write(x+"\n")
try:
from pprint import pformat
except ImportError:
pformat = lambda x: x
import cProfile
try:
from django.conf import settings
debug = settings.DEBUG
except ImportError:
debug = True
from decorator import decorator
# A debug decorator, written by Paul Butler, taken from
# http://paulbutler.org/archives/python-debugging-with-decorators/
# Additional functions and decorator functionality added by
# Henrik Levkowetz
__version__ = "0.15"
increment = 2
# Number of times to indent output
# A list is used to force access by reference
_report_indent = [4]
_mark = timeutils.clock()
def set_indent(i):
_report_indent[0] = i
def trace(fn): # renamed from 'report' by henrik 16 Jun 2011
"""Decorator to print information about a function
call for use while debugging.
Prints function name, arguments, and call number
when the function is called. Prints this information
again along with the return value when the function
returns.
"""
def fix(s,n=36):
import re
s = re.sub(r'\\t', ' ', s)
s = re.sub(r'\s+', ' ', s)
if len(s) > n+3:
s = s[:n]+"..."
return s
def wrap(fn, *params,**kwargs):
call = wrap.callcount = wrap.callcount + 1
indent = ' ' * _report_indent[0]
fc = "%s.%s(%s)" % (fn.__module__, fn.__name__, ', '.join(
[fix(repr(a)) for a in params] +
["%s = %s" % (a, fix(repr(b))) for a,b in kwargs.items()]
))
sys.stderr.write("%s* %s [#%s]\n" % (indent, fc, call))
_report_indent[0] += increment
ret = fn(*params,**kwargs)
_report_indent[0] -= increment
sys.stderr.write("%s %s [#%s] ==> %s\n" % (indent, fc, call, repr(ret)))
return ret
wrap.callcount = 0
if debug:
return decorator(wrap, fn)
else:
return fn
def mark():
say("! mark")
_mark = timeutils.clock()
def lap(s):
tau = timeutils.clock() - _mark
say("> %s: %.3fs since mark" % (s, tau))
def clock(s):
lap(s)
_mark = timeutils.clock()
def time(fn):
"""Decorator to print timing information about a function call.
"""
def wrap(fn, *params,**kwargs):
mark = timeutils.clock()
indent = ' ' * _report_indent[0]
fc = "%s.%s()" % (fn.__module__, fn.__name__,)
ret = fn(*params,**kwargs)
tau = timeutils.clock() - mark
sys.stderr.write("%s| %s | %.3fs\n" % (indent, fc, tau))
return ret
wrap.callcount = 0
if debug:
return decorator(wrap, fn)
else:
return fn
def show(name):
if debug:
frame = inspect.stack()[1][0]
value = eval(name, frame.f_globals, frame.f_locals)
indent = ' ' * (_report_indent[0])
sys.stderr.write("%s%s: %s\n" % (indent, name, value))
def log(name):
if debug:
frame = inspect.stack()[1][0]
value = eval(name, frame.f_globals, frame.f_locals)
indent = ' ' * (_report_indent[0])
write("%s%s: %s" % (indent, name, value))
def pprint(name):
if debug:
frame = inspect.stack()[1][0]
value = eval(name, frame.f_globals, frame.f_locals)
indent = ' ' * (_report_indent[0])
sys.stderr.write("%s%s:\n" % (indent, name))
lines = pformat(value).split('\n')
for line in lines:
sys.stderr.write("%s %s\n"%(indent, line))
def say(s):
if debug:
indent = ' ' * (_report_indent[0])
sys.stderr.write("%s%s\n" % (indent, s))
def profile(fn):
def wrapper(*args, **kwargs):
datafn = fn.__name__ + ".profile" # Name the data file sensibly
prof = cProfile.Profile()
retval = prof.runcall(fn, *args, **kwargs)
prof.dump_stats(datafn)
return retval
if debug:
return decorator(wrapper, fn)
else:
return fn