Skip to content

Add limit parameter to search()/search_v2() #445

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
Vitexus wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add limit parameter to search()/search_v2() #445

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 14 additions & 10 deletions mastodon/search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ def __ensure_search_params_acceptable(self, account_id, offset, min_id, max_id):
raise MastodonVersionError("Advanced search parameters require Mastodon 2.8.0+")

@api_version("1.1.0", "2.8.0")
def search(self, q: str, resolve: bool = True, result_type: Optional[str] = None,
account_id: Optional[Union[Account, IdType]] = None, offset: Optional[int] = None,
min_id: Optional[IdType] = None, max_id: Optional[IdType] = None,
exclude_unreviewed: bool = True) -> Union[Search, SearchV2]:
def search(self, q: str, resolve: bool = True, result_type: Optional[str] = None,
account_id: Optional[Union[Account, IdType]] = None, offset: Optional[int] = None,
min_id: Optional[IdType] = None, max_id: Optional[IdType] = None,
exclude_unreviewed: bool = True, limit: Optional[int] = None) -> Union[Search, SearchV2]:
"""
Fetch matching hashtags, accounts and statuses. Will perform webfinger
lookups if resolve is True. Full-text search is only enabled if
Expand All @@ -42,14 +42,18 @@ def search(self, q: str, resolve: bool = True, result_type: Optional[str] = None
those that have been reviewed by moderators. It is on by default. When using the
v1 search API (pre 2.4.1), it is ignored.

`limit` caps the number of results returned per category (accounts, statuses
and hashtags). It is only forwarded to the server when using the v2 search API
(pre 2.4.1 does not support it and it is silently ignored on search_v1).

Will use search_v1 (no tags in return values) on Mastodon versions before
2.4.1), search_v2 otherwise. Parameters other than resolve are only available
on Mastodon 2.8.0 or above - this function will throw a MastodonVersionError
if you try to use them on versions before that. Note that the cached version
number will be used for this to avoid uneccesary requests.
"""
if self.verify_minimum_version("2.4.1", cached=True):
return self.search_v2(q, resolve=resolve, result_type=result_type, account_id=account_id, offset=offset, min_id=min_id, max_id=max_id, exclude_unreviewed=exclude_unreviewed)
return self.search_v2(q, resolve=resolve, result_type=result_type, account_id=account_id, offset=offset, min_id=min_id, max_id=max_id, exclude_unreviewed=exclude_unreviewed, limit=limit)
else:
self.__ensure_search_params_acceptable(account_id, offset, min_id, max_id)
return self.search_v1(q, resolve=resolve)
Expand All @@ -68,12 +72,12 @@ def search_v1(self, q: str, resolve: bool = False) -> Search:
return self.__api_request('GET', '/api/v1/search', params)

@api_version("2.4.1", "2.8.0")
def search_v2(self, q, resolve: bool = True, result_type: Optional[str] = None,
account_id: Optional[Union[Account, IdType]] = None, offset: Optional[int] = None,
min_id: Optional[IdType] = None, max_id: Optional[IdType] = None,
exclude_unreviewed: bool = True) -> SearchV2:
def search_v2(self, q, resolve: bool = True, result_type: Optional[str] = None,
account_id: Optional[Union[Account, IdType]] = None, offset: Optional[int] = None,
min_id: Optional[IdType] = None, max_id: Optional[IdType] = None,
exclude_unreviewed: bool = True, limit: Optional[int] = None) -> SearchV2:
"""
Identical to `search_v1()`, except in that it returns tags as objects,
Identical to `search_v1()`, except in that it returns tags as objects,
has more parameters, and resolves by default.

For more details documentation, please see `search()`
Expand Down