tilebox-grpc 0.35.0__py3-none-any.whl → 0.36.1__py3-none-any.whl

_tilebox/grpc/aio/pagination.py

@@ -0,0 +1,29 @@
+from collections.abc import AsyncIterator, Awaitable, Callable
+
+from _tilebox.grpc.pagination import AnyResultPage, Pagination
+
+
+async def paginated_request(
+    paging_request: Callable[[Pagination], Awaitable[AnyResultPage]],
+    initial_page: Pagination,
+) -> AsyncIterator[AnyResultPage]:
+    """Make a paginated request to a gRPC service endpoint.
+
+    The endpoint is expected to return a next_page field, which is used for subsequent requests. Once no such
+    next_page field is returned, the request is completed.
+
+    Args:
+        paging_request: A function that takes a page as input and returns a Datapoints object
+            Often this will be a functools.partial object that wraps a gRPC service endpoint
+            and only leaves the page argument remaining
+        initial_page: The initial page to request
+
+    Yields:
+        Datapoints: The individual pages of the response
+    """
+    response = await paging_request(initial_page)
+    yield response
+
+    while response.next_page.starting_after is not None:
+        response = await paging_request(response.next_page)
+        yield response

_tilebox/grpc/pagination.py

@@ -0,0 +1,42 @@
+from collections.abc import Callable, Iterator
+from typing import Protocol, TypeVar
+from uuid import UUID
+
+
+class Pagination(Protocol):
+    limit: int | None
+    starting_after: UUID | None
+
+
+class ResultPage(Protocol):
+    @property
+    def next_page(self) -> Pagination: ...
+
+
+AnyResultPage = TypeVar("AnyResultPage", bound=ResultPage)
+
+
+def paginated_request(
+    paging_request: Callable[[Pagination], AnyResultPage],
+    initial_page: Pagination,
+) -> Iterator[AnyResultPage]:
+    """Make a paginated request to a gRPC service endpoint.
+
+    The endpoint is expected to return a next_page field, which is used for subsequent requests. Once no such
+    next_page field is returned, the request is completed.
+
+    Args:
+        paging_request: A function that takes a page as input and returns a Datapoints object
+            Often this will be a functools.partial object that wraps a gRPC service endpoint
+            and only leaves the page argument remaining
+        initial_page: The initial page to request
+
+    Yields:
+        Datapoints: The individual pages of the response
+    """
+    response = paging_request(initial_page)
+    yield response
+
+    while response.next_page.starting_after is not None:
+        response = paging_request(response.next_page)
+        yield response

{tilebox_grpc-0.35.0.dist-info → tilebox_grpc-0.36.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tilebox-grpc
-Version: 0.35.0
+Version: 0.36.1
 Summary: GRPC / Protocol Buffers functions for Tilebox
 Project-URL: Homepage, https://tilebox.com
 Project-URL: Documentation, https://docs.tilebox.com/

{tilebox_grpc-0.35.0.dist-info → tilebox_grpc-0.36.1.dist-info}/RECORD

@@ -1,13 +1,15 @@
 _tilebox/grpc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 _tilebox/grpc/channel.py,sha256=2uBAHcmKdGCzqVHhTsISAVirI9bQxXNfbC4GGM6RyHM,5332
 _tilebox/grpc/error.py,sha256=QVfLuvitYLlhWENE98zdb4m9gx0PGMsR6m1_prwkwj4,3598
+_tilebox/grpc/pagination.py,sha256=-KhkhQ_0IE-BgzjNAmkPac7fH55ZGICstaqRhCLvHGE,1292
 _tilebox/grpc/producer_consumer.py,sha256=NG6gUCcvYOGbplV1Vq9bFro-4cNpTHvT7eL4zlNDkkA,2154
 _tilebox/grpc/replay.py,sha256=_NC76BfmvazNrJI5MovSnPTC7kYwWZn3Au_0yPlOLsc,6006
 _tilebox/grpc/aio/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 _tilebox/grpc/aio/channel.py,sha256=KPmMTDDW0WGCO1ZKQ7NBauE1M7NK5FxuAa2HCMYc-r8,2317
 _tilebox/grpc/aio/error.py,sha256=Lkf20vuQn9XaLj0MlQ1uqHRaenhYJ_P3rggNZyDMML8,1222
+_tilebox/grpc/aio/pagination.py,sha256=6v95yqgC-m87kD96pjfpIsmY41YuxxR0Se1o3NTrkSs,1115
 _tilebox/grpc/aio/producer_consumer.py,sha256=aOZhZHD74GZEvfeZ9OzUsVk5uUIuuMQp1V7l3Y1PQ0w,2679
 _tilebox/grpc/aio/syncify.py,sha256=jhScVqEwsoNP6gLwJpnIIaBqMC3q4XqSkEfIPokYG8c,4035
-tilebox_grpc-0.35.0.dist-info/METADATA,sha256=nNM3uXJUsWrpPp2vH7fWqEw2GxM34GMAKwdh5i6KLHs,2323
-tilebox_grpc-0.35.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-tilebox_grpc-0.35.0.dist-info/RECORD,,
+tilebox_grpc-0.36.1.dist-info/METADATA,sha256=cevm7Kk4WIhrX7MRy4fwLvdrRSlqCa4tN5DbZGeeW_o,2323
+tilebox_grpc-0.36.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+tilebox_grpc-0.36.1.dist-info/RECORD,,