stinger-python-utils 0.1.0__py3-none-any.whl

stinger_python_utils/__init__.py

@@ -0,0 +1 @@
+""""""

stinger_python_utils/message_creator

@@ -0,0 +1,187 @@
+
+from pyqttier.message import Message
+from pydantic import BaseModel
+from typing import Union, Optional
+import uuid
+
+class MessageCreator:
+
+    @classmethod
+    def signal_message(
+        cls, topic: str, payload: BaseModel
+    ) -> Message:
+        return Message(
+            topic=topic,
+            payload=payload.model_dump_json(by_alias=True).encode("utf-8"),
+            qos=1,
+            retain=False,
+        )
+
+    @classmethod
+    def status_message(
+        cls, topic, status_message: BaseModel, expiry_seconds: int
+    ) -> Message:
+        return Message(
+            topic=topic,
+            payload=status_message.model_dump_json(by_alias=True).encode("utf-8"),
+            qos=1,
+            retain=True,
+            message_expiry_interval=expiry_seconds,
+        )
+
+    @classmethod
+    def error_response_message(
+        cls,
+        topic: str,
+        return_code: int,
+        correlation_id: Union[str, bytes],
+        debug_info: Optional[str] = None,
+    ) -> Message:
+        """
+        This could be used for a response to a request, but where there was an error fulfilling the request.
+        """
+        msg_obj = Message(
+            topic=topic,
+            payload=b"{}",
+            qos=1,
+            retain=False,
+            correlation_data=(
+                correlation_id.encode("utf-8")
+                if isinstance(correlation_id, str)
+                else correlation_id
+            ),
+            user_properties={"ReturnCode": str(return_code)},
+        )
+        if (
+            debug_info is not None and msg_obj.user_properties is not None
+        ):  # user_properties should never be None here, but checking to satisfy type checker
+            msg_obj.user_properties["DebugInfo"] = debug_info
+        return msg_obj
+
+    @classmethod
+    def response_message(
+        cls,
+        response_topic: str,
+        response_obj: BaseModel|str|bytes,
+        return_code: int,
+        correlation_id: Union[str, bytes],
+    ) -> Message:
+        """
+        This could be used for a successful response to a request.
+        """
+        payload = response_obj.model_dump_json(by_alias=True).encode("utf-8") if isinstance(response_obj, BaseModel) else response_obj
+        msg_obj = Message(
+            topic=response_topic,
+            payload=payload,
+            qos=1,
+            retain=False,
+            correlation_data=(
+                correlation_id.encode("utf-8")
+                if isinstance(correlation_id, str)
+                else correlation_id
+            ),
+            user_properties={"ReturnCode": str(return_code)},
+        )
+        return msg_obj
+
+    @classmethod
+    def property_state_message(
+        cls, topic: str, state_obj: BaseModel, state_version: Optional[int] = None
+    ) -> Message:
+        """
+        Creates a retained message representing the state/value of a property.
+        """
+        msg_obj = Message(
+            topic=topic,
+            payload=state_obj.model_dump_json(by_alias=True).encode("utf-8"),
+            qos=1,
+            retain=True,
+        )
+        if state_version is not None:
+            msg_obj.user_properties = {"PropertyVersion": str(state_version)}
+        return msg_obj
+
+    @classmethod
+    def property_update_request_message(
+        cls,
+        topic: str,
+        property_obj: BaseModel,
+        version: str,
+        response_topic: str,
+        correlation_id: Union[str, bytes, None] = None,
+    ) -> Message:
+        """
+        Creates a message representing a request to update a property.
+        """
+        msg_obj = Message(
+            topic=topic,
+            payload=property_obj.model_dump_json(by_alias=True).encode("utf-8"),
+            qos=1,
+            retain=False,
+            response_topic=response_topic,
+            correlation_data=(
+                correlation_id.encode("utf-8")
+                if isinstance(correlation_id, str)
+                else correlation_id
+            ),
+            user_properties={"PropertyVersion": str(version)},
+        )
+        return msg_obj
+
+    @classmethod
+    def property_response_message(
+        cls,
+        response_topic: str,
+        property_obj: BaseModel,
+        version: str,
+        return_code: int,
+        correlation_id: Union[str, bytes],
+        debug_info: Optional[str] = None,
+    ) -> Message:
+        """
+        Creates a message representing a response to a property update request.
+        """
+        msg_obj = Message(
+            topic=response_topic,
+            payload=property_obj.model_dump_json(by_alias=True).encode("utf-8"),
+            qos=1,
+            retain=False,
+            correlation_data=(
+                correlation_id.encode("utf-8")
+                if isinstance(correlation_id, str)
+                else correlation_id
+            ),
+            user_properties={
+                "ReturnCode": str(return_code),
+                "PropertyVersion": str(version),
+            },
+        )
+        if (
+            debug_info is not None and msg_obj.user_properties is not None
+        ):  # user_properties should never be None here, but checking to satisfy type checker
+            msg_obj.user_properties["DebugInfo"] = debug_info
+        return msg_obj
+
+    @classmethod
+    def request_message(
+        cls,
+        topic: str,
+        request_obj: BaseModel,
+        response_topic: str,
+        correlation_id: Union[str, bytes, None] = None,
+    ) -> Message:
+        if correlation_id is None:
+            correlation_id = str(uuid.uuid4())
+        msg_obj = Message(
+            topic=topic,
+            payload=request_obj.model_dump_json(by_alias=True).encode("utf-8"),
+            qos=1,
+            retain=False,
+            response_topic=response_topic,
+            correlation_data=(
+                correlation_id.encode("utf-8")
+                if isinstance(correlation_id, str)
+                else correlation_id
+            ),
+        )
+        return msg_obj

