stinger-ipc 0.0.1__py3-none-any.whl

stingeripc/connection.py

@@ -0,0 +1,7 @@
+from abc import ABC, abstractmethod
+
+class AbstractConnection(ABC):
+
+    @abstractmethod
+    def publish(self, topic: str, payload: str, qos: int, retain:bool=False):
+        pass

stingeripc/exceptions.py

@@ -0,0 +1,3 @@
+
+class InvalidStingerStructure(Exception):
+    pass

stingeripc/interface.py

@@ -0,0 +1,38 @@
+from typing import Optional, Any, Dict, IO, Union
+import yaml
+import yamlloader
+
+from .components import StingerSpec, InvalidStingerStructure
+from .topic import InterfaceTopicCreator
+
+VERSION_SUPPORTED = "0.0.6"
+
+
+class StingerInterface(StingerSpec):
+
+    def __init__(self, stinger: Dict[str, Any], topic_prefix: Optional[str] = None):
+        itc = self._create_topic_creator(stinger)
+        super().__init__(itc, stinger['interface'])
+
+    @staticmethod
+    def _create_topic_creator(stinger_spec: Dict[str, Any], topic_prefix: Optional[str] = None) -> InterfaceTopicCreator:
+        if (
+            "stingeripc" not in stinger_spec
+            or "version" not in stinger_spec["stingeripc"]
+            or stinger_spec["stingeripc"]["version"] not in [VERSION_SUPPORTED]
+        ):
+            raise InvalidStingerStructure(
+                f"Provided Stinger Spec does not claim to be version {VERSION_SUPPORTED}"
+            )
+        if "interface" not in stinger_spec or "name" not in stinger_spec["interface"]:
+            raise InvalidStingerStructure(
+                "Could not find interface name in Stinger Spec"
+            )
+        itc = InterfaceTopicCreator(stinger_spec["interface"]["name"], root=topic_prefix)
+        return itc
+
+    @classmethod
+    def from_yaml(cls, yaml_input: Union[str, IO]) -> StingerSpec:
+        yaml_obj = yaml.load(yaml_input, Loader=yamlloader.ordereddict.Loader)
+        itc = cls._create_topic_creator(yaml_obj)
+        return cls.new_spec_from_stinger(itc, yaml_obj)

stingeripc/topic.py

@@ -0,0 +1,67 @@
+from typing import Optional
+
+
+class TopicCreatorBase:
+    def __init__(self, root: Optional[str] = None):
+        if root is None:
+            self._base_topic = None
+        else:
+            self._base_topic = root.strip("/")
+
+    def slash(self, *args) -> str:
+        if self._base_topic is None:
+            return "/".join(args)
+        else:
+            return f"{self._base_topic}/{'/'.join(args)}"
+
+
+class SignalTopicCreator(TopicCreatorBase):
+    def __init__(self, root: str):
+        super().__init__(root)
+
+    def signal_topic(self, signal_name: str) -> str:
+        return self.slash("signal", signal_name)
+
+class MethodTopicCreator(TopicCreatorBase):
+    def __init__(self, root: str):
+        super().__init__(root)
+
+    def method_topic(self, method_name: str) -> str:
+        return self.slash("method", method_name)
+
+    def method_response_topic(self, method_name: str, client_id: str) -> str:
+        method_topic = self.method_topic(method_name)
+        return f"client/{client_id}/{method_topic}/response"
+
+class PropertyTopicCreator(TopicCreatorBase):
+    def __init__(self, root: str):
+        super().__init__(root)
+
+    def property_value_topic(self, property_name: str) -> str:
+        return self.slash("property", property_name)
+    
+    def property_update_topic(self, property_name: str) -> str:
+        return self.slash("property", property_name, "set_value");
+
+class InterfaceTopicCreator(TopicCreatorBase):
+    """Helper class for creating MQTT topics for various stinger elements."""
+
+    def __init__(self, interface_name: str, root: Optional[str] = None):
+        super().__init__(root)
+        self._interface_name = interface_name
+
+    @property
+    def _topic_prefix(self) -> str:
+        return self.slash(self._interface_name)
+
+    def interface_info_topic(self) -> str:
+        return f"{self._topic_prefix}/interface"
+
+    def signal_topic_creator(self) -> SignalTopicCreator:
+        return SignalTopicCreator(self._topic_prefix)
+
+    def method_topic_creator(self) -> MethodTopicCreator:
+        return MethodTopicCreator(self._topic_prefix)
+
+    def property_topic_creator(self) -> PropertyTopicCreator:
+        return PropertyTopicCreator(self._topic_prefix)