feat: paginationをやるためのクラスを追加

mipac/utils/pagination.py

@@ -0,0 +1,61 @@
+from typing import Any, Generic, Literal, TypeVar
+from mipac.http import HTTPClient, Route
+
+T = TypeVar('T')
+
+
+class Pagination(Generic[T]):
+    def __init__(
+        self,
+        http_client: HTTPClient,
+        route: Route,
+        json: dict[str, Any],
+        auth: bool = True,
+        remove_none: bool = True,
+        lower: bool = True,
+        pagination_type: Literal['until', 'count'] = 'until',
+        can_use_limit: bool = True,
+        limit: int = 100,
+        max_limit: int = 100,
+    ) -> None:
+        self.http_client: HTTPClient = http_client
+        self.route: Route = route
+        self.json: dict[str, Any] = json
+        self.auth: bool = auth
+        self.remove_none: bool = remove_none
+        self.lower: bool = lower
+        self.pagination_type: Literal['until', 'count'] = pagination_type
+        self.can_use_limit: bool = can_use_limit
+        self.limit: int = limit
+        self.max_limit: int = max_limit
+        self.count = 0
+        self.latest_res: list[Any] = []
+
+    async def next(self) -> list[T]:
+        if self.pagination_type == 'count':
+            self.json['offset'] = self.json.get('limit', self.limit) * self.count
+            self.count += 1
+        res: list[T] = await self.http_client.request(
+            self.route,
+            auth=self.auth,
+            remove_none=self.remove_none,
+            lower=self.lower,
+            json=self.json,
+        )
+        if self.pagination_type == 'until':
+            self.json['untilId'] = res[-1]['id']  # type: ignore
+        self.latest_res = res
+        return res
+
+    @property
+    def is_final(self) -> bool:
+        if (
+            self.pagination_type == 'count'
+            and len(self.latest_res) == 0
+            or len(self.latest_res) < self.max_limit
+        ):
+            return True
+        if self.pagination_type == 'until' and len(self.latest_res) == 0:
+            return True
+        return False
+