python 包装函数在装饰器中接受参数

python wrapper function taking arguments inside decorator

我正在尝试编写 python 装饰器,但我无法理解内部包装器如何接受参数。我这里有:

import time

def timing_function(some_function):
    def wrapper():
        t1 = time.time()
        some_function()
        t2 = time.time()
        return "Time it took to run: " + str((t2-t1)) + "\n"
    return wrapper

@timing_function
def my_function(x):
    return x * x

my_function(6)

---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-4-fe2786a2753c> in <module>()
----> 1 my_function(6)

TypeError: wrapper() takes no arguments (1 given)

与示例略有不同:

import time

def timing_function(some_function):

    """
    Outputs the time a function takes
    to execute.
    """

    def wrapper():
        t1 = time.time()
        some_function()
        t2 = time.time()
        return "Time it took to run the function: " + str((t2-t1)) + "\n"
    return wrapper

@timing_function
def my_function():
    num_list = []
    for x in (range(0,10000)):
        num_list.append(x)
    return "\nSum of all the numbers: " +str((sum(num_list)))


print my_function()

Time it took to run the function: 0.0

看来问题出在 'x' 参数上。我试着给 wrapper *args,但它也没有用。我的问题是

  1. 在这个简单的包装器中允许参数的正确方法是什么?谢谢

  2. 为什么我看到的装饰器例子都是内部函数,能不能不把装饰器写成一个函数?

谢谢

您需要将 arg 添加到 wrapper 然后 some_function:

def timing_function(some_function):
    def wrapper(arg): 
        t1 = time.time()
        some_function(arg)
        t2 = time.time()
        return "Time it took to run: " + str((t2-t1)) + "\n"
    return wrapper

如果您想在不同的函数上使用装饰器,请使用 *args 和 ** kwargs,它们也适用于不带参数的函数:

def timing_function(some_function):
    def wrapper(*args,**kwargs):
        t1 = time.time()
        some_function(*args,**kwargs)
        t2 = time.time()
        return "Time it took to run: " + str((t2-t1)) + "\n"
    return wrapper

附带说明一下,如果您想为代码计时,您可能会发现 timeit 模块很有用,如果您安装了 ipython,则只需使用 timeit your_function.

为什么我看到的所有装饰器例子都是内部函数,能不能不把装饰器写成一个函数?

不,Python 中的装饰器是可调用的 Python 对象,用于修改函数、方法或 class 定义。将要修改的原始对象作为参数传递给装饰器。装饰器 returns 修改后的对象,例如修改函数,绑定到定义中使用的名称,还有更多示例here

  1. 在这个简单的包装器中允许参数的正确方法是什么?谢谢

您需要将参数从 my_function 传递到 wrapper,即:

def wrapper(x):

如果您希望它能够处理更多的通用函数,那么您必须执行以下操作:

def wrapper(*args, **kwargs):

但是装饰器中的逻辑还需要能够一般地处理 argskwargs

  1. 为什么我看到的所有装饰器例子都有一个内部函数,你能不能把一个装饰器写成一个函数?

因为装饰器是一个将函数作为参数的函数,而returns是作为原始函数的包装器执行的函数。事实上,装饰器通常写成三个函数:

from functools import wraps

def somedec(somearg, someopt=None):
    def somedec_outer(fn):
        @wraps(fn)
        def somedec_inner(*args, **kwargs):
            # do stuff with somearg, someopt, args and kwargs
            response = fn(*args, **kwargs)
            return response
        return somedec_inner
    return somedec_outer

为什么要这样做?您可以根据您正在装饰的函数类型或装饰器的不同行为方式将一些信息传递给装饰器。

@somedec(30.0, 'foobarbaz')
def somefn(a, b, c):
    return a + b + c

@somedec(15.0, 'quxjinzop')
def otherfn(d, e, f):
    return d - e - f

functools.wraps 将使装饰函数看起来像 Python 解释器的原始函数。这有助于记录和调试等,是创建装饰器时使用的最佳实践。