Create v2.0.0a0 release

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
         args: [--branch, main, --branch, dev]
       - id: check-added-large-files
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.4
+    rev: v0.9.6
     hooks:
       - id: ruff
         args: [ --fix, --exit-non-zero-on-fix, "--ignore=C901" ]
@@ -35,7 +35,7 @@ repos:
         pass_filenames: false
 
   - repo: https://github.com/PyCQA/bandit.git
-    rev: 1.8.2
+    rev: 1.8.3
     hooks:
     -   id: bandit
         args: [-lll, --recursive, clumper]

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change log
 
+## [v2.0.0-alpha1](https://github.com/simvue-io/client/releases/tag/v2.0.0a1) - 2025-02-19
+* Fixed `add_alerts` so that it now works with both IDs and names
+* Improved alert and folder deduplication methods to rely on 409 responses from server upon creation
+* Added `attach_to_run` option to create alerts methods so that alerts can be created without a run attached
+* Improved merging of local staging file and _staged dict using `deepmerge` - fixes bugs with tags, alerts and metadata in offline mode
+* Added `started`, `created` and `ended` timestamps to runs in offline mode
+* Remove all erronous server calls in offline mode
+* Fixed method to find simvue.toml config files, now just looks in cwd and home
+* Added run notification option to `run.init` so that users can now get emails upon their runs completing
+* Fixed artifact retrieval by run so that `category` parameter works correctly
+* Fixed bug where file artifacts wouldn't be saved correctly in offline mode if sender runs in different location to script
+* Fixed bug where DEBUG log messages were spamming to the console
+* Fixed link to run dashboard printed to the console by removing `/api`
+* Fixed bug where offline mode wouldn't work if no run name provided
+* Fixed bug where errors would be thrown if a traceback was logged as an event when a run was already terminated
+* Fixed hierarchical artifact retrieval to maintain directory structure
+* Loosened Numpy requirement to >2.0.0
+
 ## [v2.0.0-alpha0](https://github.com/simvue-io/client/releases/tag/v2.0.0a0) - 2025-02-10
 
 * Add support for defining Simvue run defaults using `tool.simvue` in a project `pyproject.toml` file.

CITATION.cff

@@ -42,9 +42,9 @@ keywords:
   - alerting
   - simulation
 license: Apache-2.0
