Skip to main content

Polymorphic serializers for Django REST Framework.

Project description

Polymorphic serializers for Django REST Framework.

Overview

django-rest-polymorphic allows you to easily define serializers for your inherited models that you have created using django-polymorphic.

Installation

Install using pip:

$ pip install django-rest-polymorphic

Usage

Define your polymorphic models:

# models.py
from django.db import models
from polymorphic.models import PolymorphicModel


class Project(PolymorphicModel):
    topic = models.CharField(max_length=30)


class ArtProject(Project):
    artist = models.CharField(max_length=30)


class ResearchProject(Project):
    supervisor = models.CharField(max_length=30)

Define serializers for each polymorphic model the way you did it when you used django-rest-framework:

# serializers.py
from rest_framework import serializers
from .models import Project, ArtProject, ResearchProject


class ProjectSerializer(serializers.ModelSerializer):
    class Meta:
        model = Project
        fields = ('topic', )


class ArtProjectSerializer(serializers.ModelSerializer):
    class Meta:
        model = ArtProject
        fields = ('topic', 'artist')


class ResearchProjectSerializer(serializers.ModelSerializer):
    class Meta:
        model = ResearchProject
        fields = ('topic', 'supervisor')

Then you have to create a polymorphic serializer that serves as a mapper between models and serializers which you have defined above:

# serializers.py
from rest_polymorphic.serializers import PolymorphicSerializer


class ProjectPolymorphicSerializer(PolymorphicSerializer):
    model_serializer_mapping = {
        Project: ProjectSerializer,
        ArtProject: ArtProjectSerializer,
        ResearchProject: ResearchProjectSerializer
    }

Create viewset with serializer_class equals to your polymorphic serializer:

# views.py
from rest_framework import viewsets
from .models import Project
from .serializers import ProjectPolymorphicSerializer


class ProjectViewSet(viewsets.ModelViewSet):
    queryset = Project.objects.all()
    serializer_class = ProjectPolymorphicSerializer

Test it:

$ http GET "http://localhost:8000/projects/"
HTTP/1.0 200 OK
Content-Length: 227
Content-Type: application/json

[
    {
        "resourcetype": "Project",
        "topic": "John's gathering"
    },
    {
        "artist": "T. Turner",
        "resourcetype": "ArtProject",
        "topic": "Sculpting with Tim"
    },
    {
        "resourcetype": "ResearchProject",
        "supervisor": "Dr. Winter",
        "topic": "Swallow Aerodynamics"
    }
]
$ http GET "http://localhost:8000/projects/"
HTTP/1.0 200 OK
Content-Length: 227
Content-Type: application/json

[
    {
        "resourcetype": "Project",
        "topic": "John's gathering"
    },
    {
        "artist": "T. Turner",
        "resourcetype": "ArtProject",
        "topic": "Sculpting with Tim"
    },
    {
        "resourcetype": "ResearchProject",
        "supervisor": "Dr. Winter",
        "topic": "Swallow Aerodynamics"
    }
]
$ http POST "http://localhost:8000/projects/" resourcetype="ArtProject" topic="Guernica" artist="Picasso"
HTTP/1.0 201 Created
Content-Length: 67
Content-Type: application/json

{
    "artist": "Picasso",
    "resourcetype": "ArtProject",
    "topic": "Guernica"
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-rest-polymorphic-0.1.0.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

django_rest_polymorphic-0.1.0-py2.py3-none-any.whl (6.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-rest-polymorphic-0.1.0.tar.gz.

File metadata

File hashes

Hashes for django-rest-polymorphic-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1c2c536edefeabf07922ff9ae7f426acaa7d8137038f2137a4651abf488ab4d3
MD5 ab303830164bcafc17d2a275b197aa95
BLAKE2b-256 9067d9affc4f55790920b030c7783a474dce9271dbca77c4dc2e60aead6535e0

See more details on using hashes here.

Provenance

File details

Details for the file django_rest_polymorphic-0.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_rest_polymorphic-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 696a0bccec98d7d1ca820acadb92f786473cf332fb807b7a3fe834b9dcc4c1c1
MD5 f70335ac16308c6d2ddda4aa0a036ed7
BLAKE2b-256 3b9a228dfcac995ddbacbb8fd3d616fc4281144bd981e4cc83e388fb0cc6e714

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page