encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-30 01:49:50 +03:00
Code Issues Packages Projects Releases Wiki Activity

added docstring

Browse Source
This commit is contained in:
Jón Levy 2019-04-15 03:45:35 +00:00
parent 3d3d0ffa53
commit 76321de748
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
rest_framework/filters.py
View File

@ -26,7 +26,13 @@ from rest_framework.settings import api_settings
class SearchFilterForm(forms.Form): class SearchFilterForm(forms.Form):
"""
A form to sanitize incoming search parameter value.
"""
def __init__(self, search_field, *args, **kwargs): def __init__(self, search_field, *args, **kwargs):
"""
Override to pass search_param name (e.g. "search") and dynamically set as a CharField.
"""
super(SearchFilterForm, self).__init__(*args, **kwargs) super(SearchFilterForm, self).__init__(*args, **kwargs)
self.fields[search_field] = forms.CharField() self.fields[search_field] = forms.CharField()
@ -72,7 +78,8 @@ class SearchFilter(BaseFilterBackend):
def get_search_terms(self, request): def get_search_terms(self, request):
""" """
Search terms are set by a ?search=... query parameter, Search terms are set by a ?search=... query parameter,
and may be comma and/or whitespace delimited. and may be comma and/or whitespace delimited. Sanitize
the search param string by running it through a form.
""" """
form = SearchFilterForm(self.search_param, request.query_params.dict()) form = SearchFilterForm(self.search_param, request.query_params.dict())
if form.is_valid(): if form.is_valid():