-
-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
112 additions
and
0 deletions.
There are no files selected for viewing
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 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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
# Tweepy | ||
# Copyright 2009-2022 Joshua Roesslein | ||
# See LICENSE for details. | ||
|
||
from math import inf | ||
|
||
|
||
class AsyncPaginator: | ||
""":class:`AsyncPaginator` can be used to paginate for any | ||
:class:`AsyncClient` methods that support pagination | ||
.. versionadded:: 4.11 | ||
Parameters | ||
---------- | ||
method | ||
:class:`AsyncClient` method to paginate for | ||
args | ||
Positional arguments to pass to ``method`` | ||
kwargs | ||
Keyword arguments to pass to ``method`` | ||
""" | ||
|
||
def __init__(self, method, *args, **kwargs): | ||
self.method = method | ||
self.args = args | ||
self.kwargs = kwargs | ||
|
||
def __aiter__(self): | ||
return AsyncPaginationIterator(self.method, *self.args, **self.kwargs) | ||
|
||
def __reversed__(self): | ||
return AsyncPaginationIterator( | ||
self.method, *self.args, reverse=True, **self.kwargs | ||
) | ||
|
||
async def flatten(self, limit=inf): | ||
"""Flatten paginated data | ||
Parameters | ||
---------- | ||
limit | ||
Maximum number of results to yield | ||
""" | ||
if limit <= 0: | ||
return | ||
|
||
count = 0 | ||
async for response in AsyncPaginationIterator( | ||
self.method, *self.args, **self.kwargs | ||
): | ||
if response.data is not None: | ||
for data in response.data: | ||
yield data | ||
count += 1 | ||
if count == limit: | ||
return | ||
|
||
|
||
class AsyncPaginationIterator: | ||
|
||
def __init__( | ||
self, method, *args, limit=inf, pagination_token=None, reverse=False, | ||
**kwargs | ||
): | ||
self.method = method | ||
self.args = args | ||
self.limit = limit | ||
self.kwargs = kwargs | ||
self.reverse = reverse | ||
|
||
if reverse: | ||
self.previous_token = pagination_token | ||
self.next_token = None | ||
else: | ||
self.previous_token = None | ||
self.next_token = pagination_token | ||
|
||
self.count = 0 | ||
|
||
def __aiter__(self): | ||
return self | ||
|
||
async def __anext__(self): | ||
if self.reverse: | ||
pagination_token = self.previous_token | ||
else: | ||
pagination_token = self.next_token | ||
|
||
if self.count >= self.limit or self.count and pagination_token is None: | ||
raise StopAsyncIteration | ||
|
||
# https://twittercommunity.com/t/why-does-timeline-use-pagination-token-while-search-uses-next-token/150963 | ||
if self.method.__name__ in ( | ||
"search_all_tweets", "search_recent_tweets", | ||
"get_all_tweets_count" | ||
): | ||
self.kwargs["next_token"] = pagination_token | ||
else: | ||
self.kwargs["pagination_token"] = pagination_token | ||
|
||
response = await self.method(*self.args, **self.kwargs) | ||
|
||
self.previous_token = response.meta.get("previous_token") | ||
self.next_token = response.meta.get("next_token") | ||
self.count += 1 | ||
|
||
return response |