Django Rest Framework: Shared Fields on Serializers

Question

I have a few Serializers that share a few fields like meta_id, category_id and so on.

Obviously I could just declare these on the serializer as a SerializerMethodField individually but I would like to find a way to reuse the logic, either with a Mixin, Decorator, or inheritance.

How can I declare a base serializer and inherit it— while still inheriting from serializers.ModelSerializer? So that I can reuse the get_meta_id and make sure it shows up in the fields?

class Foo(serializers.ModelSerializer, somethingHere?):
    meta_id = Serializers.SerializerMethodField()

class Meta:
    model = Foo
    fields = [...]

    def get_meta_id(self, obj):
        ...

Is it possible to just pass two parameters into the class

Is your meta_id field a read_only field? or both read and write field? — JPG
– JPG, Commented Feb 23, 2020 at 5:26
@ArakkalAbu it's a read only field– it's coming from another model — aroooo
– aroooo, Commented Feb 23, 2020 at 6:15
That's not I meant. whether the common fields are used only in Serialization purpose? — JPG
– JPG, Commented Feb 23, 2020 at 8:05

kamilyrb · Accepted Answer · 2020-02-23 10:53:47Z

1

You can crete a Base serializer and use inheritence for other serializers.Like that:

class BaseSerializer(serializers.Serializer):
#your codes and extra fields
    test_field = serializer.SerializerMethodField()

    def get_test_field(self.obj):
        return 'test' # or you can use obj instance here

class ExtendedSerializer(BaseSerializer,serializers.ModelSerializer):
#your extra fields

    class Meta:
        fields = BaseSerializer.Meta.fields + () # you can add your additional fields here

edited Feb 23, 2020 at 10:53

answered Feb 23, 2020 at 1:26

kamilyrb

2,6273 gold badges13 silver badges26 bronze badges

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

2 Comments

aroooo Over a year ago

but in this case the model is defined in the metaclass of baseserializer already. I need this to work for many models

kamilyrb Over a year ago

Ok, I updated my answer, you can define BaseSerializer as serializers.Serializer. But with this way, you must add serializers.ModelSerializer to your child serializers.

David Alvarez · Accepted Answer · 2020-02-23 11:28:15Z

0

class BaseSerializer(serializers.ModelSerializer): # The BaseSerializer class inherit everthing from ModelSerializer
    class Meta(serializers.ModelSerializer.Meta): # The BaseSerializer.Meta inherits everything from ModelSerializer.Meta
        def get_meta_id(self, obj):
            return self.meta_id


class Foo(BaseSerializer):
    meta_id = Serializers.SerializerMethodField()

    class Meta(BaseSerializer.Meta): # Here you should get the ModelSerializer.Meta + your custom get_meta_id
        model = Foo
        fields = [...]

answered Feb 23, 2020 at 11:28

David Alvarez

1,30613 silver badges23 bronze badges

Collectives™ on Stack Overflow

Django Rest Framework: Shared Fields on Serializers

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related