Handle serialization for non interger primary key in ModelMultipleSerializer (#268)

* Handle serialization for non interger primary key in ModelMultipleSerializer

* Added test cases for non int pk deserialization

Author: kuldeeprishi

dynamic_preferences/serializers.py

@@ -248,8 +248,8 @@ def to_python(self, value, **kwargs):
 
         try:
             pks = value.split(",")
-            pks = [int(i) for i in pks]
-            return self.model.objects.filter(pk__in=pks)    
+            pks = [int(i) if str(i).isdigit() else str(i) for i in pks]
+            return self.model.objects.filter(pk__in=pks)
         except:
             raise self.exception("Array {0} cannot be converted to int".format(value))
 

tests/test_app/models.py

@@ -1,5 +1,12 @@
+import uuid
 from django.db import models
 
 class BlogEntry(models.Model):
     title = models.CharField(max_length=255)
     content = models.TextField()
+
+
+class BlogEntryWithNonIntPk(models.Model):
+    id = models.UUIDField(primary_key=True, default=uuid.uuid4)
+    title = models.CharField(max_length=255)
+    content = models.TextField()

tests/test_serializers.py

@@ -6,7 +6,7 @@
 from django.template import defaultfilters
 
 from dynamic_preferences import serializers
-from .test_app.models import BlogEntry
+from .test_app.models import BlogEntry, BlogEntryWithNonIntPk
 
 
 class TestSerializers(TestCase):
@@ -169,7 +169,7 @@ def test_date_deserialization(self):
 
         with self.assertRaises(s.exception):
             s.deserialize('Invalid date string')
-            
+
     def test_datetime_serialization(self):
         s = serializers.DateTimeSerializer
 
@@ -239,6 +239,11 @@ def setUp(self):
             BlogEntry(title='This is a test', content='Hello World'),
             BlogEntry(title='This is only a test', content='Hello World'),
         ])
+        BlogEntryWithNonIntPk.objects.bulk_create([
+            BlogEntryWithNonIntPk(title='This is a test', content='Hello World'),
+            BlogEntryWithNonIntPk(title='This is only a test', content='Hello World'),
+
+        ])
 
     def test_model_multiple_serialization(self):
         s = serializers.ModelMultipleSerializer(BlogEntry)
@@ -250,11 +255,32 @@ def test_model_multiple_deserialization(self):
         s = serializers.ModelMultipleSerializer(BlogEntry)
         blog_entries = BlogEntry.objects.all()
         pks = s.separator.join(map(str, sorted(list(blog_entries.values_list('pk', flat=True)))))
-
         self.assertEqual(list(s.deserialize(pks)), list(blog_entries))
 
     def test_model_multiple_single_serialization(self):
         s = serializers.ModelMultipleSerializer(BlogEntry)
         blog_entry = BlogEntry.objects.all().first()
 
         self.assertEqual(s.serialize(blog_entry), s.separator.join(map(str, [blog_entry.pk])))
+
+
+    def test_model_multiple_serialization_with_non_int_pk(self):
+        s = serializers.ModelMultipleSerializer(BlogEntryWithNonIntPk)
+        blog_entries = BlogEntryWithNonIntPk.objects.all()
+
+        self.assertEqual(s.serialize(blog_entries), s.separator.join(map(str, sorted(list(blog_entries.values_list('pk', flat=True))))))
+
+    def test_model_multiple_deserialization_with_non_int_pk(self):
+        s = serializers.ModelMultipleSerializer(BlogEntryWithNonIntPk)
+        blog_entries = BlogEntryWithNonIntPk.objects.all()
+        pks = s.separator.join(map(str, sorted(list(blog_entries.values_list('pk', flat=True)))))
+
+        deserialized_ids = sorted([instance.pk for instance in s.deserialize(pks)])
+        blog_entries_ids = sorted([entry.pk for entry in blog_entries])
+        self.assertEqual(deserialized_ids, blog_entries_ids)
+
+    def test_model_multiple_single_serialization_with_non_int_pk(self):
+        s = serializers.ModelMultipleSerializer(BlogEntryWithNonIntPk)
+        blog_entry = BlogEntryWithNonIntPk.objects.all().first()
+
+        self.assertEqual(s.serialize(blog_entry), s.separator.join(map(str, [blog_entry.pk])))