Python weakref.finalize在对象销毁时执行清理回调

weakref.finalize 是 Python 标准库中用于注册清理回调的工具。它允许你在对象被垃圾回收时自动执行指定的函数，且不会阻止对象被销毁。相比传统的 __del__ 方法，它更安全、更灵活，能有效避免循环引用导致的内存泄漏问题。

核心原理与执行流程

weakref.finalize 通过弱引用监控目标对象。当对象的引用计数归零并被垃圾回收器回收时，finalize 会立即触发预设的回调函数。

以下是对象生命周期与清理回调的执行逻辑：

基础用法：注册清理回调

要使用 weakref.finalize，需先引入模块，然后绑定对象与回调函数。

1. 导入 weakref 模块。
2. 定义 一个包含资源清理逻辑的回调函数。该函数接收的参数由注册时传入。
3. 实例化 目标对象。
4. 调用 weakref.finalize(obj, func, *args, **kwargs) 注册回调。

以下是具体代码示例：

import weakref

# 定义回调函数
def on_cleanup(name, resource_id):
    print(f"清理回调触发: 名称={name}, 资源ID={resource_id}")

class DataHandler:
    def __init__(self, name):
        self.name = name

# 1. 实例化对象
handler = DataHandler("数据处理器的实例")

# 2. 注册终结器
# 参数含义: 监控对象=handler, 回调函数=on_cleanup, 回调参数1="Handler-A", 回调参数2=1024
finalizer = weakref.finalize(handler, on_cleanup, "Handler-A", 1024)

# 3. 删除对象引用，触发垃圾回收
del handler

执行 上述代码后，当 del handler 运行，控制台将输出：

清理回调触发: 名称=Handler-A, 资源ID=1024

进阶控制：手动禁用与查询状态

weakref.finalize 返回一个 Finalize 对象，该对象提供了方法来控制回调的行为。

1. 查询回调是否存活

使用 .alive 属性检查回调是否仍有效。如果对象已被销毁或回调已被禁用，该属性返回 False。

handler = DataHandler("Temp")
finalizer = weakref.finalize(handler, on_cleanup, "Temp", 0)

print(finalizer.alive)  # 输出: True

del handler
print(finalizer.alive)  # 输出: False (回调已执行)

2. 显式调用并禁用回调

调用 .detach() 方法。此操作会返回回调函数及其参数，并永久禁用该终结器。这意味着对象销毁时不会再自动触发回调。这常用于需要手动控制资源释放时机的场景。

handler = DataHandler("Manual")
finalizer = weakref.finalize(handler, on_cleanup, "Manual", 99)

# 手动提取并执行回调，同时禁用自动清理
if finalizer.alive:
    func, args, kwargs = finalizer.detach()
    func(*args, **kwargs) # 手动执行
    print("已手动清理并禁用自动回调")

del handler # 此时不会有任何输出，因为回调已被 detach

3. 禁用回调但不执行

调用 .atexit = False。默认情况下，程序正常退出时，所有存活的终结器都会被调用。将其设为 False 可禁止程序退出时的自动调用。

对比 __del__ 方法的优势

传统的 __del__ 析构方法在处理循环引用或异常时容易出错，而 weakref.finalize 提供了更稳健的替代方案。

以下是两者的关键差异对比：

实战案例：临时文件自动清理

在处理临时文件的场景中，确保文件在使用后被删除至关重要。使用 weakref.finalize 可以保证即使程序意外结束或对象被遗忘，文件也能被清理。

1. 编写 一个创建临时文件的类。
2. 在类初始化时 注册删除文件的回调。
3. 利用 atexit 属性确保程序崩溃时也能尝试清理。

import weakref
import os

def remove_file(path):
    if os.path.exists(path):
        os.remove(path)
        print(f"已删除临时文件: {path}")

class TempFile:
    def __init__(self, file_path):
        self.path = file_path
        # 创建文件
        with open(self.path, 'w') as f:
            f.write("临时数据")

        # 注册清理回调
        # 传入 self.path 而非 self，避免增加对象引用计数
        self._finalizer = weakref.finalize(self, remove_file, self.path)

        # 确保解释器退出时也执行清理
        self._finalizer.atexit = True

    def write(self, data):
        with open(self.path, 'a') as f:
            f.write(data)

# 使用示例
temp = TempFile("demo.tmp")
temp.write("追加内容")

# 模拟对象销毁
del temp 
# 控制台输出: 已删除临时文件: demo.tmp