generated from pufereq/python-template
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8c4b49f0d7 | ||
|
f307a7f457
|
|||
|
|
0e72c93d55 | ||
|
4cc3a5bb3a
|
|||
|
|
c25ee1ebdf | ||
|
ffc4ed1897
|
|||
|
bc1bf46388
|
|||
|
9b5b104061
|
25
CHANGELOG.md
25
CHANGELOG.md
@@ -2,7 +2,30 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## [0.2.0] - 2025-08-28
|
||||
## [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
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ build-backend = "uv_build"
|
||||
|
||||
[project]
|
||||
name = "judas_protocol"
|
||||
version = "0.2.0"
|
||||
version = "0.4.1"
|
||||
description = "The judas protocol"
|
||||
readme = "README.md"
|
||||
authors = []
|
||||
|
||||
@@ -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,
|
||||
@@ -87,7 +98,12 @@ 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 from_bytes(cls, data: bytes) -> Message:
|
||||
@@ -101,14 +117,19 @@ class Message:
|
||||
return cls.from_json(data.decode("utf-8"))
|
||||
|
||||
@classmethod
|
||||
def ack(cls) -> Message:
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user