7 Commits
0.7.0 ... 0.9.0

6 changed files with 103 additions and 9 deletions

View File

@@ -2,6 +2,27 @@
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.9.0] - 2026-03-05
### Features
- [`4bba344`](https://gitea.pufereq.pl/judas/judas_protocol/commit/4bba344e8abcd64947c06b371ae84ca8f0591a9c) **message.py**: add `Message.Telemetry` factory class
- [`29bf802`](https://gitea.pufereq.pl/judas/judas_protocol/commit/29bf80235631f069be519e3e3ac0772c9a9d44db) **types.py**: add `TELEMETRY` category
## [0.8.0] - 2026-03-03
### Features
- [`7954100`](https://gitea.pufereq.pl/judas/judas_protocol/commit/795410047ef20ebb39503c09a5359e53475f2274) **types.py**: add `ActionType` type
### Miscellaneous Tasks
- [`89f9500`](https://gitea.pufereq.pl/judas/judas_protocol/commit/89f95004c1877263fbd1047fc09fe9196d8494f5) **__init__.py**: add `ActionType` to `__all__`
### Refactor
- [`1e9077c`](https://gitea.pufereq.pl/judas/judas_protocol/commit/1e9077c3a837d00c793ee50c5cbd754d5f0ec58a) **message.py**: use `ActionType` instead of `Enum`
## [0.7.0] - 2026-03-01 ## [0.7.0] - 2026-03-01
### Features ### Features

View File

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

View File

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

View File

@@ -3,10 +3,14 @@ from __future__ import annotations
import json import json
import uuid import uuid
from enum import Enum
from typing import Any, override from typing import Any, override
from judas_protocol.types import Category, ControlAction from judas_protocol.types import (
ActionType,
Category,
ControlAction,
TelemetryAction,
)
class Message: class Message:
@@ -16,7 +20,7 @@ class Message:
self, self,
id_: str | None, id_: str | None,
category: Category, category: Category,
action: Enum, action: ActionType,
payload: dict[str, Any] | None = None, payload: dict[str, Any] | None = None,
*, *,
acknowledged: bool = False, acknowledged: bool = False,
@@ -27,14 +31,14 @@ class Message:
Args: Args:
id_ (str | None): The ID of the message. If None, a new UUID will be generated. id_ (str | None): The ID of the message. If None, a new UUID will be generated.
category (Category): The category of the message. category (Category): The category of the message.
action (Enum): The action of the message. action (ActionType): 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. acknowledged (bool): Whether the message has been acknowledged. Defaults to False.
ack_required (bool): Whether the message requires an acknowledgment. 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: ActionType = action
self.payload: dict[str, Any] = payload or {} self.payload: dict[str, Any] = payload or {}
self.acknowledged: bool = acknowledged self.acknowledged: bool = acknowledged
@@ -109,6 +113,66 @@ class Message:
ack_required=True, ack_required=True,
) )
class Telemetry:
"""TELEMETRY category message factory methods."""
@staticmethod
def initial(payload: dict[str, Any]) -> Message:
"""Create an INITIAL telemetry message.
Args:
payload (dict[str, Any]): The payload of the message.
Returns:
Message: The created INITIAL telemetry message.
"""
return Message(
id_=None,
category=Category.TELEMETRY,
action=TelemetryAction.INITIAL,
payload=payload,
acknowledged=False,
ack_required=True,
)
@staticmethod
def update(payload: dict[str, Any]) -> Message:
"""Create an UPDATE telemetry message.
Args:
payload (dict[str, Any]): The payload of the message.
Returns:
Message: The created UPDATE telemetry message.
"""
return Message(
id_=None,
category=Category.TELEMETRY,
action=TelemetryAction.UPDATE,
payload=payload,
acknowledged=False,
ack_required=False,
)
@staticmethod
def on_demand(payload: dict[str, Any]) -> Message:
"""Create an ON_DEMAND telemetry message.
Args:
payload (dict[str, Any]): The payload of the message.
Returns:
Message: The created ON_DEMAND telemetry message.
"""
return Message(
id_=None,
category=Category.TELEMETRY,
action=TelemetryAction.ON_DEMAND,
payload=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.

View File

@@ -5,12 +5,21 @@ from __future__ import annotations
from enum import Enum from enum import Enum
type ActionType = ControlAction | TelemetryAction
class Category(str, Enum): class Category(str, Enum):
CONTROL = "control" CONTROL = "control"
TELEMETRY = "telemetry"
class ControlAction(str, Enum): class ControlAction(str, Enum):
HELLO = "hello" HELLO = "hello"
ACK = "ack" ACK = "ack"
CLOSE = "close" CLOSE = "close"
class TelemetryAction(str, Enum):
INITIAL = "initial"
UPDATE = "update"
ON_DEMAND = "on_demand"

2
uv.lock generated
View File

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