openmodule 14.2.0__tar.gz → 14.3.0__tar.gz

{openmodule-14.2.0 → openmodule-14.3.0}/ChangeLog

@@ -1,21 +1,11 @@
 CHANGES
 =======
 
-v14.2.0
+v14.3.0
 -------
 
+* Om 912: SignalListener and SignalSimulator for testcases
 * OM-1001: CostEntryData from settings models, added valid\_from and valid\_to to AccessCheckAccess and type hints for io/signals and io/inputs settings
-* docs
-* fixed testcase
-* maybe fixing openmodule\_test
-
-v14.2.0.rc0
------------
-
-* improvements for signal simulator
-* test util for signals
-* fixed testcase
-* added SignalListener
 
 v14.1.1
 -------

{openmodule-14.2.0 → openmodule-14.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openmodule
-Version: 14.2.0
+Version: 14.3.0
 Summary: Libraries for developing the arivo openmodule
 Home-page: https://gitlab.com/arivo-public/device-python/openmodule.git
 Author: ARIVO

{openmodule-14.2.0 → openmodule-14.3.0}/openmodule/models/signals.py

@@ -20,10 +20,10 @@ class SignalType(str, Enum):
 class SignalMessage(ZMQMessage):
     signal: str
     type: Union[SignalType, str]  # union so we can add new types without updating all services using signals
-    gate: Optional[str]
-    parking_area_id: Optional[str]
+    gate: Optional[str] = None
+    parking_area_id: Optional[str] = None
     value: bool
-    additional_data: Optional[Dict]
+    additional_data: Optional[Dict] = None
 
 
 class GetSignalValueRequest(OpenModuleModel):
@@ -32,7 +32,7 @@ class GetSignalValueRequest(OpenModuleModel):
 
 class GetSignalValueResponse(OpenModuleModel):
     value: bool
-    additional_data: Optional[Dict]
+    additional_data: Optional[Dict] = None
 
 
 class TriggerSignalsRequest(OpenModuleModel):

{openmodule-14.2.0 → openmodule-14.3.0}/openmodule/rpc/client.py

@@ -2,7 +2,7 @@ import logging
 import threading
 import time
 import warnings
-from typing import Dict, Optional, List, Type
+from typing import Dict, Optional, List, Type, TypeVar
 from uuid import uuid4
 
 import pydantic
@@ -18,6 +18,9 @@ from openmodule.models.rpc import RPCResponse, RPCRequest, RPCErrorResult, RPCSe
 from openmodule.rpc.common import channel_to_response_topic, channel_to_request_topic
 
 
+ResponseType = TypeVar('ResponseType', bound=OpenModuleModel)
+
+
 class RPCClient:
     class Exception(Exception):
         pass
@@ -54,11 +57,11 @@ class RPCClient:
             self.ready = threading.Event()
             self.cancelled = False
 
-        def done(self):
+        def done(self) -> bool:
             return bool(self.response)
 
         @sentry.trace(op="rpc.result")
-        def result(self, response_type: Type[OpenModuleModel], timeout=None):
+        def result(self, response_type: Type[ResponseType], timeout=None)-> ResponseType:
             if timeout and (timeout > self.timeout):
                 warnings.warn("You cannot extend the timeout of an RPC after sending the request. "
                               "The timeout will be limited to at most the initial timeout.", stacklevel=2)
@@ -91,8 +94,8 @@ class RPCClient:
                     elif error_result.status == RPCServerError.error:
                         raise RPCClient.RPCServerError(error_result.error)
                     else:
-                        assert RPCClient.ServerUnknownError("RPCErrorResult successfully parsed but status not handled."
-                                                            " Implement this!")
+                        raise RPCClient.ServerUnknownError("RPCErrorResult successfully parsed but status not handled."
+                                                           " Implement this!")
             except pydantic.ValidationError as e:
                 raise RPCClient.ValidationError(e.raw_errors, e.model)
 
@@ -158,7 +161,7 @@ class RPCClient:
                 self.results.pop(rpc_id, None)
             self.sent_ids = {k: v for k, v in self.sent_ids.items() if v > now}
 
-    def _call(self, channel: str, typ: str, request: Dict, timeout: float):
+    def _call(self, channel: str, typ: str, request: Dict, timeout: float) -> RPCEntry:
         rpc_id = str(uuid4())
 
         request = RPCRequest(rpc_id=rpc_id, name=settings.NAME, request=request, type=typ)
@@ -191,8 +194,8 @@ class RPCClient:
 
             return self._call(channel, type, request, timeout)
 
-    def rpc(self, channel: str, type: str, request: [Dict, BaseModel], response_type: Type[OpenModuleModel],
-            timeout: float = None) -> OpenModuleModel:
+    def rpc(self, channel: str, type: str, request: [Dict, BaseModel], response_type: Type[ResponseType],
+            timeout: float = None) -> ResponseType:
         with sentry.trace(name=f"{channel}/{type}", op="rpc"):
             entry = self.rpc_non_blocking(channel, type, request, timeout)
             return entry.result(response_type, timeout=timeout)

{openmodule-14.2.0 → openmodule-14.3.0}/openmodule/utils/signal_listener.py

@@ -56,10 +56,10 @@ class Signal:
 class Listener:
     def __init__(self, signal_name: str, filter_type: FilterType, callback: Callable[[Signal], None],
                  tag: Optional[str]):
-        self.signal_name = signal_name
-        self.filter_type = filter_type
-        self.callback = callback
-        self.tag = tag
+        self.signal_name: str = signal_name
+        self.filter_type: FilterType = filter_type
+        self.callback: Callable[[Signal], None] = callback
+        self.tag: Optional[str] = tag
 
     def matches(self, signal_name: str, change_type: ChangeType) -> bool:
         return self.signal_name == signal_name and self.filter_type.matches_change(change_type)
@@ -128,6 +128,7 @@ class SignalListener:
     def trigger_signals(self, tag: Optional[str] = None, timeout: float = 3.0) -> bool:
         """
         :param tag: if given, only signals of listeners with given tag are triggered
+        :param timeout: timeout for trigger RPC. Default is 3.0
         """
         try:
             with self.listeners_lock:
@@ -163,12 +164,12 @@ class SignalListener:
             for listener in self.listeners:
                 """
                 Handles the registered listeners the same as the dispatcher.
-                Is copied here because all messages are needed to keep current_states up to date.            
+                Is copied here because all messages are needed to keep current_states up to date.
                 """
                 if listener.matches(message.signal, change_type):
                     try:
                         listener.callback(Signal(message, change_type))
                     except zmq.ContextTerminated:
                         raise
-                    except Exception as e:
+                    except Exception:
                         self.log.exception("Error in signal callback")

{openmodule-14.2.0 → openmodule-14.3.0}/openmodule.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openmodule
-Version: 14.2.0
+Version: 14.3.0
 Summary: Libraries for developing the arivo openmodule
 Home-page: https://gitlab.com/arivo-public/device-python/openmodule.git
 Author: ARIVO

openmodule-14.3.0/openmodule.egg-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "d1f88e5", "is_release": true}

