eventsourcing 9.4.0a1__tar.gz → 9.4.0a2__tar.gz

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: eventsourcing
-Version: 9.4.0a1
+Version: 9.4.0a2
 Summary: Event sourcing in Python
 Home-page: https://github.com/pyeventsourcing/eventsourcing
 License: BSD 3-Clause
 Keywords: event sourcing,event store,domain driven design,domain-driven design,ddd,cqrs,cqs
 Author: John Bywater
 Author-email: john.bywater@appropriatesoftware.net
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.8, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
@@ -18,22 +18,24 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Provides-Extra: crypto
+Provides-Extra: cryptography
 Provides-Extra: postgres
 Requires-Dist: backports.zoneinfo ; python_version < "3.9"
-Requires-Dist: psycopg[c,pool] (<=3.2.99999) ; extra == "postgres"
-Requires-Dist: pycryptodome (>=3.21,<3.22) ; extra == "crypto"
+Requires-Dist: cryptography (>=44.0,<44.1) ; extra == "cryptography"
+Requires-Dist: psycopg[pool] (<=3.2.99999) ; extra == "postgres"
+Requires-Dist: pycryptodome (>=3.22,<3.23) ; extra == "crypto"
 Requires-Dist: typing_extensions
 Project-URL: Repository, https://github.com/pyeventsourcing/eventsourcing
 Description-Content-Type: text/markdown
 
