Faust中模型字段为其他模型时的反序列化问题排查

问题根源 #

你遇到的问题是Faust默认不会自动根据__faust标识完成多态类型的反序列化，尤其是使用自定义字段描述器时，框架无法识别字典对应的具体模型子类，只能返回原始字典结构。

两种解决思路 #

思路1：用Faust原生多态模型+Union类型（推荐） #

Faust支持通过配置多态标识实现自动反序列化，无需自定义描述器，步骤如下：

1. 给所有Filter子类定义共同父类，并配置多态识别字段

from faust import Model

class BaseFilter(Model):
    class Config:
        # 指定用来区分子类的字段名
        polymorphic_on = "filter_type"

class ChatterFilter(BaseFilter):
    threshold: float
    class Config:
        # 给当前子类分配唯一标识
        polymorphic_identity = "chatter"

class LimitFilter(BaseFilter):
    max_value: int
    class Config:
        polymorphic_identity = "limit"

class DitherFilter(BaseFilter):
    noise_level: float
    class Config:
        polymorphic_identity = "dither"

2. 在主Filter模型中使用Union类型声明字段

from typing import Union, Optional
from faust import Model

class Filter(Model):
    filter: Optional[Union[ChatterFilter, LimitFilter, DitherFilter]] = None

这样配置后，Faust在序列化时会自动添加filter_type字段，反序列化时根据该字段自动实例化对应的子类，无需手动转换。

思路2：修改自定义FilterOptions描述器，添加反序列化逻辑 #

如果必须保留自定义字段描述器，需要在描述器中实现字典到模型实例的转换逻辑：

class FilterOptions:
    def __set_name__(self, owner, name):
        self.name = name

    def __get__(self, instance, owner):
        return instance.__dict__.get(self.name)

    def __set__(self, instance, value):
        # 保留原有的初始化类型验证逻辑
        allowed_types = (ChatterFilter, LimitFilter, DitherFilter, type(None))
        if not isinstance(value, allowed_types):
            raise TypeError(f"Filter must be one of {allowed_types}")
        instance.__dict__[self.name] = value

    def __getstate__(self, value):
        # 序列化时输出模型字典（自动包含__faust标识）
        return value.dict() if value is not None else None

    def __setstate__(self, state):
        # 反序列化时根据__faust标识映射到对应子类
        if state is None:
            return None
        # 从__faust字段中提取类型名
        if "__faust" in state:
            type_name = state["__faust"]["type"]
            # 建立类型名到类的映射
            type_map = {
                "ChatterFilter": ChatterFilter,
                "LimitFilter": LimitFilter,
                "DitherFilter": DitherFilter,
            }
            return type_map[type_name](**state)
        raise TypeError("Invalid filter data: missing __faust type identifier")

这个方法通过描述器的__setstate__方法，读取字典中的__faust标识，找到对应的模型类并实例化。

注意事项 #

• 确保Faust版本≥1.10.0，旧版本对多态模型的支持不完善
• 如果使用思路1，不要在自定义描述器中覆盖序列化/反序列化逻辑，避免和Faust原生逻辑冲突

内容的提问来源于stack exchange，提问作者Fonty