glpi-python-client 0.3.1__tar.gz → 0.3.2__tar.gz

{glpi_python_client-0.3.1 → glpi_python_client-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glpi-python-client
-Version: 0.3.1
+Version: 0.3.2
 Summary: A typed Python client for GLPI ITSM APIs.
 Project-URL: Homepage, https://github.com/baraline/glpi_python_client
 Project-URL: Documentation, https://glpi-python-client.readthedocs.io/en/latest/

{glpi_python_client-0.3.1 → glpi_python_client-0.3.2}/docs/user_guide.rst

@@ -179,16 +179,40 @@ fan-outs cannot race the auth manager, while the HTTP requests
 themselves execute outside the lock through the thread-safe
 :class:`requests.Session`.
 
-A small number of helpers exist in async-only variants because they
-need real concurrency:
-
-* :meth:`AsyncGlpiClient.get_ticket_context` fans the five underlying
-  GLPI calls out concurrently with :func:`asyncio.gather`.
-* :meth:`AsyncGlpiClient.get_task_statistics` fans the per-ticket task
-  list calls out concurrently with :func:`asyncio.gather`.
-* :meth:`AsyncGlpiClient.get_task_durations` fans the per-ticket task
-  fetches out concurrently with :func:`asyncio.gather` when
-  ``return_task_details=True``.
+A number of helpers ship with hand-written async overrides rather than
+relying solely on the bridge. There are two reasons a method needs its
+own async variant:
+
+1. **Concurrency** — the method benefits from fanning multiple GLPI
+   calls out concurrently with :func:`asyncio.gather`.
+2. **Internal self-calls** — the method calls another public method
+   through ``self`` (e.g. ``self.search_tickets(...)`` inside a
+   pagination loop). When the bridge runs the synchronous body in a
+   worker thread, ``self.method`` resolves to the bridge-wrapped
+   *coroutine*, which returns a coroutine object instead of data when
+   called without ``await``. The async override replaces the body so
+   every internal call is properly awaited on the event loop.
+
+Helpers with async overrides:
+
+* :meth:`AsyncGlpiClient.get_ticket_context` — fans the five underlying
+  GLPI calls out concurrently (reason: concurrency).
+* :meth:`AsyncGlpiClient.get_task_statistics` — fans the per-ticket
+  task-list calls out concurrently (reason: concurrency).
+* :meth:`AsyncGlpiClient.get_task_durations` — fans the per-ticket task
+  fetches out concurrently when ``return_task_details=True``, and
+  properly awaits ``iter_search_tickets`` and ``search_entities``
+  internally (reasons: concurrency + internal self-calls).
+* :meth:`AsyncGlpiClient.get_ticket_statistics` — properly awaits
+  ``search_tickets`` and ``search_entities`` internally (reason:
+  internal self-calls).
+* :meth:`AsyncGlpiClient.get_user_activity` — properly awaits
+  ``search_users``, ``iter_search_tickets``, and ``get_task_durations``
+  internally (reason: internal self-calls).
+* ``iter_search_tickets``, ``iter_search_users``,
+  ``iter_search_entities`` — each pagination loop body calls
+  ``self.search_*(...)``; the async variants are native async generators
+  that ``await`` those calls directly (reason: internal self-calls).
 
 Pagination helpers (``iter_search_tickets``, ``iter_search_users``,
 ``iter_search_entities``) are exposed as **async generators** on the

{glpi_python_client-0.3.1 → glpi_python_client-0.3.2}/glpi_python_client/__init__.py

@@ -72,7 +72,7 @@ from glpi_python_client.models import (
     TicketMarkdownOptions,
 )
 
-__version__ = "0.3.1"
+__version__ = "0.3.2"
 
 __all__ = [
     "AsyncGlpiClient",

{glpi_python_client-0.3.1 → glpi_python_client-0.3.2}/glpi_python_client/clients/async_client.py

@@ -50,6 +50,7 @@ from glpi_python_client.clients.commons._config import (
     build_client_resources,
 )
 from glpi_python_client.clients.commons._transport import TransportMixin
+from glpi_python_client.clients.custom._pagination_async import AsyncPaginationMixin
 from glpi_python_client.clients.custom._statistics_async import AsyncStatisticsMixin
 from glpi_python_client.clients.custom._ticket_context_async import (
     AsyncTicketContextMixin,
@@ -61,8 +62,9 @@ if TYPE_CHECKING:
 logger = logging.getLogger(__name__)
 
 
-class AsyncGlpiClient(
+class AsyncGlpiClient(  # type: ignore[misc]
     AsyncBridge,
+    AsyncPaginationMixin,
     TicketMixin,
     TicketTaskMixin,
     FollowupMixin,

{glpi_python_client-0.3.1 → glpi_python_client-0.3.2}/glpi_python_client/clients/commons/_async_bridge.py

@@ -22,6 +22,23 @@ Concurrency notes
   releases the awaiter immediately, but the in-flight HTTP request keeps
   running on the worker thread until ``requests`` returns. This matches
   the behaviour of the original async client.
+
+Known limitation — internal ``self``-calls
+------------------------------------------
+The bridge wraps *every* public method on the async client class. As a
+result, when a synchronous body that is running inside a worker thread
+calls another public method through ``self`` (e.g.
+``self.search_tickets(...)``), it resolves to the *bridge-wrapped*
+coroutine, not the synchronous function. Calling a coroutine without
+``await`` produces a dangling coroutine object, not data.
+
+Any sync method (or generator) that internally calls other public
+methods through ``self`` must therefore be given a hand-written async
+override that ``await``s (or ``async for``s) those calls on the event
+loop. The convention used in this codebase is to place such overrides
+in a ``_*_async.py`` companion module (e.g.
+``clients/custom/_statistics_async.py``) and wire them into the async
+client's MRO *before* the sync mixin that defines the original method.
 """
 
 from __future__ import annotations

{glpi_python_client-0.3.1 → glpi_python_client-0.3.2}/glpi_python_client/clients/custom/__init__.py

@@ -17,6 +17,7 @@ composed into :class:`~glpi_python_client.clients.AsyncGlpiClient`.
 
 from __future__ import annotations
 
+from glpi_python_client.clients.custom._pagination_async import AsyncPaginationMixin
 from glpi_python_client.clients.custom._statistics import StatisticsMixin
 from glpi_python_client.clients.custom._statistics_async import AsyncStatisticsMixin
 from glpi_python_client.clients.custom._ticket_context import TicketContextMixin
@@ -25,6 +26,7 @@ from glpi_python_client.clients.custom._ticket_context_async import (
 )
 
 __all__ = [
+    "AsyncPaginationMixin",
     "AsyncStatisticsMixin",
     "AsyncTicketContextMixin",
     "StatisticsMixin",

glpi_python_client-0.3.2/glpi_python_client/clients/custom/_pagination_async.py

@@ -0,0 +1,164 @@
+"""Asynchronous overrides for the three paginated search generators.
+
+Each of the three ``iter_search_*`` generators in the API mixins
+delegates its pagination loop to a ``self.search_*()`` call.  When the
+:class:`~glpi_python_client.clients.commons._async_bridge.AsyncBridge`
+wraps a sync generator it drives ``next()`` on the generator object inside
+a worker thread.  Inside that thread ``self`` is still the
+:class:`~glpi_python_client.clients.AsyncGlpiClient` instance, so
+``self.search_tickets(...)`` resolves to the bridge-wrapped coroutine
+function and calling it without ``await`` returns a coroutine object
+instead of the expected list — triggering a
+``RuntimeWarning: coroutine … was never awaited`` and a 500 response.
+
+This mixin replaces all three generators with native async generators that
+``await self.search_*(...)`` directly on the event loop.
+
+The mixin must be positioned **before** ``TicketMixin``, ``UserMixin``, and
+``EntityMixin`` in the :class:`~glpi_python_client.clients.AsyncGlpiClient`
+base list so that the bridge's ``__init_subclass__`` hook finds the async
+generator via ``getattr`` before it would otherwise wrap the sync version.
+"""
+
+from __future__ import annotations
+
+from collections.abc import AsyncIterator
+
+from glpi_python_client.models.api_schema.administration._entity import GetEntity
+from glpi_python_client.models.api_schema.administration._user import GetUser
+from glpi_python_client.models.api_schema.assistance._ticket import GetTicket
+
+
+class AsyncPaginationMixin:
+    """Async generator overrides for the three paginated search helpers.
+
+    Each override re-implements the simple ``start``-advancing loop of
+    the synchronous counterpart but ``await``\\ s the underlying
+    ``search_*`` call so it runs on the event loop rather than inside a
+    worker-thread-dispatched ``next()`` call where the coroutine would
+    be dropped on the floor.
+    """
+
+    async def iter_search_tickets(
+        self,
+        rsql_filter: str = "",
+        *,
+        batch_size: int = 50,
+        sort: str | None = None,
+        fields: tuple[str, ...] = (),
+    ) -> AsyncIterator[list[GetTicket]]:
+        """Yield successive pages of GLPI tickets until exhausted.
+
+        Parameters
+        ----------
+        rsql_filter : str, optional
+            Raw RSQL filter forwarded as the ``filter`` query parameter.
+            Empty by default, which lists every visible ticket.
+        batch_size : int, optional
+            Number of records requested per page (default 50).
+        sort : str | None, optional
+            ``sort`` query parameter forwarded as-is to each page request.
+        fields : tuple[str, ...], optional
+            Restricted set of contract field names to request.
+
+        Yields
+        ------
+        list[GetTicket]
+            One page of tickets per iteration. The last yielded batch may
+            be shorter than ``batch_size``.
+        """
+
+        start = 0
+        while True:
+            batch: list[GetTicket] = await self.search_tickets(  # type: ignore[attr-defined]
+                rsql_filter,
+                limit=batch_size,
+                start=start,
+                sort=sort,
+                fields=fields,
+            )
+            if batch:
+                yield batch
+            if len(batch) < batch_size:
+                break
+            start += batch_size
+
+    async def iter_search_users(
+        self,
+        rsql_filter: str = "",
+        *,
+        batch_size: int = 50,
+        skip_entity: bool = False,
+    ) -> AsyncIterator[list[GetUser]]:
+        """Yield successive pages of GLPI users until exhausted.
+
+        Parameters
+        ----------
+        rsql_filter : str, optional
+            Raw RSQL filter forwarded as the ``filter`` query parameter.
+            Empty by default, which lists every visible user.
+        batch_size : int, optional
+            Number of records requested per page (default 50).
+        skip_entity : bool, optional
+            When ``True`` the ``GLPI-Entity`` header is omitted so the
+            search spans every entity the caller has access to.
+
+        Yields
+        ------
+        list[GetUser]
+            One page of users per iteration. The last yielded batch may
+            be shorter than ``batch_size``.
+        """
+
+        start = 0
+        while True:
+            batch: list[GetUser] = await self.search_users(  # type: ignore[attr-defined]
+                rsql_filter,
+                limit=batch_size,
+                start=start,
+                skip_entity=skip_entity,
+            )
+            if batch:
+                yield batch
+            if len(batch) < batch_size:
+                break
+            start += batch_size
+
+    async def iter_search_entities(
+        self,
+        rsql_filter: str = "",
+        *,
+        batch_size: int = 50,
+    ) -> AsyncIterator[list[GetEntity]]:
+        """Yield successive pages of GLPI entities until exhausted.
+
+        Parameters
+        ----------
+        rsql_filter : str, optional
+            Raw RSQL filter forwarded as the ``filter`` query parameter.
+            Empty by default, which lists every accessible entity.
+        batch_size : int, optional
+            Number of records requested per page (default 50).
+
+        Yields
+        ------
+        list[GetEntity]
+            One page of entities per iteration. The last yielded batch
+            may be shorter than ``batch_size``.
+        """
+
+        start = 0
+        while True:
+            batch: list[GetEntity] = await self.search_entities(  # type: ignore[attr-defined]
+                rsql_filter,
+                limit=batch_size,
+                start=start,
+            )
+            if batch:
+                yield batch
+            if len(batch) < batch_size:
+                break
+            start += batch_size
+
+
+__all__ = ["AsyncPaginationMixin"]