More documentation for ModelSearch

This commit is contained in:
Martin Pépin 2020-01-03 17:26:12 +01:00
parent d2c6c9da7a
commit e45ee3fb40
No known key found for this signature in database
GPG key ID: E7520278B1774448

View file

@ -9,8 +9,23 @@ M = TypeVar("M", bound=Model)
class ModelSearch(Generic[M]): 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 As the type hints indicate, the class is generic with respect to the model. This
search fields to be searched in. means that the ``search`` method only returns instances of the model specified as
the ``model`` class attribute in subclasses.
The ``search_fields`` attributes indicates which fields to search in during the
search.
Example:
>>> from django.contrib.auth.models import User
>>>
>>> class UserSearch(ModelSearch):
... model = User
... search_fields = ["username", "first_name", "last_name"]
>>>
>>> user_search = UserSearch() # has type ModelSearch[User]
>>> user_search.search(["toto", "foo"]) # returns a queryset of Users
""" """
model: Type[M] model: Type[M]