Skip to content

feat: search-a-licious integration to the Python SDK #326

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

Closed
hahacen wants to merge 2 commits into from
Closed

feat: search-a-licious integration to the Python SDK #326

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67e35e8
Add folksonomy tagging support with tests
hahacen Apr 25, 2025
0422e4e
Add search_advanced method for advanced search
hahacen Apr 25, 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
15 changes: 15 additions & 0 deletions openfoodfacts/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,21 @@ def __init__(
self.facet = FacetResource(self.api_config)
self.robotoff = RobotoffResource(self.api_config)

def search_advanced(self, query: str, filters: dict = None, page: int = 1):
Copy link
Copy Markdown
Contributor

@raphael0202 raphael0202 May 21, 2025

Choose a reason for hiding this comment

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

Invalid type for filters parameter here:

Suggested change
def search_advanced(self, query: str, filters: dict = None, page: int = 1):
def search_advanced(self, query: str, filters: Optional[dict] = None, page: int = 1):

"""Advanced product search using Search-a-licious endpoint."""
filters = filters or {}
params = {"search_terms": query, "page": page, **filters}
Copy link
Copy Markdown
Contributor

@raphael0202 raphael0202 May 21, 2025

Choose a reason for hiding this comment

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

The search terms should be provided using the q parameter, see the search-a-licious documentation here: https://search.openfoodfacts.org/docs#/default/search_get_search_get

url = f"{self.product.base_url}/cgi/search.pl"
Copy link
Copy Markdown
Contributor

@raphael0202 raphael0202 May 21, 2025

Choose a reason for hiding this comment

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

This is not search-a-licious endpoint, https://search.openfoodfacts.org/search is the right one

response = send_get_request(
url=url,
api_config=self.api_config,
params=params,
auth=get_http_auth(self.api_config.environment),
)
if response is None:
return {}
return response


def parse_ingredients(text: str, lang: str, api_config: APIConfig) -> list[JSONType]:
"""Parse ingredients text using Product Opener API.
Expand Down
Loading