encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-29 04:54:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

Don't catch exceptions in get_queryset (#7480)

Browse Source 
In the `to_internal_value` method of the primary key and slug related fields, `TypeError`s and `ValueError`s are caught from `self.get_queryset().get(...)` and presented to the user. This works fine for most cases, but can cause problems if the exception is coming from `self.get_queryset()` rather than from the `.get(...)`.

It means errors in the `get_queryset` method can be hidden and presented back to the user as though, for example, the input provided to the `to_internal_value` was the wrong type, whereas in reality there's a bug in the `get_queryset` method and therefore it should bubble up and be exposed as a server error.

I've decided to fix this because twice now I've had to debug why I'm seeing `invalid_type` errors from my serializer (errors like `wrong pk type - int` when the `pk` type on my model is `int`) when the real problem was a bug in my custom `get_queryset` method.
This commit is contained in:
Thomas Leese 2020-10-10 18:02:21 +01:00 committed by GitHub
parent fd5e1a745a
commit eff97efa28
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
rest_framework/relations.py
View File

@ -257,8 +257,9 @@ class PrimaryKeyRelatedField(RelatedField):
def to_internal_value(self, data): def to_internal_value(self, data):
if self.pk_field is not None: if self.pk_field is not None:
data = self.pk_field.to_internal_value(data) data = self.pk_field.to_internal_value(data)
queryset = self.get_queryset()
try: try:
return self.get_queryset().get(pk=data) return queryset.get(pk=data)
except ObjectDoesNotExist: except ObjectDoesNotExist:
self.fail('does_not_exist', pk_value=data) self.fail('does_not_exist', pk_value=data)
except (TypeError, ValueError): except (TypeError, ValueError):
@ -454,8 +455,9 @@ class SlugRelatedField(RelatedField):
super().__init__(**kwargs) super().__init__(**kwargs)
def to_internal_value(self, data): def to_internal_value(self, data):
queryset = self.get_queryset()
try: try:
return self.get_queryset().get(**{self.slug_field: data}) return queryset.get(**{self.slug_field: data})
except ObjectDoesNotExist: except ObjectDoesNotExist:
self.fail('does_not_exist', slug_name=self.slug_field, value=smart_str(data)) self.fail('does_not_exist', slug_name=self.slug_field, value=smart_str(data))
except (TypeError, ValueError): except (TypeError, ValueError):