Make paginators awaitable

Shorter way to flatten an iterator.

README.md

@@ -64,5 +64,3 @@ Please also edit the documentation accordingly. You may see how the final docume
 pip install genshin[doc]
 mkdocs serve
 ```
-
-**I am currently looking for any chinese mainland players who could share their `account_id` and `cookie_token` cookies to allow for testing of chinese endpoints.**

genshin/paginator.py

@@ -1,6 +1,7 @@
 """Paginators for abstracting paginated resources"""
 from __future__ import annotations
 
+import abc
 import asyncio
 import heapq
 from datetime import datetime
@@ -33,7 +34,30 @@ class _Model(Protocol):
 TransactionT = TypeVar("TransactionT", bound=BaseTransaction, covariant=True)
 
 
-class DailyRewardPaginator:
+class BasePaginator(abc.ABC):
+    """A base paginator requiring the implementation of some methods"""
+
+    @property
+    @abc.abstractmethod
+    def exhausted(self) -> bool:
+        ...
+
+    @abc.abstractmethod
+    async def next_page(self) -> Any:
+        ...
+
+    @abc.abstractmethod
+    def __aiter__(self) -> AsyncIterator[Any]:
+        ...
+
+    async def flatten(self) -> Sequence[Any]:
+        return [item async for item in self]
+
+    def __await__(self) -> Generator[Any, Any, Sequence[Any]]:
+        return self.flatten().__await__()
+
+
+class DailyRewardPaginator(BasePaginator):
     """A paginator specifically for claimed daily rewards"""
 
     client: GenshinClient
@@ -94,12 +118,6 @@ def __aiter__(self) -> AsyncIterator[ClaimedDailyReward]:
         """Iterate over all pages unril the limit is reached"""
         return aislice(self._iter(), self.limit)
 
-    async def flatten(self) -> List[ClaimedDailyReward]:
-        """Flatten the entire iterator into a list"""
-        # sending more than 1 request at once causes a ratelimit
-        # that means no posible greedy flatten implementation
-        return [item async for item in self]
-
 
 class ChineseDailyRewardPaginator(DailyRewardPaginator):
     """A paginator specifically for claimed daily rewards on chinese bbs"""
@@ -128,7 +146,7 @@ async def _get_page(self, page: int) -> List[ClaimedDailyReward]:
         return [ClaimedDailyReward(**i) for i in data["list"]]
 
 
-class DiaryPaginator:
+class DiaryPaginator(BasePaginator):
     """A paginator specifically for diary entries"""
 
     # TODO: Option to merge all months together
@@ -216,12 +234,6 @@ def __aiter__(self) -> AsyncIterator[DiaryAction]:
         """Iterate over all pages unril the limit is reached"""
         return aislice(self._iter(), self.limit)
 
-    async def flatten(self) -> List[DiaryAction]:
-        """Flatten the entire iterator into a list"""
-        # sending more than 1 request at once causes a ratelimit
-        # that means no posible greedy flatten implementation
-        return [item async for item in self]
-
     @property
     def data(self) -> BaseDiary:
         """Get data bound to the diary
@@ -234,7 +246,7 @@ def data(self) -> BaseDiary:
         return self._data
 
 
-class IDPagintor(Generic[MT]):
+class IDPagintor(BasePaginator, Generic[MT]):
     """A paginator of genshin end_id pages"""
 
     __repr_args__: Sequence[str] = ["limit"]