Add count objects in Django Rest Framework Viewset

Question

I have a question with adding Count Objects in Django Rest Framework Viewset: This is my curren API:

[
    {
        "id": 1,
        "created": "2017-12-25T10:29:13.055000Z"
    },
    {
        "id": 2,
        "created": "2017-12-25T10:29:13.055000Z"
    }
]

Now I want to add Count Objects outside this API and collect them in results array like this:

{
    "count_objects": 2,
    "results": [
        {
            "id": 1,
            "created": "2017-12-25T10:29:13.055000Z"
        },
        {
            "id": 2,
            "created": "2017-12-25T10:29:13.055000Z"
        }
    ]
  }

How can I do this in the right way? Now my viewset.py is:

class NotificationAPIView(ReadOnlyModelViewSet):
    queryset = Notification.objects.all()
    serializer_class = NotificationSerializer

    def get_queryset(self, *args, **kwargs):
        queryset_list = Notification.objects.filter(to_user=self.request.user)
        return queryset_list

Ykh · Accepted Answer · 2017-12-26T04:24:34.367

4

settings.py

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 100
}

You again,you really should read doc before ask.

Update:

from collections import OrderedDict
from rest_framework.response import Response

class Pagination(PageNumberPagination):
    def paginate_queryset(self, queryset, request, view=None):
        self.count_objects = queryset.filter(id__gt=2).count()
        return super(Pagination, self).paginate_queryset(queryset, request, view=view)

    def get_paginated_response(self, data):
        return Response(OrderedDict([
            ('count_objects', self.count_objects),
            ('count', self.count),
            ('next', self.get_next_link()),
            ('previous', self.get_previous_link()),
            ('results', data)
        ]))


class NotificationAPIView(ReadOnlyModelViewSet):
    queryset = Notification.objects.all()
    serializer_class = NotificationSerializer
    pagination_class = Pagination

edited Dec 26 '17 at 04:24

answered Dec 26 '17 at 03:59

Ykh

7,567
1
22
31

I know Pagination. But I want to add more object to count with conditions., Example, counts object with id >2 – KitKit Dec 26 '17 at 04:02
1

busy now,will update later.This should override get_paginated_response method – Ykh Dec 26 '17 at 04:05
Okay, Thanks anyway :) – KitKit Dec 26 '17 at 04:06
1

see update,it's untested code,if any error occur please tell me. – Ykh Dec 26 '17 at 04:25
That's good. Success with this. But is there anyways better? Such as `annotate`? – KitKit Dec 26 '17 at 07:11
1

annotate can add a field to queryset but can not return the field to front.If you want be simple,just override list method to custom response. – Ykh Dec 26 '17 at 07:13
Got it, Thank you x3. Hope I have your half of knowledge :)) – KitKit Dec 26 '17 at 07:18
1

keep asking,one day you will :) – Ykh Dec 26 '17 at 07:20

score 1 · Answer 2 · answered Dec 26 '17 at 04:30

1

This will filter the values and add a count for the field status in the result.

def count:
    Model.objects.filter(value=value).values('status').annotate(count=Count('status'))

For detail see documentation

Hope this helps.

answered Dec 26 '17 at 04:30

Tony Roczz

2,366
6
32
59

You put it as separate function and call the function or in your existing `queryset_list = Notification.objects.filter(to_user=self.request.user).values('to_user').annotate(count=Count('to_user'))` since the to_user will be common in all the rows use that – Tony Roczz Dec 26 '17 at 05:05
`SyntaxError: Non-ASCII character '\xe2' in file views.py on line 20, but no encoding declared; see http://python.org/dev/peps/pep-0263/ for details` This error is created – KitKit Dec 26 '17 at 05:12
I am not sure about the error may be this will help https://stackoverflow.com/questions/21639275/python-syntaxerror-non-ascii-character-xe2-in-file – Tony Roczz Dec 26 '17 at 06:39

score 1 · Answer 3 · answered Aug 25 '21 at 06:49

1

serializers.py

class YourSerializer(serializers.ModelSerializer)

    count = serializers.SerializerMethodField('get_count')
    class Meta:
         model = YourModel
         fields = ['...., count']

    def get_count(self, obj):    
        return YourModel.objects.all().count()

answered Aug 25 '21 at 06:49

Sushang Agnihotri

638
7
11

Could you elaborate ? – indianwebdevil Aug 31 '21 at 21:11
it will add 'count' field in response and give the total number of data in that model – Sushang Agnihotri Sep 01 '21 at 04:23

Add count objects in Django Rest Framework Viewset

3 Answers3