Add type annotations for request in paginate_queryset
#1491
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
This updates the docs and internal code to expect that `request` is always available, which now allows downstreams to rely on this fact. This is fully backwards-compatible with existing code which does not explicitly expect a `request` argument to `paginate_queryset`; since `request` is annotated (and invoked) as keyword-only, it will always be captured in `**params` as a fallback. The test case with `CustomPagination` now explicitly tests this backwards-compatibility by using the old-style signature.
|
This completes the changes made in a718d73. |
|
@vitalik PTAL. |
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.
This updates the docs and internal code to expect that
requestis always available, which now allows downstreams to rely on this fact.This is fully backwards-compatible with existing code which does not explicitly expect a
requestargument topaginate_queryset; sincerequestis annotated (and invoked) as keyword-only, it will always be captured in**paramsas a fallback.The test case with
CustomPaginationnow explicitly tests this backwards-compatibility by using the old-style signature.