python-event-sourcery 0.4.0a4__tar.gz → 0.4.0a6__tar.gz

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-event-sourcery
-Version: 0.4.0a4
+Version: 0.4.0a6
 Summary: 
 License: MIT
 Author: Your Name

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery/aggregate/repository.py

@@ -3,7 +3,13 @@ from contextlib import contextmanager
 from typing import Generic, TypeVar, cast
 
 from event_sourcery.aggregate import Aggregate
-from event_sourcery.event_store import Event, EventStore, Metadata, StreamId, StreamUUID
+from event_sourcery.event_store import (
+    Event,
+    EventStore,
+    StreamId,
+    StreamUUID,
+    WrappedEvent,
+)
 
 TAggregate = TypeVar("TAggregate", bound=Aggregate)
 TEvent = TypeVar("TEvent", bound=Event)
@@ -42,7 +48,7 @@ class Repository(Generic[TAggregate]):
         with aggregate.__persisting_changes__() as pending:
             start_from = old_version + 1
             events = [
-                Metadata.wrap(event, version)
+                WrappedEvent.wrap(event, version)
                 for version, event in enumerate(pending, start=start_from)
             ]
 

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery/event_store/__init__.py

@@ -9,7 +9,7 @@ __all__ = [
     "ExplicitVersioning",
     "InMemoryBackendFactory",
     "Listener",
-    "Metadata",
+    "WrappedEvent",
     "NO_VERSIONING",
     "Position",
     "RawEvent",
@@ -31,11 +31,11 @@ from event_sourcery.event_store.event import (
     Entry,
     Event,
     EventRegistry,
-    Metadata,
     Position,
     RawEvent,
     Recorded,
     RecordedRaw,
+    WrappedEvent,
 )
 from event_sourcery.event_store.event_store import EventStore
 from event_sourcery.event_store.factory import (

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery/event_store/dispatcher.py

@@ -3,14 +3,14 @@ from collections.abc import Callable
 
 from event_sourcery.event_store.event import (
     Event,
-    Metadata,
     Position,
     RecordedRaw,
     Serde,
+    WrappedEvent,
 )
 from event_sourcery.event_store.stream_id import StreamId
 
-Listener = Callable[[Metadata, StreamId, Position | None], None]
+Listener = Callable[[WrappedEvent, StreamId, Position | None], None]
 
 
 class Dispatcher:
@@ -22,10 +22,10 @@ class Dispatcher:
         for raw in raws:
             record = self._serde.deserialize_record(raw)
             for event_type, listeners in self._listeners.items():
-                if not isinstance(record.metadata.event, event_type):
+                if not isinstance(record.wrapped_event.event, event_type):
                     continue
                 for listener in listeners:
-                    listener(record.metadata, record.stream_id, record.position)
+                    listener(record.wrapped_event, record.stream_id, record.position)
 
     def register(self, listener: Listener, to: type[Event]) -> None:
         self._listeners[to].add(listener)

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery/event_store/event/__init__.py

@@ -3,7 +3,7 @@ __all__ = [
     "Entry",
     "Event",
     "EventRegistry",
-    "Metadata",
+    "WrappedEvent",
     "Position",
     "RawEvent",
     "Recorded",
@@ -16,11 +16,11 @@ from event_sourcery.event_store.event.dto import (
     Context,
     Entry,
     Event,
-    Metadata,
     Position,
     RawEvent,
     Recorded,
     RecordedRaw,
+    WrappedEvent,
 )
 from event_sourcery.event_store.event.registry import EventRegistry
 from event_sourcery.event_store.event.serde import Serde

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery/event_store/event/dto.py

@@ -35,6 +35,7 @@ class Event(BaseModel, extra="forbid"):
         order_id: OrderId
     ```
     """
+
     __registry__: ClassVar = EventRegistry()
 
     def __init_subclass__(cls, **kwargs: Any) -> None:
@@ -49,7 +50,7 @@ class Context(BaseModel, extra="allow"):
     causation_id: UUID | None = None
 
 
-class Metadata(BaseModel, Generic[TEvent], extra="forbid"):
+class WrappedEvent(BaseModel, Generic[TEvent], extra="forbid"):
     """Wrapper for events with all relevant metadata.
 
     Returned from EventStore when loading events from a stream.
@@ -60,9 +61,10 @@ class Metadata(BaseModel, Generic[TEvent], extra="forbid"):
         order_id: OrderId
 
     event = OrderCancelled(order_id=OrderId("#123"))
-    metadata = Metadata.wrap(event, version=1)
+    wrapped_event = WrappedEvent.wrap(event, version=1)
     ```
     """
+
     event: TEvent
     version: int | None
     uuid: UUID = Field(default_factory=uuid4)
@@ -70,12 +72,12 @@ class Metadata(BaseModel, Generic[TEvent], extra="forbid"):
     context: Context = Field(default_factory=Context)
 
     @classmethod
-    def wrap(cls, event: TEvent, version: int | None) -> "Metadata[TEvent]":
-        return Metadata[TEvent](event=event, version=version)
+    def wrap(cls, event: TEvent, version: int | None) -> "WrappedEvent[TEvent]":
+        return WrappedEvent[TEvent](event=event, version=version)
 
 
 class Entry(BaseModel):
-    metadata: Metadata
+    wrapped_event: WrappedEvent
     stream_id: StreamId
 
 

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery/event_store/event/serde.py

@@ -4,10 +4,10 @@ from typing import cast
 
 from event_sourcery.event_store.event.dto import (
     Event,
-    Metadata,
     RawEvent,
     Recorded,
     RecordedRaw,
+    WrappedEvent,
 )
 from event_sourcery.event_store.event.registry import EventRegistry
 from event_sourcery.event_store.stream_id import StreamId
@@ -17,27 +17,27 @@ from event_sourcery.event_store.stream_id import StreamId
 class Serde:
     registry: EventRegistry
 
-    def deserialize(self, event: RawEvent) -> Metadata:
+    def deserialize(self, event: RawEvent) -> WrappedEvent:
         event_as_dict = dict(event)
         del event_as_dict["stream_id"]
         del event_as_dict["name"]
         data = cast(Mapping, event_as_dict.pop("data"))
         event_type = self.registry.type_for_name(event.name)
-        return Metadata[event_type](  # type: ignore
+        return WrappedEvent[event_type](  # type: ignore
             **event_as_dict,
             event=event_type(**data),
         )
 
     def deserialize_record(self, record: RecordedRaw) -> Recorded:
         return Recorded(
-            metadata=self.deserialize(record.entry),
+            wrapped_event=self.deserialize(record.entry),
             stream_id=record.entry.stream_id,
             position=record.position,
         )
 
     def serialize(
         self,
-        event: Metadata,
+        event: WrappedEvent,
         stream_id: StreamId,
     ) -> RawEvent:
         model = cast(Event, event.event)

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery/event_store/event_store.py

@@ -2,7 +2,13 @@ from collections.abc import Sequence
 from functools import singledispatchmethod
 from typing import cast
 
-from event_sourcery.event_store.event import Event, Metadata, Position, RawEvent, Serde
+from event_sourcery.event_store.event import (
+    Event,
+    Position,
+    RawEvent,
+    Serde,
+    WrappedEvent,
+)
 from event_sourcery.event_store.interfaces import StorageStrategy
 from event_sourcery.event_store.stream_id import StreamId
 from event_sourcery.event_store.versioning import (
@@ -24,16 +30,16 @@ class EventStore:
         stream_id: StreamId,
         start: int | None = None,
         stop: int | None = None,
-    ) -> Sequence[Metadata]:
+    ) -> Sequence[WrappedEvent]:
         """Loads events from a given stream.
 
         Examples:
             >>> load_stream(stream_id=StreamId(name="not_existing_stream"))
             []
             >>> load_stream(stream_id=StreamId(name="existing_stream"))
-            [Metadata(..., version=1), Metadata(...), Metadata(..., version=3)]
+            [WrappedEvent(..., version=1), ..., WrappedEvent(..., version=3)]
             >>> load_stream(stream_id=StreamId(name="existing_stream"), start=2, stop=3)
-            [Metadata(..., version=2)]
+            [WrappedEvent(..., version=2)]
 
         Args:
             stream_id: The stream identifier to load events from.
@@ -49,8 +55,8 @@ class EventStore:
     @singledispatchmethod
     def append(
         self,
-        first: Metadata,
-        *events: Metadata,
+        first: WrappedEvent,
+        *events: WrappedEvent,
         stream_id: StreamId,
         expected_version: int | Versioning = 0,
     ) -> None:
@@ -60,13 +66,13 @@ class EventStore:
         To use it, pass the expected version of the stream.
 
         Examples:
-            >>> append(Metadata(...), stream_id=StreamId())
+            >>> append(WrappedEvent(...), stream_id=StreamId())
             None
-            >>> append(Metadata(...), stream_id=StreamId(), expected_version=1)
+            >>> append(WrappedEvent(...), stream_id=StreamId(), expected_version=1)
             None
 
         Args:
-            first: The first event to append (Metadata or Event).
+            first: The first event to append (WrappedEvent or Event).
             *events: The rest of the events to append (same type as first argument).
             stream_id: The stream identifier to append events to.
             expected_version: The expected version of the stream
@@ -99,22 +105,22 @@ class EventStore:
         self,
         expected_version: int,
         events: Sequence[Event],
-    ) -> Sequence[Metadata]:
+    ) -> Sequence[WrappedEvent]:
         return [
-            Metadata.wrap(event=event, version=version)
+            WrappedEvent.wrap(event=event, version=version)
             for version, event in enumerate(events, start=expected_version + 1)
         ]
 
     @_wrap_events.register
     def _wrap_events_versioning(
         self, expected_version: Versioning, events: Sequence[Event]
-    ) -> Sequence[Metadata]:
-        return [Metadata.wrap(event=event, version=None) for event in events]
+    ) -> Sequence[WrappedEvent]:
+        return [WrappedEvent.wrap(event=event, version=None) for event in events]
 
     def _append(
         self,
         stream_id: StreamId,
-        events: Sequence[Metadata],
+        events: Sequence[WrappedEvent],
         expected_version: int | Versioning,
     ) -> None:
         new_version = events[-1].version