-commit: 5aaebe682d7ec2f80fefc3eb2a8a26f5bdca1e0c
-version: 2.0.0a0
-date-released: '2025-02-11'
+commit: 124b2993d91dbff2e475aa972916b11e7bd02fa4
+version: 2.0.0a1
+date-released: '2025-02-19'
 references:
 - title: mlco2/codecarbon
   version: v2.8.2

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simvue"
-version = "2.0.0a0"
+version = "2.0.0a1"
 description = "Simulation tracking and monitoring"
 authors = [
   {name = "Simvue Development Team", email = "[email protected]"}
@@ -46,13 +46,14 @@ dependencies = [
   "humanfriendly (>=10.0,<11.0)",
   "randomname (>=0.2.1,<0.3.0)",
   "codecarbon (>=2.8.3,<3.0.0)",
-  "numpy (>=2.2.2,<3.0.0)",
+  "numpy (>=2.0.0,<3.0.0)",
   "flatdict (>=4.0.1,<5.0.0)",
   "semver (>=3.0.4,<4.0.0)",
   "email-validator (>=2.2.0,<3.0.0)",
   "psutil (>=6.1.1,<7.0.0)",
   "tenacity (>=9.0.0,<10.0.0)",
   "typing-extensions (>=4.12.2,<5.0.0) ; python_version < \"3.11\"",
+  "deepmerge (>=2.0,<3.0)",
 ]
 
 [project.urls]

simvue/api/objects/alert/events.py

@@ -87,6 +87,7 @@ def new(
             _offline=offline,
         )
         _alert._staging |= _alert_definition
+        _alert._params = {"deduplicate": True}
         return _alert
 
 

simvue/api/objects/alert/metrics.py

@@ -105,6 +105,8 @@ def new(
             _offline=offline,
         )
         _alert._staging |= _alert_definition
+        _alert._params = {"deduplicate": True}
+
         return _alert
 
 
@@ -194,6 +196,7 @@ def new(
             _offline=offline,
         )
         _alert._staging |= _alert_definition
+        _alert._params = {"deduplicate": True}
         return _alert
 
 

simvue/api/objects/alert/user.py

@@ -57,7 +57,7 @@ def new(
             whether this alert should be created locally, default is False
 
         """
-        return UserAlert(
+        _alert = UserAlert(
             name=name,
             description=description,
             notification=notification,
@@ -66,6 +66,8 @@ def new(
             _read_only=False,
             _offline=offline,
         )
+        _alert._params = {"deduplicate": True}
+        return _alert
 
     @classmethod
     def get(

simvue/api/objects/artifact/base.py

@@ -97,6 +97,7 @@ def _upload(self, file: io.BytesIO) -> None:
         _response = sv_post(
             url=_url,
             headers={},
+            params={},
             is_json=False,
             files={"file": file},
             data=self._init_data.get("fields"),

simvue/api/objects/artifact/fetch.py

@@ -23,6 +23,62 @@ def __new__(cls, identifier: str | None = None, **kwargs):
         else:
             return ObjectArtifact(identifier=identifier, **kwargs)
 
+    @classmethod
+    def from_run(
+        cls,
+        run_id: str,
+        category: typing.Literal["input", "output", "code"] | None = None,
+        **kwargs,
+    ) -> typing.Generator[tuple[str, FileArtifact | ObjectArtifact], None, None]:
+        """Return artifacts associated with a given run.
+
+        Parameters
+        ----------
+        run_id : str
+            The ID of the run to retriece artifacts from
+        category : typing.Literal["input", "output", "code"] | None, optional
+            The category of artifacts to return, by default all artifacts are returned
+
+        Returns
+        -------
+        typing.Generator[tuple[str, FileArtifact | ObjectArtifact], None, None]
+            The artifacts
+
+        Yields
+        ------
+        Iterator[typing.Generator[tuple[str, FileArtifact | ObjectArtifact], None, None]]
+            identifier for artifact
+            the artifact itself as a class instance
+
+        Raises
+        ------
+        ObjectNotFoundError
+            Raised if artifacts could not be found for that run
+        """
+        _temp = ArtifactBase(**kwargs)
+        _url = URL(_temp._user_config.server.url) / f"runs/{run_id}/artifacts"
+        _response = sv_get(
+            url=f"{_url}", params={"category": category}, headers=_temp._headers
+        )
+        _json_response = get_json_from_response(
+            expected_type=list,
+            response=_response,
+            expected_status=[http.HTTPStatus.OK, http.HTTPStatus.NOT_FOUND],
+            scenario=f"Retrieval of artifacts for run '{run_id}'",
+        )
+
+        if _response.status_code == http.HTTPStatus.NOT_FOUND or not _json_response:
+            raise ObjectNotFoundError(
+                _temp._label, category, extra=f"for run '{run_id}'"
+            )
+
+        for _entry in _json_response:
+            _id = _entry.pop("id")
+            yield (
+                _id,
+                Artifact(_local=True, _read_only=True, identifier=_id, **_entry),
+            )
+
     @classmethod
     def from_name(
         cls, run_id: str, name: str, **kwargs
@@ -99,21 +155,9 @@ def get(
         if (_data := _json_response.get("data")) is None:
             raise RuntimeError(f"Expected key 'data' for retrieval of {_label}s")
 
-        _out_dict: dict[str, FileArtifact | ObjectArtifact] = {}
-
         for _entry in _data:
             _id = _entry.pop("id")
-            if _entry["original_path"]:
-                yield (
-                    _id,
-                    FileArtifact(
-                        _local=True, _read_only=True, identifier=_id, **_entry
-                    ),
-                )
-            else:
-                yield (
-                    _id,
-                    ObjectArtifact(
-                        _local=True, _read_only=True, identifier=_id, **_entry
-                    ),
-                )
+            yield (
+                _id,
+                Artifact(_local=True, _read_only=True, identifier=_id, **_entry),
+            )

simvue/api/objects/artifact/file.py

@@ -52,14 +52,15 @@ def new(
 
         if _mime_type not in get_mimetypes():
             raise ValueError(f"Invalid MIME type '{mime_type}' specified")
-        file_path = pathlib.Path(file_path)
-        _file_size = file_path.stat().st_size
-        _file_orig_path = file_path.expanduser().absolute()
-        _file_checksum = calculate_sha256(f"{file_path}", is_file=True)
 
-        kwargs.pop("original_path", None)
-        kwargs.pop("size", None)
-        kwargs.pop("checksum", None)
+        if _file_orig_path := kwargs.pop("original_path", None):
+            _file_size = kwargs.pop("size")
+            _file_checksum = kwargs.pop("checksum")
+        else:
+            file_path = pathlib.Path(file_path)
+            _file_size = file_path.stat().st_size
+            _file_orig_path = file_path.expanduser().absolute()
+            _file_checksum = calculate_sha256(f"{file_path}", is_file=True)
 
         _artifact = FileArtifact(
             name=name,

simvue/api/objects/base.py

@@ -17,6 +17,7 @@
 import msgpack
 import pydantic
 
+from simvue.utilities import staging_merger
 from simvue.config.user import SimvueConfiguration
 from simvue.exception import ObjectNotFoundError
 from simvue.version import __version__
@@ -164,10 +165,16 @@ def __init__(
             )
         )
 
-        self._headers: dict[str, str] = {
-            "Authorization": f"Bearer {self._user_config.server.token.get_secret_value()}",
-            "User-Agent": _user_agent or f"Simvue Python client {__version__}",
-        }
+        self._headers: dict[str, str] = (
+            {
+                "Authorization": f"Bearer {self._user_config.server.token.get_secret_value()}",
+                "User-Agent": _user_agent or f"Simvue Python client {__version__}",
+            }
+            if not self._offline
+            else {}
+        )
+
+        self._params: dict[str, str] = {}
 
         self._staging: dict[str, typing.Any] = {}
 
@@ -412,6 +419,7 @@ def _post(self, is_json: bool = True, **kwargs) -> dict[str, typing.Any]:
         _response = sv_post(
             url=f"{self._base_url}",
             headers=self._headers | {"Content-Type": "application/msgpack"},
+            params=self._params,
             data=kwargs,
             is_json=is_json,
         )
@@ -423,7 +431,7 @@ def _post(self, is_json: bool = True, **kwargs) -> dict[str, typing.Any]:
 
         _json_response = get_json_from_response(
             response=_response,
-            expected_status=[http.HTTPStatus.OK],
+            expected_status=[http.HTTPStatus.OK, http.HTTPStatus.CONFLICT],
             scenario=f"Creation of {self._label}",
         )
 
@@ -452,7 +460,7 @@ def _put(self, **kwargs) -> dict[str, typing.Any]:
 
         return get_json_from_response(
             response=_response,
-            expected_status=[http.HTTPStatus.OK],
+            expected_status=[http.HTTPStatus.OK, http.HTTPStatus.CONFLICT],
             scenario=f"Creation of {self._label} '{self._identifier}",
         )
 
@@ -524,7 +532,8 @@ def _cache(self) -> None:
             with self._local_staging_file.open() as in_f:
                 _local_data = json.load(in_f)
 
-        _local_data |= self._staging
+        staging_merger.merge(_local_data, self._staging)
+
         with self._local_staging_file.open("w", encoding="utf-8") as out_f:
             json.dump(_local_data, out_f, indent=2)
 

simvue/api/objects/metrics.py

@@ -37,7 +37,7 @@ def __init__(
     def new(
         cls, *, run: str, offline: bool = False, metrics: list[MetricSet], **kwargs
     ):
-        """Create a new Events entry on the Simvue server"""
+        """Create a new Metrics entry on the Simvue server"""
         return Metrics(
             run=run,
             metrics=[metric.model_dump() for metric in metrics],
@@ -51,27 +51,23 @@ def get(
         cls,
         metrics: list[str],
         xaxis: typing.Literal["timestamp", "step", "time"],
+        runs: list[str],
         *,
         count: pydantic.PositiveInt | None = None,
         offset: pydantic.PositiveInt | None = None,
         **kwargs,
     ) -> typing.Generator[MetricSet, None, None]:
         _class_instance = cls(_read_only=True, _local=True)
-        if (
-            _data := cls._get_all_objects(
-                count,
-                offset,
-                metrics=json.dumps(metrics),
-                xaxis=xaxis,
-                **kwargs,
-            ).get("data")
-        ) is None:
-            raise RuntimeError(
-                f"Expected key 'data' for retrieval of {_class_instance.__class__.__name__.lower()}s"
-            )
-
-        for _entry in _data:
-            yield MetricSet(**_entry)
+        _data = cls._get_all_objects(
+            count,
+            offset,
+            metrics=json.dumps(metrics),
+            runs=json.dumps(runs),
+            xaxis=xaxis,
+            **kwargs,
+        )
+        # TODO: Temp fix, just return the dictionary. Not sure what format we really want this in...
+        return _data
 
     @pydantic.validate_call
     def span(self, run_ids: list[str]) -> dict[str, int | float]: