13 Commits
0.1.0 ... 0.4.1

5 changed files with 84 additions and 7 deletions

View File

@@ -2,6 +2,38 @@
All notable changes to this project will be documented in this file.
## [0.4.1] - 2025-10-05
### Miscellaneous Tasks
- [`f307a7f`](https://gitea.pufereq.pl/judas/judas_protocol/commit/f307a7f457924ff1717ed4c8ce195ce022dd5680) **message.py**: add `target_id` argument to `Message.ack` classmethod
## [0.4.0] - 2025-10-05
### Features
- [`4cc3a5b`](https://gitea.pufereq.pl/judas/judas_protocol/commit/4cc3a5bb3a0fce0c4d90958f26fa09a1d638a4b3) **message.py**: add message uuid
## [0.3.0] - 2025-09-23
### Features
- [`ffc4ed1`](https://gitea.pufereq.pl/judas/judas_protocol/commit/ffc4ed18974e89c6f1f5554d9e8832065432310a) **message.py**: add `__str__` and `__repr__` methods
- [`bc1bf46`](https://gitea.pufereq.pl/judas/judas_protocol/commit/bc1bf46388eb904738893a2f86b5050b4ce2489e) **message.py**: raise ValueError if invalid json in `Message.from_bytes()`
### Styling
- [`9b5b104`](https://gitea.pufereq.pl/judas/judas_protocol/commit/9b5b104061859b2dd4ab93258414edd8ce34b4a7) **message.py**: organize imports
## [0.2.0] - 2025-08-29
### Features
- [`fd070b1`](https://gitea.pufereq.pl/judas/judas_protocol/commit/fd070b176347a0f7b81f937b189d8f50736f3514) **message.py**: add `b"\n"` at end of data from `to_bytes()`
- [`df55e0c`](https://gitea.pufereq.pl/judas/judas_protocol/commit/df55e0c5cba00c6d08b98cf09f265c130bc11f73) **message.py**: add `Message.from_bytes()`
- [`762d09e`](https://gitea.pufereq.pl/judas/judas_protocol/commit/762d09ea9b3e28efdfdd2ac0674bb874154b41a9) **message.py**: add `Message.to_bytes()`
- [`b90653b`](https://gitea.pufereq.pl/judas/judas_protocol/commit/b90653b3fd90957a0056dcd803da20a78a589314) **__init__.py**: add public api
## [0.1.0] - 2025-08-28
### Features

View File

@@ -4,7 +4,7 @@ build-backend = "uv_build"
[project]
name = "judas_protocol"
version = "0.1.0"
version = "0.4.1"
description = "The judas protocol"
readme = "README.md"
authors = []

View File

@@ -1 +1,6 @@
__version__: str = "0.1.0"
from .message import Message
from .types import Category, ControlAction
__all__ = ["__version__", "Message", "Category", "ControlAction"]

View File

@@ -1,9 +1,10 @@
# -*- coding: utf-8 -*-
from __future__ import annotations
from enum import Enum
import json
from typing import Any
import uuid
from enum import Enum
from typing import Any, override
from judas_protocol.types import Category, ControlAction
@@ -24,10 +25,19 @@ class Message:
action (Enum): The action of the message.
payload (dict[str, Any] | None): The payload of the message.
"""
self.id: str = str(uuid.uuid4())
self.category: Category = category
self.action: Enum = action
self.payload: dict[str, Any] = payload or {}
@override
def __str__(self) -> str:
return f"Message ({self.id}) [{self.category.name}] {self.action.name} - {self.payload}"
@override
def __repr__(self) -> str:
return f"Message(category={self.category}, action={self.action}, payload={self.payload})"
def to_dict(self) -> dict[str, Any]:
"""Convert the message to a dictionary.
@@ -35,6 +45,7 @@ class Message:
dict[str, Any]: The message as a dictionary.
"""
return {
"id": self.id,
"category": self.category,
"action": self.action,
"payload": self.payload,
@@ -48,6 +59,14 @@ class Message:
"""
return json.dumps(self.to_dict())
def to_bytes(self) -> bytes:
"""Convert the message to bytes.
Returns:
bytes: The message as bytes.
"""
return self.to_json().encode("utf-8") + b"\n"
@classmethod
def from_dict(cls, data: dict[str, Any]) -> Message:
"""Create a Message from a dictionary.
@@ -79,17 +98,38 @@ class Message:
Returns:
Message: The created message.
"""
return cls.from_dict(json.loads(data))
try:
json_data = json.loads(data)
except json.JSONDecodeError as e:
raise ValueError("Invalid JSON data") from e
return cls.from_dict(json_data)
@classmethod
def ack(cls) -> Message:
def from_bytes(cls, data: bytes) -> Message:
"""Create a Message from bytes.
Args:
data (bytes): The bytes to create the message from.
Returns:
Message: The created message.
"""
return cls.from_json(data.decode("utf-8"))
@classmethod
def ack(cls, target_id: str) -> Message:
"""Create an ACK message.
Args:
target_id (str): The ID of the message to acknowledge.
Returns:
Message: The created ACK message.
"""
return cls(
category=Category.CONTROL, action=ControlAction.ACK, payload={}
category=Category.CONTROL,
action=ControlAction.ACK,
payload={"target_id": target_id},
)
@classmethod

2
uv.lock generated
View File

@@ -240,7 +240,7 @@ wheels = [
[[package]]
name = "judas-protocol"
version = "0.1.0"
version = "0.4.1"
source = { editable = "." }
[package.dev-dependencies]