3 Commits

Author SHA1 Message Date
332ce3ffa1 feat(message.py): add acknowledged and ack_required properties 2025-10-05 14:36:51 +02:00
github-actions[bot]
5ef300ff93 chore(release): 0.4.3 2025-10-05 11:43:19 +00:00
1ab577ebd5 fix(message.py): provide id_ in ack() and hello() 2025-10-05 13:42:23 +02:00
4 changed files with 40 additions and 5 deletions

View File

@@ -2,6 +2,12 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [0.4.3] - 2025-10-05
### Bug Fixes
- [`1ab577e`](https://gitea.pufereq.pl/judas/judas_protocol/commit/1ab577ebd583ed17f813d37745b5dc195855d9c3) **message.py**: provide `id_` in `ack()` and `hello()`
## [0.4.2] - 2025-10-05 ## [0.4.2] - 2025-10-05
### Bug Fixes ### Bug Fixes

View File

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

View File

@@ -18,6 +18,9 @@ class Message:
category: Category, category: Category,
action: Enum, action: Enum,
payload: dict[str, Any] | None = None, payload: dict[str, Any] | None = None,
*,
acknowledged: bool = False,
ack_required: bool = False,
) -> None: ) -> None:
"""Initialize a Message. """Initialize a Message.
@@ -26,19 +29,28 @@ class Message:
category (Category): The category of the message. category (Category): The category of the message.
action (Enum): The action of the message. action (Enum): The action of the message.
payload (dict[str, Any] | None): The payload of the message. payload (dict[str, Any] | None): The payload of the message.
acknowledged (bool): Whether the message has been acknowledged. Defaults to False.
ack_required (bool): Whether the message requires an acknowledgment. Defaults to False.
""" """
self.id: str = id_ or str(uuid.uuid4()) self.id: str = id_ or str(uuid.uuid4())
self.category: Category = category self.category: Category = category
self.action: Enum = action self.action: Enum = action
self.payload: dict[str, Any] = payload or {} self.payload: dict[str, Any] = payload or {}
self.acknowledged: bool = acknowledged
self.ack_required: bool = ack_required
@override @override
def __str__(self) -> str: def __str__(self) -> str:
return f"Message ({self.id}) [{self.category.name}] {self.action.name} - {self.payload}" return f"Message ({self.id}) ack'd: {self.acknowledged}, req: {self.ack_required} [{self.category.name}] {self.action.name} - {self.payload}"
@override @override
def __repr__(self) -> str: def __repr__(self) -> str:
return f"Message(category={self.category}, action={self.action}, payload={self.payload})" return (
f"Message(id_={self.id}, category={self.category}, action={self.action}"
f", payload={self.payload}, acknowledged={self.acknowledged}"
f", ack_required={self.ack_required})"
)
def to_dict(self) -> dict[str, Any]: def to_dict(self) -> dict[str, Any]:
"""Convert the message to a dictionary. """Convert the message to a dictionary.
@@ -51,6 +63,8 @@ class Message:
"category": self.category, "category": self.category,
"action": self.action, "action": self.action,
"payload": self.payload, "payload": self.payload,
"acknowledged": self.acknowledged,
"ack_required": self.ack_required,
} }
def to_json(self) -> str: def to_json(self) -> str:
@@ -85,6 +99,8 @@ class Message:
id_: str | None = data["id"] id_: str | None = data["id"]
category = Category(data["category"]) category = Category(data["category"])
action_str = data["action"] action_str = data["action"]
acknowledged = data["acknowledged"]
ack_required = data["ack_required"]
match category: match category:
case Category.CONTROL: case Category.CONTROL:
@@ -93,7 +109,14 @@ class Message:
raise ValueError(f"Unknown category: {category}") raise ValueError(f"Unknown category: {category}")
payload = data.get("payload", {}) payload = data.get("payload", {})
return cls(id_=id_, category=category, action=action, payload=payload) return cls(
id_=id_,
category=category,
action=action,
payload=payload,
acknowledged=acknowledged,
ack_required=ack_required,
)
@classmethod @classmethod
def from_json(cls, data: str) -> Message: def from_json(cls, data: str) -> Message:
@@ -133,9 +156,12 @@ class Message:
Message: The created ACK message. Message: The created ACK message.
""" """
return cls( return cls(
id_=None,
category=Category.CONTROL, category=Category.CONTROL,
action=ControlAction.ACK, action=ControlAction.ACK,
payload={"target_id": target_id}, payload={"target_id": target_id},
acknowledged=False,
ack_required=False,
) )
@classmethod @classmethod
@@ -148,7 +174,10 @@ class Message:
Message: The created HELLO message. Message: The created HELLO message.
""" """
return cls( return cls(
id_=None,
category=Category.CONTROL, category=Category.CONTROL,
action=ControlAction.HELLO, action=ControlAction.HELLO,
payload={"mac": mac}, payload={"mac": mac},
acknowledged=False,
ack_required=True,
) )

2
uv.lock generated
View File

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