python-cqrs 5.0.0__tar.gz → 5.1.0__tar.gz

{python_cqrs-5.0.0/src/python_cqrs.egg-info → python_cqrs-5.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-cqrs
-Version: 5.0.0
+Version: 5.1.0
 Summary: Event-Driven Architecture Framework for Distributed Systems
 Author-email: Vadim Kozyrevskiy <vadikko2@mail.ru>, Dmitry Kutlubaev <kutlubaev00@mail.ru>
 Maintainer-email: Vadim Kozyrevskiy <vadikko2@mail.ru>
@@ -29,6 +29,9 @@ Provides-Extra: pydantic
 Requires-Dist: pydantic==2.*; extra == "pydantic"
 Provides-Extra: sqlalchemy
 Requires-Dist: sqlalchemy[asyncio]==2.0.*; extra == "sqlalchemy"
+Provides-Extra: sqlmodel
+Requires-Dist: sqlmodel>=0.0.22; extra == "sqlmodel"
+Requires-Dist: sqlalchemy[asyncio]==2.0.*; extra == "sqlmodel"
 Provides-Extra: dev
 Requires-Dist: pycln==2.5.0; extra == "dev"
 Requires-Dist: pre-commit==3.8.0; extra == "dev"
@@ -54,6 +57,8 @@ Requires-Dist: dishka>=1.0; extra == "dev"
 Requires-Dist: protobuf>=4.25.8; extra == "dev"
 Requires-Dist: pydantic==2.*; extra == "dev"
 Requires-Dist: sqlalchemy[asyncio]==2.0.*; extra == "dev"
+Requires-Dist: sqlmodel>=0.0.22; extra == "dev"
+Requires-Dist: aiosqlite>=0.20.0; extra == "dev"
 Provides-Extra: examples
 Requires-Dist: fastapi==0.109.*; extra == "examples"
 Requires-Dist: faststream[kafka]==0.5.28; extra == "examples"
@@ -98,9 +103,6 @@ Dynamic: license-file
     <a href="https://codecov.io/gh/vadikko2/python-cqrs">
       <img src="https://img.shields.io/codecov/c/github/vadikko2/python-cqrs?logo=codecov&logoColor=white" alt="Coverage">
     </a>
-    <a href="https://codspeed.io/vadikko2/python-cqrs?utm_source=badge">
-      <img src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" alt="CodSpeed">
-    </a>
     <a href="https://mkdocs.python-cqrs.dev/">
       <img src="https://img.shields.io/badge/docs-mkdocs-blue?logo=readthedocs" alt="Documentation">
     </a>
@@ -113,17 +115,11 @@ Dynamic: license-file
   </p>
 </div>
 
-> [!WARNING]
-> **Breaking Changes in v5.0.0**
->
-> Starting with version 5.0.0, Pydantic support will become optional. The default implementations of `Request`, `Response`, `DomainEvent`, and `NotificationEvent` will be migrated to dataclasses-based implementations.
-
 ## Table of Contents
 
 - [Overview](#overview)
 - [When NOT to use python-cqrs](#when-not-to-use-python-cqrs)
 - [Installation](#installation)
-- [Version Support](#version-support)
 - [Quick Start](#quick-start)
 - [Request and Response Types](#request-and-response-types)
 - [Request Handlers](#request-handlers)
@@ -166,7 +162,7 @@ project ([documentation](https://akhundmurad.github.io/diator/)) with several en
 
 - **Typing:** Pydantic [v2.*](https://docs.pydantic.dev/2.8/) and `IRequest`/`IResponse` interfaces — use Pydantic-based, dataclass-based, or custom Request/Response implementations.
 - **Broker:** Kafka via [aiokafka](https://github.com/aio-libs/aiokafka).
-- **Storage:** SQLAlchemy-based Outbox and Saga storage on MySQL/MariaDB and PostgreSQL.
+- **Storage:** SQLAlchemy and SQLModel outbox and saga storage on MySQL/MariaDB and PostgreSQL.
 - **Integration:** Ready for integration with FastAPI and FastStream.
 - **Documentation:** Built-in Mermaid diagram generation (Sequence and Class diagrams).
 - **Protobuf:** Interface-level support for converting Notification events to Protobuf and back.
@@ -189,11 +185,12 @@ Do not add a Saga for a single `UPDATE` in one service, and do not use a Saga as
 pip install python-cqrs
 ```
 
-Optional extras (5.0+ — pydantic and SQLAlchemy are no longer core dependencies):
+Optional extras (5.0+ — pydantic and SQLAlchemy are no longer core dependencies; SQLModel storage is 5.1+):
 
 ```bash
 pip install "python-cqrs[pydantic]"     # PydanticRequest / Pydantic* events
 pip install "python-cqrs[sqlalchemy]"   # Outbox / Saga SQLAlchemy storage
+pip install "python-cqrs[sqlmodel]"     # Outbox / Saga SQLModel storage
 pip install "python-cqrs[kafka]"        # Kafka broker (aiokafka)
 pip install "python-cqrs[examples]"     # FastAPI, FastStream, uvicorn, etc.
 pip install "python-cqrs[aiobreaker]"   # Circuit breaker for saga fallbacks
@@ -203,37 +200,6 @@ Default `Request` / `Response` / `Event` / `DomainEvent` / `NotificationEvent` a
 are dataclass-based (`DC*`). Use `Pydantic*` types with the pydantic extra when you
 need validation.
 
-### Import paths (5.0+)
-
-| Area | Import |
-|------|--------|
-| Bootstrap | `from cqrs.bootstrap import requests, events, saga` |
-| Mediators | `from cqrs.mediators import RequestMediator, SagaMediator, …` |
-| Handlers | `from cqrs.handlers import RequestHandler, EventHandler, …` |
-| Models | `from cqrs.models import Request, Event, …` / `cqrs.models.pydantic` |
-| Maps | `from cqrs.mapping import RequestMap, EventMap, OutboxedEventMap` |
-| Mermaid | `from cqrs.mermaid import CoRMermaid, SagaMermaid` |
-| Outbox producer | `from cqrs.message_brokers.producer import EventProducer` |
-
-`SagaMediator.execute(...)` replaces the former `SagaMediator.stream(...)`
-(StreamingRequestMediator.stream is unchanged).
-
-## Version Support
-
-| Line | Git branch | What changes |
-|------|------------|--------------|
-| **4.x** | `4.x` | Bug fixes and security only (~12 months after 5.0.0) |
-| **5.x** | `master` | Features and breaking changes |
-
-Stay on 4.x until you migrate:
-
-```bash
-pip install "python-cqrs>=4,<5"
-```
-
-Docs: [4.x](https://mkdocs.python-cqrs.dev/4.0/) and [5.x / latest](https://mkdocs.python-cqrs.dev/latest/) (version switcher after mike deploy). See [SECURITY.md](SECURITY.md) for the support window and vulnerability reporting, and [CONTRIBUTING.md](CONTRIBUTING.md#8-maintaining--fixing-4x) for how to contribute 4.x bugfixes.
-
-A package-level EOL `DeprecationWarning` toward 5.x will be added on the **first 4.x patch after 5.0.0** — not before.
 
 ## Quick Start
 

{python_cqrs-5.0.0 → python_cqrs-5.1.0}/README.md

@@ -20,9 +20,6 @@
     <a href="https://codecov.io/gh/vadikko2/python-cqrs">
       <img src="https://img.shields.io/codecov/c/github/vadikko2/python-cqrs?logo=codecov&logoColor=white" alt="Coverage">
     </a>
-    <a href="https://codspeed.io/vadikko2/python-cqrs?utm_source=badge">
-      <img src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" alt="CodSpeed">
-    </a>
     <a href="https://mkdocs.python-cqrs.dev/">
       <img src="https://img.shields.io/badge/docs-mkdocs-blue?logo=readthedocs" alt="Documentation">
     </a>
@@ -35,17 +32,11 @@
   </p>
 </div>
 
-> [!WARNING]
-> **Breaking Changes in v5.0.0**
->
-> Starting with version 5.0.0, Pydantic support will become optional. The default implementations of `Request`, `Response`, `DomainEvent`, and `NotificationEvent` will be migrated to dataclasses-based implementations.
-
 ## Table of Contents
 
 - [Overview](#overview)
 - [When NOT to use python-cqrs](#when-not-to-use-python-cqrs)
 - [Installation](#installation)
-- [Version Support](#version-support)
 - [Quick Start](#quick-start)
 - [Request and Response Types](#request-and-response-types)
 - [Request Handlers](#request-handlers)
@@ -88,7 +79,7 @@ project ([documentation](https://akhundmurad.github.io/diator/)) with several en
 
 - **Typing:** Pydantic [v2.*](https://docs.pydantic.dev/2.8/) and `IRequest`/`IResponse` interfaces — use Pydantic-based, dataclass-based, or custom Request/Response implementations.
 - **Broker:** Kafka via [aiokafka](https://github.com/aio-libs/aiokafka).
-- **Storage:** SQLAlchemy-based Outbox and Saga storage on MySQL/MariaDB and PostgreSQL.
+- **Storage:** SQLAlchemy and SQLModel outbox and saga storage on MySQL/MariaDB and PostgreSQL.
 - **Integration:** Ready for integration with FastAPI and FastStream.
 - **Documentation:** Built-in Mermaid diagram generation (Sequence and Class diagrams).
 - **Protobuf:** Interface-level support for converting Notification events to Protobuf and back.
@@ -111,11 +102,12 @@ Do not add a Saga for a single `UPDATE` in one service, and do not use a Saga as
 pip install python-cqrs
 ```
 
-Optional extras (5.0+ — pydantic and SQLAlchemy are no longer core dependencies):
+Optional extras (5.0+ — pydantic and SQLAlchemy are no longer core dependencies; SQLModel storage is 5.1+):
 
 ```bash
 pip install "python-cqrs[pydantic]"     # PydanticRequest / Pydantic* events
 pip install "python-cqrs[sqlalchemy]"   # Outbox / Saga SQLAlchemy storage
+pip install "python-cqrs[sqlmodel]"     # Outbox / Saga SQLModel storage
 pip install "python-cqrs[kafka]"        # Kafka broker (aiokafka)
 pip install "python-cqrs[examples]"     # FastAPI, FastStream, uvicorn, etc.
 pip install "python-cqrs[aiobreaker]"   # Circuit breaker for saga fallbacks
@@ -125,37 +117,6 @@ Default `Request` / `Response` / `Event` / `DomainEvent` / `NotificationEvent` a
 are dataclass-based (`DC*`). Use `Pydantic*` types with the pydantic extra when you
 need validation.
 
-### Import paths (5.0+)
-
-| Area | Import |
-|------|--------|
-| Bootstrap | `from cqrs.bootstrap import requests, events, saga` |
-| Mediators | `from cqrs.mediators import RequestMediator, SagaMediator, …` |
-| Handlers | `from cqrs.handlers import RequestHandler, EventHandler, …` |
-| Models | `from cqrs.models import Request, Event, …` / `cqrs.models.pydantic` |
-| Maps | `from cqrs.mapping import RequestMap, EventMap, OutboxedEventMap` |
-| Mermaid | `from cqrs.mermaid import CoRMermaid, SagaMermaid` |
-| Outbox producer | `from cqrs.message_brokers.producer import EventProducer` |
-
-`SagaMediator.execute(...)` replaces the former `SagaMediator.stream(...)`
-(StreamingRequestMediator.stream is unchanged).
-
-## Version Support
-
-| Line | Git branch | What changes |
-|------|------------|--------------|
-| **4.x** | `4.x` | Bug fixes and security only (~12 months after 5.0.0) |
-| **5.x** | `master` | Features and breaking changes |
-
-Stay on 4.x until you migrate:
-
-```bash
-pip install "python-cqrs>=4,<5"
-```
-
-Docs: [4.x](https://mkdocs.python-cqrs.dev/4.0/) and [5.x / latest](https://mkdocs.python-cqrs.dev/latest/) (version switcher after mike deploy). See [SECURITY.md](SECURITY.md) for the support window and vulnerability reporting, and [CONTRIBUTING.md](CONTRIBUTING.md#8-maintaining--fixing-4x) for how to contribute 4.x bugfixes.
-
-A package-level EOL `DeprecationWarning` toward 5.x will be added on the **first 4.x patch after 5.0.0** — not before.
 
 ## Quick Start
 

{python_cqrs-5.0.0 → python_cqrs-5.1.0}/pyproject.toml

@@ -29,12 +29,13 @@ maintainers = [{ name = "Vadim Kozyrevskiy", email = "vadikko2@mail.ru" }]
 name = "python-cqrs"
 readme = "README.md"
 requires-python = ">=3.10"
-version = "5.0.0"
+version = "5.1.0"
 
 [project.optional-dependencies]
 aiobreaker = ["aiobreaker>=0.3.0"]
 pydantic = ["pydantic==2.*"]
 sqlalchemy = ["sqlalchemy[asyncio]==2.0.*"]
+sqlmodel = ["sqlmodel>=0.0.22", "sqlalchemy[asyncio]==2.0.*"]
 dev = [
   # Develope tools
   "pycln==2.5.0",
@@ -64,6 +65,8 @@ dev = [
   # Full suite extras
   "pydantic==2.*",
   "sqlalchemy[asyncio]==2.0.*",
+  "sqlmodel>=0.0.22",
+  "aiosqlite>=0.20.0",
 ]
 examples = [
   "fastapi==0.109.*",
@@ -95,6 +98,7 @@ testpaths = ["tests"]
 markers = [
   "pydantic: tests that require the pydantic optional extra",
   "sqlalchemy: tests that require the sqlalchemy optional extra",
+  "sqlmodel: tests that require the sqlmodel optional extra",
 ]
 
 [tool.setuptools.packages.find]

{python_cqrs-5.0.0 → python_cqrs-5.1.0}/src/cqrs/__init__.py

@@ -12,6 +12,7 @@ if typing.TYPE_CHECKING:
         SqlAlchemyOutboxedEventRepository,
         rebind_outbox_model,
     )
+    from cqrs.outbox.sqlmodel import SqlModelOutboxedEventRepository
     from cqrs.sqlalchemy_types import (
         Binary16,
         DialectAwareType,
@@ -129,6 +130,7 @@ __all__ = (
     "PydanticResponse",
     "OutboxedEventRepository",
     "SqlAlchemyOutboxedEventRepository",
+    "SqlModelOutboxedEventRepository",
     "EventProducer",
     "EventSerializer",
     "EventCodec",
@@ -187,6 +189,13 @@ _LAZY_SQLALCHEMY = {
     "PayloadBinary": ("cqrs.sqlalchemy_types", "PayloadBinary"),
 }
 
+_LAZY_SQLMODEL = {
+    "SqlModelOutboxedEventRepository": (
+        "cqrs.outbox.sqlmodel",
+        "SqlModelOutboxedEventRepository",
+    ),
+}
+
 
 def __getattr__(name: str) -> typing.Any:
     if name in _LAZY_PYDANTIC:
@@ -201,4 +210,9 @@ def __getattr__(name: str) -> typing.Any:
         # ImportError message is raised by the sqlalchemy modules themselves.
         module = __import__(module_name, fromlist=[attr])
         return getattr(module, attr)
+    if name in _LAZY_SQLMODEL:
+        module_name, attr = _LAZY_SQLMODEL[name]
+        # ImportError message is raised by the sqlmodel modules themselves.
+        module = __import__(module_name, fromlist=[attr])
+        return getattr(module, attr)
     raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

{python_cqrs-5.0.0 → python_cqrs-5.1.0}/src/cqrs/outbox/sqlalchemy.py

@@ -173,11 +173,13 @@ class SqlAlchemyOutboxedEventRepository(repository.OutboxedEventRepository):
         *,
         serializer: EventCodec | None = None,
         event_map: map.OutboxedEventMap | None = None,
+        model: typing.Any = None,
     ):
         self.session = session
         self._compressor = compressor
         self._serializer = serializer or JsonEventSerializer()
         self._event_map = event_map if event_map is not None else map.OutboxedEventMap
+        self._model = OutboxModel if model is None else model
 
     def _resolve_codec(self, event_name: str) -> EventCodec:
         return self._event_map.get_serializer(event_name) or self._serializer
@@ -211,7 +213,7 @@ class SqlAlchemyOutboxedEventRepository(repository.OutboxedEventRepository):
             bytes_payload = self._compressor.compress(bytes_payload)
 
         self.session.add(
-            OutboxModel(
+            self._model(
                 event_id=event.event_id,
                 event_id_bin=event.event_id.bytes,
                 event_name=event.event_name,
@@ -221,7 +223,7 @@ class SqlAlchemyOutboxedEventRepository(repository.OutboxedEventRepository):
             ),
         )
 
-    def _process_events(self, model: OutboxModel) -> repository.OutboxedEvent | None:
+    def _process_events(self, model: typing.Any) -> repository.OutboxedEvent | None:
         event_dict = model.row_to_dict()
         event_name = event_dict["event_name"]
 
@@ -260,8 +262,8 @@ class SqlAlchemyOutboxedEventRepository(repository.OutboxedEventRepository):
         batch_size: int = 100,
         topic: typing.Text | None = None,
     ) -> typing.List[repository.OutboxedEvent]:
-        events: typing.Sequence[OutboxModel] = (
-            (await self.session.execute(OutboxModel.get_batch_query(batch_size, topic))).scalars().all()
+        events: typing.Sequence[typing.Any] = (
+            (await self.session.execute(self._model.get_batch_query(batch_size, topic))).scalars().all()
         )
 
         result = []
@@ -285,7 +287,7 @@ class SqlAlchemyOutboxedEventRepository(repository.OutboxedEventRepository):
         new_status: repository.EventStatus,
     ) -> None:
         await self.session.execute(
-            statement=OutboxModel.update_status_query(outboxed_event_id, new_status),
+            statement=self._model.update_status_query(outboxed_event_id, new_status),
         )
 
     async def commit(self):

python_cqrs-5.1.0/src/cqrs/outbox/sqlmodel.py

@@ -0,0 +1,189 @@
+"""SQLModel outbox: same table, queries, and repository behavior as SQLAlchemy."""
+
+import datetime
+import typing
+import uuid
+
+from cqrs import compressors
+from cqrs.mapping import outbox as map
+from cqrs.outbox import repository
+from cqrs.serializers.protocol import EventCodec
+
+try:
+    from cqrs.outbox.sqlalchemy import (
+        MAX_FLUSH_COUNTER_VALUE,
+        BinaryUUID,
+        OutboxModel as SqlAlchemyOutboxModel,
+        SqlAlchemyOutboxedEventRepository,
+        rebind_outbox_model,
+    )
+
+    import sqlalchemy
+    from sqlalchemy import func
+    from sqlmodel import Field
+    from sqlmodel.ext.asyncio.session import AsyncSession
+
+    from cqrs import sqlalchemy_types
+    from cqrs.sqlmodel_base import CqrsSQLModel, SqlAlchemyExecuteSession
+except ImportError:
+    raise ImportError(
+        "You are trying to use the SQLModel outbox implementation, "
+        "but 'sqlmodel' is not installed. "
+        "Please install it using: pip install python-cqrs[sqlmodel]",
+    ) from None
+
+Base = CqrsSQLModel
+
+DEFAULT_OUTBOX_TABLE_NAME = "outbox"
+
+
+class OutboxModel(Base, table=True):
+    __tablename__ = DEFAULT_OUTBOX_TABLE_NAME  # type: ignore[assignment]
+
+    __table_args__ = (
+        sqlalchemy.UniqueConstraint(
+            "event_id_bin",
+            "event_name",
+            name="event_id_unique_index",
+        ),
+    )
+
+    id: int | None = Field(
+        default=None,
+        sa_column=sqlalchemy.Column(
+            sqlalchemy.BigInteger,
+            sqlalchemy.Identity(),
+            primary_key=True,
+            nullable=False,
+            autoincrement=True,
+            comment="Identity",
+        ),
+    )
+    event_id: uuid.UUID = Field(
+        sa_column=sqlalchemy.Column(
+            sqlalchemy_types.UUIDBinary,
+            nullable=False,
+            comment="Event idempotency id",
+        ),
+    )
+    event_id_bin: bytes = Field(
+        sa_column=sqlalchemy.Column(
+            sqlalchemy_types.Binary16,
+            nullable=False,
+            comment="Event idempotency id in 16 bit presentation",
+        ),
+    )
+    event_status: repository.EventStatus = Field(
+        default=repository.EventStatus.NEW,
+        sa_column=sqlalchemy.Column(
+            sqlalchemy.Enum(repository.EventStatus),
+            nullable=False,
+            default=repository.EventStatus.NEW,
+            comment="Event producing status",
+        ),
+    )
+    flush_counter: int = Field(
+        default=0,
+        sa_column=sqlalchemy.Column(
+            sqlalchemy.SmallInteger,
+            nullable=False,
+            default=0,
+            comment="Event producing flush counter",
+        ),
+    )
+    event_name: str = Field(
+        sa_column=sqlalchemy.Column(
+            sqlalchemy.String(255),
+            nullable=False,
+            comment="Event name",
+        ),
+    )
+    topic: str = Field(
+        default="",
+        sa_column=sqlalchemy.Column(
+            sqlalchemy.String(255),
+            nullable=False,
+            default="",
+            comment="Event topic",
+        ),
+    )
+    created_at: datetime.datetime | None = Field(
+        default=None,
+        sa_column=sqlalchemy.Column(
+            sqlalchemy.DateTime,
+            nullable=False,
+            server_default=func.now(),
+            comment="Event creation timestamp",
+        ),
+    )
+    payload: bytes = Field(
+        sa_column=sqlalchemy.Column(
+            sqlalchemy_types.PayloadBinary,
+            nullable=False,
+            comment="Event payload",
+        ),
+    )
+
+    def row_to_dict(self) -> typing.Dict[typing.Text, typing.Any]:
+        table = typing.cast(typing.Any, self).__table__
+        return {column.name: getattr(self, column.name) for column in table.columns}
+
+    @classmethod
+    def get_batch_query(
+        cls,
+        size: int,
+        topic: typing.Text | None = None,
+    ) -> sqlalchemy.Select:
+        query = SqlAlchemyOutboxModel.get_batch_query
+        return query.__func__(cls, size, topic)  # type: ignore[attr-defined]
+
+    @classmethod
+    def update_status_query(
+        cls,
+        outboxed_event_id: int,
+        status: repository.EventStatus,
+    ) -> sqlalchemy.Update:
+        query = SqlAlchemyOutboxModel.update_status_query
+        return query.__func__(cls, outboxed_event_id, status)  # type: ignore[attr-defined]
+
+    @classmethod
+    def status_sorting_case(cls) -> sqlalchemy.Case:
+        query = SqlAlchemyOutboxModel.status_sorting_case
+        return query.__func__(cls)  # type: ignore[attr-defined]
+
+
+class SqlModelOutboxedEventRepository(SqlAlchemyOutboxedEventRepository):
+    """Outbox repository that stores rows as SQLModel ``OutboxModel`` instances.
+
+    Pass a ``sqlmodel.ext.asyncio.session.AsyncSession``. Behavior matches
+    ``SqlAlchemyOutboxedEventRepository``: the same batch query, flush budget,
+    status ordering, codecs, and compressor hooks.
+    """
+
+    def __init__(
+        self,
+        session: AsyncSession,
+        compressor: compressors.Compressor | None = None,
+        *,
+        serializer: EventCodec | None = None,
+        event_map: map.OutboxedEventMap | None = None,
+    ):
+        super().__init__(
+            typing.cast(typing.Any, SqlAlchemyExecuteSession(session)),
+            compressor,
+            serializer=serializer,
+            event_map=event_map,
+            model=OutboxModel,
+        )
+
+
+__all__ = (
+    "AsyncSession",
+    "Base",
+    "BinaryUUID",
+    "DEFAULT_OUTBOX_TABLE_NAME",
+    "MAX_FLUSH_COUNTER_VALUE",
+    "OutboxModel",
+    "SqlModelOutboxedEventRepository",
+    "rebind_outbox_model",
+)