stinger_python_utils/return_codes.py

@@ -0,0 +1,151 @@
+from typing import Optional
+from enum import IntEnum
+from pyqttier.message import Message
+
+
+class MethodReturnCode(IntEnum):
+    SUCCESS = 0
+    CLIENT_ERROR = 1
+    SERVER_ERROR = 2
+    TRANSPORT_ERROR = 3
+    PAYLOAD_ERROR = 4
+    CLIENT_SERIALIZATION_ERROR = 5
+    CLIENT_DESERIALIZATION_ERROR = 6
+    SERVER_SERIALIZATION_ERROR = 7
+    SERVER_DESERIALIZATION_ERROR = 8
+    METHOD_NOT_FOUND = 9
+    UNAUTHORIZED = 10
+    TIMEOUT = 11
+    OUT_OF_SYNC = 12
+    UNKNOWN_ERROR = 13
+    NOT_IMPLEMENTED = 14
+    SERVICE_UNAVAILABLE = 15
+
+
+class StingerMethodException(Exception):
+
+    def __init__(self, return_code: MethodReturnCode, message: str):
+        super().__init__(message)
+        self._return_code = return_code
+
+    @property
+    def return_code(self) -> MethodReturnCode:
+        return self._return_code
+
+    def to_response_message(
+        self, response_topic: str, correlation_id: Optional[bytes] = None
+    ) -> Message:
+        return Message(
+            topic=response_topic,
+            payload=b"{}",
+            qos=1,
+            retain=False,
+            correlation_data=correlation_id,
+            user_properties={
+                "ReturnCode": str(self._return_code.value),
+                "DebugInfo": str(self),
+            },
+        )
+
+
+class SuccessStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.SUCCESS, message)
+
+
+class ClientErrorStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.CLIENT_ERROR, message)
+
+
+class ServerErrorStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.SERVER_ERROR, message)
+
+
+class TransportErrorStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.TRANSPORT_ERROR, message)
+
+
+class PayloadErrorStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.PAYLOAD_ERROR, message)
+
+
+class ClientSerializationErrorStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.CLIENT_SERIALIZATION_ERROR, message)
+
+
+class ClientDeserializationErrorStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.CLIENT_DESERIALIZATION_ERROR, message)
+
+
+class ServerSerializationErrorStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.SERVER_SERIALIZATION_ERROR, message)
+
+
+class ServerDeserializationErrorStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.SERVER_DESERIALIZATION_ERROR, message)
+
+
+class MethodNotFoundStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.METHOD_NOT_FOUND, message)
+
+
+class UnauthorizedStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.UNAUTHORIZED, message)
+
+
+class TimeoutStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.TIMEOUT, message)
+
+
+class OutOfSyncStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.OUT_OF_SYNC, message)
+
+
+class UnknownErrorStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.UNKNOWN_ERROR, message)
+
+
+class NotImplementedStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.NOT_IMPLEMENTED, message)
+
+
+class ServiceUnavailableStingerMethodException(StingerMethodException):
+    def __init__(self, message: str):
+        super().__init__(MethodReturnCode.SERVICE_UNAVAILABLE, message)
+
+
+def stinger_exception_factory(return_code: int, message: Optional[str] = None):
+    exc_classes = {
+        0: SuccessStingerMethodException,
+        1: ClientErrorStingerMethodException,
+        2: ServerErrorStingerMethodException,
+        3: TransportErrorStingerMethodException,
+        4: PayloadErrorStingerMethodException,
+        5: ClientSerializationErrorStingerMethodException,
+        6: ClientDeserializationErrorStingerMethodException,
+        7: ServerSerializationErrorStingerMethodException,
+        8: ServerDeserializationErrorStingerMethodException,
+        9: MethodNotFoundStingerMethodException,
+        10: UnauthorizedStingerMethodException,
+        11: TimeoutStingerMethodException,
+        12: OutOfSyncStingerMethodException,
+        13: UnknownErrorStingerMethodException,
+        14: NotImplementedStingerMethodException,
+        15: ServiceUnavailableStingerMethodException,
+    }
+    exc_class = exc_classes[return_code]
+    return exc_class(message or "")

stinger_python_utils-0.1.0.dist-info/METADATA

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: stinger-python-utils
+Version: 0.1.0
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.7
+Requires-Dist: pydantic>=2.5.3
+Requires-Dist: pyqttier>=0.1.6
+Provides-Extra: dev
+Description-Content-Type: text/markdown
+
+# stinger-python-utils
+Common code needed for stinger python generations

stinger_python_utils-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+stinger_python_utils/__init__.py,sha256=IjHRV0k2DNwvFrEHebmsXiBvmITE8nQUnsR07h9tVkU,7
+stinger_python_utils/message_creator,sha256=Tho68dvdCje0a4DELlbzH2C9fhEqg7s2TkdBDohoON0,5942
+stinger_python_utils/return_codes.py,sha256=AAwshvHu3SBoctwMX35k3j666J4a7DQ3V8AnR7QBjC8,5114
+stinger_python_utils-0.1.0.dist-info/METADATA,sha256=zHjbeGUJso2nf_tXJjT5aoJffVNKzuK2dDqXlY6Iv00,329
+stinger_python_utils-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+stinger_python_utils-0.1.0.dist-info/licenses/LICENSE,sha256=_T-8ExmblJbhv-1AxC6XDVEHg1JdJA-126NvRiMqS-I,1070
+stinger_python_utils-0.1.0.dist-info/RECORD,,

stinger_python_utils-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

stinger_python_utils-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jacob Brunson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.