Django rest_framework: nombre d'objets enfants dans le sérialiseur

Question

Je dois compter le nombre d'enfants dont un objet dispose et renvoyer cette valeur dans mon API via le sérialiseur d'objet. J'ai également besoin de compter un sous-ensemble de ces objets enfants.

J'ai un objet Tâche avec des enfants Asignees. Dans mon API lorsque je fais une recherche les tâches que je veux avoir l'ensemble de données suivantes retourné:

[ 
    { label: "Cross the bridge", 
     count_assigned: 5, 
     count_completed: 3 }, 
    { label: "Build a fire", 
     count_assigned: 5, 
     count_completed: 2 } 
] 

Comment puis-je faire cela? J'ai trouvé la méthode .annotate() mais ce résultat n'est pas disponible dans la classe sérialiseur.

models.py

class Task(models.Model): 
    label   = models.CharField(max_length=255,null=False,blank=False) 

class Assignee(models.model): 
    task   = models.ForeignKey(Task, related_name='assignees', on_delete=models.CASCADE, blank=True, null=True) 
    person  = models.ForeignKey(Person, on_delete=models.CASCADE, blank=True, null=True) 
    completed = models.DateTimeField(null=True,blank=True) 

serializers.py

from rest_framework import serializers 

from .models import Task, Assignee 
from people.serializers import PersonSerializer 

class AssigneeSerializer(serializers.ModelSerializer): 
    id = serializers.ReadOnlyField() 
    person = PersonSerializer(read_only=True) 

    class Meta: 
     model = Assignee 

     fields = ('id','task','person','completed') 
     read_only_fields = ['id'] 


class TaskSerializer(serializers.ModelSerializer): 
    id = serializers.ReadOnlyField() 

    class Meta: 
     model = Task 

     fields = ('id', 'label') 
     read_only_fields = ['id'] 

Answer 1

La façon proposée

class TaskSerializer(serializers.ModelSerializer): 
    id = serializers.ReadOnlyField() 
    count_assigned = serializers.SerializerMethodField() 
    count_completed = serializers.SerializerMethodField() 

    class Meta: 
     model = Task 
     fields = ('id', 'label', 'count_assigned', 'count_completed') 

    def get_count_assigned(self, obj): 
     return obj.assignees.count() 

    def get_count_completed(self, obj): 
     return obj.assignees.exclude(completed__isnull=True).count() 

http://www.django-rest-framework.org/api-guide/fields/#serializermethodfield

Answer 2

Si je comprends votre logique correctement, vous pouvez essayer

dans serializers

class TaskSerializer(serializers.ModelSerializer): 
    count_assigned = serializers.IntegerField(read_only=True) 
    count_completed = serializers.IntegerField(read_only=True) 

puis par queryset :

from django.db.models import Count, Case, When, IntegerField 

qs = Task.objects.annotate(
     count_completed=Count(Case(
      When(assignees__completed__isnull=False, then=1), 
      output_field=IntegerField(), 
     )) 
    ).annotate(count_assigned=Count('assignees')) 

serializer = TaskSerializer(qs, many=True) 

Ou terriblement inefficace dans les modèles:

from django.utils.functional import cached_property 

class Task(models.Model): 

@cached_property 
def all_assignee(self): 
    return self.assignees.all() 

def count_assigned(self): 
    return self.all_assignee.count() 

def count_completed(self): 
    return self.all_assignee.filter(completed__isnull=False).count()