6 
from functools import wraps
def logged(func):
    @wraps(func)
    def with_logging(*args, **kwargs):
        print func.__name__ + " was called"
        return func(*args, **kwargs)
    return with_logging

@logged
def f(x):
   """does some math"""
   return x + x * x

print f.__name__  # prints 'f'
print f.__doc__   # prints 'does some math'

Given this sample code, how would I be able to do @logged(variable)?

I tried this

from functools import wraps
def logged(func):
    def outer(var):
        @wraps(func)
        def with_logging(*args, **kwargs):
            print func.__name__ + " was called"
            return func(*args, **kwargs)
        return with_logging
    return outer

I was hoping to execute like this: logged(func)(session_variable)

But doesn't work. Any idea? I want to be able to do @logged and @logged(var) ( or even @logged(var1, var2)) Thanks.

4

5 回答 5

12

这里的诀窍是，你必须反省你得到了什么：

def logged(*setting_args, **setting_kwargs):
    no_args = False
    if len(setting_args) == 1 \
        and not setting_kwargs \
        and callable(setting_args[0]):
        # We were called without args
        func = setting_args[0]
        no_args = True

    def outer(func):
        @wraps(func)
        def with_logging(*args, **kwargs):
            print "{} was called".format(func.__name__)
            print "Setting args are: {}".format(setting_args)
            print "Setting keyword args are: {}".format(setting_kwargs)
            return func(*args, **kwargs)
        return with_logging

    if no_args:
        return outer(func)
    else:
        return outer

这将适用于以下任何一项：

# No arguments
@logged
def some_function(x):
    pass

# One or more arguments
@logged(1, 2, 3)
def some_function(x):
    pass

# One or more keyword arguments
@logged(key=1, another_key=2)
def some_function(x):
    pass

# A mix of the two
@logged(1, 2, key=3)
def some_function(x):
    pass

如果仅使用一个可调用参数调用它，它将不起作用：

# This will break.
@logged(lambda: "Just for fun")
def some_function(x):
    pass

没有办法区分单个可调用设置和装饰器的无参数调用之间的区别。但是，即使您需要，也可以传递垃圾关键字 arg 来绕过：

# This gets around the above limitation
@logged(lambda: "Just for fun", ignored=True)
def some_function(x):
    pass
于 2013-06-15T01:03:00.890 回答
3

这个问题已经超过 6 年了，并且已经有了答案。我遇到了同样的情况——不得不更新代码中很多地方使用的装饰器，并想添加一个可选参数。

我能够使用不同的方法来完成它 - 来自Python CookBook 3rd Edition，Chapter 9 - 9.6 一书。 定义一个带有可选参数的装饰器。它提出问题，提出解决方案并以讨论结束（太好了）。

解决方案：对于Python 3.3+

from functools import wraps, partial

def logged(func=None, *, var1=None, var2=None):
    if func is None:
        return partial(logged, var1=var1, var2=var2)

    @wraps(func)
    def with_logging(*args, **kwargs):
        print func.__name__ + " was called"
        return func(*args, **kwargs)
    return with_logging

使用上述方法，您可以执行以下任一操作：

@logged
def f(x):

@logger(var1)
def f(x):

@logger(var1, var2)
def f(x)

说明（最好在书里找）

要了解代码是如何工作的，您需要对装饰器如何应用于函数及其调用约定有一个深刻的理解。

1. 简单的装饰器，例如：

# Example use
@logged
def add(x, y):
    return x + y

调用顺序如下：

def add(x, y):
    return x + y

add = logged(add)

在这种情况下，要包装的函数只是作为第一个参数传递给日志记录。因此，在解决方案中，logged() 的第一个参数是被包装的函数。所有其他参数都必须具有默认值。

2. Decorator 接受参数：

@logged(level=logging.CRITICAL, name='example')
def spam():
    print('Spam!')

调用顺序如下：

def spam():
    print('Spam!')

spam = logged(level=logging.CRITICAL, name='example')(spam)

上面的最后一行，是如何调用带参数的装饰器，即在logged()要装饰的函数的初始调用中spam()不传递，因此我们在装饰器中将其设置为可选，即func=None在logged定义中。所以，在第一次调用中，只有参数被传递。

这反过来又强制其他参数由关键字指定。此外，当参数被传递时，装饰器应该返回一个接受该函数并将其包装的函数（见 9.5 节）。为此，该解决方案使用了一个巧妙的技巧，涉及functools.partial. 具体来说，它只是返回其自身的部分应用版本，其中所有参数都是固定的，除了要包装的函数。

