devrev-Python-SDK 3.0.0__py3-none-any.whl → 3.0.1__py3-none-any.whl

devrev/services/_pagination.py

@@ -0,0 +1,54 @@
+"""Shared pagination helpers for cursor-streaming list helpers.
+
+The DevRev ``*.list`` endpoints cap per-page responses at 100 items and the
+corresponding ``*ListRequest.limit`` fields are pydantic-constrained to
+``le=100``. Any service that drives cursor pagination from a user-supplied
+``overall_limit`` / ``page_size`` pair must therefore clamp the value it puts
+on the request body before construction, or the request will fail validation
+locally before it is ever sent.
+
+:func:`resolve_page_limit` centralises that clamping so every ``list_*_since``
+helper resolves the per-page ``limit`` identically.
+"""
+
+from __future__ import annotations
+
+from typing import Final
+
+_MAX_PAGE: Final[int] = 100
+
+
+def resolve_page_limit(
+    overall_limit: int | None,
+    collected: int,
+    page_size: int | None,
+) -> int | None:
+    """Compute the ``limit`` to send for the next page request.
+
+    The returned value is always clamped to :data:`_MAX_PAGE` so callers using
+    an ``overall_limit`` greater than the server maximum (e.g. ``limit=200,
+    page_size=None``) still paginate correctly. When both ``overall_limit`` and
+    ``page_size`` are supplied the tightest of ``{page_size, remaining,
+    _MAX_PAGE}`` wins.
+
+    Args:
+        overall_limit: Caller-supplied hard cap on total items to return across
+            all pages, or ``None`` to stream until the server runs out of
+            results.
+        collected: Number of items already accumulated across prior pages.
+        page_size: Caller-supplied per-page size, or ``None`` to defer to the
+            server default (still clamped to :data:`_MAX_PAGE`).
+
+    Returns:
+        The ``limit`` to put on the next ``*ListRequest``, or ``None`` to omit
+        it entirely (only when both ``overall_limit`` and ``page_size`` are
+        ``None``).
+    """
+    if overall_limit is None:
+        if page_size is None:
+            return None
+        return min(page_size, _MAX_PAGE)
+    remaining = overall_limit - collected
+    if page_size is None:
+        return min(remaining, _MAX_PAGE)
+    return min(page_size, remaining, _MAX_PAGE)

devrev/services/conversations.py

@@ -23,6 +23,7 @@ from devrev.models.conversations import (
     ConversationsUpdateRequest,
     ConversationsUpdateResponse,
 )
+from devrev.services._pagination import resolve_page_limit
 from devrev.services.base import AsyncBaseService, BaseService
 
 
@@ -47,33 +48,6 @@ def _normalize_sort_by(sort_by: Sequence[str] | None) -> list[str] | None:
     return normalized
 
 
