diff --git a/docs/api-guide/filtering.md b/docs/api-guide/filtering.md index ff5f3c7759..de8a5c5579 100644 --- a/docs/api-guide/filtering.md +++ b/docs/api-guide/filtering.md @@ -230,6 +230,7 @@ The search behavior may be specified by prefixing field names in `search_fields` | `$` | `iregex` | Regex search. | | `@` | `search` | Full-text search (Currently only supported Django's [PostgreSQL backend][postgres-search]). | | None | `icontains` | Contains search (Default). | +| `&` | `unaccent` | Accent-insensitive search. (Currently only supported Django's [PostgreSQL backend][postgres-lookups]). | For example: @@ -370,3 +371,4 @@ The [djangorestframework-word-filter][django-rest-framework-word-search-filter] [HStoreField]: https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/fields/#hstorefield [JSONField]: https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/fields/#jsonfield [postgres-search]: https://docs.djangoproject.com/en/stable/ref/contrib/postgres/search/ +[postgres-lookups]: https://docs.djangoproject.com/en/stable/ref/contrib/postgres/lookups/#unaccent diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 435c30c88d..871d102776 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -68,6 +68,7 @@ class SearchFilter(BaseFilterBackend): '=': 'iexact', '@': 'search', '$': 'iregex', + '&': 'unaccent', } search_title = _('Search') search_description = _('A search term.') diff --git a/tests/test_filters.py b/tests/test_filters.py index 6db0c3deb2..1e49d08d53 100644 --- a/tests/test_filters.py +++ b/tests/test_filters.py @@ -10,7 +10,7 @@ from django.test.utils import override_settings from rest_framework import filters, generics, serializers -from rest_framework.compat import coreschema +from rest_framework.compat import coreschema, postgres_fields from rest_framework.exceptions import ValidationError from rest_framework.test import APIRequestFactory @@ -305,6 +305,25 @@ class SearchListView(generics.ListAPIView): ] +@pytest.mark.skipif(not postgres_fields, reason='psycopg2 is not installed') +class SearchPostgreSQLFilterTests(TestCase): + + def test_unaccent_search(self): + class SearchListView(generics.ListAPIView): + queryset = SearchFilterModel.objects.all() + serializer_class = SearchFilterSerializer + filter_backends = (filters.SearchFilter,) + search_fields = ('title', '&text') + + obj = SearchFilterModel.objects.create(title='Accent títle', text='Accent téxt') + view = SearchListView.as_view() + request = factory.get('/', {'search': 'accent text'}) + response = view(request) + assert response.data == [ + {'id': obj.id, 'title': 'Accent títle', 'text': 'Accent téxt'} + ] + + class AttributeModel(models.Model): label = models.CharField(max_length=32)