encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-01-23 15:54:16 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added url_field_name class attribute to ModelSerializer. Closes #3106.

Browse Source
This commit is contained in:
Tom Christie 2015-07-14 11:21:33 +01:00
parent 538ffaf6c7
commit 209bcb9087
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
rest_framework/serializers.py
View File

@ -752,8 +752,16 @@ class ModelSerializer(Serializer):
serializer_url_field = HyperlinkedIdentityField serializer_url_field = HyperlinkedIdentityField
serializer_choice_field = ChoiceField serializer_choice_field = ChoiceField
# Default `create` and `update` behavior... # The field name for hyperlinked identity fields. Defaults to 'url'.
# You can modify this using the API setting.
#
# Note that if you instead need modify this on a per-serializer basis,
# you'll also need to ensure you update the `create` method on any generic
# views, to correctly handle the 'Location' response header for
# "HTTP 201 Created" responses.
url_field_name = api_settings.URL_FIELD_NAME
# Default `create` and `update` behavior...
def create(self, validated_data): def create(self, validated_data):
""" """
We have a bit of extra checking around this in order to provide We have a bit of extra checking around this in order to provide
@ -995,7 +1003,7 @@ class ModelSerializer(Serializer):
elif hasattr(model_class, field_name): elif hasattr(model_class, field_name):
return self.build_property_field(field_name, model_class) return self.build_property_field(field_name, model_class)
elif field_name == api_settings.URL_FIELD_NAME: elif field_name == self.url_field_name:
return self.build_url_field(field_name, model_class) return self.build_url_field(field_name, model_class)
return self.build_unknown_field(field_name, model_class) return self.build_unknown_field(field_name, model_class)
@ -1150,9 +1158,9 @@ class ModelSerializer(Serializer):
DeprecationWarning, DeprecationWarning,
stacklevel=3 stacklevel=3
) )
kwargs = extra_kwargs.get(api_settings.URL_FIELD_NAME, {}) kwargs = extra_kwargs.get(self.url_field_name, {})
kwargs['view_name'] = view_name kwargs['view_name'] = view_name
extra_kwargs[api_settings.URL_FIELD_NAME] = kwargs extra_kwargs[self.url_field_name] = kwargs
lookup_field = getattr(self.Meta, 'lookup_field', None) lookup_field = getattr(self.Meta, 'lookup_field', None)
if lookup_field is not None: if lookup_field is not None:
@ -1162,9 +1170,9 @@ class ModelSerializer(Serializer):
DeprecationWarning, DeprecationWarning,
stacklevel=3 stacklevel=3
) )
kwargs = extra_kwargs.get(api_settings.URL_FIELD_NAME, {}) kwargs = extra_kwargs.get(self.url_field_name, {})
kwargs['lookup_field'] = lookup_field kwargs['lookup_field'] = lookup_field
extra_kwargs[api_settings.URL_FIELD_NAME] = kwargs extra_kwargs[self.url_field_name] = kwargs
return extra_kwargs return extra_kwargs
@ -1399,7 +1407,7 @@ class HyperlinkedModelSerializer(ModelSerializer):
`Meta.fields` option is not specified. `Meta.fields` option is not specified.
""" """
return ( return (
[api_settings.URL_FIELD_NAME] + [self.url_field_name] +
list(declared_fields.keys()) + list(declared_fields.keys()) +
list(model_info.fields.keys()) + list(model_info.fields.keys()) +
list(model_info.forward_relations.keys()) list(model_info.forward_relations.keys())