pydantic 可变对象默认值行为详解及解决方案
本文深入探讨 Pydantic 类中使用可变对象（如列表、字典）作为默认值时，可能导致实例间数据共享的问题，并提供解决方案。
让我们来看一个例子：
from typing import List from pydantic import BaseModel class User(BaseModel): friends: List[int] = [] user1 = User() user1.friends.append(1) print(f"user1.friends: {user1.friends}") # 输出: user1.friends: [1] user2 = User() print(f"user2.friends: {user2.friends}") # 输出: user2.friends: []
令人困惑的是，friends 属性的默认值明明是一个空列表，为什么 user1 和 user2 实例的 friends 属性却指向不同的列表？
如果我们不使用 BaseModel，结果会不同：
from typing import List class User: friends: List[int] = [] user1 = User() user1.friends.append(1) print(f"user1.friends: {user1.friends}") # 输出: user1.friends: [1] user2 = User() print(f"user2.friends: {user2.friends}") # 输出: user2.friends: [1]
现在 user2.friends 也变成了 [1]，这说明问题在于 pydantic.BaseModel。
关键在于默认值的创建时机。在不继承 BaseModel 的情况下，friends: List[int] = [] 只在类定义阶段执行一次，所有实例共享同一个列表。 而 BaseModel 为了避免此问题，会在每次实例化时创建新的默认值对象，确保每个实例拥有独立的属性，避免了意外的副作用。
解决方案：
为了避免这个问题，应该使用工厂函数或 Field 来创建默认值：
方法一：使用工厂函数
from typing import List from pydantic import BaseModel def default_friends(): return [] class User(BaseModel): friends: List[int] = default_friends() user1 = User() user1.friends.append(1) print(f"user1.friends: {user1.friends}") # 输出: user1.friends: [1] user2 = User() print(f"user2.friends: {user2.friends}") # 输出: user2.friends: []
方法二：使用 Field
from typing import List from pydantic import BaseModel, Field class User(BaseModel): friends: List[int] = Field(default_factory=list) user1 = User() user1.friends.append(1) print(f"user1.friends: {user1.friends}") # 输出: user1.friends: [1] user2 = User() print(f"user2.friends: {user2.friends}") # 输出: user2.friends: []
两种方法都能确保每次创建 User 实例时，friends 属性都指向一个新的空列表，避免了实例间数据共享。 推荐使用 Field 方法，因为它更简洁且直接在模型定义中指定了默认值行为。 记住，对于可变对象，永远不要直接在类定义中赋值为默认值。
© 版权声明
文章版权归作者所有，未经允许请勿转载。
THE END
