Add convenience methods to EndpointSet #10
Closed
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.
What does this PR do?
Adds commonly used code to
EndpointSet.prepare()
to retrieve a Resource object if the Resource object model is based on Django ModelBase, and if the request method is appropriate.Where should the reviewer start?
Read the updated code.
How should this be manually tested?
Run tests.
Any background context you want to provide?
In another project requiring pinax-api I noticed 75% of EndpointSets use almost identical logic to obtain a Resource object via their individual
prepare()
andget_queryset()
methods. This update aims to relieve that tedium.get_pk()
andget_resource_object_model()
allow for customizing the object model and PK before object retrieval. This helps when an endpoint proxies for other models, or when a PK needs translation before object lookup.What ticket or issue # does this fix?
N/A
Definition of Done (check if considered and/or addressed):