Make View, TemplateView, and TemplateResponseMixin generic on response type
#2874
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 will allow subclasses of `View` to narrow the type of their responses. Co-authored-by: Charlie Denton <[email protected]>
…sponse type This allows us to specify that the default response type for template views is a `TemplateResponse`. N.B. The `LogoutView` may return a response that is not a template response (i.e. a redirect), so we annotate it as returning a less specific type. We have not been more specific about exactly which types it returns because doing so might require it to also become generic to support subclasses that return different specific response types. Co-authored-by: Charlie Denton <[email protected]>
|
Diff from mypy_primer, showing the effect of this PR on type check results on a corpus of open source code: zulip (https://github.com/zulip/zulip)
+ zerver/views/documentation.py:309: error: Signature of "get" incompatible with supertype "django.views.generic.base.TemplateView" [override]
+ zerver/views/documentation.py:309: note: Superclass:
+ zerver/views/documentation.py:309: note: def get(self, request: HttpRequest, *args: Any, **kwargs: Any) -> TemplateResponse
+ zerver/views/documentation.py:309: note: Subclass:
+ zerver/views/documentation.py:309: note: def get(self, request: HttpRequest, *args: object, article: str = ..., **kwargs: object) -> HttpResponse
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 allows us to specify that the default response type for template
views is a
TemplateResponse.N.B. The
LogoutViewmay return a response that is not a templateresponse (i.e. a redirect), so we annotate it as returning a less
specific type. We have not been more specific about exactly which types
it returns because doing so might require it to also become generic to
support subclasses that return different specific response types.
We could take this further and make more generic view subclasses generic,
but wanted to verify this approach with y'all before pushing too far ahead.
Related issues
Fixes #2873