Let SearchFilter subclasses dynamically set search fields #6279
Conversation
|
👍 Happy to add any unit tests to ensure forward compatibility for consumers who might subclass it. |
|
I added a test that ensures that subclasses can properly inherit from both |
|
@carltongibson @rpkilby any more thoughts on this? Thank you! |
|
Apologies for the delay; been a bit busy at work. Thanks for reviewing, @rpkilby! |
|
Thanks! |
| @@ -218,6 +218,13 @@ For example: | |||
|
|
|||
| By default, the search parameter is named `'search`', but this may be overridden with the `SEARCH_PARAM` setting. | |||
|
|
|||
| To dynamically change search fields based on request content, it's possible to subclass the `SearchFilter` and override the `get_search_fields()` function. For example, the following subclass will only search on `title` if the query parameter `title_only` is in the request: | |||
|
|
|||
| class CustomSearchFilter(self, view, request): | |||
There was a problem hiding this comment.
Did you mean:
class CustomSearchFilter(SearchFilter):
def get_search_fields(self, view, request):
...
There was a problem hiding this comment.
Thanks, someone else noticed this in #6487.
There was a problem hiding this comment.
Thanks for catching! Apologies for the mistake :(
| search_fields = ('$title', '$text') | ||
|
|
||
| view = SearchListView.as_view() | ||
| request = factory.get('/', {'search': '^\w{3}$'}) |
There was a problem hiding this comment.
Use raw strings to avoid Python warnings.
Description
This pull request refactors
#filter_querysetand extracts a#get_search_fieldsmethod, passing in the request in as a second argument (currently unused). This allows subclasses to override this method and dynamically set search fields (vs. overriding the entire#filter_querysetmethod). A few example use cases:Suppose you have 5 search fields, with
emailbeing one of them. If you run the search terms through a regex and recognize an email, you can dynamically set the search fields only toemail. (This avoids wasteful searches on the other 4 fields.)Suppose the default search fields are
("^book_title",). In combination with overriding the#get_search_termsmethod, a subclass might implement a light lexer/parser to recognize when a search term is encased in quotes, e.g."Green Eggs and Ham"to translate to an exact search of that string onbook_title. This is how Google searches (roughly) work. Otherwise, the existing behavior would do a prefix search on['"Green", 'Eggs', 'and', 'Ham"'].Handling more complex search configurations, e.g. Google advanced search.
Thanks! ❤️ DRF!