Question

为了帮助我调试我编写的一些代码，我想创建一个函数装饰器，在创建或修改每个变量时打印变量的名称及其值，基本上给我一个“play-by-play “查看我调用函数时会发生什么。

到目前为止，我一直在使用的方法只是添加一行print(foo)，只要我想看看发生了什么，但这非常耗时并且让我的代码看起来很乱（可能非Pythonicness的缩影。）

实际上，我想做的就是：

@show_guts
def foo(a,b):
    biz = str(a)
    baz = str(b)
    return biz + baz

foo("banana","phone")

在IDE中打印这样的内容：

biz = "banana"
baz = "phone"
bananaphone

我的问题是@show_guts的样子。我知道可以使用类似

的装饰器打印a和b的值

def print_args(function):
    def wrapper(*args,**kwargs):
        print("Arguments:",args)
        print("Keyword Arguments:",kwargs)
        return function(*args,**kwargs)
    return wrapper

给了我

Arguments: ('banana', 'phone')
Keyword Arguments: {}
'bananaphone'

但我完全不知道如何打印局部变量名及其值。更不用说以“整洁”的方式做到这一点。

Answer 1

如果不启用跟踪，则无法执行此操作;这会伤害表现。调用函数时会构造函数本地，并在函数返回时进行清理，因此没有其他方法可以从装饰器访问这些本地函数。

您可以使用sys.settrace()插入跟踪功能，然后响应Python解释器发送该功能的事件。我们想要做的是跟踪只是装饰函数，并在函数返回时记录本地：

import sys
import threading

def show_guts(f):
    sentinel = object()
    gutsdata = threading.local()
    gutsdata.captured_locals = None
    gutsdata.tracing = False

    def trace_locals(frame, event, arg):
        if event.startswith('c_'):  # C code traces, no new hook
            return 
        if event == 'call':  # start tracing only the first call
            if gutsdata.tracing:
                return None
            gutsdata.tracing = True
            return trace_locals
        if event == 'line':  # continue tracing
            return trace_locals

        # event is either exception or return, capture locals, end tracing
        gutsdata.captured_locals = frame.f_locals.copy()
        return None

    def wrapper(*args, **kw):
        # preserve existing tracer, start our trace
        old_trace = sys.gettrace()
        sys.settrace(trace_locals)

        retval = sentinel
        try:
            retval = f(*args, **kw)
        finally:
            # reinstate existing tracer, report, clean up
            sys.settrace(old_trace)
            for key, val in gutsdata.captured_locals.items():
                print '{}: {!r}'.format(key, val)
            if retval is not sentinel:
                print 'Returned: {!r}'.format(retval)
            gutsdata.captured_locals = None
            gutsdata.tracing = False

        return retval

    return wrapper

演示：

>>> @show_guts
... def foo(a,b):
...     biz = str(a)
...     baz = str(b)
...     return biz + baz
... 
>>> result = foo("banana","phone")
a: 'banana'
biz: 'banana'
b: 'phone'
baz: 'phone'
Returned: 'bananaphone'

Answer 2

本着调试的精神，我提出了我的hax：

import re
import inspect

assignment_regex = re.compile(r'(\s*)([\w\d_]+)\s*=\s*[\w\d+]')

def show_guts(fn):
    source = inspect.getsource(fn)
    lines = []
    for line in source.split('\n'):
        if 'show_guts' in line:
            continue
        lines.append(line)
        if 'def' in line:
            # kwargs will match the regex
            continue
        search = assignment_regex.search(line)
        try:
            groups = search.groups()
            leading_whitespace = groups[0]
            variable_name = groups[1]
            lines.append(leading_whitespace + 'print "Assigning {0} =", {0}'.format(variable_name))
        except AttributeError:  # no match
            pass
    new_source = '\n'.join(lines)
    namespace = {}
    exec new_source in namespace
    fn = namespace[fn.__name__]

    def wrapped(*args, **kwargs):
        arg_string = ', '.join(map(str, args))
        kwarg_string = ', '.join(key + '=' + str(value) for key, value in kwargs.iteritems())
        print "Calling", fn.__name__ + '(' + ', '.join((arg_string, kwarg_string)) + ')'
        return fn(*args, **kwargs)
    return wrapped

基本上，这会自动完成你正在做的事情。它获取传入函数的源，循环遍历源中的每一行，并为每个赋值语句创建一个新的print语句并将其附加到源体。编译新源代码，并用新编译的函数替换该函数。然后，为了得到*args和**kwargs，我创建了正常的装饰器包装函数，并抛出一些不错的打印语句。在inspect模块的帮助下，这部分可能会更好一点，但是whatevs。

foo（） - ＆gt;带有打印语句的foo（）

# This...
@show_guts
def complicated(a, b, keyword=6):
    bar = str(a)
    baz = str(b)
    if a == b:
        if keyword != 6:
            keyword = a
    else:
        keyword = b
    return bar + baz

# becomes this
def complicated(a, b, keyword=6):
    bar = str(a)
    print "Assigning bar =", bar
    baz = str(b)
    print "Assigning baz =", baz
    if a == b:
        if keyword != 6:
            keyword = a
            print "Assigning keyword =", keyword
    else:
        keyword = b
        print "Assigning keyword =", keyword
    return bar + baz

用法

@show_guts
def foo(a, b):
    bar = str(a)
    baz = str(b)
    return bar + baz


@show_guts
def complicated(a, b, keyword=6):
    bar = str(a)
    baz = str(b)
    if a == b:
        if keyword != 6:
            keyword = a
    else:
        keyword = b
    return bar + baz


foo(1, 2)
complicated(3, 4)
complicated(3, 3)
complicated(3, 3, keyword=123)

输出

Calling foo(1, 2, )
Assigning bar = 1
Assigning baz = 2
Calling complicated(3, 4, )
Assigning bar = 3
Assigning baz = 4
Assigning keyword = 4
Calling complicated(3, 3, )
Assigning bar = 3
Assigning baz = 3
Calling complicated(3, 3, keyword=123)
Assigning bar = 3
Assigning baz = 3
Assigning keyword = 3

我可能会在正则表达式中遗漏一些极端情况，但这会让你接近。

打印函数的局部变量名称和值

2 个答案:

本着调试的精神，我提出了我的hax：

foo（） - ＆gt;带有打印语句的foo（）

用法

输出