Skip to main content

Qx CQRS / Mediator: commands, queries, events, pipeline behaviors

Project description

qx-cqrs

CQRS and Mediator implementation for the Qx framework. Dispatches commands, queries, domain events, integration events, and notifications through a composable pipeline of behaviors.

What lives here

  • qx.cqrs.Mediator — central dispatcher. Resolves handlers via the DI container; supports three registration modes: decorator scan, explicit register(), and type-based lookup.
  • qx.cqrs.Command / Query — base Pydantic models for all messages. Command[TResult] mutates state; Query[TResult] is read-only.
  • qx.cqrs.command_handler / query_handler / event_handler — decorators that bind a handler class to its message type.
  • qx.cqrs.Behavior — single-method interface (handle(request, next)) for pipeline stages.
  • Built-in behaviors: LoggingBehavior, TracingBehavior, MetricsBehavior, IdempotencyBehavior, ExceptionTranslationBehavior, TransactionBehavior, ValidationBehavior, RetryBehavior, AuthorizationBehavior.
  • qx.cqrs.compose — assemble a BehaviorChain from an ordered list of behaviors.

Usage

from qx.cqrs import Command, Mediator, command_handler
from qx.core import Result

class CreateUserCommand(Command[UserDto]):
    email: str
    name: str

@command_handler(CreateUserCommand)
class CreateUserHandler:
    def __init__(self, repo: UserRepository, uow: UnitOfWork) -> None: ...

    async def handle(self, cmd: CreateUserCommand) -> Result[UserDto]:
        result = User.register(cmd.email, cmd.name)
        ...
        return Result.success(dto)

# Bootstrap
mediator = Mediator(container)
mediator.register_decorated("myapp.application")

# Dispatch (in a route or test)
result = await mediator.send(CreateUserCommand(email="a@b.com", name="Ada"), scope=scope)

Pipeline composition

from qx.cqrs import compose, LoggingBehavior, TracingBehavior, ExceptionTranslationBehavior

pipeline = compose(
    LoggingBehavior(),
    TracingBehavior(tracer),
    ExceptionTranslationBehavior(),
)
mediator = Mediator(container, pipeline=pipeline)

Design rules

  • Handlers return Result[T] — they never raise. ExceptionTranslationBehavior converts unexpected exceptions to InfrastructureError before they escape the pipeline.
  • Commands and queries are plain Pydantic models; validation happens automatically before handle() is called.
  • The mediator resolves handlers lazily per send() call so the DI scope for that request is used correctly.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qx_cqrs-1.1.0.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qx_cqrs-1.1.0-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file qx_cqrs-1.1.0.tar.gz.

File metadata

  • Download URL: qx_cqrs-1.1.0.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qx_cqrs-1.1.0.tar.gz
Algorithm Hash digest
SHA256 7f1df31bc62e678253bc0364c58d3f477c08ad009d091dc1485080861fce19e8
MD5 c20b4113d87a10b2996a8f4b4a73b7c6
BLAKE2b-256 113f231d790a5cc9d4ac75147eac291942e1afaab216f9726b58517e9026f49b

See more details on using hashes here.

File details

Details for the file qx_cqrs-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: qx_cqrs-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qx_cqrs-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 16201c614f53bc34490bc9067a39216fbab8bf8f42c73fa74e44ab8e9533b5bc
MD5 88ca4684998a44472ab7c04d9a0224dc
BLAKE2b-256 418a6ffe2a00bf59103d8f90c6eb8b3427dd5abb72916b51ddef48645531c659

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page