- Update tests

- Fix bug with nullable lists (e.g. `boards[].drivers`)
- Add timeout to non intercept connections

Author: AndyEveritt

.vscode/settings.json

@@ -1,4 +1,12 @@
 {
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./tests",
+        "-p",
+        "test_*.py"
+    ],
+    "debugpy.debugJustMyCode": false
 }

examples/subscribe_object_model.py

@@ -13,21 +13,17 @@ def subscribe():
     subscribe_connection = SubscribeConnection(SubscriptionMode.PATCH)
     subscribe_connection.connect()
 
-    try:
-        # Get the complete model once
-        object_model = subscribe_connection.get_object_model()
-        print(object_model)
-
-        # Get multiple incremental updates, due to SubscriptionMode.PATCH, only a
-        # subset of the object model will be updated
-        for _ in range(0, 3):
-            update = subscribe_connection.get_object_model_patch()
-            object_model.update_from_json(update)
-            print(update)
-    except Exception as e:
-        print(f"An error occurred: {e}")
-    finally:
-        subscribe_connection.close()
+    # Get the complete model once
+    object_model = subscribe_connection.get_object_model()
+    print(object_model)
+
+    # Get multiple incremental updates, due to SubscriptionMode.PATCH, only a
+    # subset of the object model will be updated
+    for _ in range(0, 3):
+        update = subscribe_connection.get_object_model_patch()
+        object_model.update_from_json(update)
+        print(update)
+    subscribe_connection.close()
 
 
 if __name__ == "__main__":

requirements.txt

@@ -2,4 +2,5 @@ pytest
 wheel
 build
 twine
-bump2version
+bump2version
+python-dateutil

src/dsf/connections/base_connection.py

@@ -1,5 +1,6 @@
 import json
 import socket
+import time
 from typing import Optional
 
 from .exceptions import IncompatibleVersionException, InternalServerException, TaskCanceledException
@@ -25,7 +26,8 @@ def connect(self, init_message: client_init_messages.ClientInitMessage, socket_f
 
         self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
         self.socket.connect(socket_file)
-        self.socket.setblocking(True)
+        self.socket.settimeout(self.timeout if self.timeout > 0 else None)
+        # self.socket.setblocking(True)
         server_init_msg = server_init_message.ServerInitMessage.from_json(
             json.loads(self.socket.recv(50).decode("utf8"))
         )
@@ -98,7 +100,11 @@ def receive_json(self) -> str:
             json_string = json_string[:end_index]
         else:
             found = False
+            start_time = time.time()
             while not found:
+                if (self.timeout > 0) and (time.time() - start_time > self.timeout):
+                    raise TimeoutError("Timeout while waiting for JSON response")
+
                 # Refill the buffer and check again
                 BUFF_SIZE = 4096  # 4 KiB
                 data = b""

src/dsf/connections/intercept_connection.py

@@ -37,8 +37,9 @@ def __init__(
         auto_evaluate_expression: bool = True,
         priority_codes: bool = False,
         debug: bool = False,
+        timeout: int = 0
     ):
-        super().__init__(debug)
+        super().__init__(debug, timeout)
         self.interception_mode = interception_mode
         self.channels = channels if channels is not None else CodeChannel.list()
         self.filters = filters

src/dsf/object_model/model_collection.py

@@ -19,7 +19,14 @@ def __init__(self, item_constructor: Type[T], value: Optional[List[T]] = None) -
         self._item_constructor: Type[T] = item_constructor
 
         if value is not None:
-            self[:] = value
+            self[:] = []
+            for (i, item) in enumerate(value):
+                if isinstance(item, self._item_constructor):
+                    self.append(item)
+                else:
+                    ref_item = self._item_constructor()
+                    ref_item.update_from_json(item)
+                    self.append(ref_item)
 
     def update_from_json(self, json_element: List[Any]) -> 'ModelCollection[T]':
         """

src/dsf/object_model/utils.py

@@ -1,3 +1,5 @@
+from typing import Type, TypeVar, Any, Union, Dict
+
 
 def is_model_object(o):
     from .model_object import ModelObject
@@ -7,7 +9,10 @@ def is_model_object(o):
     return isinstance(o, ModelObject) or isinstance(o, ModelCollection) or isinstance(o, ModelDictionary)
 
 
-def wrap_model_property(name, model_type):
+T = TypeVar('T')  # Type variable for model objects
+
+
+def wrap_model_property(name: str, model_type: Type[T]) -> Union[Type[T], None]:
     """
     Wrap a nullable model object property so that type checks can be performed during update
     :param name: Property of the derived class
@@ -18,11 +23,11 @@ def wrap_model_property(name, model_type):
     STORAGE_NAME = '_' + name
 
     @property
-    def prop(self):
+    def prop(self) -> Union[Type[T], None]:
         return getattr(self, STORAGE_NAME)
 
     @prop.setter
-    def prop(self, value):
+    def prop(self, value: Union[Type[T], str, Dict[str, Any], None]):
         if value is None or isinstance(value, model_type):
             setattr(self, STORAGE_NAME, value)
         elif isinstance(value, dict):  # Update from JSON