-# ``ConversationsListRequest.limit`` is pydantic-constrained to ``le=100``;
-# clamp any computed per-page limit so pagination loops do not construct a
-# request body that fails validation before it is ever sent.
-_CONVERSATIONS_MAX_PAGE = 100
-
-
-def _resolve_page_limit(
-    overall_limit: int | None,
-    collected: int,
-    page_size: int | None,
-) -> int | None:
-    """Compute the ``limit`` to send for the next page request.
-
-    The returned value is always clamped to ``_CONVERSATIONS_MAX_PAGE`` so
-    callers using an ``overall_limit`` greater than the server maximum (e.g.
-    ``limit=200, page_size=None``) still paginate correctly.
-    """
-    if overall_limit is None:
-        if page_size is None:
-            return None
-        return min(page_size, _CONVERSATIONS_MAX_PAGE)
-    remaining = overall_limit - collected
-    if page_size is None:
-        return min(remaining, _CONVERSATIONS_MAX_PAGE)
-    return min(page_size, remaining, _CONVERSATIONS_MAX_PAGE)
-
-
 def _is_before_cutoff(modified_date: datetime | None, cutoff: datetime) -> bool:
     """Return True if ``modified_date`` is strictly older than ``cutoff``.
 
@@ -135,7 +109,7 @@ class ConversationsService(BaseService):
         while True:
             if limit is not None and len(results) >= limit:
                 break
-            request_limit = _resolve_page_limit(limit, len(results), page_size)
+            request_limit = resolve_page_limit(limit, len(results), page_size)
             request = ConversationsListRequest(
                 cursor=cursor,
                 limit=request_limit,
@@ -267,7 +241,7 @@ class AsyncConversationsService(AsyncBaseService):
         while True:
             if limit is not None and len(results) >= limit:
                 break
-            request_limit = _resolve_page_limit(limit, len(results), page_size)
+            request_limit = resolve_page_limit(limit, len(results), page_size)
             request = ConversationsListRequest(
                 cursor=cursor,
                 limit=request_limit,

devrev/services/works.py

@@ -31,6 +31,7 @@ from devrev.models.works import (
     WorksUpdateResponse,
     WorkType,
 )
+from devrev.services._pagination import resolve_page_limit
 from devrev.services.base import AsyncBaseService, BaseService
 
 if TYPE_CHECKING:
@@ -58,31 +59,6 @@ def _is_before_cutoff(timestamp: datetime | None, cutoff: datetime) -> bool:
         return False
 
 
-# ``WorksListRequest.limit`` is pydantic-constrained to ``le=100``; clamp any
-# computed per-page limit so pagination loops do not construct a request body
-# that fails validation before it is ever sent.
-_WORKS_MAX_PAGE = 100
-
-
-def _resolve_page_limit(
-    overall_limit: int | None,
-    collected: int,
-    page_size: int | None,
-) -> int | None:
-    """Compute the ``limit`` to send for the next page request.
-
-    The returned value is always clamped to ``_WORKS_MAX_PAGE`` so callers using
-    an ``overall_limit`` greater than the server maximum (e.g. ``limit=200,
-    page_size=None``) still paginate correctly.
-    """
-    if page_size is not None:
-        return min(page_size, _WORKS_MAX_PAGE)
-    if overall_limit is None:
-        return None
-    remaining = overall_limit - collected
-    return min(remaining, _WORKS_MAX_PAGE)
-
-
 def _normalize_sort_by(sort_by: Sequence[str] | None) -> _StrList | None:
     """Normalize sort_by entries to the server-expected ``field:direction`` form.
 
@@ -351,7 +327,7 @@ class WorksService(BaseService):
                 owned_by=owned_by,
                 applies_to_part=applies_to_part,
                 cursor=cursor,
-                limit=_resolve_page_limit(limit, len(collected), page_size),
+                limit=resolve_page_limit(limit, len(collected), page_size),
                 sort_by=sort_by,
             )
             stop = False
@@ -577,7 +553,7 @@ class AsyncWorksService(AsyncBaseService):
                 owned_by=owned_by,
                 applies_to_part=applies_to_part,
                 cursor=cursor,
-                limit=_resolve_page_limit(limit, len(collected), page_size),
+                limit=resolve_page_limit(limit, len(collected), page_size),
                 sort_by=sort_by,
             )
             stop = False

