Skip to content

enforce exact max results in search_entities #907

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.

Sign up for GitHub

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

Open
combinatorist wants to merge 2 commits into
base: master
Choose a base branch
from
Open

enforce exact max results in search_entities #907

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6e48e9
enforce exact max results in search_entities
combinatorist Sep 17, 2025
49e655d
Annotate params variable with type hint
LeMyst Sep 18, 2025
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
6 changes: 3 additions & 3 deletions wikibaseintegrator/wbi_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,12 +439,11 @@ def search_entities(search_string: str, language: str | None = None, strict_lang

language = str(language or config['DEFAULT_LANGUAGE'])

params = {
params: dict[str, str | int] = {
'action': 'wbsearchentities',
'search': search_string,
'language': language,
'type': search_type,
'limit': 50,
'format': 'json'
}

Expand All @@ -455,7 +454,8 @@ def search_entities(search_string: str, language: str | None = None, strict_lang
results = []

while True:
params.update({'continue': cont_count})
max_page_results = min(50, max_results - cont_count)
params.update({'continue': cont_count, 'limit': max_page_results})
Copy link
Contributor Author

@combinatorist combinatorist Sep 17, 2025

Choose a reason for hiding this comment

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

More than open to style and logic suggestions.

Copy link
Contributor Author

@combinatorist combinatorist Sep 17, 2025

Choose a reason for hiding this comment

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

BTW, it seems we could move the cont_count < max_results criteria into the While condition above (and save 3 lines at the bottom of the function).

Comment on lines +457 to +458
Copy link

Copilot AI Sep 19, 2025

Choose a reason for hiding this comment

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

The calculation max_results - cont_count can result in negative or zero values when cont_count >= max_results, which would cause max_page_results to be 0 or negative. This could lead to API errors or infinite loops. Add a check to break the loop when cont_count >= max_results before calculating max_page_results.

Copilot uses AI. Check for mistakes.

search_results = mediawiki_api_call_helper(data=params, allow_anonymous=allow_anonymous, **kwargs)

Expand Down
Loading