-[![Build Status](https://github.com/pyeventsourcing/eventsourcing/actions/workflows/runtests.yaml/badge.svg?branch=main)](https://github.com/pyeventsourcing/eventsourcing/tree/main)
+[![Build Status](https://github.com/pyeventsourcing/eventsourcing/actions/workflows/runtests.yaml/badge.svg)](https://github.com/pyeventsourcing/eventsourcing)
 [![Coverage Status](https://coveralls.io/repos/github/pyeventsourcing/eventsourcing/badge.svg?branch=main)](https://coveralls.io/github/pyeventsourcing/eventsourcing?branch=main)
 [![Documentation Status](https://readthedocs.org/projects/eventsourcing/badge/?version=stable)](https://eventsourcing.readthedocs.io/en/stable/)
 [![Latest Release](https://badge.fury.io/py/eventsourcing.svg)](https://pypi.org/project/eventsourcing/)

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://github.com/pyeventsourcing/eventsourcing/actions/workflows/runtests.yaml/badge.svg?branch=main)](https://github.com/pyeventsourcing/eventsourcing/tree/main)
+[![Build Status](https://github.com/pyeventsourcing/eventsourcing/actions/workflows/runtests.yaml/badge.svg)](https://github.com/pyeventsourcing/eventsourcing)
 [![Coverage Status](https://coveralls.io/repos/github/pyeventsourcing/eventsourcing/badge.svg?branch=main)](https://coveralls.io/github/pyeventsourcing/eventsourcing?branch=main)
 [![Documentation Status](https://readthedocs.org/projects/eventsourcing/badge/?version=stable)](https://eventsourcing.readthedocs.io/en/stable/)
 [![Latest Release](https://badge.fury.io/py/eventsourcing.svg)](https://pypi.org/project/eventsourcing/)

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/eventsourcing/application.py

@@ -25,7 +25,7 @@ from typing import (
 )
 from warnings import warn
 
-from typing_extensions import Self, deprecated
+from typing_extensions import deprecated
 
 from eventsourcing.domain import (
     Aggregate,
@@ -57,7 +57,7 @@ from eventsourcing.persistence import (
 )
 from eventsourcing.utils import Environment, EnvType, strtobool
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from uuid import UUID
 
 ProjectorFunction = Callable[
@@ -903,21 +903,6 @@ class Application:
         need to take action when new domain events have been saved.
         """
 
-    def subscribe(self, gt: int | None = None) -> ApplicationSubscription:
-        """
-        Returns an iterator that yields all domain events recorded in an application
-        sequence that have notification IDs greater than a given value. The iterator
-        will block when all recorded domain events have been yielded, and then
-        continue when new events are recorded. Domain events are returned along
-        with tracking objects that identify the position in the application sequence.
-        """
-        return ApplicationSubscription(
-            name=self.name,
-            recorder=self.recorder,
-            mapper=self.mapper,
-            gt=gt,
-        )
-
     def close(self) -> None:
         self.closing.set()
         self.factory.close()
@@ -1042,36 +1027,3 @@ class EventSourcedLog(Generic[TDomainEvent]):
                 limit=limit,
             ),
         )
-
-
-class ApplicationSubscription:
-    def __init__(
-        self,
-        name: str,
-        recorder: ApplicationRecorder,
-        mapper: Mapper,
-        gt: int | None = None,
-    ):
-        self.name = name
-        self.recorder = recorder
-        self.mapper = mapper
-        self.subscription = self.recorder.subscribe(gt=gt)
-
-    def __enter__(self) -> Self:
-        self.subscription.__enter__()
-        return self
-
-    def __exit__(self, *args: object, **kwargs: Any) -> None:
-        self.subscription.__exit__(*args, **kwargs)
-
-    def __iter__(self) -> Self:
-        return self
-
-    def __next__(self) -> Tuple[DomainEventProtocol, Tracking]:
-        notification = next(self.subscription)
-        tracking = Tracking(self.name, notification.id)
-        domain_event = self.mapper.to_domain_event(notification)
-        return domain_event, tracking
-
-    def __del__(self) -> None:
-        self.subscription.stop()

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/eventsourcing/cipher.py

@@ -10,13 +10,14 @@ from Crypto.Cipher.AES import key_size
 
 from eventsourcing.persistence import Cipher
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from eventsourcing.utils import Environment
 
 
 class AESCipher(Cipher):
     """
-    Cipher strategy that uses AES cipher in GCM mode.
+    Cipher strategy that uses AES cipher (in GCM mode)
+    from the Python pycryptodome package.
     """
 
     CIPHER_KEY = "CIPHER_KEY"
@@ -71,6 +72,7 @@ class AESCipher(Cipher):
 
         # Return ciphertext.
         return nonce + tag + encrypted
+        # return nonce + tag + encrypted
 
     def construct_cipher(self, nonce: bytes) -> GcmMode:
         cipher = AES.new(

eventsourcing-9.4.0a2/eventsourcing/cryptography.py

@@ -0,0 +1,96 @@
+from __future__ import annotations
+
+import os
+from base64 import b64decode, b64encode
+from typing import TYPE_CHECKING
+
+from cryptography.exceptions import InvalidTag
+from cryptography.hazmat.primitives.ciphers.aead import AESGCM
+
+from eventsourcing.persistence import Cipher
+
+if TYPE_CHECKING:
+    from eventsourcing.utils import Environment
+
+
+class AESCipher(Cipher):
+    """
+    Cipher strategy that uses AES cipher (in GCM mode)
+    from the Python cryptography package.
+    """
+
+    CIPHER_KEY = "CIPHER_KEY"
+    KEY_SIZES = (16, 24, 32)
+
+    @staticmethod
+    def create_key(num_bytes: int) -> str:
+        """
+        Creates AES cipher key, with length num_bytes.
+
+        :param num_bytes: An int value, either 16, 24, or 32.
+
+        """
+        AESCipher.check_key_size(num_bytes)
+        key = AESGCM.generate_key(num_bytes * 8)
+        return b64encode(key).decode("utf8")
+
+    @staticmethod
+    def check_key_size(num_bytes: int) -> None:
+        if num_bytes not in AESCipher.KEY_SIZES:
+            msg = f"Invalid key size: {num_bytes} not in {AESCipher.KEY_SIZES}"
+            raise ValueError(msg)
+
+    @staticmethod
+    def random_bytes(num_bytes: int) -> bytes:
+        return os.urandom(num_bytes)
+
+    def __init__(self, environment: Environment):
+        """
+        Initialises AES cipher with ``cipher_key``.
+
+        :param str cipher_key: 16, 24, or 32 bytes encoded as base64
+        """
+        cipher_key = environment.get(self.CIPHER_KEY)
+        if not cipher_key:
+            msg = f"'{self.CIPHER_KEY}' not in env"
+            raise OSError(msg)
+        key = b64decode(cipher_key.encode("utf8"))
+        AESCipher.check_key_size(len(key))
+        self.key = key
+
+    def encrypt(self, plaintext: bytes) -> bytes:
+        """Return ciphertext for given plaintext."""
+
+        # Construct AES-GCM cipher, with 96-bit nonce.
+        aesgcm = AESGCM(self.key)
+        nonce = AESCipher.random_bytes(12)
+        res = aesgcm.encrypt(nonce, plaintext, None)
+        # Put tag at the front for compatibility with eventsourcing.crypto.AESCipher.
+        tag = res[-16:]
+        encrypted = res[:-16]
+        return nonce + tag + encrypted
+
+    def decrypt(self, ciphertext: bytes) -> bytes:
+        """Return plaintext for given ciphertext."""
+
+        # Split out the nonce, tag, and encrypted data.
+        nonce = ciphertext[:12]
+        if len(nonce) != 12:
+            msg = "Damaged cipher text: invalid nonce length"
+            raise ValueError(msg)
+
+        # Expect tag at the front.
+        tag = ciphertext[12:28]
+        if len(tag) != 16:
+            msg = "Damaged cipher text: invalid tag length"
+            raise ValueError(msg)
+        encrypted = ciphertext[28:]
+
+        aesgcm = AESGCM(self.key)
+        try:
+            plaintext = aesgcm.decrypt(nonce, encrypted + tag, None)
+        except InvalidTag as e:
+            msg = "Invalid cipher tag"
+            raise ValueError(msg) from e
+        # Decrypt and verify.
+        return plaintext

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/eventsourcing/domain.py

@@ -410,7 +410,7 @@ def _spec_filter_kwargs_for_method_params(method: Callable[..., Any]) -> set[str
     return set(method_signature.parameters)
 
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     EventSpecType = Union[str, Type[CanMutateAggregate]]
 
 CommandMethod = Callable[..., None]
@@ -1552,12 +1552,6 @@ class VersionError(OriginatorVersionError):
 
 
 class SnapshotProtocol(DomainEventProtocol, Protocol):
-    @property
-    def topic(self) -> str:
-        """
-        Snapshots have a read-only 'topic'.
-        """
-
     @property
     def state(self) -> Dict[str, Any]:
         """

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/eventsourcing/persistence.py

@@ -37,7 +37,7 @@ from eventsourcing.utils import (
     strtobool,
 )
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from typing_extensions import Self
 
 

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/eventsourcing/popo.py

@@ -19,7 +19,7 @@ from eventsourcing.persistence import (
 )
 from eventsourcing.utils import resolve_topic, reversed_keys
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from uuid import UUID
 
 

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/eventsourcing/postgres.py

@@ -35,7 +35,7 @@ from eventsourcing.persistence import (
 )
 from eventsourcing.utils import Environment, resolve_topic, retry, strtobool
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from uuid import UUID
 
     from typing_extensions import Self

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/eventsourcing/projection.py

@@ -5,11 +5,12 @@ import weakref
 from abc import ABC, abstractmethod
 from threading import Event, Thread
 from traceback import format_exc
-from typing import TYPE_CHECKING, Any, Dict, Generic, Type, TypeVar
+from typing import TYPE_CHECKING, Any, Dict, Generic, Iterator, Tuple, Type, TypeVar
 from warnings import warn
 
 from eventsourcing.application import Application
 from eventsourcing.dispatch import singledispatchmethod
+from eventsourcing.domain import DomainEventProtocol
 from eventsourcing.persistence import (
     InfrastructureFactory,
     Tracking,
@@ -19,11 +20,50 @@ from eventsourcing.persistence import (
 )
 from eventsourcing.utils import Environment, EnvType
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from typing_extensions import Self
 
-    from eventsourcing.application import ApplicationSubscription
-    from eventsourcing.domain import DomainEventProtocol
+
+class ApplicationSubscription(Iterator[Tuple[DomainEventProtocol, Tracking]]):
+    """
+    An iterator that yields all domain events recorded in an application
+    sequence that have notification IDs greater than a given value. The iterator
+    will block when all recorded domain events have been yielded, and then
+    continue when new events are recorded. Domain events are returned along
+    with tracking objects that identify the position in the application sequence.
+    """
+
+    def __init__(
+        self,
+        app: Application,
+        gt: int | None = None,
+    ):
+        self.name = app.name
+        self.recorder = app.recorder
+        self.mapper = app.mapper
+        self.subscription = self.recorder.subscribe(gt=gt)
+
+    def __enter__(self) -> Self:
+        self.subscription.__enter__()
+        return self
+
+    def __exit__(self, *args: object, **kwargs: Any) -> None:
+        self.subscription.__exit__(*args, **kwargs)
+
+    def __iter__(self) -> Self:
+        return self
+
+    def __next__(self) -> Tuple[DomainEventProtocol, Tracking]:
+        notification = next(self.subscription)
+        tracking = Tracking(self.name, notification.id)
+        domain_event = self.mapper.to_domain_event(notification)
+        return domain_event, tracking
+
+    def __del__(self) -> None:
+        self.stop()
+
+    def stop(self) -> None:
+        self.subscription.stop()
 
 
 class Projection(ABC, Generic[TTrackingRecorder]):
@@ -46,6 +86,8 @@ class Projection(ABC, Generic[TTrackingRecorder]):
 
 
 TProjection = TypeVar("TProjection", bound=Projection[Any])
+
+
 TApplication = TypeVar("TApplication", bound=Application)
 
 
@@ -70,8 +112,9 @@ class ProjectionRunner(Generic[TApplication, TTrackingRecorder]):
             self.projection_factory.tracking_recorder(tracking_recorder_class)
         )
 
-        self.subscription = self.app.subscribe(
-            gt=self.tracking_recorder.max_tracking_id(self.app.name)
+        self.subscription = ApplicationSubscription(
+            app=self.app,
+            gt=self.tracking_recorder.max_tracking_id(self.app.name),
         )
         self.projection = projection_class(
             tracking_recorder=self.tracking_recorder,
@@ -100,7 +143,7 @@ class ProjectionRunner(Generic[TApplication, TTrackingRecorder]):
         return Environment(name, _env)
 
     def stop(self) -> None:
-        self.subscription.subscription.stop()
+        self.subscription.stop()
 
     @staticmethod
     def _process_events_loop(

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/eventsourcing/sqlite.py

@@ -31,7 +31,7 @@ from eventsourcing.persistence import (
 )
 from eventsourcing.utils import Environment, resolve_topic, strtobool
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from types import TracebackType
 
 SQLITE3_DEFAULT_LOCK_TIMEOUT = 5

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/eventsourcing/system.py

@@ -23,7 +23,7 @@ from typing import (
     cast,
 )
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from typing_extensions import Self
 
 from eventsourcing.application import (

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/eventsourcing/tests/application.py

@@ -20,7 +20,6 @@ from eventsourcing.persistence import (
     InfrastructureFactory,
     IntegrityError,
     JSONTranscoder,
-    Tracking,
     Transcoding,
 )
 from eventsourcing.tests.domain import BankAccount, EmailAddress
@@ -490,43 +489,3 @@ class ApplicationTestCase(TestCase):
         self.assertEqual(
             "'log' is deprecated, use 'notifications' instead", w[-1].message.args[0]
         )
-
-    def test_catchup_subscription(self):
-        app = Application()
-
-        max_notification_id = app.recorder.max_notification_id()
-
-        aggregate = Aggregate()
-        aggregate.trigger_event(Aggregate.Event)
-        aggregate.trigger_event(Aggregate.Event)
-        aggregate.trigger_event(Aggregate.Event)
-        app.save(aggregate)
-
-        subscription = app.subscribe(gt=max_notification_id)
-
-        # Catch up.
-        for domain_event, tracking in subscription:
-            self.assertIsInstance(domain_event, Aggregate.Event)
-            self.assertIsInstance(tracking, Tracking)
-            self.assertEqual(tracking.application_name, app.name)
-            if max_notification_id is not None:
-                self.assertGreater(tracking.notification_id, max_notification_id)
-            if tracking.notification_id == app.recorder.max_notification_id():
-                break
-
-        max_notification_id = app.recorder.max_notification_id()
-
-        aggregate.trigger_event(Aggregate.Event)
-        aggregate.trigger_event(Aggregate.Event)
-        aggregate.trigger_event(Aggregate.Event)
-        app.save(aggregate)
-
-        # Continue.
-        for domain_event, tracking in subscription:
-            self.assertIsInstance(domain_event, Aggregate.Event)
-            self.assertIsInstance(tracking, Tracking)
-            self.assertEqual(tracking.application_name, app.name)
-            if max_notification_id is not None:
-                self.assertGreater(tracking.notification_id, max_notification_id)
-            if tracking.notification_id == app.recorder.max_notification_id():
-                break

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/eventsourcing/utils.py

@@ -22,7 +22,7 @@ from typing import (
     overload,
 )
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from types import FunctionType, WrapperDescriptorType
 
 

{eventsourcing-9.4.0a1 → eventsourcing-9.4.0a2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "eventsourcing"
-version = "9.4.0a1"
+version = "9.4.0a2"
 
 description = "Event sourcing in Python"
 authors = [
@@ -41,14 +41,16 @@ keywords=[
 ]
 
 [tool.poetry.dependencies]
-python = ">=3.8,<4.0"
+python = ">=3.8,<4.0,!=3.9.0,!=3.9.1"
 typing_extensions = "*"
-"backports.zoneinfo" = { version = "*", python =  "<3.9" }
-pycryptodome = { version = "~3.21", optional = true }
-psycopg = { version = "<=3.2.99999", optional = true, extras=["c,pool"]}
+"backports.zoneinfo" = { version = "*", python = "<3.9" }
+pycryptodome = { version = "~3.22", optional = true }
+cryptography = { version = "~44.0", optional = true }
+psycopg = { version = "<=3.2.99999", optional = true, extras=["pool"]}
 
 [tool.poetry.extras]
 crypto = ["pycryptodome"]
+cryptography = ["cryptography"]
 postgres = ["psycopg"]
 
 [tool.poetry.group.dev.dependencies]
@@ -56,8 +58,13 @@ black = { version = "*", allow-prereleases = true }
 coverage = "^7.2.7"
 isort = "*"
 mypy = "*"
-psycopg = { version = "<=3.2.99999", extras = ["binary", "pool"] }
 ruff = "^0.1.14"
+psycopg = { version = "<=3.2.99999", extras = ["pool"] }
+psycopg-c = {version="*", python = "<3.9", markers="sys_platform == 'darwin' and platform_machine == 'arm64'"}
+psycopg-binary = [
+    {version="*", python = "<3.9", markers="sys_platform != 'darwin' or platform_machine != 'arm64'"},
+    {version="*", python = ">=3.9"},
+]
 
 [tool.poetry.group.docs.dependencies]
 Sphinx = { version = "*"}
@@ -94,7 +101,19 @@ exclude = '''
 
 [tool.coverage.run]
 branch = true
-omit = []
+source = [
+    "eventsourcing"
+]
+relative_files = true
+omit = [
+    "eventsourcing/tests/*",
+    "eventsourcing/examples/bankaccounts/test.py",
+    "eventsourcing/examples/cargoshipping/domainmodel.py",
+    "eventsourcing/examples/cargoshipping/application.py",
+    "eventsourcing/examples/cargoshipping/interface.py",
+    "eventsourcing/examples/cargoshipping/test.py",
+    "eventsourcing/dispatch.py",
+]
 
 [tool.coverage.report]
 exclude_lines = [
@@ -118,6 +137,9 @@ exclude_lines = [
 ]
 #ignore_errors = true
 #precision = 2
+exclude_also = [
+    'if TYPE_CHECKING:'
+]
 
 [tool.isort]
 multi_line_output = 3

eventsourcing-9.4.0a1/eventsourcing/__init__.py

@@ -1 +0,0 @@
-__version__ = "9.3.0dev0"