Added support for search_regex_function #94
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
This can be used to generate regex to limit the search query to
substring within the menu entries.
e.g.
A menu entries may be defined as
[
" 1 : menu A : 2024/09/18",
" 2 : menu B : 2024/09/17",
" 3 : menu C : 2024/09/19",
...
"10 : menu J : 2023/09/10"
]
If I want to limit the search to just the serial number, I can change
the search string '2' to regex '^2', so that it does not match '2'024.
For this, I can provide an optional parameter search_regex_function
defined as:
def my_search_regex_function(text):
if re.match('[0-9][0-9]*$', text) and int(text) < len(menu_items):
text = f'^ *{text}(?= : )'
return re.compile(text, flags=re.IGNORECASE)
With above function, 2 will only match menu B. 2024 will match all menu entries.
The function itself can be customized for individual requirements.
The search regex functionality had a logic to highlight the pattern. With the search_regex_function logic the highlight functionality was getting lost, because we used additional anchors like ^/$/lookahead/lookbehind, etc. So, this change limits the custom function to filtering logic, while keeping the original logic for highlighting.
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.
This can be used to generate regex to limit the search query to a substring within the menu entries.
e.g.
Menu entries may be defined as
If I want to limit the search to just the serial number, I can change the search string '2' to regex '^2', so that it does not match 2024.
For this, I can provide an optional parameter search_regex_function defined as:
With the above function, 2 will only match menu B. 2024 will match all menu entries. The function itself can be customized for individual requirements.