具有ChoiceField的Django Rest框架

Question

我的用户模型中有几个字段是choice字段，并且正在尝试找出如何将其最好地实现到Django Rest框架中。

下面是一些简化的代码来显示我正在做什么。

# models.py
class User(AbstractUser):
    GENDER_CHOICES = (
        ('M', 'Male'),
        ('F', 'Female'),
    )

    gender = models.CharField(max_length=1, choices=GENDER_CHOICES)


# serializers.py 
class UserSerializer(serializers.ModelSerializer):
    gender = serializers.CharField(source='get_gender_display')

    class Meta:
        model = User


# viewsets.py
class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

基本上，我要做的是让get/post/put方法使用choice字段的display值，而不是代码，类似于下面的JSON。

{
  'username': 'newtestuser',
  'email': '[e-mail]',
  'first_name': 'first',
  'last_name': 'last',
  'gender': 'Male'
  // instead of 'gender': 'M'
}

我该怎么做呢？上面的代码不起作用。之前，我有这样的东西用于GET，但用于post/put会给我带来错误。我正在寻找如何这样做的一般建议，似乎这将是一些常见的东西，但我找不到例子。要么就是我做错了什么。

Answer 1

这个线程的更新，在DRF的最新版本中，实际上有一个ChoiceField。

因此，如果要返回display_name，您所需要做的就是将choicefieldto_representation方法子类化，如下所示：

from django.contrib.auth import get_user_model
from rest_framework import serializers

User = get_user_model()

class ChoiceField(serializers.ChoiceField):

    def to_representation(self, obj):
        if obj == '' and self.allow_blank:
            return obj
        return self._choices[obj]

    def to_internal_value(self, data):
        # To support inserts with the value
        if data == '' and self.allow_blank:
            return ''

        for key, val in self._choices.items():
            if val == data:
                return key
        self.fail('invalid_choice', input=data)


class UserSerializer(serializers.ModelSerializer):
    gender = ChoiceField(choices=User.GENDER_CHOICES)

    class Meta:
        model = User

因此不需要更改__init__方法或添加任何附加包。