python-cq 0.18.0

CQRS library for async Python projects.

python-cq

python-cq is an async-first Python library for organizing code around CQRS. It separates reads (queries), writes (commands), and notifications (events) into dedicated message buses, and lets you plug in any dependency injection framework behind a small protocol.

What is CQRS?

CQRS (Command Query Responsibility Segregation) splits read operations from write operations. Each operation has a single, well-defined responsibility, which:

• clarifies intent: a CreateUserCommand does one thing, and its name says so;
• keeps handlers small: one message, one handler, easy to test in isolation;
• makes side effects explicit: events fan out to subscribers without coupling the producer to them.

CQRS is often discussed alongside distributed systems and Event Sourcing, but the pattern is just as useful in a local or monolithic application. The boundaries it draws are valuable on their own.

Three message types

Type	Intent	Handlers	Returns
Command	Change the state of the system	Exactly one	The handler's return value
Query	Read state without side effects	Exactly one	The handler's return value
Event	Notify that something has happened	Zero, one, or many	Nothing

A Command is allowed to return a value (for convenience, typically an id or a result object), but that does not mean it should be used as a query. Keep intent clear.

Installation

Requires Python 3.12 or higher.

With the default DI backend (python-injection, recommended):

pip install "python-cq[injection]"

Without dependency injection (you will need to implement a DIAdapter):

pip install python-cq

Quickstart

import asyncio
from cq import CommandBus, command_handler
from dataclasses import dataclass
from injection import inject

@dataclass
class CreateUserCommand:
    name: str
    email: str

@command_handler
class CreateUserHandler:
    async def handle(self, command: CreateUserCommand) -> int:
        # ... persist the user, return its id
        return 42

@inject
async def main(bus: CommandBus[int]) -> None:
    command = CreateUserCommand(name="Ada", email="[e-mail]")
    user_id = await bus.dispatch(command)
    print(f"Created user {user_id}")

asyncio.run(main())

The decorator registers the handler against the type of its first handle parameter. The bus is resolved by the DI container and dispatched to that handler.

Prerequisites

Familiarity with the following helps you get the most out of python-cq:

• CQRS, in particular the distinction between Commands, Queries, and Events.
• Domain Driven Design (DDD), particularly aggregates and bounded contexts, which complement CQRS well.