stinger-python-utils 0.1.3__tar.gz

stinger_python_utils-0.1.3/.gitignore

@@ -0,0 +1,210 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# uv
+.uv
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

stinger_python_utils-0.1.3/.python-version

@@ -0,0 +1,4 @@
+# Manage Python versions and dependencies with uv
+# https://docs.astral.sh/uv/
+
+Python = "3.7"

stinger_python_utils-0.1.3/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.

stinger_python_utils-0.1.3/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: stinger-python-utils
+Version: 0.1.3
+Summary: Common utilities for Stinger Python services.
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.7
+Requires-Dist: pydantic>=2.5.3
+Requires-Dist: pyqttier>=0.2.0
+Description-Content-Type: text/markdown
+
+# stinger-python-utils
+Common code needed for stinger python generations

stinger_python_utils-0.1.3/README.md

@@ -0,0 +1,2 @@
+# stinger-python-utils
+Common code needed for stinger python generations

stinger_python_utils-0.1.3/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "stinger-python-utils"
+version = "0.1.3"
+description = "Common utilities for Stinger Python services."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.7"
+dependencies = [
+    "pydantic>=2.5.3",
+    "pyqttier>=0.2.0",
+]
+
+[tool.uv]
+managed = true
+
+[dependency-groups]
+dev = [
+    "black>=23.3.0",
+    "mypy>=1.4.1",
+]

stinger_python_utils-0.1.3/src/stinger_python_utils/__init__.py

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

stinger_python_utils-0.1.3/src/stinger_python_utils/message_creator.py

@@ -0,0 +1,191 @@
+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, None] = None,
+        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, None] = None,
+    ) -> Message:
+        """
+        This could be used for a successful response to a request.
+        """
+        if isinstance(response_obj, BaseModel):
+            payload = response_obj.model_dump_json(by_alias=True).encode("utf-8")
+        elif isinstance(response_obj, str):
+            payload = response_obj.encode("utf-8")
+        else:
+            payload = 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,
+            content_type="application/json",
+        )
+        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, None] = None,
+        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-0.1.3/src/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 "")