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

view_name argument to HyperlinkedModelSerializer is now properly enforced. Closes #471

Browse Source
This commit is contained in:
Tom Christie 2013-06-02 19:50:24 +01:00
parent 363b342548
commit 8b73dce51d
2 changed files with 20 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
rest_framework/relations.py
View File

@ -72,7 +72,6 @@ class RelatedField(WritableField):
else: # Reverse else: # Reverse
self.queryset = manager.field.rel.to._default_manager.all() self.queryset = manager.field.rel.to._default_manager.all()
except Exception: except Exception:
raise
msg = ('Serializer related fields must include a `queryset`' + msg = ('Serializer related fields must include a `queryset`' +
' argument or set `read_only=True') ' argument or set `read_only=True')
raise Exception(msg) raise Exception(msg)
@ -488,14 +487,15 @@ class HyperlinkedIdentityField(Field):
slug_url_kwarg = None # Defaults to same as `slug_field` unless overridden slug_url_kwarg = None # Defaults to same as `slug_field` unless overridden
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
# TODO: Make view_name mandatory, and have the try:
# HyperlinkedModelSerializer set it on-the-fly self.view_name = kwargs.pop('view_name')
self.view_name = kwargs.pop('view_name', None) except KeyError:
# Optionally the format of the target hyperlink may be specified msg = "HyperlinkedIdentityField requires 'view_name' argument"
raise ValueError(msg)
self.format = kwargs.pop('format', None) self.format = kwargs.pop('format', None)
lookup_field = kwargs.pop('lookup_field', None) lookup_field = kwargs.pop('lookup_field', None)
if lookup_field is not None: self.lookup_field = lookup_field or self.lookup_field
self.lookup_field = lookup_field
# These are pending deprecation # These are pending deprecation
if 'pk_url_kwarg' in kwargs: if 'pk_url_kwarg' in kwargs:
@ -518,7 +518,7 @@ class HyperlinkedIdentityField(Field):
def field_to_native(self, obj, field_name): def field_to_native(self, obj, field_name):
request = self.context.get('request', None) request = self.context.get('request', None)
format = self.context.get('format', None) format = self.context.get('format', None)
view_name = self.view_name or self.parent.opts.view_name view_name = self.view_name
if request is None: if request is None:
warnings.warn("Using `HyperlinkedIdentityField` without including the " warnings.warn("Using `HyperlinkedIdentityField` without including the "

15
rest_framework/serializers.py
View File

@ -903,15 +903,24 @@ class HyperlinkedModelSerializer(ModelSerializer):
_default_view_name = '%(model_name)s-detail' _default_view_name = '%(model_name)s-detail'
_hyperlink_field_class = HyperlinkedRelatedField _hyperlink_field_class = HyperlinkedRelatedField
url = HyperlinkedIdentityField() # Just a placeholder to ensure 'url' is the first field
# The field itself is actually created on initialization,
# when the view_name and lookup_field arguments are available.
url = Field()
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
super(HyperlinkedModelSerializer, self).__init__(*args, **kwargs) super(HyperlinkedModelSerializer, self).__init__(*args, **kwargs)
lookup_field = self.opts.lookup_field
self.fields['url'] = HyperlinkedIdentityField(lookup_field=lookup_field)
if self.opts.view_name is None: if self.opts.view_name is None:
self.opts.view_name = self._get_default_view_name(self.opts.model) self.opts.view_name = self._get_default_view_name(self.opts.model)
url_field = HyperlinkedIdentityField(
view_name=self.opts.view_name,
lookup_field=self.opts.lookup_field
)
url_field.initialize(self, 'url')
self.fields['url'] = url_field
def _get_default_view_name(self, model): def _get_default_view_name(self, model):
""" """
Return the view name to use if 'view_name' is not specified in 'Meta' Return the view name to use if 'view_name' is not specified in 'Meta'