SearchFilter.get_search_terms returns list.
#9338
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merged
yuwash
reviewed
Mar 22, 2024
| @@ -24,15 +24,19 @@ def search_smart_split(search_terms): | |||
| """generator that first splits string by spaces, leaving quoted phrases together, | |||
There was a problem hiding this comment.
Came from your haiku
Just to add 🐼 comment
Docstring needs fix
(“generator” -> Create list)
sevdog
reviewed
Mar 22, 2024
| @@ -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) | |||
There was a problem hiding this comment.
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.
|
PS: an anti-regression test should be implemented to avoid this, since both older and new versions passed the same tests without any failure. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#9017 unintentionally treated
SearchFilter.get_search_termsas a private method, changing its signature from a list of strings, to a string.This pull request reverts that change, by pulling the
"search_smart_split"inside the method, ensuring that search terms are correctly tokenised by"quoted strings like this"andcomma,sperated,strings,like,this.Closes #9308