messageit
Message (Command and Event) passing for Python
Examples
Create custom event
Custom events could be used to notify multiple subscribers about something that happened to the the application or to the world. To create custom event, you subclass the Event class and mark it as dataclass:
from dataclasses import dataclass
from messageit import Event
@dataclass
class MessageReceived(Event):
message: str = None
Each message has message_id property automatically set to an UUID. If you do not
pass correlation_id during message creation, correlation_id is set to the message_id.
The correlation_id could be used to track the execution of complex flows.
event = MessageReceived(message="Hello world")
event.message_id # UUID('ddeb3e81-3b75-403b-9b1e-13007b1f3abe')
event.correlation_id # UUID('ddeb3e81-3b75-403b-9b1e-13007b1f3abe')
Create custom command
Commands are used to perform actions. To create custom command, you subclass the Command class and mark it as dataclass:
from dataclasses import dataclass
from messageit import Command
@dataclass
class CleanMessage(Command):
message: str = None
If correlation_id is passed during message creation the passed value is set to the message's correlation_id attribute. With proper logging this could be used to track complex flows, e.g. distributed event and message handling.
clean = CleanMessage(message="Hello world", correlation_id=event.correlation_id)
clean.message_id # UUID('e0812459-5145-4de8-8d96-d0fce7fefb42')
clean.correlation_id # UUID('ddeb3e81-3b75-403b-9b1e-13007b1f3abe')
event.correlation_id # UUID('ddeb3e81-3b75-403b-9b1e-13007b1f3abe')
Handle Commands - Assign algorithm to perform the action
Building on the previous example, we could assign algorithm to be executed when action is requested:
from messageit import Executor
def clean_message(command: CleanMessage):
return command.message.strip()
commands = Executor()
commands.register(CleanMessage, clean_message)
command = CleanMessage(message=" Hello ")
commands.handle(command) # 'Hello'
Subscribe to Events - Get notified when event takes place
Building on previous examples:
from messageit import Publisher
def on_message_received(event: MessageReceived):
clean_command = CleanMessage(message = event.message, correlation_id = event.message_id)
cleaned = commands.handle(clean_command)
print(f"Cleaned message: {repr(cleaned)}")
def echo_message(event: MessageReceived):
print(f"Your input is: '{event.message}'")
raise NotImplementedError()
events = Publisher()
events.register(MessageReceived, echo_message)
events.register(MessageReceived, on_message_received)
result = events.handle(
MessageReceived(message="Hello World!!!")
) # Your input is: 'Hello World!!!''
# Cleaned message: 'Hello World!!!'
result # [None, NotImplementedError()]
The two registered subscribers were called and produced output. The result from handle() is a collection from the results returned by subscribers invoked by handle(). If subscriber raised an exception, the exception is used as return result.
Complete example
Here is a complete example putting all the pieces from above together. It is a simple command line applicationo that reads a line from the user and prints the cleansed message.
from dataclasses import dataclass
from messageit import Command, Event, Executor, Publisher
@dataclass
class CleanMessage(Command):
message: str = None
@dataclass
class MessageReceived(Event):
message: str = None
def on_message_received(event: MessageReceived):
print(f"Received message: {repr(event.message)}")
clean_command = CleanMessage(message = event.message, correlation_id = event.message_id)
cleaned = commands.handle(clean_command)
print(f"Cleaned message: {repr(cleaned)}")
def clean_message(command: CleanMessage):
return command.message.strip()
events = Publisher()
events.register(MessageReceived, on_message_received)
commands = Executor()
commands.register(CleanMessage, clean_message)
while True:
print("Type your message or leave empty to exit and press <Enter>: ")
message = input()
if message == "":
break
result = events.handle(MessageReceived(message=message))
Package and publish
To run the tests:
$ pytest
To package and publish:
$ pip install -U build twine
$ python -m build
$ python -m twine upload dist/*
Metadata
Release files for messageit 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| messageit-0.1.0.tar.gz | 7.9 kB | Without provenance | Details for messageit-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| messageit-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for messageit-0.1.0-py3-none-any.whl |
Total release size: 16.0 kB
Release files / messageit-0.1.0.tar.gz
| Download URL | messageit-0.1.0.tar.gz |
|---|---|
| Size | 7.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
688223432a4e430bab81769ca27c7385b0cfc4d2f5f591700fd49e87681c5b38
|
|
BLAKE2b-256 checksum How to use checksums |
bdc616a1f38e87389f82af39df89b5f1b604e137e73f81716d47513f4493d034
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.2
|
Release files / messageit-0.1.0-py3-none-any.whl
| Download URL | messageit-0.1.0-py3-none-any.whl |
|---|---|
| Size | 8.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c0c6a1b602f559566857fdfc28b8869a6119f5e85791c2de86daa4ddce9bae92
|
|
BLAKE2b-256 checksum How to use checksums |
e7f5d5ad0900a1d662bd0dd7e4cf8a008ab5a91c00be5971ecabd46f95585e85
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.2
|
Security for messageit 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.