Pydantic类属性不可变性实现指南

from pydantic import BaseModel, Field

class ImmutableInstanceModel(BaseModel):
    name: str = Field(default="默认名称")
    age: int = Field(default=25)

    class Config:
        """
        配置类，用于设置模型行为。
        allow_mutation = False 确保模型实例的属性在创建后不可修改。
        """
        allow_mutation = False

# 创建一个ImmutableInstanceModel的实例
instance = ImmutableInstanceModel()  
print(f"初始实例属性: Name={instance.name}, Age={instance.age}")

# 尝试修改实例属性
try:
    instance.age = 30  # 这将引发ValidationError
except Exception as e:
    print(f"\n尝试修改实例属性时捕获到错误: {e}")

# 验证属性确实未被修改
print(f"修改失败后实例属性: Name={instance.name}, Age={instance.age}")

from pydantic import BaseModel, Field
from pydantic.main import ModelMetaclass

class ImmutableClassMeta(ModelMetaclass):
    """
    自定义元类，用于控制类属性的不可变性。
    """
    # 定义一个列表，包含需要设置为不可变的类属性名称
    IMMUTABLE_CLASS_ATTRS = ['_class_name_attr']

    def __setattr__(cls, name, value):
        """
        拦截类属性的设置操作。
        如果尝试修改IMMUTABLE_CLASS_ATTRS中定义的属性，则抛出AssertionError。
        """
        if hasattr(cls, name):  # 检查属性是否已存在（即修改现有属性）
            if name in cls.IMMUTABLE_CLASS_ATTRS:
                raise AttributeError(f"无法修改类属性 '{name}'，它是不可变的。")
        super().__setattr__(cls, name, value) # 调用父类__setattr__处理其他属性

class ImmutableModelWithClassAttrs(BaseModel, metaclass=ImmutableClassMeta):
    """
    使用自定义元类的Pydantic模型，实现类属性和实例属性的不可变性。
    """
    # 定义一个类属性，我们希望它是不可变的
    _class_name_attr: str = '这是一个不可变的类属性'

    # 定义一个实例属性
    instance_name: str = Field(default="这是一个可变的实例属性")

    class Config:
        """
        配置类，确保模型实例的属性在创建后不可修改。
        """
        allow_mutation = False

# -------------------- 测试类属性不可变性 --------------------
print(f"初始类属性: _class_name_attr = {ImmutableModelWithClassAttrs._class_name_attr}")

# 尝试修改不可变的类属性
try:
    ImmutableModelWithClassAttrs._class_name_attr = '尝试修改类属性'
except AttributeError as e:
    print(f"\n尝试修改类属性时捕获到错误: {e}")

# 验证类属性确实未被修改
print(f"修改失败后类属性: _class_name_attr = {ImmutableModelWithClassAttrs._class_name_attr}")

# -------------------- 测试实例属性不可变性 --------------------
model_instance = ImmutableModelWithClassAttrs()
print(f"\n初始实例属性: instance_name = {model_instance.instance_name}")

# 尝试修改不可变的实例属性
try:
    model_instance.instance_name = '尝试修改实例属性'
except Exception as e: # Pydantic会抛出ValidationError
    print(f"尝试修改实例属性时捕获到错误: {e}")

# 验证实例属性确实未被修改
print(f"修改失败后实例属性: instance_name = {model_instance.instance_name}")

# -------------------- 额外测试：从实例访问类属性 --------------------
# 从实例访问类属性是允许的
print(f"\n从实例访问类属性: {model_instance._class_name_attr}")

# 尝试从实例修改类属性 (这不会被元类拦截，但通常不推荐直接从实例修改类属性)
# 并且因为_class_name_attr不是Pydantic Field，它不会受allow_mutation=False影响
# 但Python的常规行为是，这会创建一个同名的实例属性，而不是修改类属性
model_instance._class_name_attr = "通过实例修改的同名属性"
print(f"实例上的同名属性: {model_instance._class_name_attr}")
print(f"原始类属性未变: {ImmutableModelWithClassAttrs._class_name_attr}")