{devrev_python_sdk-3.0.0.dist-info → devrev_python_sdk-3.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devrev-Python-SDK
-Version: 3.0.0
+Version: 3.0.1
 Summary: A modern, type-safe Python SDK for the DevRev API
 Project-URL: Homepage, https://github.com/mgmonteleone/py-dev-rev
 Project-URL: Documentation, https://github.com/mgmonteleone/py-dev-rev

{devrev_python_sdk-3.0.0.dist-info → devrev_python_sdk-3.0.1.dist-info}/RECORD

@@ -36,13 +36,14 @@ devrev/models/webhooks.py,sha256=DzrLJiW1GYWvfaB-aVPcYCf4XkEGHz3dkyzbBKKdhFI,365
 devrev/models/widgets.py,sha256=7WWN17_ySqnu1pjYSIS5B8J5dEaqkoB8X8GWzvI0ZYc,4577
 devrev/models/works.py,sha256=sHZ_eJ6eCadWxPkM6HGcmbkiGRDYT2RnH3QZRO4T3tY,11198
 devrev/services/__init__.py,sha256=LWy_0xGNH692d6Wc4S4E9v6AoxjgfExFMzFmbrL2NTY,3975
+devrev/services/_pagination.py,sha256=J6AXu1P3iNRyC8_nH709Z8nOLhHeSctOLRmY_eYI6QA,2100
 devrev/services/accounts.py,sha256=X7FgcODex0XKLiV_VvXKDl2Jm8XsNpn9qp40oRjZqME,9704
 devrev/services/articles.py,sha256=xOpJOG9f29a5W3IFROplL1a9eJdGucbUFkK-MAIIYlc,41637
 devrev/services/artifacts.py,sha256=SJzIi5M4np0ENoOTTGEAcoqoRFMVd8pe-BCo9vvhYzk,14124
 devrev/services/base.py,sha256=pzUOkOA0kc7yxQQS8AP65L-inpW1WxpsYwtZwA_LXk4,7174
 devrev/services/brands.py,sha256=W6FB9XXTtEzGOfm9IBI6dqY8WXrMeH6urwjiZKrDVgI,5679
 devrev/services/code_changes.py,sha256=ahDniXCz54GGmTFmNh88heUg0mHQcIAgaqwlqm1CP6E,3199
-devrev/services/conversations.py,sha256=Kx1pOyBc1Wkk32PmPhjXlM2KnLlLuN5Ydzrm9y5iJhM,13635
+devrev/services/conversations.py,sha256=Xw8hDZuwte57fH2Z3D19gd5nrm91OURcWkBrKAcbqAQ,12716
 devrev/services/dev_users.py,sha256=YDJUNk6Crz2TN_uwkWQIBmztIYrLd8EX3toNLdb_HEk,11870
 devrev/services/engagements.py,sha256=nT6AElHbFO40utp6R_QCGwTGunXjVci73I8YAtkqu8A,9094
 devrev/services/groups.py,sha256=0VpOKTwHiRjrKXrO1kdHo8V_z2I02GphYQhyDFnImxg,4960
@@ -62,7 +63,7 @@ devrev/services/timeline_entries.py,sha256=6nbVPcWlE3-ohLhvkM421eqYS5ztKtHmGsPek
 devrev/services/track_events.py,sha256=lI4wXkWu3uUuXtuRg1MGNkTZ7B0Lc1PjM8Kw-6sUnWc,1439
 devrev/services/uoms.py,sha256=AA3ymoHj24FIbsZpYC4tg2elSdQ3iINTVOz7MraZcj8,8163
 devrev/services/webhooks.py,sha256=-TSkcaya1y48WB24_vHd-bqO5xSqxRsCLiilncNzQZU,3917
-devrev/services/works.py,sha256=EUlDaUOttiRhvFLa0tkZXtgF3PpLLZlyUqjf3Hp4zRo,21239
+devrev/services/works.py,sha256=hAK7ZUqLph5Db15p4RDbeRFLZUALAF5tCFOQSYytj_g,20456
 devrev/utils/__init__.py,sha256=NOrbpkjDVLH8n9xf-xpZJiIIa_GVI_6vqTm3E8L3Udw,857
 devrev/utils/content_converter.py,sha256=emRBLiVoOfDGpPDzrMRnqQr4-QkqN13OdWlYOyU_LCg,28141
 devrev/utils/deprecation.py,sha256=7qB2Dx531oP7mNi7q2txOYsOKC9YwdHqlKPMFHOW9Ws,1275
@@ -116,7 +117,7 @@ devrev_mcp/utils/don_id.py,sha256=PAVzOSgaiqJQSdo1fwohFHq2x7PDNUZoBTN4LFGYM48,62
 devrev_mcp/utils/errors.py,sha256=5mRAo76rJvvEVi6b1ZokPxDtX5JKkptaqmiYDLCkwBE,2110
 devrev_mcp/utils/formatting.py,sha256=6JssG5x1BxjdgSiQ8Ou3H-9Wo3wgWTWmejsrGez4wKc,2431
 devrev_mcp/utils/pagination.py,sha256=EOUgL-ZdSToM1Q-ydXmjhibsef5K1u1g3CaS9K8I2fY,1286
-devrev_python_sdk-3.0.0.dist-info/METADATA,sha256=X6qGjwru56IRRe8VAMJqh8AQTWKhjn0r4S_-GjGkbc4,40906
-devrev_python_sdk-3.0.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
-devrev_python_sdk-3.0.0.dist-info/entry_points.txt,sha256=XiV4J_yy0yzVZVxg7T66YERVIlqdPNp3O-NHTHkllqQ,63
-devrev_python_sdk-3.0.0.dist-info/RECORD,,
+devrev_python_sdk-3.0.1.dist-info/METADATA,sha256=lTWWDMuQ7SvBTLsT1ape1IhGmY4b8OixjrHpqvkQL2o,40906
+devrev_python_sdk-3.0.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+devrev_python_sdk-3.0.1.dist-info/entry_points.txt,sha256=XiV4J_yy0yzVZVxg7T66YERVIlqdPNp3O-NHTHkllqQ,63
+devrev_python_sdk-3.0.1.dist-info/RECORD,,