Django REST Serializer处理Python保留字from字段的解决方案问询

我之前对接第三方Webhook时也碰到过一模一样的问题——from是Python的保留字，没法直接用作DRF序列化器的字段名，试了好几种方法都踩坑了。不过有两个靠谱的方案能完美解决你的验证和字段映射问题：

方案一：利用DRF的source参数（推荐） #

这是最简洁的方法，DRF的source参数可以帮我们把序列化器里的合法字段名，映射到请求/响应中的from字段：

from rest_framework import serializers

class FromSerializer(serializers.Serializer):
    id = serializers.CharField(required=True)
    name = serializers.CharField(required=True)

class FacebookReactionSerializer(serializers.Serializer):
    # 用from_作为字段名（Python允许下划线结尾的保留字变体），source='from'映射到目标字段
    from_ = FromSerializer(source='from', required=True)
    # 其他业务字段示例
    reaction_type = serializers.CharField(required=True)
    created_time = serializers.DateTimeField(required=True)

为什么这个方案能解决你的问题？ #

• 接收请求时：DRF会自动把请求体中的from数据绑定到from_字段上，验证逻辑完全基于FromSerializer，不会再提示from_key必填（因为我们根本不需要自定义from_key字段）。
• 响应输出时：DRF会自动把from_序列化为from字段返回，完全符合Facebook的格式要求，不需要额外在to_representation里手动转换。

方案二：重写to_internal_value和to_representation（更灵活） #

如果需要对字段做额外的自定义处理，可以手动重写这两个方法来实现字段名的映射：

class FacebookReactionSerializer(serializers.Serializer):
    from_field = FromSerializer(required=True)
    reaction_type = serializers.CharField(required=True)
    created_time = serializers.DateTimeField(required=True)

    def to_internal_value(self, data):
        # 把请求中的`from`字段数据转移到`from_field`，供序列化器验证
        if 'from' in data:
            data['from_field'] = data.pop('from')
        return super().to_internal_value(data)

    def to_representation(self, instance):
        # 把序列化后的`from_field`转换回`from`字段输出
        representation = super().to_representation(instance)
        if 'from_field' in representation:
            representation['from'] = representation.pop('from_field')
        return representation

分析你之前踩坑的原因 #

1. 直接使用from = FromSerializer()：from是Python保留字，语法层面就不允许用作变量/属性名，编译器直接报错是必然的。
2. 用from_key替代仅在to_representation转换：DRF的验证逻辑是基于你定义的字段名，请求中传的是from而非from_key，序列化器找不到from_key的数据，自然会提示必填。
3. 动态添加from字段：动态添加字段的时机如果不对（比如在验证之后），DRF的验证流程已经走完，会导致字段格式校验失败；另外动态字段如果没有正确关联FromSerializer，也会出现格式错误。
4. 用FromSerializer关联from_key：和第二个问题一样，请求中不存在from_key字段，验证环节自然不通过。

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