pydantic 中的可变对象默认值行为探究

本文将探讨 pydantic 中可变对象（例如列表）的默认值行为，以及为什么在使用 basemodel 时，多次实例化对象后，可变对象的修改不会影响其他实例。

我们来看一段代码：

from datetime import datetime
from typing import list, optional
from pydantic import basemodel


class user(basemodel):
    friends: list[int] = []


user_1 = user()
user_1.friends.append(1)
print(user_1.friends)  # 输出：[1]

user_2 = user()
print(user_2.friends)  # 输出：[]

这段代码中，user 类继承自 pydantic.basemodel，friends 属性的默认值是一个空列表 []。令人意外的是，user_1 修改了 friends 列表后，user_2 的 friends 列表仍然为空。这与我们通常理解的可变对象行为不同。

如果我们去掉 basemodel 的继承，结果就会改变：

from datetime import datetime
from typing import List, Optional
from pydantic import BaseModel


class User():
    friends: List[int] = []


user_1 = User()
user_1.friends.append(1)
print(user_1.friends)  # 输出：[1]

user_2 = User()
print(user_2.friends)  # 输出：[1]

这次，user_2 的 friends 列表也包含了 1。这是因为没有 basemodel 的介入，friends 的默认值在类定义时被创建，所有实例共享同一个列表对象。

那么，basemodel 究竟做了什么？关键在于默认值的处理方式。当一个类继承自 basemodel 时，pydantic 会在内部为每个实例创建一个新的配置类，从而确保每个实例都拥有自己独立的默认值对象，即使这些默认值在定义时看起来相同。 这与直接定义类时，所有实例共享同一个默认值对象形成了鲜明对比。

在 pydantic 的内部实现中（例如早期版本的 pydantic/main.py 文件），元类 modelmetaclass 会处理类的创建过程，其中包括对默认值的设置。 当检测到类继承自 basemodel 时，该元类会为每个字段创建独立的默认值，从而避免实例之间共享可变对象。 虽然最新的版本可能对实现细节做了优化，但其核心思想保持不变，即确保每个 basemodel 实例拥有其自身独立的可变对象默认值。