Extend return type of django.views.generic.list.ListView.get_queryset to allow any iterable
#897
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
sobolevn
reviewed
Mar 29, 2022
django-stubs/views/generic/list.pyi
Outdated
| @@ -18,7 +18,7 @@ class MultipleObjectMixin(Generic[T], ContextMixin): | |||
| paginator_class: Type[Paginator] = ... | |||
| page_kwarg: str = ... | |||
| ordering: Sequence[str] = ... | |||
| def get_queryset(self) -> QuerySet[T]: ... | |||
| def get_queryset(self) -> Union[QuerySet[T], Iterable[Any]]: ... | |||
There was a problem hiding this comment.
One more thing, we try to use less Union return types, where possible.
This will force our users to always check what exactly was returned. Which is not very nice.
Which can return either a `QuerySet` or an iterable. See, e.g. https://github.com/django/django/blob/83c803f161044fbfbfcd9a0c94ca93dc131be662/django/views/generic/list.py#L26-L27 This has always been true for the generic `ListView` class.
codeinthehole
force-pushed
the
get_query_set
branch
from
12e3c79 to
0fb447e
Compare
|
I will close this with the argument found in #2174, that the method named |
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.
Which can return either a
QuerySetor an iterable. See, e.g.https://github.com/django/django/blob/83c803f161044fbfbfcd9a0c94ca93dc131be662/django/views/generic/list.py#L26-L27
This has been true for the generic
ListViewclass since at least Django 1.7:https://github.com/django/django/blob/1.6/django/views/generic/list.py#L24-L27
Happy to write some tests if you can point my in the right direction for how to do that.