glpi-python-client 0.3.1__py3-none-any.whl → 0.3.3__py3-none-any.whl

glpi_python_client/__init__.py

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

glpi_python_client/clients/api/assistance/timeline/_document.py

@@ -7,11 +7,12 @@ Notes
 -----
 The live GLPI v2 server returns each entry of the list endpoint wrapped
 in a ``{"type": "Document_Item", "item": {...}}`` envelope, even though
-the OpenAPI contract documents a flat array of ``Document_Item``. Real
-behaviour wins over the contract, so :func:`list_ticket_timeline_documents`
-unwraps the envelope through the shared
-:meth:`~glpi_python_client.clients.commons._transport.TransportMixin._resource_list`
-helper and tolerates both shapes.
+the OpenAPI contract documents a flat array of ``Document_Item``.  The
+``item`` value is a full ``Document`` record (matching :class:`GetDocument`),
+not a ``Document_Item`` link record — real behaviour wins over the contract.
+:func:`list_ticket_timeline_documents` unwraps the envelope through the shared
+``TransportMixin._resource_list`` helper and deserialises each inner object
+as :class:`GetDocument`.
 """
 
 from __future__ import annotations
@@ -24,19 +25,17 @@ from glpi_python_client.clients.commons._constants import (
 from glpi_python_client.clients.commons._transport import TransportMixin
 from glpi_python_client.models.api_schema.assistance.timeline._document import (
     DeleteTimelineDocument,
-    GetTimelineDocument,
     PatchTimelineDocument,
     PostTimelineDocument,
 )
+from glpi_python_client.models.api_schema.management._document import GetDocument
 
 
 class TimelineDocumentMixin(TransportMixin):
     """Synchronous CRUD helpers for the ticket document timeline endpoint."""
 
-    def list_ticket_timeline_documents(
-        self, ticket_id: GlpiId
-    ) -> list[GetTimelineDocument]:
-        """List all timeline documents linked to one ticket.
+    def list_ticket_timeline_documents(self, ticket_id: GlpiId) -> list[GetDocument]:
+        """List all documents linked to one ticket timeline.
 
         Parameters
         ----------
@@ -45,14 +44,16 @@ class TimelineDocumentMixin(TransportMixin):
 
         Returns
         -------
-        list[GetTimelineDocument]
-            Document links returned by the GLPI server, with the timeline
-            envelope unwrapped where present.
+        list[GetDocument]
+            Document records returned by the GLPI server.  The live API
+            wraps each entry in a ``{"type": "Document_Item", "item": {...}}``
+            envelope whose ``item`` value is a full ``Document`` record; the
+            envelope is unwrapped automatically.
         """
 
         return self._resource_list(
             f"{TICKET_ENDPOINT}/{ticket_id}/{TIMELINE_DOCUMENT_SUFFIX}",
-            GetTimelineDocument,
+            GetDocument,
             failure_message=(
                 f"Failed to list timeline documents for ticket {ticket_id}"
             ),
@@ -61,20 +62,20 @@ class TimelineDocumentMixin(TransportMixin):
 
     def get_ticket_timeline_document(
         self, ticket_id: GlpiId, document_link_id: GlpiId
-    ) -> GetTimelineDocument:
-        """Fetch one timeline document link by identifier.
+    ) -> GetDocument:
+        """Fetch one document linked to the ticket timeline by its document ID.
 
         Parameters
         ----------
         ticket_id : GlpiId
             Numeric identifier of the parent ticket.
         document_link_id : GlpiId
-            Numeric identifier of the timeline document link to retrieve.
+            Numeric identifier of the linked document to retrieve.
 
         Returns
         -------
-        GetTimelineDocument
-            Validated document-link payload.
+        GetDocument
+            Validated document payload.
 
         Raises
         ------
@@ -85,7 +86,7 @@ class TimelineDocumentMixin(TransportMixin):
         return self._resource_get(
             f"{TICKET_ENDPOINT}/{ticket_id}/"
             f"{TIMELINE_DOCUMENT_SUFFIX}/{document_link_id}",
-            GetTimelineDocument,
+            GetDocument,
             failure_message=(
                 f"Failed to get timeline document {document_link_id} on "
                 f"ticket {ticket_id}"

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/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/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/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"]

glpi_python_client/clients/custom/_statistics.py

@@ -95,10 +95,12 @@ class StatisticsMixin(TransportMixin):
         Parameters
         ----------
         start_date : str | None, optional
-            ISO ``YYYY-MM-DD`` start of the window. Defaults to
-            ``end_date - default_days + 1`` when omitted.
+            ISO ``YYYY-MM-DD`` start of the window (inclusive from
+            00:00:00). Defaults to ``end_date - default_days + 1``
+            when omitted.
         end_date : str | None, optional
-            ISO ``YYYY-MM-DD`` end of the window. Defaults to today.
+            ISO ``YYYY-MM-DD`` end of the window (inclusive through
+            23:59:59). Defaults to today.
         default_days : int, optional
             Span in days used when ``start_date`` is omitted (defaults
             to 30 and must be a positive integer).
@@ -147,9 +149,10 @@ class StatisticsMixin(TransportMixin):
             entity_filter = rsql_any_filter(
                 *(f"entities_id=={e.id}" for e in entities if e.id is not None)
             )
-
+        date_filter = f"date_creation=ge={start.isoformat()};"
+        date_filter += f"date_creation=le={end.isoformat()} 23:59:59"
         query = rsql_all_filter(
-            f"date_creation=ge={start.isoformat()};date_creation=le={end.isoformat()}",
+            date_filter,
             entity_filter,
             extra_filter,
         )
@@ -226,10 +229,12 @@ class StatisticsMixin(TransportMixin):
         Parameters
         ----------
         start_date : str | None, optional
-            ISO ``YYYY-MM-DD`` start of the window. Defaults to
-            ``end_date - default_days + 1`` when omitted.
+            ISO ``YYYY-MM-DD`` start of the window (inclusive from
+            00:00:00). Defaults to ``end_date - default_days + 1``
+            when omitted.
         end_date : str | None, optional
-            ISO ``YYYY-MM-DD`` end of the window. Defaults to today.
+            ISO ``YYYY-MM-DD`` end of the window (inclusive through
+            23:59:59). Defaults to today.
         default_days : int, optional
             Span in days used when ``start_date`` is omitted (defaults
             to 30 and must be a positive integer).
@@ -269,9 +274,8 @@ class StatisticsMixin(TransportMixin):
             end_date=end_date,
             default_days=default_days,
         )
-        date_filter = (
-            f"date_creation=ge={start.isoformat()};date_creation=le={end.isoformat()}"
-        )
+        date_filter = f"date_creation=ge={start.isoformat()};"
+        date_filter += f"date_creation=le={end.isoformat()} 23:59:59"
 
         entity_filter: str | None = None
         if entity_id is not None:
@@ -399,9 +403,11 @@ class StatisticsMixin(TransportMixin):
         firstname : str | None, optional
             Filter by given name (substring match).
         start_date : str | None, optional
-            ISO ``YYYY-MM-DD`` start of the activity window.
+            ISO ``YYYY-MM-DD`` start of the activity window (inclusive
+            from 00:00:00).
         end_date : str | None, optional
-            ISO ``YYYY-MM-DD`` end of the activity window. Defaults to today.
+            ISO ``YYYY-MM-DD`` end of the activity window (inclusive
+            through 23:59:59). Defaults to today.
         default_days : int, optional
             Span in days used when ``start_date`` is omitted (default 30).
 
@@ -460,9 +466,8 @@ class StatisticsMixin(TransportMixin):
                 if u.id is not None
             }
 
-        date_range = (
-            f"date_creation=ge={start.isoformat()};date_creation=le={end.isoformat()}"
-        )
+        date_range = f"date_creation=ge={start.isoformat()};"
+        date_range += f"date_creation=le={end.isoformat()} 23:59:59"
 
         users_output: dict[str, UserActivityEntry] = {}
         for uid in resolved_user_ids: