Doc'd Model.MultipleObjectsReturned docs and improved documentation related with models exceptions. #13194
Conversation
This file contains 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
adamchainz
force-pushed
the
document_multiple_objects_returned
branch
from
4616bb8
to
4063905
Compare
adamchainz
force-pushed
the
document_multiple_objects_returned
branch
from
4063905
to
975080a
Compare
ngnpope
suggested changes
Jul 16, 2020
adamchainz
force-pushed
the
document_multiple_objects_returned
branch
from
975080a
to
3d88663
Compare
|
Thank you very much for all your review today 🤘 |
felixxm
reviewed
Jul 22, 2020
There was a problem hiding this comment.
@adamchainz Thanks 👍 I moved DoesNotExist to a separate commit and pushed small edits.
docs/ref/models/fields.txt
Outdated
|
|
||
| >>> user.supervisor_of | ||
| Traceback (most recent call last): | ||
| ... | ||
| DoesNotExist: User matching query does not exist. | ||
| RelatedObjectDoesNotExist: User matching query does not exist. |
There was a problem hiding this comment.
Suggested change
| RelatedObjectDoesNotExist: User matching query does not exist. | |
| RelatedObjectDoesNotExist: User has no supervisor_of. |
There was a problem hiding this comment.
Yes it's good to show the right error message 😅
docs/ref/models/querysets.txt
Outdated
| @@ -1844,34 +1844,42 @@ they query the database each time they're called. | |||
| .. method:: get(**kwargs) | |||
|
|
|||
| Returns the object matching the given lookup parameters, which should be in | |||
| the format described in `Field lookups`_. | |||
| the format described in `Field lookups`_. Normally you should use lookups | |||
There was a problem hiding this comment.
I think there are use cases where the database doesn't have any uniqueness constraints but application level logic is relied on for unique results with given lookups. This even aplpies when using order_with_respect_to.
There was a problem hiding this comment.
Maybe we will chop also "... by the database". This should cover all cases.
There was a problem hiding this comment.
That sounds reasonable and shorter. I've pushed the change.
docs/ref/models/querysets.txt
Outdated
| e = Entry.objects.get(id=3) | ||
| b = Blog.objects.get(id=1) | ||
| blog = Blog.objects.get(id=1) | ||
| entry = Entry.objects.get(blog=blog, id=3) |
There was a problem hiding this comment.
Suggested change
| entry = Entry.objects.get(blog=blog, id=3) | |
| entry = Entry.objects.get(blog=blog, entry_number=1) |
felixxm
force-pushed
the
document_multiple_objects_returned
branch
2 times, most recently
from
abdfb7d
to
ded6354
Compare
felixxm
changed the title
felixxm
force-pushed
the
document_multiple_objects_returned
branch
from
ded6354
to
df62816
Compare
|
Changes LGTM |
…elated with models exceptions.
adamchainz
force-pushed
the
document_multiple_objects_returned
branch
from
df62816
to
bc4fea9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
DoesNotExist and MultipleObjectsReturned are very similar but had very different documentation prior to this change. I also added a note that get() should generally be used for lookups that the DB guarantees uniqueness on.