{openmodule-14.2.0 → openmodule-14.3.0}/openmodule_test/signal_simulator.py

@@ -18,7 +18,7 @@ class SignalSimulator:
             signal_msg = SignalMessage(signal=signal_name, type=signal_type, gate=gate, parking_area_id=parking_area_id,
                                        value=value, additional_data=additional_data)
         elif signal_type == SignalType.parkinglot_full:
-            signal_name = "parkinglot_full"
+            signal_name = signal_type.value
             signal_msg = SignalMessage(signal=signal_name, type=signal_type,
                                        value=value, additional_data=additional_data)
         elif signal_type == SignalType.area_full:

{openmodule-14.2.0 → openmodule-14.3.0}/tests/test_utils_signal.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from openmodule.models.signals import SignalMessage, SignalType, TriggerSignalsRequest, TriggerSignalsResponse
 from openmodule.rpc import RPCClient
 from openmodule.utils.signal_listener import (SignalListener, GetSignalValueRequest, GetSignalValueResponse, FilterType,
@@ -186,7 +188,7 @@ class TestSignalListener(OpenModuleCoreTestMixin):
         self.assertEqual(True, signal_listener.get_value("false"))
 
     def test_trigger(self):
-        request = None
+        request: Optional[TriggerSignalsRequest] = None
         res = TriggerSignalsResponse(success=True)
         def trigger(req: TriggerSignalsRequest, _) -> bool:
             nonlocal request, res
@@ -227,4 +229,3 @@ class TestSignalListener(OpenModuleCoreTestMixin):
         with self.assertLogs() as log:
             self.assertEqual(False, signal_listener.trigger_signals())
         self.assertIn("Error while triggering signals.", str(log.output))
-

openmodule-14.2.0/openmodule.egg-info/pbr.json

@@ -1 +0,0 @@
-{"git_version": "3b899ae", "is_release": true}