Fix propagation of configuration to offline class and initialisation from parent class for Offline

Author: kzscisoft

CHANGELOG.md

@@ -5,6 +5,7 @@
 * Fixed bug with `requirements.txt` metadata read.
 * Added Simvue server version check.
 * Remove checking of server version in offline mode and add default run mode to configuration options.
+* Fix offline mode class initialisation, and propagation of configuration.
 
 ## [v1.1.2](https://github.com/simvue-io/client/releases/tag/v1.1.2) - 2024-11-06
 

simvue/factory/proxy/__init__.py

@@ -23,7 +23,9 @@ def Simvue(
     suppress_errors: bool = True,
 ) -> "SimvueBaseClass":
     if mode == "offline":
-        return Offline(name=name, uniq_id=uniq_id, suppress_errors=suppress_errors)
+        return Offline(
+            name=name, uniq_id=uniq_id, suppress_errors=suppress_errors, config=config
+        )
     else:
         return Remote(
             name=name, uniq_id=uniq_id, config=config, suppress_errors=suppress_errors

simvue/factory/proxy/offline.py

@@ -28,11 +28,15 @@ class Offline(SimvueBaseClass):
     """
 
     def __init__(
-        self, name: typing.Optional[str], uniq_id: str, suppress_errors: bool = True
+        self,
+        name: typing.Optional[str],
+        uniq_id: str,
+        config: SimvueConfiguration,
+        suppress_errors: bool = True,
     ) -> None:
-        super().__init__(name, uniq_id, suppress_errors)
+        super().__init__(name=name, uniq_id=uniq_id, suppress_errors=suppress_errors)
 
-        _offline_dir = SimvueConfiguration.fetch().offline.cache
+        _offline_dir = config.offline.cache
         self._directory: str = os.path.join(_offline_dir, self._uuid)
 
         os.makedirs(self._directory, exist_ok=True)

simvue/run.py

@@ -74,7 +74,7 @@ def check_run_initialised(
 ) -> typing.Callable[..., typing.Any]:
     @functools.wraps(function)
     def _wrapper(self: Self, *args: typing.Any, **kwargs: typing.Any) -> typing.Any:
-        if self._mode == "disabled":
+        if self._user_config.run.mode == "disabled":
             return True
 
         if self._retention and time.time() - self._timer > self._retention:
@@ -129,7 +129,6 @@ def __init__(
             run in debug mode, default is False
         """
         self._uuid: str = f"{uuid.uuid4()}"
-        self._mode: typing.Literal["online", "offline", "disabled"] = mode
         self._name: typing.Optional[str] = None
 
         # monitor duration with respect to retention period
@@ -202,7 +201,9 @@ def _handle_exception_throw(
         )
         _is_running: bool = self._status == "running"
         _is_running_online: bool = self._id is not None and _is_running
-        _is_running_offline: bool = self._mode == "offline" and _is_running
+        _is_running_offline: bool = (
+            self._user_config.run.mode == "offline" and _is_running
+        )
         _is_terminated: bool = (
             _exception_thrown is not None and _exception_thrown == "KeyboardInterrupt"
         )
@@ -250,7 +251,7 @@ def __exit__(
     ) -> None:
         logger.debug(
             "Automatically closing run '%s' in status %s",
-            self._id if self._mode == "online" else "unregistered",
+            self._id if self._user_config.run.mode == "online" else "unregistered",
             self._status,
         )
 
@@ -315,7 +316,7 @@ def _create_heartbeat_callback(
         self,
     ) -> typing.Callable[[threading.Event], None]:
         if (
-            self._mode == "online"
+            self._user_config.run.mode == "online"
             and (not self._user_config.server.url or not self._id)
         ) or not self._heartbeat_termination_trigger:
             raise RuntimeError("Could not commence heartbeat, run not initialised")
@@ -395,7 +396,7 @@ def _create_dispatch_callback(
         executed on metrics and events objects held in a buffer.
         """
 
-        if self._mode == "online" and not self._id:
+        if self._user_config.run.mode == "online" and not self._id:
             raise RuntimeError("Expected identifier for run")
 
         if not self._user_config.server.url:
@@ -456,7 +457,7 @@ def _online_dispatch_callback(
 
         return (
             _online_dispatch_callback
-            if self._mode == "online"
+            if self._user_config.run.mode == "online"
             else _offline_dispatch_callback
         )
 
@@ -473,10 +474,10 @@ def _start(self, reconnect: bool = False) -> bool:
         bool
             if successful
         """
-        if self._mode == "disabled":
+        if self._user_config.run.mode == "disabled":
             return True
 
-        if self._mode != "offline":
+        if self._user_config.run.mode != "offline":
             self._uuid = "notused"
 
         logger.debug("Starting run")
@@ -631,7 +632,7 @@ def init(
         bool
             whether the initialisation was successful
         """
-        if self._mode == "disabled":
+        if self._user_config.run.mode == "disabled":
             logger.warning(
                 "Simvue monitoring has been deactivated for this run, metrics and artifacts will not be recorded."
             )
@@ -650,7 +651,7 @@ def init(
                 "invalid visibility option, must be either None, 'public', 'tenant' or a list of users"
             )
 
-        if self._mode not in ("online", "offline"):
+        if self._user_config.run.mode not in ("online", "offline"):
             self._error("invalid mode specified, must be online, offline or disabled")
             return False
 
@@ -709,7 +710,7 @@ def init(
         self._simvue = Simvue(
             name=self._name,
             uniq_id=self._uuid,
-            mode=self._mode,
+            mode=self._user_config.run.mode,
             config=self._user_config,
             suppress_errors=self._suppress_errors,
         )
@@ -726,7 +727,7 @@ def init(
         if self._status == "running":
             self._start()
 
-        if self._mode == "online":
+        if self._user_config.run.mode == "online":
             click.secho(
                 f"[simvue] Run {self._name} created",
                 bold=self._term_color,
@@ -941,7 +942,11 @@ def reconnect(self, run_id: str) -> bool:
 
         self._id = run_id
         self._simvue = Simvue(
-            self._name, self._id, self._mode, self._user_config, self._suppress_errors
+            self._name,
+            self._id,
+            self._user_config.run.mode,
+            self._user_config,
+            self._suppress_errors,
         )
         self._start(reconnect=True)
 
@@ -1192,7 +1197,7 @@ def _add_metrics_to_dispatch(
         timestamp: typing.Optional[str] = None,
         join_on_fail: bool = True,
     ) -> bool:
-        if self._mode == "disabled":
+        if self._user_config.run.mode == "disabled":
             return True
 
         # If there are no metrics to log just ignore