什么是装饰器，如何使用装饰器？-Python教程-PHP中文网

装饰器是python中用于在不修改原函数的情况下动态扩展其功能的工具。1. 装饰器的基本用法是通过在函数前后添加额外的逻辑，如日志记录和性能监控。2. 高级用法包括接受参数的装饰器，如重复执行函数。3. 常见错误可以通过使用functools.wraps保留函数元数据来解决。4. 性能优化和最佳实践包括简洁高效的逻辑和清晰的可读性。

什么是装饰器，如何使用装饰器？

引言

在编程世界里，装饰器就像是魔法棒，让代码变得更加灵活和强大。我记得第一次接触装饰器时，那种豁然开朗的感觉至今难忘。今天，我们来聊聊什么是装饰器，以及如何在Python中使用它们。通过这篇文章，你将学会如何用装饰器提升你的代码效率，并且了解一些常见的使用场景和陷阱。

基础知识回顾

装饰器是Python中一个非常有用的特性，它允许你在不修改原函数的情况下，添加额外的功能。想象一下，你有一个函数，你想在它执行前后做一些额外的操作，比如记录日志、性能监控或者权限检查，这时装饰器就派上用场了。

Python中的函数是一等公民，这意味着它们可以像普通变量一样被传递和赋值。这为装饰器的实现提供了基础。装饰器本身是一个函数，它接受一个函数作为参数，并返回一个新的函数，这个新函数包装了原函数，并可以在执行前后添加额外的逻辑。

核心概念或功能解析

装饰器的定义与作用

装饰器的核心思想是"不改变原函数的情况下，动态地扩展其功能"。这在很多场景下都非常有用，比如日志记录、性能监控、事务管理等。

让我们看一个简单的装饰器示例：

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()

在这个例子中，my_decorator 是一个装饰器，它接受 say_hello 函数作为参数，并返回一个新的 wrapper 函数。这个 wrapper 函数在调用 say_hello 前后添加了一些额外的操作。

工作原理

装饰器的工作原理可以理解为函数的包装。装饰器函数返回一个新的函数，这个新函数在执行时会调用原函数，并在其前后执行额外的逻辑。Python的语法糖 @decorator 实际上是将函数作为参数传递给装饰器，然后用装饰器的返回值替换原函数。

理解装饰器的工作原理后，我们可以更深入地探讨一些细节，比如闭包、作用域和函数的返回值处理。

使用示例

基本用法

让我们看看如何使用装饰器来记录函数的执行时间：

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac，无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启：辅助功能 + 屏幕录制权限

下载

import time

def timer_decorator(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f"{func.__name__} took {end_time - start_time:.4f} seconds to run.")
        return result
    return wrapper

@timer_decorator
def slow_function():
    time.sleep(2)
    print("Function executed.")

slow_function()

在这个例子中，timer_decorator 记录了 slow_function 的执行时间，并在函数执行后打印出来。

高级用法

装饰器也可以接受参数，这使得它们更加灵活。比如，我们可以创建一个装饰器来重复执行某个函数：

def repeat(num_times):
    def decorator_repeat(func):
        def wrapper(*args, **kwargs):
            for _ in range(num_times):
                result = func(*args, **kwargs)
            return result
        return wrapper
    return decorator_repeat

@repeat(num_times=3)
def greet(name):
    print(f"Hello, {name}!")

greet("Alice")

在这个例子中，repeat 装饰器接受一个参数 num_times，然后返回一个装饰器函数，这个装饰器函数再返回一个包装函数。这个包装函数会重复执行原函数指定的次数。

常见错误与调试技巧

使用装饰器时，常见的问题包括函数的元数据丢失（如函数名和文档字符串）和装饰器的嵌套使用。让我们看看如何解决这些问题：

from functools import wraps

def my_decorator(func):
    @wraps(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
    return wrapper

@my_decorator
def say_hello():
    """This function says hello."""
    print("Hello!")

print(say_hello.__name__)  # 输出: say_hello
print(say_hello.__doc__)   # 输出: This function says hello.

使用 functools.wraps 可以保留原函数的元数据，避免调试时的困惑。