Merge pull request #18 from yezyilomo/rename_pk_to_accept_pk

Rename pk to accept pk
yezyilomo · Sep 6, 2019 · 59a8ed8 · 59a8ed8
2 parents 49997c3 + f737f72
commit 59a8ed8
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -133,8 +133,8 @@ Response
 <br>
 
 
-### Using NestedField with `pk=True` kwarg.
-`pk=True` is used if you want to update nested field by using id of existing data(basically associate and dessociate existing nested resources with the parent resource without actually mutating the nested resource). This applies to ForeignKey relation only.
+### Using NestedField with `accept_pk=True` kwarg.
+`accept_pk=True` is used if you want to update nested field by using pk/id of existing data(basically associate and dessociate existing nested resources with the parent resource without actually mutating the nested resource). This applies to ForeignKey relation only.
 
 ```python
 from app.models import Location, Amenity, Property
@@ -149,7 +149,7 @@ class LocationSerializer(NestedModelSerializer):
 
 
 class PropertySerializer(NestedModelSerializer):
-    location = NestedField(ocationSerializer, pk=True)
+    location = NestedField(ocationSerializer, accept_pk=True)
     class Meta:
         model = Property
         fields = (

diff --git a/drf_pretty_update/fields.py b/drf_pretty_update/fields.py
@@ -17,12 +17,12 @@ class _WritableField(object):
     pass
 
 def BaseNestedFieldSerializerFactory(*args, 
-                                     pk=False, 
+                                     accept_pk=False, 
                                      create_ops=[ADD, CREATE], 
                                      update_ops=[ADD, CREATE, REMOVE, UPDATE],
                                      serializer_class=None, 
                                      **kwargs):
-    BaseClass = _ReplaceableField if pk else _WritableField
+    BaseClass = _ReplaceableField if accept_pk else _WritableField
 
     if not set(create_ops).issubset(set(CREATE_SUPPORTED_OPERATIONS)):
         msg = (
@@ -172,7 +172,7 @@ def validate_data_based_nested(self, data):
             return parent_serializer.validated_data
 
         def to_internal_value(self, data):
-            if pk:
+            if accept_pk:
                 return self.validate_pk_based_nested(data)
             return self.validate_data_based_nested(data)
 

diff --git a/setup.py b/setup.py
@@ -9,7 +9,7 @@
 
 setup(
     name = 'drf-pretty-update',
-    version = '0.1.3',
+    version = '0.1.4',
     description = DESCRIPTION,
     long_description = readme,
     long_description_content_type = 'text/markdown',

diff --git a/tests/testapp/serializers.py b/tests/testapp/serializers.py
@@ -24,15 +24,15 @@ class Meta:
 
 
 class ReplaceableCourseSerializer(NestedModelSerializer):
-    books = NestedField(BookSerializer, pk=True, many=True, required=False)
+    books = NestedField(BookSerializer, accept_pk=True, many=True, required=False)
 
     class Meta:
         model = Course
         fields = ['name', 'code', 'books']
 
 
 class ReplaceableStudentSerializer(NestedModelSerializer):
-    course = NestedField(WritableCourseSerializer, pk=True)
+    course = NestedField(WritableCourseSerializer, accept_pk=True)
     phone_numbers = PhoneSerializer(many=True, read_only=True)
 
     class Meta: