Merge branch 'v1.1' into dev

Author: kzscisoft

CHANGELOG.md

@@ -5,10 +5,18 @@
 * Add support for defining Simvue run defaults using `tool.simvue` in a project `pyproject.toml` file.
 * Drop support for INI based configuration files.
 * Retrieve all metric values if `max_points` is unspecified or set to `None`.
+
+## [v1.1.3](https://github.com/simvue-io/client/releases/tag/v1.1.3) - 2024-12-09
+
 * 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
 
 * Fix bug in offline mode directory retrieval.
+
 ## [v1.1.1](https://github.com/simvue-io/client/releases/tag/v1.1.1) - 2024-10-22
 
 * Add missing `offline.cache` key to TOML config.

CITATION.cff

@@ -42,6 +42,6 @@ keywords:
   - alerting
   - simulation
 license: Apache-2.0
-commit: e220740c747a56de0915d583918e1999d253fdfc
-version: 1.1.2
-date-released: '2024-11-06'
+commit: 3ea5c3f1a579a44bc144a8fa0e2983475e46dd63
+version: 1.1.3
+date-released: '2024-12-09'

poetry.lock

@@ -55,6 +55,7 @@ tabulate = "^0.9.0"
 randomname = "^0.2.1"
 codecarbon = "^2.7.1"
 numpy = "^2.1.2"
+semver = "^3.0.2"
 
 [tool.poetry.extras]
 plot = ["matplotlib", "plotly"]

pyproject.toml

@@ -7,18 +7,13 @@
 """
 
 import logging
-import os
 import time
 import pydantic
 import typing
 import pathlib
-import http
-import functools
 
 import simvue.models as sv_models
 from simvue.utilities import get_expiry
-from simvue.version import __version__
-from simvue.api import get
 
 
 logger = logging.getLogger(__file__)
@@ -42,37 +37,6 @@ def check_token(cls, v: typing.Any) -> str:
             raise AssertionError("Simvue token has expired")
         return value
 
-    @classmethod
-    @functools.lru_cache
-    def _check_server(cls, token: str, url: str) -> None:
-        headers: dict[str, str] = {
-            "Authorization": f"Bearer {token}",
-            "User-Agent": f"Simvue Python client {__version__}",
-        }
-        try:
-            response = get(f"{url}/api/version", headers)
-
-            if response.status_code != http.HTTPStatus.OK or not response.json().get(
-                "version"
-            ):
-                raise AssertionError
-
-            if response.status_code == http.HTTPStatus.UNAUTHORIZED:
-                raise AssertionError("Unauthorised token")
-
-        except Exception as err:
-            raise AssertionError(f"Exception retrieving server version: {str(err)}")
-
-    @pydantic.model_validator(mode="after")
-    @classmethod
-    def check_valid_server(cls, values: "ServerSpecifications") -> bool:
-        if os.environ.get("SIMVUE_NO_SERVER_CHECK"):
-            return values
-
-        cls._check_server(values.token, values.url)
-
-        return values
-
 
 class OfflineSpecifications(pydantic.BaseModel):
     cache: typing.Optional[pathlib.Path] = None
@@ -89,6 +53,7 @@ class DefaultRunSpecifications(pydantic.BaseModel):
     tags: typing.Optional[list[str]] = None
     folder: str = pydantic.Field("/", pattern=sv_models.FOLDER_REGEX)
     metadata: typing.Optional[dict[str, typing.Union[str, int, float, bool]]] = None
+    mode: typing.Literal["offline", "disabled", "online"] = "online"
 
 
 class ClientGeneralOptions(pydantic.BaseModel):

simvue/config/parameters.py

@@ -10,10 +10,11 @@
 import logging
 import os
 import typing
+import http
 import pathlib
-
 import pydantic
 import toml
+import semver
 
 import simvue.utilities as sv_util
 from simvue.config.parameters import (
@@ -28,9 +29,16 @@
     CONFIG_INI_FILE_NAMES,
     DEFAULT_OFFLINE_DIRECTORY,
 )
+from simvue.version import __version__
+from simvue.api import get
 
 logger = logging.getLogger(__name__)
 
+SIMVUE_SERVER_UPPER_CONSTRAINT: typing.Optional[semver.Version] = semver.Version.parse(
+    "1.0.0"
+)
+SIMVUE_SERVER_LOWER_CONSTRAINT: typing.Optional[semver.Version] = None
+
 
 class SimvueConfiguration(pydantic.BaseModel):
     # Hide values as they contain token and URL
@@ -74,12 +82,65 @@ def _load_pyproject_configs(cls) -> typing.Optional[dict]:
 
         return _simvue_setup
 
+    @classmethod
+    @functools.lru_cache
+    def _check_server(
+        cls, token: str, url: str, mode: typing.Literal["offline", "online", "disabled"]
+    ) -> None:
+        if mode in ("offline", "disabled"):
+            return
+
+        headers: dict[str, str] = {
+            "Authorization": f"Bearer {token}",
+            "User-Agent": f"Simvue Python client {__version__}",
+        }
+        try:
+            response = get(f"{url}/api/version", headers)
+
+            if response.status_code != http.HTTPStatus.OK or not (
+                _version_str := response.json().get("version")
+            ):
+                raise AssertionError
+
+            if response.status_code == http.HTTPStatus.UNAUTHORIZED:
+                raise AssertionError("Unauthorised token")
+
+        except Exception as err:
+            raise AssertionError(f"Exception retrieving server version: {str(err)}")
+
+        _version = semver.Version.parse(_version_str)
+
+        if (
+            SIMVUE_SERVER_UPPER_CONSTRAINT
+            and _version >= SIMVUE_SERVER_UPPER_CONSTRAINT
+        ):
+            raise AssertionError(
+                f"Python API v{_version_str} is not compatible with Simvue server versions "
+                f">= {SIMVUE_SERVER_UPPER_CONSTRAINT}"
+            )
+        if SIMVUE_SERVER_LOWER_CONSTRAINT and _version < SIMVUE_SERVER_LOWER_CONSTRAINT:
+            raise AssertionError(
+                f"Python API v{_version_str} is not compatible with Simvue server versions "
+                f"< {SIMVUE_SERVER_LOWER_CONSTRAINT}"
+            )
+
+    @pydantic.model_validator(mode="after")
+    @classmethod
+    def check_valid_server(cls, values: "SimvueConfiguration") -> bool:
+        if os.environ.get("SIMVUE_NO_SERVER_CHECK"):
+            return values
+
+        cls._check_server(values.server.token, values.server.url, values.run.mode)
+
+        return values
+
     @classmethod
     @sv_util.prettify_pydantic
     def fetch(
         cls,
         server_url: typing.Optional[str] = None,
         server_token: typing.Optional[str] = None,
+        mode: typing.Optional[typing.Literal["offline", "online", "disabled"]] = None,
     ) -> "SimvueConfiguration":
         """Retrieve the Simvue configuration from this project
 
@@ -92,6 +153,8 @@ def fetch(
             override the URL used for this session
         server_token : str, optional
             override the token used for this session
+        mode : 'online' | 'offline' | 'disabled'
+            set the run mode for this session
 
         Return
         ------
@@ -116,6 +179,8 @@ def fetch(
 
         _config_dict["offline"] = _config_dict.get("offline", {})
 
+        _config_dict["run"] = _config_dict.get("run", {})
+
         # Allow override of specification of offline directory via environment variable
         if not (_default_dir := os.environ.get("SIMVUE_OFFLINE_DIRECTORY")):
             _default_dir = _config_dict["offline"].get(
@@ -135,6 +200,8 @@ def fetch(
             "SIMVUE_TOKEN", server_token or _config_dict["server"].get("token")
         )
 
+        _run_mode = mode or _config_dict["run"].get("mode")
+
         if not _server_url:
             raise RuntimeError("No server URL was specified")
 
@@ -143,6 +210,7 @@ def fetch(
 
         _config_dict["server"]["token"] = _server_token
         _config_dict["server"]["url"] = _server_url
+        _config_dict["run"]["mode"] = _run_mode
 
         return SimvueConfiguration(**_config_dict)
 

simvue/config/user.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/__init__.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)