如何使用Python装饰器装饰函数("Python装饰器详解：如何优雅地装饰函数")

原创

ithorizon 4周前 (10-19) 阅读数 20 #后端开发

Python装饰器详解：怎样优雅地装饰函数

一、Python装饰器简介

Python装饰器是一种非常有用的功能，允许我们以不修改原有函数定义的方案，扩展或增长函数的行为。装饰器在很多高级应用中都扮演着重要角色，比如在Web框架、日志记录、权限校验等方面。

二、装饰器的基本原理

装饰器本质上是一个返回函数的函数。它接收一个函数作为参数，然后返回一个新的函数，这个新的函数会在执行原函数之前或之后，添加一些额外的功能。

三、装饰器的定义与使用

下面我们通过一个简洁的例子来定义并使用一个装饰器：


def my_decorator(func):
    def wrapper():
        print("Something is happening before the function is called.")
        func()
        print("Something is happening after the function is called.")
    return wrapper
@my_decorator
def say_hello():
    print("Hello!")
say_hello()

执行上述代码，输出将会是：


Something is happening before the function is called.
Hello!
Something is happening after the function is called.

四、装饰器进阶：带参数的装饰器

有时候我们期待装饰器能够接收一些参数，以便更灵活地控制装饰的行为。这时，我们需要在装饰器内部再定义一个函数来接收这些参数。


def repeat(num_times):
    def decorator(func):
        def wrapper():
            for _ in range(num_times):
                func()
        return wrapper
    return decorator
@repeat(3)
def say_hello():
    print("Hello!")
say_hello()

执行上述代码，输出将会是：

Hello!

五、装饰器进阶：装饰有参数的函数

如果我们要装饰的函数有参数，我们需要在装饰器内部的wrapper函数中适当地处理这些参数。


def my_decorator(func):
    def wrapper(*args, **kwargs):
        print("Something is happening before the function is called.")
        result = func(*args, **kwargs)
        print("Something is happening after the function is called.")
        return result
@my_decorator
def greet(name, greeting="Hello"):
    return f"{greeting}, {name}!"
greet("Alice")
greet("Bob", greeting="Hi")

执行上述代码，输出将会是：


Something is happening before the function is called.
Hello, Alice!
Something is happening after the function is called.
Something is happening before the function is called.
Hi, Bob!
Something is happening after the function is called.

六、functools.wraps装饰器

在使用装饰器时，我们通常期待保留原函数的一些元信息，如文档字符串、名字、参数列表等。Python标准库中的functools模块提供了一个装饰器wraps，它可以用来保持原函数的元信息。


from functools import wraps
def my_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        """This is the wrapper function."""
        print("Something is happening before the function is called.")
        result = func(*args, **kwargs)
        print("Something is happening after the function is called.")
        return result
@my_decorator
def greet(name):
    """This function greets the person."""
    return f"Hello, {name}!"
print(greet.__name__)
print(greet.__doc__)