Python 的装饰器有多神？给函数加个 @，自动记录运行时间
本文围绕 Python 装饰器记录函数运行时间这一实用功能展开，先介绍装饰器的基本概念与作用，说明其如何通过一个 @符号实现对函数运行时间的自动记录。接着详细讲解装饰器的工作原理、基础实现方法，包括无参装饰器和带参装饰器的编写，还会分享实际应用场景与进阶技巧，如装饰器的嵌套使用、保留函数元信息等。最后总结装饰器在提升代码效率与可维护性上的价值，帮助读者全面掌握这一 Python 进阶技能，满足搜索引擎对实用技术内容的检索需求。
在 Python 的众多特性中，装饰器无疑是一项极具 “魔法” 色彩的功能。它就像一位隐形的助手，只需在函数上方加上一个简单的 @符号，就能悄无声息地为函数增添各种强大的功能，而记录函数运行时间就是其最常见且实用的应用之一。对于开发者来说，了解函数的运行时间至关重要，无论是调试代码、优化性能还是评估算法效率，都离不开这一关键数据。而装饰器的出现，让记录函数运行时间的过程变得异常简洁高效，无需修改函数内部代码，就能轻松实现功能扩展。下面，我们就来深入探索 Python 装饰器的奥秘，看看它是如何凭借一个 @符号，实现自动记录函数运行时间的。
一、装饰器的基础认知
装饰器本质上是一个 Python 函数或类，它可以让其他函数或类在不需要做任何代码修改的前提下增加额外功能。装饰器的出现遵循了面向对象编程中的 “开放 - 封闭” 原则，即对扩展开放，对修改封闭。这意味着当我们需要给一个已有的函数添加新功能时，不需要改动函数本身的代码，只需通过装饰器进行扩展即可。
在记录函数运行时间这个场景中，装饰器的作用就是在函数执行前后分别记录时间，然后计算出函数的运行时长。这种方式不仅不会影响原函数的逻辑，还能让代码更加简洁、易读，便于后期维护和扩展。
二、实现一个简单的计时装饰器
要实现一个能自动记录函数运行时间的装饰器，我们可以按照以下步骤进行：
首先，导入 Python 中的 time 模块，该模块提供了与时间相关的函数，我们可以使用 time.time () 来获取当前的时间戳。
然后，定义一个装饰器函数，比如叫做 timer。这个装饰器函数需要接收一个函数作为参数，也就是我们要装饰的函数。
在装饰器函数内部，我们需要定义一个 wrapper 函数（包装函数）。这个 wrapper 函数会先记录函数开始执行的时间，然后调用被装饰的函数，接着记录函数执行结束的时间，最后计算并输出函数的运行时间。
最后，返回 wrapper 函数作为装饰器的结果。
下面是一个简单的计时装饰器代码示例：
import time
def timer(func):
def wrapper(*args, **kwargs):
start_time = time.time()
result = func(*args, **kwargs)
end_time = time.time()
print(f\"函数 {func.__name__} 运行时间：{end_time - start_time:.6f} 秒\")
return result
return wrapper
在这个示例中，*args和**kwargs的作用是让 wrapper 函数能够接收任意数量和类型的参数，从而保证被装饰的函数可以正常传递参数。当我们给一个函数加上 @timer 装饰器后，调用该函数时，实际上是调用了 wrapper 函数，从而实现了自动记录运行时间的功能。
例如，我们定义一个计算斐波那契数列的函数，并使用 timer 装饰器：
@timer
def fibonacci(n):
a, b = 0, 1
for _ in range(n):
a, b = b, a + b
return a
fibonacci(100000)
运行这段代码后，会输出类似 “函数 fibonacci 运行时间：0.052341 秒” 的结果，清晰地显示出函数的运行时间。
三、带参数的计时装饰器
有时候，我们可能需要对计时装饰器进行一些自定义设置，比如指定输出时间的格式、是否将结果写入日志文件等。这时候，带参数的装饰器就派上用场了。
带参数的装饰器其实是在普通装饰器的基础上再封装一层函数，用于接收参数。具体来说，我们需要定义一个外层函数，该函数接收装饰器的参数，然后返回一个普通的装饰器函数。
下面是一个带参数的计时装饰器示例，它可以指定输出时间的格式：
在这个示例中，timer_with_format 函数接收一个 fmt 参数，用于指定输出的格式。然后返回 decorator 装饰器函数，该函数与之前的 timer 装饰器类似，只是在输出时使用了指定的格式。
使用这个带参数的装饰器时，我们可以这样做：
@timer_with_format(fmt=\"[{func_name}] 耗时：{time:.2f} 秒\")
def add(a, b):
time.sleep(1)
return a + b
add(3, 5)
运行后会输出 “[add] 耗时：1.00 秒”，符合我们指定的格式。
带参数的装饰器让装饰器的功能更加灵活多样，能够满足不同场景下的需求。
四、装饰器的嵌套使用
在实际开发中，我们可能需要给一个函数同时添加多个装饰器，这就是装饰器的嵌套使用。装饰器的嵌套遵循从里到外的执行顺序，即最靠近函数的装饰器先执行，然后依次向外执行。
例如，我们有两个装饰器，一个用于记录函数运行时间，另一个用于打印函数的输入参数：
在这个例子中，函数 multiply 同时被 log_args 和 timer 装饰器装饰，并且 log_args 更靠近函数。当调用 multiply (4,6) 时，执行顺序是先执行 log_args 装饰器的 wrapper 函数，打印输入参数，然后执行 timer 装饰器的 wrapper 函数，记录运行时间。最终的输出结果会先显示输入参数，再显示运行时间。
装饰器的嵌套使用可以让我们组合多个功能，为函数添加更丰富的扩展，而无需修改函数本身的代码。
五、保留函数元信息
在使用装饰器的过程中，我们可能会发现一个问题：被装饰后的函数，其元信息（如函数名、文档字符串等）会丢失，变成了 wrapper 函数的元信息。这在某些情况下可能会带来不便，比如当我们需要获取函数的名称或文档时。
为了解决这个问题，Python 的 functools 模块提供了一个 wraps 装饰器，它可以帮助我们保留被装饰函数的元信息。
使用 wraps 装饰器的方法很简单，只需在 wrapper 函数上方加上 @wraps (func) 即可。下面是修改后的计时装饰器示例：
import time
from functools import wraps
def timer(func):
@wraps(func)
def wrapper(*args, **kwargs):
start_time = time.time()
result = func(*args, **kwargs)
end_time = time.time()
print(f\"函数 {func.__name__} 运行时间：{end_time - start_time:.6f} 秒\")
return result
return wrapper
@timer
def square(n):
\"\"\"计算一个数的平方\"\"\"
return n * n
print(square.__name__) # 输出：square
print(square.__doc__) # 输出：计算一个数的平方
如果不使用 wraps 装饰器，square.__name__会输出 “wrapper”，square.__doc__会输出 None。而使用 wraps 装饰器后，就能够正确保留被装饰函数的元信息了。
六、实际应用场景与价值
装饰器在记录函数运行时间方面的应用非常广泛，以下是一些常见的实际场景：
- 性能优化：在开发大型应用程序时，我们需要找出性能瓶颈。通过给关键函数添加计时装饰器，可以快速了解哪些函数运行时间过长，从而有针对性地进行优化。
- 算法评估：在比较不同算法的效率时，计时装饰器可以准确地记录每个算法的运行时间，帮助我们选择更优的算法。
- 任务调度：在一些需要定时执行任务的场景中，我们可以使用计时装饰器来监控任务的执行时间，确保任务在规定的时间内完成。
除了记录函数运行时间，装饰器还可以应用于很多其他场景，如日志记录、权限验证、缓存等。掌握装饰器的使用，能够极大地提高我们的代码编写效率和质量，让代码更加简洁、灵活、可维护。
七、总结
Python 装饰器是一项非常强大且实用的功能，仅仅通过一个 @符号，就能为函数自动添加记录运行时间等多种功能，充分体现了其 “神奇” 之处。从简单的计时装饰器到带参数的装饰器，再到装饰器的嵌套使用和保留函数元信息，我们逐步深入地了解了装饰器的工作原理和使用方法。
在实际开发中，合理运用装饰器可以帮助我们更好地进行代码扩展和维护，提升开发效率。无论是性能优化、算法评估还是其他功能扩展，装饰器都能发挥重要作用。希望通过本文的介绍，大家能够熟练掌握装饰器的使用，让自己的 Python 代码更加优雅、高效。
