Don't catch exceptions in get_queryset #7480
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Contributor
|
This looks good! Could you add a tests for each of the classes where the |
lovelydinosaur
approved these changes
Oct 10, 2020
Contributor
lovelydinosaur
left a comment
lovelydinosaur
left a comment
There was a problem hiding this comment.
Good call.
Personally I'm okay with this without adding extra test cases, since it self evidently is an improvement to ensure that the try...except is as narrowly scoped as possible.
Contributor
Fair enough. I guess a regression is very unlikely. |
Merged
sigvef
pushed a commit
to sigvef/django-rest-framework
that referenced
this pull request
Dec 3, 2022
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the
to_internal_valuemethod of the primary key and slug related fields,TypeErrors andValueErrors are caught fromself.get_queryset().get(...)and presented to the user. This works fine for most cases, but can cause problems if the exception is coming fromself.get_queryset()rather than from the.get(...).It means errors in the
get_querysetmethod can be hidden and presented back to the user as though, for example, the input provided to theto_internal_valuewas the wrong type, whereas in reality there's a bug in theget_querysetmethod 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_typeerrors from my serializer (errors likewrong pk type - intwhen thepktype on my model isint) when the real problem was a bug in my customget_querysetmethod.