Làm cách nào để lọc một bộ tuần tự lồng nhau trong Django Rest Framework?

Question 1

Trong Django Rest Framework, làm cách nào để lọc một bộ tuần tự khi nó được lồng trong một bộ nối tiếp khác?

Các bộ lọc của tôi được áp dụng trong các bộ xem DRF, nhưng khi bạn gọi một bộ nối tiếp từ bên trong một bộ nối tiếp khác, bộ xem của bộ nối tiếp lồng nhau sẽ không bao giờ được gọi, vì vậy các kết quả lồng nhau sẽ không được lọc.

Tôi đã thử thêm một bộ lọc trên tập hợp chế độ xem gốc, nhưng dường như nó không lọc được các kết quả lồng nhau vì các kết quả lồng nhau được gọi là một truy vấn được viết sẵn riêng biệt. (Bộ nối tiếp lồng nhau là một tra cứu ngược, bạn thấy đấy.)

Có thể thêm ghi đè get_queryset () trong chính bộ tuần tự lồng nhau (di chuyển nó ra khỏi chế độ xem), để thêm bộ lọc vào đó không? Tôi cũng đã thử mà không gặp may.

Đây là những gì tôi đã thử, nhưng nó thậm chí không được gọi là:

class QuestionnaireSerializer(serializers.ModelSerializer):
    edition = EditionSerializer(read_only=True)
    company = serializers.StringRelatedField(read_only=True)

    class Meta:
        model = Questionnaire

    def get_queryset(self):
        query = super(QuestionnaireSerializer, self).get_queryset(instance)
        if not self.request.user.is_staff:
            query = query.filter(user=self.request.user, edition__hide=False)
        return query

Question 2

Bạn có thể phân lớp ListSerializer và ghi đè to_representationphương thức.

Theo mặc định, to_representationphương thức gọi data.all()trên bộ truy vấn lồng nhau. Vì vậy, bạn cần phải thực hiện data = data.filter(**your_filters)trước khi phương thức được gọi. Sau đó, bạn cần thêm ListSerializer phân lớp của mình dưới dạng list_serializer_class trên meta của trình tuần tự lồng nhau.

lớp con ListSerializer, ghi đè to_representationvà sau đó gọi super
thêm ListSerializer phân lớp dưới dạng meta list_serializer_classtrên Serializer lồng nhau

Đây là mã liên quan cho mẫu của bạn.

class FilteredListSerializer(serializers.ListSerializer):

    def to_representation(self, data):
        data = data.filter(user=self.context['request'].user, edition__hide=False)
        return super(FilteredListSerializer, self).to_representation(data)


class EditionSerializer(serializers.ModelSerializer):

    class Meta:
        list_serializer_class = FilteredListSerializer
        model = Edition


class QuestionnaireSerializer(serializers.ModelSerializer):
    edition = EditionSerializer(read_only=True)
    company = serializers.StringRelatedField(read_only=True)

    class Meta:
        model = Questionnaire

Question 3

Đã thử nghiệm nhiều giải pháp từ SO và những nơi khác.

Chỉ tìm thấy một giải pháp hoạt động cho Django 2.0 + DRF 3.7.7.

Định nghĩa một phương thức trong mô hình có lớp lồng nhau. Tạo một bộ lọc phù hợp với nhu cầu của bạn.

class Channel(models.Model):
    name = models.CharField(max_length=40)
    number = models.IntegerField(unique=True)
    active = models.BooleanField(default=True)

    def current_epg(self):
        return Epg.objects.filter(channel=self, end__gt=datetime.now()).order_by("end")[:6]


class Epg(models.Model):
    start = models.DateTimeField()
    end = models.DateTimeField(db_index=True)
    title = models.CharField(max_length=300)
    description = models.CharField(max_length=800)
    channel = models.ForeignKey(Channel, related_name='onair', on_delete=models.CASCADE)

.

class EpgSerializer(serializers.ModelSerializer):
    class Meta:
        model = Epg
        fields = ('channel', 'start', 'end', 'title', 'description',)


class ChannelSerializer(serializers.ModelSerializer):
    onair = EpgSerializer(many=True, read_only=True, source="current_epg")

    class Meta:
        model = Channel
        fields = ('number', 'name', 'onair',)

