generated from pufereq/python-template
Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
48a848bb60 | ||
|
0c0595b5f6
|
@@ -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.7.0] - 2026-03-01
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- [`0c0595b`](https://gitea.pufereq.pl/judas/judas_protocol/commit/0c0595b5f67526f1caa4f3650c04ae36180045c3) **message.py**: move CONTROL-specific methods into `Message.Control` inner class
|
||||||
|
|
||||||
## [0.6.0] - 2026-02-28
|
## [0.6.0] - 2026-02-28
|
||||||
|
|
||||||
### Refactor
|
### Refactor
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ build-backend = "uv_build"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "judas_protocol"
|
name = "judas_protocol"
|
||||||
version = "0.6.0"
|
version = "0.7.0"
|
||||||
description = "The judas protocol"
|
description = "The judas protocol"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
authors = []
|
authors = []
|
||||||
|
|||||||
@@ -52,6 +52,63 @@ class Message:
|
|||||||
f", ack_required={self.ack_required})"
|
f", ack_required={self.ack_required})"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
class Control:
|
||||||
|
"""CONTROL category message factory methods."""
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def ack(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 Message(
|
||||||
|
id_=None,
|
||||||
|
category=Category.CONTROL,
|
||||||
|
action=ControlAction.ACK,
|
||||||
|
payload={"target_id": target_id},
|
||||||
|
acknowledged=False,
|
||||||
|
ack_required=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def hello(id_: str) -> Message:
|
||||||
|
"""Create a HELLO message.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
id_ (str): The ID to include in the HELLO message.
|
||||||
|
Returns:
|
||||||
|
Message: The created HELLO message.
|
||||||
|
"""
|
||||||
|
return Message(
|
||||||
|
id_=None,
|
||||||
|
category=Category.CONTROL,
|
||||||
|
action=ControlAction.HELLO,
|
||||||
|
payload={"id": id_},
|
||||||
|
acknowledged=False,
|
||||||
|
ack_required=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def close() -> Message:
|
||||||
|
"""Create a CLOSE message.
|
||||||
|
Prompts the recipient to close the connection and not reconnect.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Message: The created CLOSE message.
|
||||||
|
"""
|
||||||
|
return Message(
|
||||||
|
id_=None,
|
||||||
|
category=Category.CONTROL,
|
||||||
|
action=ControlAction.CLOSE,
|
||||||
|
payload={},
|
||||||
|
acknowledged=False,
|
||||||
|
ack_required=True,
|
||||||
|
)
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
@@ -144,57 +201,3 @@ class Message:
|
|||||||
Message: The created message.
|
Message: The created message.
|
||||||
"""
|
"""
|
||||||
return cls.from_json(data.decode("utf-8"))
|
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(
|
|
||||||
id_=None,
|
|
||||||
category=Category.CONTROL,
|
|
||||||
action=ControlAction.ACK,
|
|
||||||
payload={"target_id": target_id},
|
|
||||||
acknowledged=False,
|
|
||||||
ack_required=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def hello(cls, id_: str) -> Message:
|
|
||||||
"""Create a HELLO message.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
id_ (str): The ID to include in the HELLO message.
|
|
||||||
Returns:
|
|
||||||
Message: The created HELLO message.
|
|
||||||
"""
|
|
||||||
return cls(
|
|
||||||
id_=None,
|
|
||||||
category=Category.CONTROL,
|
|
||||||
action=ControlAction.HELLO,
|
|
||||||
payload={"id": id_},
|
|
||||||
acknowledged=False,
|
|
||||||
ack_required=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def close(cls) -> Message:
|
|
||||||
"""Create a CLOSE message.
|
|
||||||
Prompts the recipient to close the connection and not reconnect.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
Message: The created CLOSE message.
|
|
||||||
"""
|
|
||||||
return cls(
|
|
||||||
id_=None,
|
|
||||||
category=Category.CONTROL,
|
|
||||||
action=ControlAction.CLOSE,
|
|
||||||
payload={},
|
|
||||||
acknowledged=False,
|
|
||||||
ack_required=True,
|
|
||||||
)
|
|
||||||
|
|||||||
Reference in New Issue
Block a user