Python库 | drf-writable-nested-0.1.2.tar.gz

DRF Writable Nested ==================== [](https://travis-ci.org/Brogency/drf-writable-nested) [](https://codecov.io/gh/Brogency/drf-writable-nested) [](https://pypi.python.org/pypi/drf-writable-nested) This is a writable nested model serializer for Django REST Framework which allows you to create/update your models with related nested data. The following relations are supported: - OneToOne (direct/reverse) - ForeignKey (direct/reverse) - ManyToMany (direct/reverse excluding m2m relations with through model) Requirements ============ - Python (2.7, 3.2, 3.3, 3.4, 3.5) - Django (1.8, 1.9, 1.10) - djangorestframework (3.x) Installation ============ ``` pip install drf-writable-nested ``` Usage ===== For example, for the following model structure: ```python from django.db import models class Site(models.Model): url = models.CharField(max_length=100) class User(models.Model): username = models.CharField(max_length=100) class AccessKey(models.Model): key = models.CharField(max_length=100) class Profile(models.Model): sites = models.ManyToManyField(Site) user = models.OneToOneField(User) access_key = models.ForeignKey(AccessKey, null=True) class Avatar(models.Model): image = models.CharField(max_length=100) profile = models.ForeignKey(Profile, related_name='avatars') ``` We should create the following list of serializers: ```python from rest_framework import serializers from drf_writable_nested import WritableNestedModelSerializer class AvatarSerializer(serializers.ModelSerializer): image = serializers.CharField() class Meta: model = Avatar fields = ('pk', 'image',) class SiteSerializer(serializers.ModelSerializer): url = serializers.CharField() class Meta: model = Site fields = ('pk', 'url',) class AccessKeySerializer(serializers.ModelSerializer): class Meta: model = AccessKey fields = ('pk', 'key',) class ProfileSerializer(WritableNestedModelSerializer): # Direct ManyToMany relation sites = SiteSerializer(many=True) # Reverse FK relation avatars = AvatarSerializer(many=True) # Direct FK relation access_key = AccessKeySerializer(allow_null=True) class Meta: model = Profile fields = ('pk', 'sites', 'avatars', 'access_key',) class UserSerializer(WritableNestedModelSerializer): # Reverse OneToOne relation profile = ProfileSerializer() class Meta: model = User fields = ('pk', 'profile', 'username',) ``` Also, you can use `NestedCreateMixin` or `NestedUpdateMixin` from this package if you want to support only create or update logic. For example, we can pass the following data with related nested fields to our main serializer: ```python data = { 'username': 'test', 'profile': { 'access_key': { 'key': 'key', }, 'sites': [ { 'url': 'http://google.com', }, { 'url': 'http://yahoo.com', }, ], 'avatars': [ { 'image': 'image-1.png', }, { 'image': 'image-2.png', }, ], }, } user_serializer = UserSerializer(data=data) user_serializer.is_valid(raise_exception=True) user = user_serializer.save() ``` This serializer automatically will create all nested relations and we receive a complete instance with filled data. ```python user_serializer = UserSerializer(instance=user) print(user_serializer.data) ``` ```python { 'pk': 1, 'username': 'test', 'profile': { 'pk': 1, 'access_key': { 'pk': 1, 'key': 'key' }, 'sites': [ { 'pk': 1, 'url': 'http://google.com', }, { 'pk': 2, 'url': 'http://yahoo.com', }, ], 'avatars': [ { 'pk': 1, 'image': 'image-1.png', }, { 'pk': 2, 'image': 'image-2.png', }, ], }, } ``` Authors ======= 2014-2017, Bro.engineering