Добавить пользовательские поля в Django REST Framework serializer

Я хочу добавить поле в сериализатор, содержащий информацию, специфичную для пользователя, делающего текущий запрос (я не хочу создавать для этого отдельную конечную точку). Вот как я это сделал:

Вид:

class ArticleViewSet(viewsets.ModelViewSet):
    queryset = Article.objects.all()
    serializer_class = ArticleSerializer
    filter_class = ArticleFilterSet

    def prefetch_likes(self, ids):
        self.current_user_likes = dict([(like.article_id, like.pk) for like in Like.objects.filter(user=self.request.user, article_id__in=ids)])

    def get_object(self, queryset=None):
        article = super(ArticleViewSet, self).get_object(queryset)
        self.prefetch_likes([article.pk])
        return article

    def paginate_queryset(self, queryset, page_size=None):
        page = super(ArticleViewSet, self).paginate_queryset(queryset, page_size)
        if page is None:
            return None

        ids = [article.pk for article in page.object_list]
        self.prefetch_likes(ids)

        return page

Сериализатор:

class ArticleSerializer(serializers.ModelSerializer):
    class Meta:
        model = Article

    def to_native(self, obj):
        ret = super(ArticleSerializer, self).to_native(obj)

        if obj:
            view = self.context['view']
            ret['has_liked'] = False
            if hasattr(view, 'current_user_liked'):
                ret['has_liked'] = obj.pk in view.current_user_liked

        return ret

Есть ли лучшее место для ввода предварительной выборки любимых статей или более приятного способа сделать это в целом?

Ответы

Ответ 1

вы можете сделать это с помощью SerializerMethodField

Пример:

class PostSerializer(serializers.ModelSerializer):
    fav = serializers.SerializerMethodField('likedByUser')

    def likedByUser(self, obj):
        request = self.context.get('request', None)
        if request is not None:
            try:
                liked=Favorite.objects.filter(user=request.user, post=obj.id).count()
                return liked == 1
            except Favorite.DoesNotExist:
                return False
        return "error"

    class Meta:
        model = Post

тогда вы должны вызвать сериализатор из вида следующим образом:

class PostView(APIVIEW):
     def get(self,request):
         serializers = PostSerializer(PostObjects,context={'request':request})

Ответ 2

Я был бы склонен попытаться поставить как можно больше на объект модели Like, а затем перетащить остальное в пользовательское поле сериализатора.

В поля сериализатора вы можете получить доступ к request с помощью параметра context, который они наследуют от своего родительского сериализатора.

Итак, вы можете сделать что-то вроде этого:

class LikedByUserField(Field):
    def to_native(self, article):
        request = self.context.get('request', None)
        return Like.user_likes_article(request.user, article)

Метод класса user_likes_article может затем инкапсулировать вашу логику предварительной выборки (и кэширования).

Я надеюсь, что это поможет.

Ответ 3

В соответствии с Django Documentation - SerializerMethodField мне пришлось немного изменить код quick2share.

class ResourceSerializer(serializers.ModelSerializer):
    liked_by_user = serializers.SerializerMethodField()

    def get_liked_by_user(self, obj : Resource):
        request = self.context.get('request')
        return request is not None and obj.likes.filter(user=request.user).exists()