Python 装饰器实战：从基础扩展到类装饰器与 functools.wraps

Python 装饰器基础与开闭原则

本文通过具体实例介绍 Python 中装饰器 @ 的使用，旨在对函数进行功能扩展。内容供参考学习。

装饰器的核心作用是在不修改原函数代码、也不改变原函数调用方式的前提下，对原函数进行功能扩展，这符合开闭原则。

以下是基础装饰器的实现示例代码：

# 闭包
def w1(func):
  def inner():
    # 对原函数进行功能扩展
    print("功能扩展")
    func()
    # return func() # 如果原函数需要返回值,可以return
  return inner # 闭包
@w1
# 相当于 f1 = w1(f1)
def f1():
  print('f1') # 原函数不需要修改
f1() # 原函数的调用也不需要修改

接下来展示通用格式的装饰器，用于处理带有不定长参数且需要返回值的函数：

def set_func(func):
  def call_func(*args, **kwargs):
    print("装饰器扩展的功能")
    return func(*args, **kwargs) # 这里的*和*表示拆包。 不管有没有返回值,return都没问题。
  return call_func
@set_func # 相当于 test1 = set_func(test1)
# 对含有不定长参数并且有返回值的函数进行装饰。
def test1(num, *args, **kwargs):
  print("-----test1----%d" % num)
  return "ok"
ret = test1(100)
print(ret)

当存在多个装饰器时，其装饰顺序及执行逻辑如下所示：

def add_1(func):
  def call_func(*args, **kwargs):
    print("装饰器1 扩展的功能")
    return func(*args, **kwargs)
  return call_func
def add_2(func):
  def call_func(*args, **kwargs):
    print("装饰器2 扩展的功能")
    return func(*args, **kwargs)
  return call_func
@add_2
@add_1
# 先装饰add_1，再装饰add_2
def test1():
  print("------test1------")
test1() # 在调用函数之前就已经装饰好了。
# 装饰器2 扩展的功能
# 装饰器1 扩展的功能
# ------test1------

此外，还可以使用类来充当装饰器，具体实现如下：

# 用类充当装饰器
class Test(object):
  def __init__(self, func):
    self.func = func
  def __call__(self, *args, **kwargs):
    print("这里是装饰器添加的功能.....")
    return self.func(*args, **kwargs)
@Test # 相当于get_str = Test(get_str) # 实例化对象,调用__init__方法。
def get_str():
  return "haha"
print(get_str())  # 实例对象(),会自动调用对象的__call__方法。

在装饰器的内层函数上使用 @functools.wraps 修饰器，可以确保被装饰函数的 __name__ 和 __doc__ 属性不会被装饰器覆盖或改变。

结合 的具体使用示例代码如下：

# coding:utf-8
import functools # 导入
# 自定义的装饰器
def login_required(func):
  @functools.wraps(func)
  # 装饰器的内层函数,一般要加@functools.wraps装饰器
  def wrapper(*arg, **kwargs):
    """wrapper的说明文档"""
    # 。。。
    return func(*arg, **kwargs)
  return wrapper
# 使用自定义的装饰器
@login_required
def demofunc():
  """demofunc的说明文档"""
  pass
print(demofunc.__name__)  # 不加@functools.wraps装饰器时："wrapper"。 加装饰器时："demofunc"
print(demofunc.__doc__)  # 不加@functools.wraps装饰器时："wrapper的说明文档"。 加装饰器时："demofunc的说明文档"

如需了解更多 Python 相关知识，可参考本站的《Python 面向对象程序设计入门与进阶教程》、《Python 数据结构与算法教程》、《Python 函数使用技巧总结》、《Python 字符串操作技巧汇总》、《Python 编码操作技巧总结》及《Python 入门与进阶经典教程》等专题。

希望上述内容能对您的 Python 程序设计有所帮助。