@@ -152,13 +158,13 @@ class EventStore:
         """
         self._storage_strategy.delete_stream(stream_id)
 
-    def save_snapshot(self, stream_id: StreamId, snapshot: Metadata) -> None:
+    def save_snapshot(self, stream_id: StreamId, snapshot: WrappedEvent) -> None:
         """Saves a snapshot of the stream.
 
         Examples:
-            >>> save_snapshot(StreamId(), Metadata(...))
+            >>> save_snapshot(StreamId(), WrappedEvent(...))
             None
-            >>> save_snapshot(StreamId(name="not_existing_stream"), Metadata(...))
+            >>> save_snapshot(StreamId(name="not_existing_stream"), WrappedEvent(...))
             None
 
         Args:
@@ -172,12 +178,12 @@ class EventStore:
         serialized = self._serde.serialize(event=snapshot, stream_id=stream_id)
         self._storage_strategy.save_snapshot(serialized)
 
-    def _deserialize_events(self, events: list[RawEvent]) -> list[Metadata]:
+    def _deserialize_events(self, events: list[RawEvent]) -> list[WrappedEvent]:
         return [self._serde.deserialize(e) for e in events]
 
     def _serialize_events(
         self,
-        events: Sequence[Metadata],
+        events: Sequence[WrappedEvent],
         stream_id: StreamId,
     ) -> list[RawEvent]:
         return [self._serde.serialize(event=e, stream_id=stream_id) for e in events]

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery/event_store/outbox.py

