suggest

gurume.suggest

Area and keyword suggestion helpers.

AreaSuggestion dataclass

AreaSuggestion(
    name: str,
    datatype: str,
    id_in_datatype: int,
    lat: float | None = None,
    lng: float | None = None,
)

Area suggestion.

KeywordSuggestion dataclass

KeywordSuggestion(
    name: str,
    datatype: str,
    id_in_datatype: int | str,
    lat: float | None = None,
    lng: float | None = None,
)

Keyword suggestion.

TabelogSuggestUnavailableError

Bases: RuntimeError

Raised when Tabelog's suggest API returns no data (upstream endpoint change).

get_area_suggestions

get_area_suggestions(
    query: str, timeout: float = 10.0
) -> list[AreaSuggestion]

Get area suggestions.

Source code in src/gurume/suggest.py

def get_area_suggestions(query: str, timeout: float = 10.0) -> list[AreaSuggestion]:
    """Get area suggestions."""
    return _parse_area_suggestions(_fetch_suggestion_data("sa", query, timeout))

get_area_suggestions_async async

get_area_suggestions_async(
    query: str, request_timeout: float = 10.0
) -> list[AreaSuggestion]

Get area suggestions asynchronously.

Source code in src/gurume/suggest.py

async def get_area_suggestions_async(query: str, request_timeout: float = 10.0) -> list[AreaSuggestion]:
    """Get area suggestions asynchronously."""
    data = await _fetch_suggestion_data_async("sa", query, request_timeout)
    return _parse_area_suggestions(data)

get_keyword_suggestions

get_keyword_suggestions(
    query: str, timeout: float = 10.0
) -> list[KeywordSuggestion]

Get keyword suggestions.

Source code in src/gurume/suggest.py

def get_keyword_suggestions(query: str, timeout: float = 10.0) -> list[KeywordSuggestion]:
    """Get keyword suggestions."""
    return _parse_keyword_suggestions(_fetch_suggestion_data("sk", query, timeout))

get_keyword_suggestions_async async

get_keyword_suggestions_async(
    query: str, request_timeout: float = 10.0
) -> list[KeywordSuggestion]

Get keyword suggestions asynchronously.

Source code in src/gurume/suggest.py

async def get_keyword_suggestions_async(query: str, request_timeout: float = 10.0) -> list[KeywordSuggestion]:
    """Get keyword suggestions asynchronously."""
    data = await _fetch_suggestion_data_async("sk", query, request_timeout)
    return _parse_keyword_suggestions(data)