spakky-event 5.0.1

Event handling stereotype for Spakky Framework (@EventHandler, @on_event)

Spakky Event

Event handling stereotype for Spakky Framework.

Installation

pip install spakky-event

Features

• @EventHandler: Stereotype for event handler classes
• @on_event: Decorator for marking methods as event handlers
• Type-safe: Full type hint support for event types
• Async support: Native async/await for event processing

Quick Start

Define Events

Events should extend AbstractDomainEvent from spakky-domain:

from dataclasses import dataclass

from spakky.domain.models.event import AbstractDomainEvent


@dataclass
class UserCreatedEvent(AbstractDomainEvent):
    user_id: str
    email: str


@dataclass
class UserDeletedEvent(AbstractDomainEvent):
    user_id: str

Create Event Handler

Use @EventHandler stereotype with @on_event decorators:

from spakky.event.stereotype.event_handler import EventHandler, on_event


@EventHandler()
class UserEventHandler:
    def __init__(self, notification_service: NotificationService) -> None:
        self.notification_service = notification_service

    @on_event(UserCreatedEvent)
    async def on_user_created(self, event: UserCreatedEvent) -> None:
        await self.notification_service.send_welcome_email(event.email)

    @on_event(UserDeletedEvent)
    async def on_user_deleted(self, event: UserDeletedEvent) -> None:
        await self.notification_service.send_goodbye_email(event.user_id)

Integration with Message Brokers

The @EventHandler stereotype works with Spakky's message broker plugins:

RabbitMQ

pip install spakky-rabbitmq

from spakky.core.application.application import SpakkyApplication
from spakky.core.application.application_context import ApplicationContext

app = (
    SpakkyApplication(ApplicationContext())
    .load_plugins()  # Loads spakky-rabbitmq plugin
    .scan()
    .start()
)

Kafka

pip install spakky-kafka

from spakky.core.application.application import SpakkyApplication
from spakky.core.application.application_context import ApplicationContext

app = (
    SpakkyApplication(ApplicationContext())
    .load_plugins()  # Loads spakky-kafka plugin
    .scan()
    .start()
)

API Reference

Stereotypes

Decorator	Description
@EventHandler()	Marks a class as an event handler (extends @Pod)
@on_event(EventType)	Marks a method as handler for specific event type

Interfaces

Class	Description
IEventPublisher	Sync event publisher interface
IAsyncEventPublisher	Async event publisher interface
IEventConsumer	Sync event consumer interface
IAsyncEventConsumer	Async event consumer interface

Types

Type	Description
EventRoute	Annotation class for event routing metadata
DomainEventT	Type variable bound to AbstractDomainEvent
IEventHandlerCallback	Type alias for event handler callbacks

Errors

Class	Description
AbstractSpakkyEventError	Base error for event operations
DuplicateEventHandlerError	Raised when duplicate handlers registered
InvalidMessageError	Raised when message is malformed

Related Packages

Package	Description
spakky-domain	DDD building blocks including AbstractDomainEvent
spakky-rabbitmq	RabbitMQ implementation of event publisher/consumer
spakky-kafka	Kafka implementation of event publisher/consumer

License

MIT License