add port and adapters for serializers (#178)

* refactor
* fix unknown types
* update import statements in server folder
* fix import statements and bugs
* fix conftest

Author: VigneshVSV

.github/workflows/ci-pipeline.yml

@@ -80,12 +80,14 @@ jobs:
         run: |
           source .venv/bin/activate
           ruff check --config ruff.toml hololinked/client
+          ruff check --config ruff.toml hololinked/serializers
 
       - name: run ty type checker
         if: matrix.tool == 'ty'
         run: |
           source .venv/bin/activate
           ty check hololinked/client
+          ty check hololinked/serializers
 
   scan:
     name: security scan (${{ matrix.tool }})

hololinked/__init__.py

@@ -1,4 +1,7 @@
-__version__ = "0.3.12"
+"""beginner friendly data acquisition and IoT in python."""
+
+__version__ = "0.4.0"
 
 from .config import global_config  # noqa
 import hololinked.core  # noqa: F401
+import hololinked.serializers  # noqa: F401

hololinked/client/factory.py

@@ -25,8 +25,7 @@
     OAuthDirectAccessGrant,
 )
 from hololinked.constants import ZMQ_TRANSPORTS
-from hololinked.core import Thing
-from hololinked.serializers import Serializers
+from hololinked.core import Serializers, Thing
 from hololinked.td.interaction_affordance import (
     ActionAffordance,
     EventAffordance,

hololinked/client/http/consumed_interactions.py

@@ -20,7 +20,7 @@
 )
 from hololinked.client.exceptions import raise_local_exception
 from hololinked.constants import Operations
-from hololinked.serializers import Serializers
+from hololinked.core import Serializers
 from hololinked.td.forms import Form
 from hololinked.td.interaction_affordance import (
     ActionAffordance,

hololinked/client/mqtt/consumed_interactions.py

@@ -10,7 +10,8 @@
 from paho.mqtt.client import MQTTMessage
 
 from hololinked.client.abstractions import SSE, ConsumedThingEvent
-from hololinked.serializers import BaseSerializer, Serializers  # noqa: F401
+from hololinked.core import Serializers
+from hololinked.core.interfaces import BaseSerializer  # noqa: F401
 from hololinked.td.forms import Form
 from hololinked.td.interaction_affordance import EventAffordance, PropertyAffordance
 

hololinked/client/zmq/consumed_interactions.py

@@ -35,7 +35,7 @@
     TIMEOUT,
     ResponseMessage,
 )
-from ...serializers.payloads import SerializableData
+from ...core.zmq.payloads import SerializableData
 from ...td import ActionAffordance, EventAffordance, PropertyAffordance
 from ...td.forms import Form
 from ..exceptions import ReplyNotArrivedError

hololinked/core/__init__.py

@@ -1,7 +1,15 @@
+"""
+Core logic, what is a Property, Action or Event, what is a Thing and how request-reply and pub-sub patterns work.
+
+State machines, meta classes, descriptor registries and the concrete implementation of how an operation is executed
+is also included here.
+"""
 # Order of import is reflected in this file to avoid circular imports
+
 from .thing import *  # noqa
 from .events import *  # noqa
 from .actions import *  # noqa
 from .property import *  # noqa
 from .state_machine import StateMachine as StateMachine
 from .meta import ThingMeta as ThingMeta
+from .serializer_registry import Serializers as Serializers

hololinked/core/events.py

@@ -94,7 +94,7 @@ class EventDispatcher:
     def __init__(
         self,
         unique_identifier: str,
-        publisher: "EventPublisher",
+        publisher: "EventPublisher",  # noqa TODO fix
         owner_inst: ParameterizedMetaclass,
         descriptor: Event,
     ) -> None:
@@ -104,12 +104,15 @@ def __init__(
         self.publisher = publisher
 
     @property
-    def publisher(self) -> "EventPublisher":
+    def publisher(self) -> "EventPublisher":  # noqa TODO fix
         """Event publishing PUB socket owning object"""
         return self._publisher
 
     @publisher.setter
-    def publisher(self, value: "EventPublisher") -> None:
+    def publisher(self, value: "EventPublisher") -> None:  # noqa TODO fix
+        # TODO fix this once the architecture is resolved
+        from .zmq.brokers import EventPublisher  # noqa: E402
+
         if not hasattr(self, "_publisher"):
             self._publisher = value
         elif not isinstance(value, EventPublisher):
@@ -119,7 +122,7 @@ def publisher(self, value: "EventPublisher") -> None:
 
     def push(self, data: Any) -> None:
         """
-        publish the event. Multipart payloads are not supported. Supply either a serializable object or a
+        Publish the event. Multipart payloads are not supported. Supply either a serializable object or a
         bytes object for binary data, not both.
 
         Parameters
@@ -148,9 +151,6 @@ def _set_acknowledgement(self, *args, **kwargs) -> None:
         self._synchronize_event.set()
 
 
-from .zmq.brokers import EventPublisher  # noqa: E402
-
-
 __all__ = [
     Event.__name__,
 ]

hololinked/core/interfaces/__init__.py

@@ -0,0 +1,8 @@
+"""
+Interface classes for dependencies or features that are not part of the main logic.
+
+Follows Hexagonal Architecture.
+"""
+
+# TODO once all items have base classes, dont use relative imports.
+from .serializer import BaseSerializer as BaseSerializer

hololinked/core/interfaces/serializer.py

@@ -0,0 +1,55 @@
+"""Base class for serializer implementations."""
+
+from typing import Any
+
+
+class BaseSerializer(object):
+    """
+    Base class for serializer implementations.
+
+    All serializers must inherit this class
+    and overload dumps() and loads() to be usable. Any serializer
+    that returns bytes when serialized and a python object on deserialization will be accepted.
+    Serialization and deserialization errors will be passed as invalid message type
+    from server side and a exception will be raised on the client.
+    """
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.type = None
+
+    def loads(self, data) -> Any:
+        """Deserialize data."""
+        raise NotImplementedError("implement loads()/deserialization in subclass")
+
+    def dumps(self, data) -> bytes:
+        """Serialize data."""
+        raise NotImplementedError("implement dumps()/serialization in subclass")
+
+    def convert_to_bytes(self, data) -> bytes:
+        """
+        Convert data to bytes if it is bytearray or memoryview.
+
+        Returns
+        -------
+        bytes
+
+        Raises
+        ------
+        TypeError
+            if data is not bytes, bytearray or memoryview
+        """
+        if isinstance(data, bytes):
+            return data
+        if isinstance(data, bytearray):
+            return bytes(data)
+        if isinstance(data, memoryview):
+            return data.tobytes()
+        raise TypeError(
+            "serializer convert_to_bytes accepts only bytes, bytearray or memoryview, not type {}".format(type(data))
+        )
+
+    @property
+    def content_type(self) -> str:
+        """Content type of the serializer."""
+        raise NotImplementedError("serializer must implement a content type")