Django rest framework cannot deal with multiple objects in model viewset

Question

I have a very simple model and its related serializer and views:

class Page(models.Model):
    user = models.ForeignKey(User)
    title = models.CharField(max_length=255)
    pub_date = models.DateTimeField(default=timezone.now)

class PageSerializer(serializers.ModelSerializer):
    class Meta:
        model = Page
        fields = ('user', 'title', 'pub_date')

class PageViewSet(viewsets.ModelViewSet):
    queryset = Page.objects.all()
    serializer_class = PageSerializer

Now I can post like this:

{
    "user": 1,
    "title": "Lorem ipsum"
}

This works fine. But I would like to post multiple objects like this:

[
    {
        "user": 1,
        "title": "Lorem ipsum one"
    },
    {
        "user": 1,
        "title": "Lorem ipsum two"
    }
]

But this gives me an error:

"non_field_errors": [

"Invalid data. Expected a dictionary, but got list."

]

So to accept multiple objects I modified the view as per the doc:

class PageViewSet(viewsets.ModelViewSet):
    queryset = Page.objects.all()
    serializer_class = PageSerializer(queryset, many=True)

But I am getting an error:

TypeError at /api/blog/pages/

'ListSerializer' object is not callable

What am I missing here?

Cody Parker · Accepted Answer · 2017-04-21 17:48:25Z

12

You had it set up correctly before, the serializer_class should point to the class like this:

serializer_class = PageSerializer

You were right on the error, it doesn't like receiving multiple objects in the POST. One way to fix it would be to override the get_serializer method n the view, adding in many=True there.

Something like:

def get_serializer(self, *args, **kwargs):
    if "data" in kwargs:
        data = kwargs["data"]

        # check if many is required
        if isinstance(data, list):
            kwargs["many"] = True

    return super(PageViewSet, self).get_serializer(*args, **kwargs)

To answer your question in the comments: isinstance() is a Python method to check the type of an object. In this case, it's a list when passing in multiple objects, so we just check what type data is and set many=true if it's a list.

DRF docs regarding get_serializer (under methods)

Python docs regarding isinstance

edited Apr 21, 2017 at 17:48

answered Apr 20, 2017 at 18:14

Cody Parker

1,1216 silver badges10 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Robin Over a year ago

Woah... Thank you. I didn't show any docs on isinstance() method. Could you maybe point me where it is, or maybe elaborate how to use isinstance() please.

Cody Parker Over a year ago

No problem, glad it helped. I've updated my answer to provide more info on that.

Robin Over a year ago

Thank you so much!

Cody Parker Over a year ago

Sure thing! Glad I could help.

Raju Singh · Accepted Answer · 2022-08-02 08:53:20Z

0

Other way to do this

def create(self, request, *args, **kwargs):
    many = True if isinstance(request.data, list) else False
    serializer = self.get_serializer(data=request.data, many=many)

    if serializer.is_valid():
        serializer.save()
    else:
        return Response(serializer.errors,
                        status=status.HTTP_400_BAD_REQUEST)
    return Response(serializer.data, status=status.HTTP_201_CREATED)

answered Aug 2, 2022 at 8:53

Raju Singh

4751 gold badge6 silver badges17 bronze badges

Collectives™ on Stack Overflow

Django rest framework cannot deal with multiple objects in model viewset

2 Answers 2

4 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related