Hãy chú ý source="current_epg"và bạn sẽ nhận được điểm.

Question 4

Mặc dù tất cả các câu trả lời trên đều hoạt động, nhưng tôi thấy việc sử dụng Prefetchđối tượng của Django là cách dễ nhất.

Giả sử một đối tượng Restaurantcó rất nhiều MenuItems, trong đó có một số is_remove == Truevà bạn chỉ muốn những đối tượng không bị xóa.

Trong RestaurantViewSet, làm một cái gì đó như

from django.db.models import Prefetch

queryset = Restaurant.objects.prefetch_related(
    Prefetch('menu_items', queryset=MenuItem.objects.filter(is_removed=False), to_attr='filtered_menu_items')
)

Trong RestaurantSerializer, làm một cái gì đó như

class RestaurantSerializer(serializers.ModelSerializer):
    menu_items = MenuItemSerializer(source='filtered_menu_items', many=True, read_only=True)

Question 5

Khi một trình tuần tự được khởi tạo và nhiều = True được chuyển, một thể hiện ListSerializer sẽ được tạo. Sau đó, lớp serializer trở thành con của ListSerializer cha

Phương thức này lấy đích của trường làm đối số giá trị và sẽ trả về biểu diễn cần được sử dụng để tuần tự hóa đích. Đối số giá trị thường sẽ là một cá thể mô hình.

Dưới đây là ví dụ về bộ nối tiếp lồng nhau

class UserSerializer(serializers.ModelSerializer):
    """ Here many=True is passed, So a ListSerializer instance will be 
     created"""
    system = SystemSerializer(many=True, read_only=True)

    class Meta:
        model = UserProfile
        fields = ('system', 'name')

class FilteredListSerializer(serializers.ListSerializer):
    
    """Serializer to filter the active system, which is a boolen field in 
       System Model. The value argument to to_representation() method is 
      the model instance"""
    
    def to_representation(self, data):
        data = data.filter(system_active=True)
        return super(FilteredListSerializer, self).to_representation(data)

class SystemSerializer(serializers.ModelSerializer):
    mac_id = serializers.CharField(source='id')
    system_name = serializers.CharField(source='name')
    serial_number = serializers.CharField(source='serial')

    class Meta:
        model = System
        list_serializer_class = FilteredListSerializer
        fields = (
            'mac_id', 'serial_number', 'system_name', 'system_active', 
        )

Theo quan điểm:

class SystemView(viewsets.GenericViewSet, viewsets.ViewSet):
    def retrieve(self, request, email=None):
        data = get_object_or_404(UserProfile.objects.all(), email=email)
        serializer = UserSerializer(data)
        return Response(serializer.data)

Question 6

Tôi thấy việc sử dụng một SerializerMethodFieldtrên trường serializer mà bạn muốn lọc sẽ dễ dàng hơn và dễ dàng hơn .

Vì vậy, bạn sẽ làm một cái gì đó như thế này.

class CarTypesSerializer(serializers.ModelSerializer):

    class Meta:
        model = CarType
        fields = '__all__'


class CarSerializer(serializers.ModelSerializer):

    car_types = serializers.SerializerMethodField()

    class Meta:
        model = Car
        fields = '__all__'

    def get_car_types(self, instance):
        # Filter using the Car model instance and the CarType's related_name
        # (which in this case defaults to car_types_set)
        car_types_instances = instance.car_types_set.filter(brand="Toyota")
        return CarTypesSerializer(car_types_instances, many=True).data

Điều này giúp bạn không phải tạo nhiều ghi đè serializers.ListSerializernếu bạn cần các tiêu chí lọc khác nhau cho các bộ tuần tự khác nhau.

Nó cũng có thêm lợi ích là thấy chính xác những gì bộ lọc làm trong bộ tuần tự hóa thay vì đi sâu vào định nghĩa lớp con.

Tất nhiên, nhược điểm là nếu bạn có một bộ nối tiếp với nhiều đối tượng lồng vào nhau mà tất cả đều cần được lọc theo một cách nào đó. Nó có thể làm cho mã serializer tăng lên rất nhiều. Bạn muốn lọc như thế nào tùy thuộc vào bạn.

Hi vọng điêu nay co ich!