encode/django-rest-frameworkPublic

NotificationsYou must be signed in to change notification settings
Fork7k
Star29.8k

Add`unaccent` to`SearchFilter`#9385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

mgaligniana wants to merge1 commit intoencode:main

base:main

Choose a base branch

frommgaligniana:add-unaccent-to-search-filter

Open

Add`unaccent` to`SearchFilter`#9385

mgaligniana wants to merge1 commit intoencode:mainfrommgaligniana:add-unaccent-to-search-filter

Conversation

Copy link

Contributor

mgaligniana commentedApr 15, 2024•
edited
Loading

Description

Based on discussion#7759 I've created this PR to continue the work made in#8775 and#7733

There are no tests with PostgreSQL but I'm creating this to test with the CI

mgaligniana force-pushed theadd-unaccent-to-search-filter branch from3a71f9b tof8825baCompare

April 15, 2024 14:10

mgaligniana changed the title~~Addunaccent toSearchFilter (based on #7733)~~Addunaccent toSearchFilter

Apr 15, 2024

mgaligniana force-pushed theadd-unaccent-to-search-filter branch fromf8825ba to2ff3f77Compare

April 15, 2024 14:15

mgaligniana marked this pull request as draft

April 15, 2024 14:20

mgaligniana force-pushed theadd-unaccent-to-search-filter branch from2ff3f77 toa2bb1fbCompare

April 15, 2024 18:55

Copy link

ContributorAuthor

mgaligniana commentedApr 15, 2024•
edited
Loading

Hi@auvipy!

In case I would like to add a postgres db creation step, to be able to add new tests: should I add a step here.github/workflows/main.yml?

Copy link

ContributorAuthor

mgaligniana commentedMay 27, 2024•
edited
Loading

I move this PR toReady for review as the work is done but I need confirmation on how to add (or if it worth it) a step using PostgreSQL to be able to test it.

Thank you!

mgaligniana marked this pull request as ready for review

May 27, 2024 15:49

Copy link

jensjeflensje commentedAug 29, 2024

Tried this locally and the unaccent works great. It got me thinking though: anyone usingunaccent is probably not interested in a full match either? The current code limitsicontains from being used too alongside unaccent. I personally set my lookup prefix to"&": "unaccent__icontains" as that better fits my (and probably also other people's) usecases.

mgaligniana force-pushed theadd-unaccent-to-search-filter branch froma2bb1fb tof195decCompare

August 29, 2024 18:16

Copy link

stalebot commentedApr 26, 2025

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stalebot added the stale label

Apr 26, 2025

auvipy requested a review fromCopilot

April 27, 2025 07:56

CopilotAI reviewed

Apr 27, 2025

View reviewed changes

Copy link

CopilotAI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Pull Request Overview

This PR adds unaccent support to the SearchFilter, enabling accent‐insensitive searches on PostgreSQL by mapping the "&" prefix to the "unaccent" lookup.

Updates the lookup prefixes in the SearchFilter backend
Introduces a PostgreSQL‑specific test for unaccent search
Updates the API documentation to include the new lookup operator

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
tests/test_filters.py	Added a new test class that verifies unaccent search functionality
rest_framework/filters.py	Updated lookup prefixes to include the unaccent operator
docs/api-guide/filtering.md	Added new documentation row for accent‑insensitive unaccent search lookup

tests/test_filters.py OutdatedShow resolvedHide resolved

stalebot removed the stale label

Apr 27, 2025

auvipy reviewed

Apr 27, 2025

View reviewed changes

Copy link

Collaborator

auvipy left a comment•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

test is failing with following error

raise FieldError(
E django.core.exceptions.FieldError: Unsupported lookup 'unaccent' for CharField or join on the field not permitted.

Copy link

stalebot commentedJul 19, 2025

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Copy link

ContributorAuthor

mgaligniana commentedJul 26, 2025•
edited
Loading

test is failing with following error
raise FieldError( E django.core.exceptions.FieldError: Unsupported lookup 'unaccent' for CharField or join on the field not permitted.

Yes!

But is because the test is not being run over a PostgreSQL database, right?

I've tried adding this@pytest.mark.skipif(not postgres_fields, reason='PostgreSQL support (postgres_fields) is not available') to see if it is skiped by the CI, but nope! Any suggesiton?