Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SearchFilter.get_search_terms returns list. #9338

Merged
merged 1 commit into from
Mar 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions rest_framework/filters.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,19 @@ def search_smart_split(search_terms):
"""generator that first splits string by spaces, leaving quoted phrases together,
Copy link

Choose a reason for hiding this comment

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

Came from your haiku
Just to add 🐼 comment
Docstring needs fix

(“generator” -> Create list)

Copy link
Contributor

Choose a reason for hiding this comment

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

I'll put up a PR for it!

then it splits non-quoted phrases by commas.
"""
split_terms = []
for term in smart_split(search_terms):
# trim commas to avoid bad matching for quoted phrases
term = term.strip(',')
if term.startswith(('"', "'")) and term[0] == term[-1]:
# quoted phrases are kept together without any other split
yield unescape_string_literal(term)
split_terms.append(unescape_string_literal(term))
else:
# non-quoted tokens are split by comma, keeping only non-empty ones
yield from (sub_term.strip() for sub_term in term.split(',') if sub_term)
for sub_term in term.split(','):
if sub_term:
split_terms.append(sub_term.strip())
return split_terms


class BaseFilterBackend:
Expand Down Expand Up @@ -85,7 +89,8 @@ def get_search_terms(self, request):
"""
value = request.query_params.get(self.search_param, '')
field = CharField(trim_whitespace=False, allow_blank=True)
return field.run_validation(value)
cleaned_value = field.run_validation(value)
return search_smart_split(cleaned_value)
Copy link
Contributor

Choose a reason for hiding this comment

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

This could have been done by simply changing to

return list(search_smart_split(cleaned_value))

There is no point to changing the return value and definition of search_smart_split.


def construct_search(self, field_name, queryset):
lookup = self.lookup_prefixes.get(field_name[0])
Expand Down Expand Up @@ -163,7 +168,7 @@ def filter_queryset(self, request, queryset, view):
reduce(
operator.or_,
(models.Q(**{orm_lookup: term}) for orm_lookup in orm_lookups)
) for term in search_smart_split(search_terms)
) for term in search_terms
)
queryset = queryset.filter(reduce(operator.and_, conditions))

Expand Down
Loading