Merge branch 'dev' into feature/toml-config

Author: kzscisoft

.github/workflows/deploy.yaml

@@ -79,7 +79,7 @@ jobs:
           name: python-package-distributions
           path: dist/
       - name: Sign the dists with Sigstore
-        uses: sigstore/gh-action-sigstore-python@v2.1.1
+        uses: sigstore/gh-action-sigstore-python@v3
         with:
           inputs: >-
             ./dist/*.tar.gz

.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.6.4
+    rev: v0.6.7
     hooks:
       - id: ruff
         args: [ --fix, --exit-non-zero-on-fix, "--ignore=C901" ]

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change log
 
-## Unreleased
+## [v1.0.4](https://github.com/simvue-io/client/releases/tag/v1.0.4) - 2024-09-24
+
+* Set resource metrics to be recorded by default.
+
+## [v1.0.3](https://github.com/simvue-io/client/releases/tag/v1.0.3) - 2024-09-23
 
 * Fix issue of hanging threads when exception raised by script using the API.
 

CITATION.cff

@@ -42,6 +42,6 @@ keywords:
   - alerting
   - simulation
 license: Apache-2.0
-commit: dd47b0c04e5c634a5bb39b216c71a38987de4360
-version: 1.0.2
-date-released: '2024-08-21'
+commit: c08894da7a4c1519dc39e5caf62cc104ecf015dd
+version: 1.0.4
+date-released: '2024-09-24'

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "simvue"
-version = "1.0.2"
+version = "1.0.4"
 description = "Simulation tracking and monitoring"
 authors = ["Simvue Development Team <[email protected]>"]
 license = "Apache v2"
@@ -54,6 +54,7 @@ gitpython = "^3.1.43"
 humanfriendly = "^10.0"
 tabulate = "^0.9.0"
 randomname = "^0.2.1"
+codecarbon = "^2.7.1"
 
 [tool.poetry.extras]
 plot = ["matplotlib", "plotly"]
@@ -100,7 +101,9 @@ markers = [
     "executor: tests of executors",
     "config: tests of simvue configuration",
     "api: tests of RestAPI functionality",
-    "unix: tests for UNIX systems only"
+    "unix: tests for UNIX systems only",
+    "metadata: tests of metadata gathering functions",
+    "proxies: tests for remote/offline Simvue proxies"
 ]
 
 [tool.interrogate]

pyproject.toml

@@ -10,6 +10,7 @@
 import copy
 import json
 import typing
+import http
 
 import requests
 from tenacity import (
@@ -75,18 +76,25 @@ def post(
         url, headers=headers, data=data_sent, timeout=DEFAULT_API_TIMEOUT
     )
 
-    if response.status_code in (401, 403):
+    if response.status_code in (
+        http.HTTPStatus.UNAUTHORIZED,
+        http.HTTPStatus.FORBIDDEN,
+    ):
         raise RuntimeError(
             f"Authorization error [{response.status_code}]: {response.text}"
         )
 
-    if response.status_code == 422:
+    if response.status_code == http.HTTPStatus.UNPROCESSABLE_ENTITY:
         _parsed_response = parse_validation_response(response.json())
         raise ValueError(
             f"Validation error for '{url}' [{response.status_code}]:\n{_parsed_response}"
         )
 
-    if response.status_code not in (200, 201, 409):
+    if response.status_code not in (
+        http.HTTPStatus.OK,
+        http.HTTPStatus.CREATED,
+        http.HTTPStatus.CONFLICT,
+    ):
         raise RuntimeError(
             f"HTTP error for '{url}' [{response.status_code}]: {response.text}"
         )

simvue/api.py

@@ -10,6 +10,7 @@
 import logging
 import os
 import typing
+import http
 import pydantic
 from concurrent.futures import ThreadPoolExecutor, as_completed
 from pandas import DataFrame
@@ -22,7 +23,7 @@
     parse_run_set_metrics,
 )
 from .serialization import deserialize_data
-from .types import DeserializedContent
+from .simvue_types import DeserializedContent
 from .utilities import check_extra, get_auth, prettify_pydantic
 from .models import FOLDER_REGEX, NAME_REGEX
 
@@ -168,7 +169,7 @@ def get_run_id_from_name(
         )
 
         json_response = self._get_json_from_response(
-            expected_status=[200],
+            expected_status=[http.HTTPStatus.OK],
             scenario="Retrieval of run ID from name",
             response=response,
         )
@@ -218,12 +219,12 @@ def get_run(self, run_id: str) -> typing.Optional[dict[str, typing.Any]]:
         )
 
         json_response = self._get_json_from_response(
-            expected_status=[200, 404],
+            expected_status=[http.HTTPStatus.OK, http.HTTPStatus.NOT_FOUND],
             scenario=f"Retrieval of run '{run_id}'",
             response=response,
         )
 
-        if response.status_code == 404:
+        if response.status_code == http.HTTPStatus.NOT_FOUND:
             return None
 
         if not isinstance(json_response, dict):
@@ -339,7 +340,9 @@ def get_runs(
             raise ValueError("Invalid format specified")
 
         json_response = self._get_json_from_response(
-            expected_status=[200], scenario="Run retrieval", response=response
+            expected_status=[http.HTTPStatus.OK],
+            scenario="Run retrieval",
+            response=response,
         )
 
         if not isinstance(json_response, dict):
@@ -381,7 +384,7 @@ def delete_run(self, run_identifier: str) -> typing.Optional[dict]:
         )
 
         json_response = self._get_json_from_response(
-            expected_status=[200],
+            expected_status=[http.HTTPStatus.OK],
             scenario=f"Deletion of run '{run_identifier}'",
             response=response,
         )
@@ -416,7 +419,7 @@ def _get_folder_id_from_path(self, path: str) -> typing.Optional[str]:
         )
 
         if (
-            response.status_code == 200
+            response.status_code == http.HTTPStatus.OK
             and (response_data := response.json().get("data"))
             and (identifier := response_data[0].get("id"))
         ):
@@ -458,7 +461,7 @@ def delete_runs(
             f"{self._url}/api/folders/{folder_id}", headers=self._headers, params=params
         )
 
-        if response.status_code == 200:
+        if response.status_code == http.HTTPStatus.OK:
             if runs := response.json().get("runs", []):
                 logger.debug(f"Runs from '{folder_path}' deleted successfully: {runs}")
             else:
@@ -523,7 +526,7 @@ def delete_folder(
         )
 
         json_response = self._get_json_from_response(
-            expected_status=[200, 404],
+            expected_status=[http.HTTPStatus.OK, http.HTTPStatus.NOT_FOUND],
             scenario=f"Deletion of folder '{folder_path}'",
             response=response,
         )
@@ -551,7 +554,7 @@ def delete_alert(self, alert_id: str) -> None:
             f"{self._url}/api/alerts/{alert_id}", headers=self._headers
         )
 
-        if response.status_code == 200:
+        if response.status_code == http.HTTPStatus.OK:
             logger.debug(f"Alert '{alert_id}' deleted successfully")
             return
 
@@ -587,7 +590,7 @@ def list_artifacts(self, run_id: str) -> list[dict[str, typing.Any]]:
         )
 
         json_response = self._get_json_from_response(
-            expected_status=[200],
+            expected_status=[http.HTTPStatus.OK],
             scenario=f"Retrieval of artifacts for run '{run_id}",
             response=response,
         )
@@ -613,7 +616,7 @@ def _retrieve_artifact_from_server(
         )
 
         json_response = self._get_json_from_response(
-            expected_status=[200, 404],
+            expected_status=[http.HTTPStatus.OK, http.HTTPStatus.NOT_FOUND],
             scenario=f"Retrieval of artifact '{name}' for run '{run_id}'",
             response=response,
         )
@@ -652,7 +655,7 @@ def abort_run(self, run_id: str, reason: str) -> typing.Union[dict, list]:
         )
 
         json_response = self._get_json_from_response(
-            expected_status=[200, 404],
+            expected_status=[http.HTTPStatus.OK, http.HTTPStatus.NOT_FOUND],
             scenario=f"Abort of run '{run_id}'",
             response=response,
         )
@@ -846,7 +849,7 @@ def get_artifacts_as_files(
         )
 
         self._get_json_from_response(
-            expected_status=[200],
+            expected_status=[http.HTTPStatus.OK],
             scenario=f"Download of artifacts for run '{run_id}'",
             response=response,
         )
@@ -936,7 +939,9 @@ def get_folders(
         )
 
         json_response = self._get_json_from_response(
-            expected_status=[200], scenario="Retrieval of folders", response=response
+            expected_status=[http.HTTPStatus.OK],
+            scenario="Retrieval of folders",
+            response=response,
         )
 
         if not isinstance(json_response, dict):
@@ -979,7 +984,7 @@ def get_metrics_names(self, run_id: str) -> list[str]:
         )
 
         json_response = self._get_json_from_response(
-            expected_status=[200],
+            expected_status=[http.HTTPStatus.OK],
             scenario=f"Request for metric names for run '{run_id}'",
             response=response,
         )
@@ -1013,7 +1018,7 @@ def _get_run_metrics_from_server(
         )
 
         json_response = self._get_json_from_response(
-            expected_status=[200],
+            expected_status=[http.HTTPStatus.OK],
             scenario=f"Retrieval of metrics '{metric_names}' in " f"runs '{run_ids}'",
             response=metrics_response,
         )
@@ -1270,7 +1275,7 @@ def get_events(
         )
 
         json_response = self._get_json_from_response(
-            expected_status=[200],
+            expected_status=[http.HTTPStatus.OK],
             scenario=f"Retrieval of events for run '{run_id}'",
             response=response,
         )
@@ -1285,16 +1290,19 @@ def get_events(
     @prettify_pydantic
     @pydantic.validate_call
     def get_alerts(
-        self, run_id: str, critical_only: bool = True, names_only: bool = True
+        self,
+        run_id: typing.Optional[str] = None,
+        critical_only: bool = True,
+        names_only: bool = True,
     ) -> list[dict[str, typing.Any]]:
         """Retrieve alerts for a given run
 
         Parameters
         ----------
-        run_id : str
+        run_id : str | None
             The ID of the run to find alerts for
         critical_only : bool, optional
-            Whether to only return details about alerts which are currently critical, by default True
+            If a run is specified, whether to only return details about alerts which are currently critical, by default True
         names_only: bool, optional
             Whether to only return the names of the alerts (otherwise return the full details of the alerts), by default True
 
@@ -1308,26 +1316,42 @@ def get_alerts(
         RuntimeError
             if there was a failure retrieving data from the server
         """
-        response = requests.get(f"{self._url}/api/runs/{run_id}", headers=self._headers)
+        if not run_id:
+            response = requests.get(f"{self._url}/api/alerts/", headers=self._headers)
 
-        json_response = self._get_json_from_response(
-            expected_status=[200],
-            scenario=f"Retrieval of alerts for run '{run_id}'",
-            response=response,
-        )
+            json_response = self._get_json_from_response(
+                expected_status=[http.HTTPStatus.OK],
+                scenario=f"Retrieval of alerts for run '{run_id}'",
+                response=response,
+            )
+        else:
+            response = requests.get(
+                f"{self._url}/api/runs/{run_id}", headers=self._headers
+            )
+
+            json_response = self._get_json_from_response(
+                expected_status=[200],
+                scenario=f"Retrieval of alerts for run '{run_id}'",
+                response=response,
+            )
 
         if not isinstance(json_response, dict):
             raise RuntimeError(
                 "Expected dictionary from JSON response when retrieving alerts"
             )
 
-        if (alerts := json_response.get("alerts")) is None:
+        if run_id and (alerts := json_response.get("alerts")) is None:
             raise RuntimeError(
                 "Expected key 'alerts' in response when retrieving "
                 f"alerts for run '{run_id}': {json_response}"
             )
+        elif not run_id and (alerts := json_response.get("data")) is None:
+            raise RuntimeError(
+                "Expected key 'data' in response when retrieving "
+                f"alerts: {json_response}"
+            )
 
-        if critical_only:
+        if run_id and critical_only:
             if names_only:
                 return [
                     alert["alert"].get("name")
@@ -1340,7 +1364,10 @@ def get_alerts(
                     for alert in alerts
                     if alert["status"].get("current") == "critical"
                 ]
-        elif names_only:
-            return [alert["alert"].get("name") for alert in alerts]
+        if names_only:
+            if run_id:
+                return [alert["alert"].get("name") for alert in alerts]
+            else:
+                return [alert.get("name") for alert in alerts]
 
         return alerts