@@ -19,7 +19,7 @@ class Outbox:
             with entry as raw_record:
                 event = self._serde.deserialize(raw_record.entry)
                 record = Recorded(
-                    metadata=event,
+                    wrapped_event=event,
                     stream_id=raw_record.entry.stream_id,
                     position=raw_record.position,
                 )

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery/event_store/subscription.py

@@ -110,6 +110,6 @@ class SubscriptionBuilder(PositionPhase, FilterPhase, BuildPhase):
     ) -> Iterator[list[Recorded]]:
         seconds = self._to_timedelta(timelimit)
         subscription = self._build(batch_size=size, timelimit=seconds)
-        return (
+        return (  # pragma: no cover  # apparently, bug in coverage.py
             [self._serde.deserialize_record(e) for e in batch] for batch in subscription
         )

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery/read_model/projector.py

@@ -1,10 +1,10 @@
 from collections.abc import Callable
 from typing import TypeAlias
 
-from event_sourcery.event_store import Event, EventStore, Metadata, StreamId
+from event_sourcery.event_store import Event, EventStore, StreamId, WrappedEvent
 from event_sourcery.read_model.cursors_dao import CursorsDao
 
-ReadModel: TypeAlias = Callable[[Metadata, StreamId], None]
+ReadModel: TypeAlias = Callable[[WrappedEvent, StreamId], None]
 
 
 class Projector:
@@ -23,38 +23,38 @@ class Projector:
         self._cursors_dao = cursors_dao
         self._read_model = read_model
 
-    def project(self, metadata: Metadata[Event], stream_id: StreamId) -> None:
-        if metadata.version is None:
+    def project(self, wrapped_event: WrappedEvent[Event], stream_id: StreamId) -> None:
+        if wrapped_event.version is None:
             raise self.CantProjectUnversionedEvent
 
         try:
             self._cursors_dao.increment(
-                name=self._name, stream_id=stream_id, version=metadata.version
+                name=self._name, stream_id=stream_id, version=wrapped_event.version
             )
-            self._read_model(metadata, stream_id)
+            self._read_model(wrapped_event, stream_id)
         except self._cursors_dao.StreamNotTracked:
             self._cursors_dao.put_at(
-                name=self._name, stream_id=stream_id, version=metadata.version
+                name=self._name, stream_id=stream_id, version=wrapped_event.version
             )
             missed_events = self._event_store.load_stream(
-                stream_id=stream_id, stop=metadata.version
+                stream_id=stream_id, stop=wrapped_event.version
             )
             for event in missed_events:
                 self._read_model(event, stream_id)
 
-            self._read_model(metadata, stream_id)
+            self._read_model(wrapped_event, stream_id)
         except self._cursors_dao.BehindStream as exc:
             self._cursors_dao.move_to(
-                name=self._name, stream_id=stream_id, version=metadata.version
+                name=self._name, stream_id=stream_id, version=wrapped_event.version
             )
             missed_events = self._event_store.load_stream(
                 stream_id=stream_id,
                 start=exc.current_version + 1,
-                stop=metadata.version,
+                stop=wrapped_event.version,
             )
             for event in missed_events:
                 self._read_model(event, stream_id)
 
-            self._read_model(metadata, stream_id)
+            self._read_model(wrapped_event, stream_id)
         except self._cursors_dao.AheadOfStream:
             return

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery_esdb/outbox.py

@@ -6,7 +6,7 @@ from itertools import islice
 
 from esdbclient import EventStoreDBClient, RecordedEvent
 from esdbclient.exceptions import DeadlineExceeded, NotFound
-from esdbclient.persistent import PersistentSubscription
+from esdbclient.persistent import AbstractPersistentSubscription
 
 from event_sourcery.event_store import RecordedRaw
 from event_sourcery.event_store.interfaces import (
@@ -25,7 +25,7 @@ class ESDBOutboxStorageStrategy(OutboxStorageStrategy):
     _outbox_name: str
     _max_publish_attempts: int
     _timeout: float | None
-    _active_subscription: PersistentSubscription = field(init=False)
+    _active_subscription: AbstractPersistentSubscription = field(init=False)
 
     def create_subscription(self) -> None:
         try:
@@ -51,7 +51,7 @@ class ESDBOutboxStorageStrategy(OutboxStorageStrategy):
         delattr(self, "_active_subscription")
 
     @property
-    def active_subscription(self) -> PersistentSubscription:
+    def active_subscription(self) -> AbstractPersistentSubscription:
         return self._active_subscription
 
     def outbox_entries(

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery_esdb/subscription.py

@@ -1,7 +1,8 @@
-from collections.abc import Callable, Iterator
+from collections.abc import Iterator
 from dataclasses import dataclass
 from datetime import timedelta
 from functools import partial
+from typing import Protocol
 
 import esdbclient.exceptions
 from esdbclient import EventStoreDBClient, RecordedEvent
@@ -11,13 +12,19 @@ from event_sourcery.event_store.interfaces import SubscriptionStrategy
 from event_sourcery_esdb import dto
 
 
+class BuilderCallable(Protocol):
+    def __call__(
+        self, commit_position: Position | None = None
+    ) -> Iterator[RecordedEvent]: ...
+
+
 @dataclass(repr=False)
 class ESDBSubscriptionStrategy(SubscriptionStrategy):
     _client: EventStoreDBClient
 
     @staticmethod
     def _iterator(
-        builder: Callable[[], Iterator[RecordedEvent]],
+        builder: BuilderCallable,
         size: int,
     ) -> Iterator[list[RecordedRaw]]:
         subscription = builder()

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery_sqlalchemy/cursors_dao.py

@@ -38,7 +38,7 @@ class SqlAlchemyCursorsDao(CursorsDao):
             .values({ProjectorCursor.version: version})
         )
         result = self._session.execute(update_stmt)
-        if result.rowcount == 1:  # type: ignore
+        if result.rowcount == 1:
             return
         else:
             current_version = self._current_version(name, stream_id)

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/event_sourcery_sqlalchemy/event_store.py

@@ -155,7 +155,7 @@ class SqlAlchemyStorageStrategy(StorageStrategy):
             )
             result = self._session.execute(bump_version_stmt)
 
-            if result.rowcount != 1:  # type: ignore
+            if result.rowcount != 1:
                 # optimistic lock failed
                 raise ConcurrentStreamWriteError
 

{python_event_sourcery-0.4.0a4 → python_event_sourcery-0.4.0a6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-event-sourcery"
-version = "0.4.0a4"
+version = "0.4.0a6"
 description = ""
 authors = ["Your Name <you@example.com>"]
 license = "MIT"