Merge pull request #127 from palfrey/mypy-testing

Add minimal typing support to pass mypy checks

Author: ir4y

.gitignore

@@ -16,4 +16,4 @@ coverage.*
 !.gitignore
 !.travis.yml
 
-sample*
+sample*

README.md

@@ -50,13 +50,13 @@ class AccessKey(models.Model):
 
 class Profile(models.Model):
     sites = models.ManyToManyField(Site)
-    user = models.OneToOneField(User)
-    access_key = models.ForeignKey(AccessKey, null=True)
+    user = models.OneToOneField(User, on_delete=models.CASCADE)
+    access_key = models.ForeignKey(AccessKey, null=True, on_delete=models.CASCADE)
 
 
 class Avatar(models.Model):
     image = models.CharField(max_length=100)
-    profile = models.ForeignKey(Profile, related_name='avatars')
+    profile = models.ForeignKey(Profile, related_name='avatars', on_delete=models.CASCADE)
 ```
 
 We should create the following list of serializers:

drf_writable_nested/mixins.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from collections import OrderedDict, defaultdict
+from typing import List
 
 from django.contrib.contenttypes.fields import GenericRelation
 from django.contrib.contenttypes.models import ContentType
@@ -382,7 +383,7 @@ class Meta:
     (`UniqueFieldsMixin` and `NestedCreateMixin` or `NestedUpdateMixin`)
     you should put `UniqueFieldsMixin` ahead.
     """
-    _unique_fields = []
+    _unique_fields = [] # type: List[str]
 
     def get_fields(self):
         self._unique_fields = []

drf_writable_nested/py.typed

@@ -0,0 +1 @@
+Stripped down example project, based on top-level README

example/README.md

@@ -0,0 +1,24 @@
+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, on_delete=models.CASCADE)
+    access_key = models.ForeignKey(AccessKey, null=True, on_delete=models.CASCADE)
+
+
+class Avatar(models.Model):
+    image = models.CharField(max_length=100)
+    profile = models.ForeignKey(Profile, related_name='avatars', on_delete=models.CASCADE)

example/__init__.py

@@ -0,0 +1 @@
+djangorestframework-stubs

example/models.py

@@ -0,0 +1,49 @@
+from rest_framework import serializers
+from drf_writable_nested.serializers import WritableNestedModelSerializer
+from .models import Avatar, AccessKey, Profile, User, Site
+
+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',)

example/requirements.txt

@@ -0,0 +1,2 @@
+# Minimal Django config so the django-stubs mypy plugin doesn't complain
+SECRET_KEY="something secret"