Skip to content

[django-filter] add support for callable queryset getter #16453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sevdog wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[django-filter] add support for callable queryset getter #16453

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions stubs/django-filter/django_filters/filters.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from collections import OrderedDict
from collections.abc import Callable, Iterable
from typing import Any
from typing import Any, TypeAlias

from django import forms
from django.db.models import QuerySet
Expand Down Expand Up @@ -152,9 +152,11 @@ class TimeFilter(Filter):
class DurationFilter(Filter):
field_class: type[forms.DurationField]

_QuerySetOrRequest: TypeAlias = QuerySet[Any] | Callable[[Any], QuerySet[Any]] | None

class QuerySetRequestMixin:
queryset: QuerySet[Any] | None
def __init__(self, *, queryset: QuerySet[Any] | None) -> None: ...
queryset: _QuerySetOrRequest
def __init__(self, *, queryset: _QuerySetOrRequest) -> None: ...
def get_request(self) -> Any: ... # Request can be HttpRequest or other request types
def get_queryset(self, request: Any) -> QuerySet[Any]: ... # Request parameter accepts various request types
@property
Expand All @@ -168,7 +170,7 @@ class ModelChoiceFilter(QuerySetRequestMixin, ChoiceFilter):
lookup_expr: str | None = None,
*,
# Inherited from QuerySetRequestMixin
queryset: QuerySet[Any] | None = None,
queryset: _QuerySetOrRequest = None,
# Inherited from ChoiceFilter
null_value: Any = ..., # Null value can be any type (None, empty string, etc.)
# Inherited from Filter
Expand All @@ -187,7 +189,7 @@ class ModelMultipleChoiceFilter(QuerySetRequestMixin, MultipleChoiceFilter):
lookup_expr: str | None = None,
*,
# Inherited from QuerySetRequestMixin
queryset: QuerySet[Any] | None = None,
queryset: _QuerySetOrRequest = None,
# Inherited from MultipleChoiceFilter
distinct: bool = True, # Overrides distinct default
conjoined: bool = False,
Expand Down
Loading