eventsourcing 9.3.5__py3-none-any.whl → 9.4.0__py3-none-any.whl

eventsourcing/interface.py

@@ -3,50 +3,50 @@ from __future__ import annotations
 import json
 from abc import ABC, abstractmethod
 from base64 import b64decode, b64encode
-from typing import Generic, List, Sequence
+from typing import TYPE_CHECKING, Generic
 from uuid import UUID
 
 from eventsourcing.application import NotificationLog, Section, TApplication
 from eventsourcing.persistence import Notification
 
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
 
 class NotificationLogInterface(ABC):
-    """
-    Abstract base class for obtaining serialised
+    """Abstract base class for obtaining serialised
     sections of a notification log.
     """
 
     @abstractmethod
     def get_log_section(self, section_id: str) -> str:
-        """
-        Returns a serialised :class:`~eventsourcing.application.Section`
+        """Returns a serialised :class:`~eventsourcing.application.Section`
         from a notification log.
         """
 
     @abstractmethod
     def get_notifications(
-        self, start: int, limit: int, topics: Sequence[str] = ()
+        self,
+        start: int | None,
+        limit: int,
+        topics: Sequence[str] = (),
+        *,
+        inclusive_of_start: bool = True,
     ) -> str:
-        """
-        Returns a serialised list of :class:`~eventsourcing.persistence.Notification`
+        """Returns a serialised list of :class:`~eventsourcing.persistence.Notification`
         objects from a notification log.
         """
 
 
 class NotificationLogJSONService(NotificationLogInterface, Generic[TApplication]):
-    """
-    Presents serialised sections of a notification log.
-    """
+    """Presents serialised sections of a notification log."""
 
     def __init__(self, app: TApplication):
-        """
-        Initialises service with given application.
-        """
+        """Initialises service with given application."""
         self.app = app
 
     def get_log_section(self, section_id: str) -> str:
-        """
-        Returns JSON serialised :class:`~eventsourcing.application.Section`
+        """Returns JSON serialised :class:`~eventsourcing.application.Section`
         from a notification log.
         """
         section = self.app.notification_log[section_id]
@@ -68,10 +68,18 @@ class NotificationLogJSONService(NotificationLogInterface, Generic[TApplication]
         )
 
     def get_notifications(
-        self, start: int, limit: int, topics: Sequence[str] = ()
+        self,
+        start: int | None,
+        limit: int,
+        topics: Sequence[str] = (),
+        *,
+        inclusive_of_start: bool = True,
     ) -> str:
         notifications = self.app.notification_log.select(
-            start=start, limit=limit, topics=topics
+            start=start,
+            limit=limit,
+            topics=topics,
+            inclusive_of_start=inclusive_of_start,
         )
         return json.dumps(
             [
@@ -88,19 +96,14 @@ class NotificationLogJSONService(NotificationLogInterface, Generic[TApplication]
 
 
 class NotificationLogJSONClient(NotificationLog):
-    """
-    Presents deserialized sections of a notification log.
-    """
+    """Presents deserialized sections of a notification log."""
 
     def __init__(self, interface: NotificationLogInterface):
-        """
-        Initialises log with a given interface.
-        """
+        """Initialises log with a given interface."""
         self.interface = interface
 
     def __getitem__(self, section_id: str) -> Section:
-        """
-        Returns a :class:`Section` of
+        """Returns a :class:`Section` of
         :class:`~eventsourcing.persistence.Notification` objects
         from the notification log.
         """
@@ -123,13 +126,14 @@ class NotificationLogJSONClient(NotificationLog):
 
     def select(
         self,
-        start: int,
+        start: int | None,
         limit: int,
-        _: int | None = None,
+        stop: int | None = None,
         topics: Sequence[str] = (),
-    ) -> List[Notification]:
-        """
-        Returns a selection of
+        *,
+        inclusive_of_start: bool = True,
+    ) -> list[Notification]:
+        """Returns a selection of
         :class:`~eventsourcing.persistence.Notification` objects
         from the notification log.
         """
@@ -143,7 +147,10 @@ class NotificationLogJSONClient(NotificationLog):
             )
             for item in json.loads(
                 self.interface.get_notifications(
-                    start=start, limit=limit, topics=topics
+                    start=start,
+                    limit=limit,
+                    topics=topics,
+                    inclusive_of_start=inclusive_of_start,
                 )
             )
         ]