Question
Asked By – Roel
I want to clarify the given documentation of Django-rest-framework regarding the creation of a model object. So far I have found that there are 3 approaches on how to handle such events.
-
The Serializer’s
create()
method. Here is the documentationclass CommentSerializer(serializers.Serializer): def create(self, validated_data): return Comment.objects.create(**validated_data)
-
The ModelViewset
create()
method. Documentationclass AccountViewSet(viewsets.ModelViewSet): queryset = Account.objects.all() serializer_class = AccountSerializer permission_classes = [IsAccountAdminOrReadOnly]
-
The ModelViewset
perform_create()
method. Documentationclass SnippetViewSet(viewsets.ModelViewSet): def perform_create(self, serializer): serializer.save(owner=self.request.user)
These three approaches are important depending on your application environment.
But when do we need to use each create() / perform_create()
function? On the other hand, I found some accounts that two create methods were called for a single post request the ModelViewSet
‘s create()
and serializer’s create()
.
Now we will see solution for issue: When to use Serializer’s create() and ModelViewset’s perform_create()
Answer
-
You would use
create(self, validated_data)
to add any extra details into the object before saving AND “prod” values into each model field just like**validated_data
does. Ideally speaking, you want to do this form of “prodding” only in ONE location so thecreate
method in yourCommentSerializer
is the best place. On top of this, you might want to also call external apis to create user accounts on their side just before saving your accounts into your own database. You should use thiscreate
function in conjunction withModelViewSet
. Always think – “Thin views, Thick serializers”.Example:
def create(self, validated_data): email = validated_data.get("email", None) validated.pop("email") # Now you have a clean valid email string # You might want to call an external API or modify another table # (eg. keep track of number of accounts registered.) or even # make changes to the email format. # Once you are done, create the instance with the validated data return models.YourModel.objects.create(email=email, **validated_data)
-
The
create(self, request, *args, **kwargs)
function in theModelViewSet
is defined in theCreateModelMixin
class which is the parent ofModelViewSet
.CreateModelMixin
‘s main functions are these:from rest_framework import status from rest_framework.response import Response def create(self, request, *args, **kwargs): serializer = self.get_serializer(data=request.data) serializer.is_valid(raise_exception=True) self.perform_create(serializer) headers = self.get_success_headers(serializer.data) return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers) def perform_create(self, serializer): serializer.save()
As you can see, the above
create
function takes care of calling validation on your serializer and producing the correct response. The beauty behind this, is that you can now isolate your application logic and NOT concern yourself about the mundane and repetitive validation calls and handling response output :). This works quite well in conjuction with thecreate(self, validated_data)
found in the serializer (where your specific application logic might reside). -
Now you might ask, why do we have a separate
perform_create(self, serializer)
function with just one line of code!?!? Well, the main reason behind this is to allow customizeability when calling thesave
function. You might want to supply extra data before callingsave
(likeserializer.save(owner=self.request.user)
and if we didn’t haveperform_create(self, serializer)
, you would have to override thecreate(self, request, *args, **kwargs)
and that just defeats the purpose of having mixins doing the heavy and boring work.
This question is answered By – Apoorv Kansal
This answer is collected from stackoverflow and reviewed by FixPython community admins, is licensed under cc by-sa 2.5 , cc by-sa 3.0 and cc by-sa 4.0