【问题标题】:DRF ViewSet Returns QuerySet With Empty ValuesDRF ViewSet 返回空值的 QuerySet
【发布时间】:2019-01-21 17:28:01
【问题描述】:

我有一个名为“QueryCriteriaViewSet”的 DRF 视图集,我在查询构建器中使用它,它允许用户选择一个字段,然后从相关条件中进行选择。因此,例如,用户可以选择“reg_status”字段,然后从“Active”和“Inactive”的相关标准中进行选择。

当我从主“人”模型中选择一个字段时,这完全正常。但是当我从“lookup_party”模型等相关模型中选择一个字段时,我遇到了问题。奇怪的是,当我将查询集打印到控制台时,它工作得很好,但是当我调用 API 时,它返回一个空对象列表。

再举一个例子,以下是我拨打电话时发生的情况:

api/querycriteria/?fields=reg_status 返回:

[
    {"reg_status": "Active"}, 
    {"reg_status": "Inactive"}
]

api/querycriteria/?fields=party__party_name 返回时:

[
    {},
    {},
    {},
    {},
    {}
]

即使我在返回查询集之前print(queryset),也会打印以下内容:

<QuerySet [{'party__party_name': None}, {'party__party_name': 'Democratic'}, 
{'party__party_name': 'Non-Partisan'}, {'party__party_name': 'Registered 
Independent'}, {'party__party_name': 'Republican'}]>

这是完整的视图集:

class QueryCriteriaViewSet(DefaultsMixin, viewsets.ModelViewSet):
    serializer_class = QueryCriteriaSerializer

    def get_queryset(self):
        fields = self.request.GET.get('fields', None)
        queryset = Person.objects.values(fields).distinct()
        print(queryset)
        return queryset

    def get_fields_to_display(self):
        fields = self.request.GET.get('fields', None)
        return fields.split(',') if fields else None

    def get_serializer(self, instance=None, data=empty, many=False,
                       partial=False):
        """
        Return the serializer instance that should be used for validating and
        deserializing input, and for serializing output.
        """
        serializer_class = self.get_serializer_class()
        context = self.get_serializer_context()
        fields = self.get_fields_to_display()
        return serializer_class(instance, data=data,
                                many=many, partial=partial,
                                context=context, fields=fields)

如果有任何其他信息有帮助,请告诉我。

这是我的序列化程序:

from django.contrib.auth import get_user_model
from rest_framework import serializers
from rest_framework.reverse import reverse
from ..models.people import Person
from ..models.people_emails import Email
from ..models.people_addresses import Address
from ..models.people_phones import Phone
from ..models.people_tags import PersonTag
from ..models.people_elections import PersonElection
from ..models.people_districts import PersonDistrict
from ..models.people_attributes import Attribute
from .serializer_dynamic_fields import DynamicFieldsModelSerializer
from .serializer_tag import TagSerializer
from .serializer_email import EmailSerializer
from .serializer_address import AddressSerializer
from .serializer_phone import PhoneSerializer
from .serializer_election import ElectionSerializer
from .serializer_attribute import AttributeSerializer
from .serializer_district import DistrictSerializer

class QueryCriteriaSerializer(DynamicFieldsModelSerializer):

    emails = EmailSerializer(many=True, required=False)
    addresses = AddressSerializer(many=True, required=False)
    phones = PhoneSerializer(many=True, required=False)
    tags = TagSerializer(many=True, required=False)
    elections = ElectionSerializer(many=True, required=False)
    attributes = AttributeSerializer(many=True, required=False)
    districts = DistrictSerializer(many=True, required=False)

    class Meta:
        model = Person
        fields = ('id', 'elected_official', 'title', 'first', 'last', 'middle',    'suffix',
        'full_name', 'birthdate', 'sex', 'website', 'deceased', 'registered',    'party',
        'reg_date', 'reg_status', 'reg_state', 'county', 'match_id',
        'date_added', 'date_updated', 'do_not_call', 'do_not_mail',    'do_not_email', 'do_not_text', 'emails',
        'addresses', 'phones', 'tags', 'attributes', 'elections', 'districts')

这里是 DynamicFieldsModelSerializer:

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

class DynamicFieldsModelSerializer(serializers.ModelSerializer):
    """
    A ModelSerializer that takes an additional `fields` argument that
    controls which fields should be displayed.
    """

    def __init__(self, *args, **kwargs):
        # Don't pass the 'fields' arg up to the superclass
        fields = kwargs.pop('fields', None)

        # Instantiate the superclass normally
        super(DynamicFieldsModelSerializer, self).__init__(*args, **kwargs)

        if fields is not None:
            # Drop any fields that are not specified in the `fields` argument.
            allowed = set(fields)
            existing = set(self.fields)
            for field_name in existing - allowed:
                self.fields.pop(field_name)

【问题讨论】:

  • 我认为您的序列化程序有问题,请提出您的问题
  • @changak 刚刚添加到我的序列化程序中
  • 请也添加 DynamicFieldsModelSerializer,我认为只有当字段是序列化程序中原始字段的子集时它才有效
  • @changak,谢谢,刚刚用 DynamicFieldsModelSerializer 更新了
  • 我已经更新了我的答案。让我知道它是否有效。

标签: django django-rest-framework django-rest-viewsets drf-queryset


【解决方案1】:

好的,现在发现了问题,DynamicFieldsModelSerializer 仅在您传递给它的字段是序列化程序原始字段的子集时才有效。

您应该以接受额外字段的方式使用序列化程序,如下所示:

class ExtraDynamicFieldsModelSerializer(serializers.ModelSerializer):


    def __init__(self, *args, **kwargs):
        extra_fields = kwargs.pop('fields', [])
        self.extra_fields = set()
        # Instantiate the superclass normally
        super(ExtraDynamicFieldsModelSerializer, self).__init__(*args, **kwargs)

        allowed = set(extra_fields)
        existing = set(self.fields)
        for field_name in existing - allowed:
            self.fields.pop(field_name)

        for field_name in allowed - existing:
            self.extra_fields.add(field_name)



    def to_representation(self, obj):
        data = super().to_representation(obj)
        for field in self.extra_fields:
            data[field] = obj[field]
        return data

【讨论】:

  • 谢谢@changak。它不太有效(但我觉得它很接近)。你能解释一下def to_representation(self, obj)在做什么吗?
  • 刚刚更新了我的答案,问题出在 init 函数中,to_representation 是序列化程序调用的函数,用于将实例更改为原始数据类型的 dict。
  • 同样在to_represntaion中,它会从对象中获取我们放在extra中的所有字段的值,并将它们添加到返回的数据中。
  • 谢谢!我不得不改变一行,但现在这行得通。出于某种原因,data[field] = getattr(obj, field, '') 返回了空值(它没有将“字段”识别为属性。但是当我将该行更改为data[field] = obj[field] 时它起作用了!如果您知道为什么会这样,我会喜欢进一步了解它,但很高兴问题得到解决!
  • 谢谢,我会更新我的答案,我认为 .values() 导致了这种情况,如果没有该查询集将返回模型实例列表,但现在它将返回一个字典列表.
猜你喜欢
  • 1970-01-01
  • 2021-08-07
  • 1970-01-01
  • 1970-01-01
  • 2019-09-10
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2018-12-06
相关资源
最近更新 更多