Commit1ba0d68

authored and

committed

Added SearchFilter.get_search_fields() hook. (encode#6279)

1 parent9b06feb commit1ba0d68Copy full SHA for 1ba0d68

File tree

+41

-1

lines changed

+41

-1

lines changed

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -218,6 +218,13 @@ For example:`
`218`	`218`
`219`	`219`	By default, the search parameter is named`'search`', but this may be overridden with the`SEARCH_PARAM` setting.
`220`	`220`
	`221`	+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:
	`222`	`+`
	`223`	`+class CustomSearchFilter(self, view, request):`
	`224`	`+ if request.query_params.get('title_only'):`
	`225`	`+ return ('title',)`
	`226`	`+ return super(CustomSearchFilter, self).get_search_fields(view, request)`
	`227`	`+`
`221`	`228`	`For more details, see the[Django documentation][search-django-admin].`
`222`	`229`
`223`	`230`	`---`

Lines changed: 9 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,14 @@ class SearchFilter(BaseFilterBackend):`
`53`	`53`	`search_title=_('Search')`
`54`	`54`	`search_description=_('A search term.')`
`55`	`55`
	`56`	`+defget_search_fields(self,view,request):`
	`57`	`+"""`
	`58`	`+ Search fields are obtained from the view, but the request is always`
	`59`	`+ passed to this method. Sub-classes can override this method to`
	`60`	`+ dynamically change the search fields based on request content.`
	`61`	`+ """`
	`62`	`+returngetattr(view,'search_fields',None)`
	`63`	`+`
`56`	`64`	`defget_search_terms(self,request):`
`57`	`65`	`"""`
`58`	`66`	`Search terms are set by a ?search=... query parameter,`
`@@ -90,7 +98,7 @@ def must_call_distinct(self, queryset, search_fields):`
`90`	`98`	`returnFalse`
`91`	`99`
`92`	`100`	`deffilter_queryset(self,request,queryset,view):`
`93`		`-search_fields=getattr(view,'search_fields',None)`
	`101`	`+search_fields=self.get_search_fields(view,request)`
`94`	`102`	`search_terms=self.get_search_terms(request)`
`95`	`103`
`96`	`104`	`ifnotsearch_fieldsornotsearch_terms:`

Lines changed: 25 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -156,6 +156,31 @@ class SearchListView(generics.ListAPIView):`
`156`	`156`
`157`	`157`	`reload_module(filters)`
`158`	`158`
	`159`	`+deftest_search_with_filter_subclass(self):`
	`160`	`+classCustomSearchFilter(filters.SearchFilter):`
	`161`	`+# Filter that dynamically changes search fields`
	`162`	`+defget_search_fields(self,view,request):`
	`163`	`+ifrequest.query_params.get('title_only'):`
	`164`	`+return ('$title',)`
	`165`	`+returnsuper(CustomSearchFilter,self).get_search_fields(view,request)`
	`166`	`+`
	`167`	`+classSearchListView(generics.ListAPIView):`
	`168`	`+queryset=SearchFilterModel.objects.all()`
	`169`	`+serializer_class=SearchFilterSerializer`
	`170`	`+filter_backends= (CustomSearchFilter,)`
	`171`	`+search_fields= ('$title','$text')`
	`172`	`+`
	`173`	`+view=SearchListView.as_view()`
	`174`	`+request=factory.get('/', {'search':'^\w{3}$'})`
	`175`	`+response=view(request)`
	`176`	`+assertlen(response.data)==10`
	`177`	`+`
	`178`	`+request=factory.get('/', {'search':'^\w{3}$','title_only':'true'})`
	`179`	`+response=view(request)`
	`180`	`+assertresponse.data== [`
	`181`	`+ {'id':3,'title':'zzz','text':'cde'}`
	`182`	`+ ]`
	`183`	`+`
`159`	`184`
`160`	`185`	`classAttributeModel(models.Model):`
`161`	`186`	`label=models.CharField(max_length=32)`

Comments

(0)