cst1/kpsul
1
0
Fork 0
forked from DGNum/gestioCOF
Code Pull requests Activity

Type hints in shared.views.autocomplete

Browse source
This commit is contained in:
Martin Pépin 2020-01-02 17:07:50 +01:00
parent 914888d18a
commit d2c6c9da7a
No known key found for this signature in database
GPG key ID: E7520278B1774448
1 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
shared/views/autocomplete.py
View file

@ -1,18 +1,22 @@
from dal import autocomplete from typing import Generic, Iterable, Type, TypeVar
from django.db.models import Q
from dal import autocomplete # type: ignore
from django.db.models import Model, Q
M = TypeVar("M", bound=Model)
class ModelSearch: class ModelSearch(Generic[M]):
"""Basic search engine for models based on filtering. """Basic search engine for models based on filtering.
Subclasses should override the ``model`` class attribute and specify the list of Subclasses should override the ``model`` class attribute and specify the list of
search fields to be searched in. search fields to be searched in.
""" """
model = None model: Type[M]
search_fields = [] search_fields: Iterable[str]
def get_queryset_filter(self, keywords): def get_queryset_filter(self, keywords: Iterable[str]) -> Q:
filter_q = Q() filter_q = Q()
if not keywords: if not keywords:
@ -26,7 +30,7 @@ class ModelSearch:
return filter_q return filter_q
def search(self, keywords): def search(self, keywords: Iterable[str]) -> Iterable[M]:
"""Returns the queryset of model instances matching all the keywords. """Returns the queryset of model instances matching all the keywords.
The semantic of the search is the following: a model instance appears in the The semantic of the search is the following: a model instance appears in the