函数装饰器

时间:2009-05-20 16:57:13

标签: python decorator argument-passing

我喜欢能够测量我编码的python函数的性能,所以我常常做类似的事情......

import time

def some_function(arg1, arg2, ..., argN, verbose = True) :
    t = time.clock() # works best in Windows
    # t = time.time() # apparently works better in Linux

    # Function code goes here

    t = time.clock() - t
    if verbose :
        print "some_function executed in",t,"sec."

    return return_val

是的,我知道你应该用timeit测量性能,但是这对我的需求来说很好,并允许我打开和关闭这些信息以便非常顺利地进行调试。

那段代码当然是在我了解函数装饰器之前...不是我现在对它们了解很多,但我想我可以使用** kwds字典编写一个装饰器来完成以下操作:

some_function(arg1, arg2, ..., argN) # Does not time function
some_function(arg1, arg2, ..., argN, verbose = True) # Times function

但我仍然希望复制我的函数的先前工作,以便工作更像是:

some_function(arg1, arg2, ..., argN) # Does not time function
some_function(arg1, arg2, ..., argN, False) # Does not time function
some_function(arg1, arg2, ..., argN, True) # Times function

我想这需要装饰者计算参数的数量,知道原始函数需要多少,去掉任何多余的,将它们的正确数量传递给函数...我不确定如何告诉python这样做......有可能吗?有没有更好的方法来实现同样的目标?

3 个答案:

答案 0 :(得分:9)

虽然inspect可能会让你有所帮助,但你想要的却是而不是

def f(*args):
    pass

现在f有多少参数?由于*args**kwargs允许任意数量的参数,因此无法确定函数所需的参数数量。事实上,有些情况下函数真正处理的次数与它的数量相同!


修改:如果您愿意将verbose作为特殊关键字参数,您可以这样做:

import time

def timed(f):
    def dec(*args, **kwargs):
        verbose = kwargs.pop('verbose', False)
        t = time.clock()

        ret = f(*args, **kwargs)

        if verbose:
            print("%s executed in %ds" % (f.__name__, time.clock() - t))

        return ret

    return dec

@timed
def add(a, b):
    return a + b

print(add(2, 2, verbose=True))

(感谢kwargs.pop获得{{1}}小费!)

答案 1 :(得分:8)

然而,对于Stephan202的答案,

+1(由于评论不能很好地格式化代码,因此将其放在一个单独的答案中),该答案中的以下代码:

verbose = False
if 'verbose' in kwargs:
     verbose = True
     del kwargs['verbose']

可以更明确,更简洁地表达为:

verbose = kwargs.pop('verbose', False)

答案 2 :(得分:0)

可能很难,但你可以在这些方面做点什么。下面的代码试图删除任何额外的参数并打印出来。

def mydeco(func):
    def wrap(*args, **kwargs):
        """
        we want to eat any extra argument, so just count args and kwargs
        and if more(>func.func_code.co_argcount) first take it out from kwargs 
        based on func.func_code.co_varnames, else last one from args
        """
        extraArgs = []

        newKwargs = {}
        for name, value in kwargs.iteritems():
            if name in func.func_code.co_varnames:
                newKwargs[name] = value
            else:
                extraArgs.append(kwargs[name])

        diff = len(args) + len(newKwargs) - func.func_code.co_argcount
        if diff:
            extraArgs.extend(args[-diff:])
            args = args[:-diff]

        func(*args, **newKwargs)
        print "%s has extra args=%s"%(func.func_name, extraArgs)

    return wrap

@mydeco
def func1(a, b, c=3):
    pass

func1(1,b=2,c=3, d="x")
func1(1,2,3,"y")

输出

func1 has extra args=['x']
func1 has extra args=['y']