于 2020-01-30T09:56:01.307 回答
0

Sean Vieira 的一个可能的替代解决方案可能是：

from functools import wraps
import inspect


def decorator_defaults(**defined_defaults):
    def decorator(f):
        args_names = inspect.getargspec(f)[0]

        def wrapper(*new_args, **new_kwargs):
            defaults = dict(defined_defaults, **new_kwargs)
            if len(new_args) == 0:
                return f(**defaults)
            elif len(new_args) == 1 and callable(new_args[0]):
                return f(**defaults)(new_args[0])
            else:
                too_many_args = False
                if len(new_args) > len(args_names):
                    too_many_args = True
                else:
                    for i in range(len(new_args)):
                        arg = new_args[i]
                        arg_name = args_names[i]
                        defaults[arg_name] = arg
                if len(defaults) > len(args_names):
                    too_many_args = True
                if not too_many_args:
                    final_defaults = []
                    for name in args_names:
                        final_defaults.append(defaults[name])
                    return f(*final_defaults)
                if too_many_args:
                    raise TypeError("{0}() takes {1} argument(s) "
                                    "but {2} were given".
                                    format(f.__name__,
                                           len(args_names),
                                           len(defaults)))
        return wrapper
    return decorator


@decorator_defaults(start_val="-=[", end_val="]=-")
def my_text_decorator(start_val, end_val):
    def decorator(f):
        @wraps(f)
        def wrapper(*args, **kwargs):
            return "".join([f.__name__, ' ', start_val,
                            f(*args, **kwargs), end_val])
        return wrapper
    return decorator


@decorator_defaults(end_val="]=-")
def my_text_decorator2(start_val, end_val):
    def decorator(f):
        @wraps(f)
        def wrapper(*args, **kwargs):
            return "".join([f.__name__, ' ', start_val,
                            f(*args, **kwargs), end_val])
        return wrapper
    return decorator


@my_text_decorator
def func1a(value):
    return value


@my_text_decorator()
def func2a(value):
    return value


@my_text_decorator2("-=[")
def func2b(value):
    return value


@my_text_decorator(end_val=" ...")
def func3a(value):
    return value


@my_text_decorator2("-=[", end_val=" ...")
def func3b(value):
    return value


@my_text_decorator("|> ", " <|")
def func4a(value):
    return value


@my_text_decorator2("|> ", " <|")
def func4b(value):
    return value


@my_text_decorator(end_val=" ...", start_val="|> ")
def func5a(value):
    return value


@my_text_decorator2("|> ", end_val=" ...")
def func5b(value):
    return value


print(func1a('My sample text'))  # func1a -=[My sample text]=-
print(func2a('My sample text'))  # func2a -=[My sample text]=-
print(func2b('My sample text'))  # func2b -=[My sample text]=-
print(func3a('My sample text'))  # func3a -=[My sample text ...
print(func3b('My sample text'))  # func3b -=[My sample text ...
print(func4a('My sample text'))  # func4a |> My sample text <|
print(func4b('My sample text'))  # func4b |> My sample text <|
print(func5a('My sample text'))  # func5a |> My sample text ...
print(func5b('My sample text'))  # func5b |> My sample text ...

注意：它有同样的缺点，你不能将 1 个参数作为函数传递给装饰器，但如果你想在多个装饰器上使用这个功能，你可以避开代码样板。

于 2015-01-28T07:38:40.590 回答
0

您尝试的代码中有小错误。而不是创建带有参数的嵌套函数func>> ，顺序应该是var>> 。*args, **kwargsvarfunc*args, **kwargs

下面是满足您要求的代码片段。

from functools import wraps

def logged(var=None):
    def outer(func):
        @wraps(func)
        def with_logging(*args, **kwargs):
            print func.__name__ + " was called"
            return func(*args, **kwargs)
        return with_logging
    return outer

你可以称这个装饰器为：

@logged
def func1():
    ...

或者，

@logged(xyz)
def func2():
    ...

要了解有关装饰器如何工作的更多信息，请参阅文章带有可选参数的装饰器。

于 2014-12-24T08:19:13.503 回答
0

把def outer(var)外面，也就是

def outer(var):
    def logged(func):
        ...

，然后@outer(somevar)用于您的功能，这将起作用。

于 2013-06-15T01:00:19.977 回答