Python装饰器：为您的函数赋予超能力

你好，有抱负的Python程序员们！今天，我们将深入探讨神奇的Python装饰器世界。把装饰器想象成可以为你的函数赋予超能力的魔法包装器。是不是很兴奋？让我们一起踏上这段旅程吧！

Python - Decorators

装饰器是什么？

想象一下你有一个包装精美的礼物。包装纸并没有改变礼物本身，但它让礼物看起来更漂亮，对吧？Python中的装饰器对你的函数做的就是类似的事情。它们包裹在你的函数周围，添加了额外的功能，而不会改变原始函数本身。

让我们从一个简单的例子开始：

def my_decorator(func):
def wrapper():
print("在函数被调用之前发生了一些事情。")
func()
print("在函数被调用之后发生了一些事情。")
return wrapper

@my_decorator
def say_hello():
print("你好！")

say_hello()

如果你运行这段代码，你会看到：

在函数被调用之前发生了一些事情。
你好！
在函数被调用之后发生了一些事情。

让我们来分解一下：

我们定义了一个装饰器函数 my_decorator，它接收一个函数作为参数。
在 my_decorator 内部，我们定义了一个 wrapper 函数，它在调用原始函数之前和之后添加了一些行为。
我们使用 @my_decorator 语法将我们的装饰器应用于 say_hello 函数。
当我们调用 say_hello() 时，实际上是在调用包装后的函数版本。

是不是很整洁？我们刚刚为我们的 say_hello 函数添加了一些额外的行为，而无需修改其代码！

带参数的装饰器

但是等等，还有更多！如果我们的函数需要参数呢？没问题！我们可以修改我们的装饰器来处理这个问题：

def my_decorator(func):
def wrapper(*args, **kwargs):
print("在函数被调用之前。")
result = func(*args, **kwargs)
print("在函数被调用之后。")
return result
return wrapper

@my_decorator
def add(a, b):
return a + b

print(add(3, 5))

这将输出：

在函数被调用之前。
在函数被调用之后。
8

在这里，*args 和 **kwargs 允许我们的装饰器处理任意数量的位置参数和关键字参数。

内置装饰器

Python提供了一些内置的装饰器，它们非常有用。让我们来探索它们！

@classmethod装饰器

@classmethod 装饰器用于定义在类本身上操作的方法，而不是在类的实例上。

class Pizza:
def __init__(self, ingredients):
self.ingredients = ingredients

@classmethod
def margherita(cls):
return cls(['马苏里拉奶酪', '番茄'])

@classmethod
def prosciutto(cls):
return cls(['马苏里拉奶酪', '番茄', '火腿'])

print(Pizza.margherita().ingredients)
print(Pizza.prosciutto().ingredients)

这将输出：

['马苏里拉奶酪', '番茄']
['马苏里拉奶酪', '番茄', '火腿']

在这里，margherita 和 prosciutto 是类方法，它们使用预定义的配料创建并返回新的Pizza实例。

@staticmethod装饰器

静态方法是既不作用于实例也不作用于类的方法。它们只是恰好存在于类中的普通函数。

class Math:
@staticmethod
def add(a, b):
return a + b

print(Math.add(5, 10))

这将输出：

@property装饰器

@property 装饰器允许你定义可以像属性一样访问的方法。

class Circle:
def __init__(self, radius):
self._radius = radius

@property
def radius(self):
return self._radius

@property
def area(self):
return 3.14 * self._radius ** 2

c = Circle(5)
print(c.radius)
print(c.area)

这将输出：

5
78.5

在这里，我们可以像访问属性一样访问 radius 和 area，但实际上它们是方法。

@functools.wraps装饰器

这个装饰器用于在创建装饰器时保留原始函数的元数据。

from functools import wraps

def my_decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
"""这是包装函数"""
return func(*args, **kwargs)
return wrapper

@my_decorator
def my_function():
"""这是我的函数"""
pass

print(my_function.__name__)
print(my_function.__doc__)

这将输出：

my_function
这是我的函数

如果没有 @wraps，函数的名称和文档字符串将是包装函数的名称和文档字符串。

结论

装饰器是Python中的一个强大特性，它允许你修改或增强函数和方法。它们在框架和库中被广泛使用，用于添加如日志记录、访问控制等功能。

记住，掌握装饰器的关键在于实践。尝试创建自己的装饰器并将它们应用于不同的函数。很快，你就能像专业人士一样为你的函数包装超能力了！

以下是我们在本文中介绍的装饰器的总结表：

装饰器	用途
`@classmethod`	定义在类本身上操作的方法
`@staticmethod`	定义既不作用于实例也不作用于类的方法
`@property`	定义可以像属性一样访问的方法
`@functools.wraps`	在装饰器中保留原始函数的元数据

编码愉快，愿你的函数总是装饰得美丽动人！

Credits: Image by storyset