Merge pull request #585 from simvue-io/hotfix/wrong-attribute-retrieval

Fix wrong attribute in offline directory retrieval

Author: kzscisoft

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change log
 
+## [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: a475a0e3f6e48257f8d2d04d0ddf1652e2d9e924
-version: 1.1.1
-date-released: '2024-10-22'
+commit: e220740c747a56de0915d583918e1999d253fdfc
+version: 1.1.2
+date-released: '2024-11-06'

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "simvue"
-version = "1.1.1"
+version = "1.1.2"
 description = "Simulation tracking and monitoring"
 authors = ["Simvue Development Team <[email protected]>"]
 license = "Apache v2"

simvue/client.py

@@ -106,18 +106,19 @@ def __init__(
         server_url : str, optional
             specify URL, if unset this is read from the config file
         """
-        self._config = SimvueConfiguration.fetch(
+        self._user_config = SimvueConfiguration.fetch(
             server_token=server_token, server_url=server_url
         )
 
         for label, value in zip(
-            ("URL", "API token"), (self._config.server.url, self._config.server.url)
+            ("URL", "API token"),
+            (self._user_config.server.url, self._user_config.server.url),
         ):
             if not value:
                 logger.warning(f"No {label} specified")
 
         self._headers: dict[str, str] = {
-            "Authorization": f"Bearer {self._config.server.token}"
+            "Authorization": f"Bearer {self._user_config.server.token}"
         }
 
     def _get_json_from_response(
@@ -182,7 +183,9 @@ def get_run_id_from_name(
         params: dict[str, str] = {"filters": json.dumps([f"name == {name}"])}
 
         response: requests.Response = requests.get(
-            f"{self._config.server.url}/api/runs", headers=self._headers, params=params
+            f"{self._user_config.server.url}/api/runs",
+            headers=self._headers,
+            params=params,
         )
 
         json_response = self._get_json_from_response(
@@ -232,7 +235,7 @@ def get_run(self, run_id: str) -> typing.Optional[dict[str, typing.Any]]:
         """
 
         response: requests.Response = requests.get(
-            f"{self._config.server.url}/api/runs/{run_id}", headers=self._headers
+            f"{self._user_config.server.url}/api/runs/{run_id}", headers=self._headers
         )
 
         json_response = self._get_json_from_response(
@@ -349,7 +352,9 @@ def get_runs(
         }
 
         response = requests.get(
-            f"{self._config.server.url}/api/runs", headers=self._headers, params=params
+            f"{self._user_config.server.url}/api/runs",
+            headers=self._headers,
+            params=params,
         )
 
         response.raise_for_status()
@@ -398,7 +403,7 @@ def delete_run(self, run_id: str) -> typing.Optional[dict]:
         """
 
         response = requests.delete(
-            f"{self._config.server.url}/api/runs/{run_id}",
+            f"{self._user_config.server.url}/api/runs/{run_id}",
             headers=self._headers,
         )
 
@@ -434,7 +439,7 @@ def _get_folder_id_from_path(self, path: str) -> typing.Optional[str]:
         params: dict[str, str] = {"filters": json.dumps([f"path == {path}"])}
 
         response: requests.Response = requests.get(
-            f"{self._config.server.url}/api/folders",
+            f"{self._user_config.server.url}/api/folders",
             headers=self._headers,
             params=params,
         )
@@ -479,7 +484,7 @@ def delete_runs(
         params: dict[str, bool] = {"runs_only": True, "runs": True}
 
         response = requests.delete(
-            f"{self._config.server.url}/api/folders/{folder_id}",
+            f"{self._user_config.server.url}/api/folders/{folder_id}",
             headers=self._headers,
             params=params,
         )
@@ -545,7 +550,7 @@ def delete_folder(
         params |= {"recursive": recursive}
 
         response = requests.delete(
-            f"{self._config.server.url}/api/folders/{folder_id}",
+            f"{self._user_config.server.url}/api/folders/{folder_id}",
             headers=self._headers,
             params=params,
         )
@@ -576,7 +581,8 @@ def delete_alert(self, alert_id: str) -> None:
             the unique identifier for the alert
         """
         response = requests.delete(
-            f"{self._config.server.url}/api/alerts/{alert_id}", headers=self._headers
+            f"{self._user_config.server.url}/api/alerts/{alert_id}",
+            headers=self._headers,
         )
 
         if response.status_code == http.HTTPStatus.OK:
@@ -611,7 +617,7 @@ def list_artifacts(self, run_id: str) -> list[dict[str, typing.Any]]:
         params: dict[str, str] = {"runs": json.dumps([run_id])}
 
         response: requests.Response = requests.get(
-            f"{self._config.server.url}/api/artifacts",
+            f"{self._user_config.server.url}/api/artifacts",
             headers=self._headers,
             params=params,
         )
@@ -637,7 +643,7 @@ def _retrieve_artifact_from_server(
         params: dict[str, str | None] = {"name": name}
 
         response = requests.get(
-            f"{self._config.server.url}/api/runs/{run_id}/artifacts",
+            f"{self._user_config.server.url}/api/runs/{run_id}/artifacts",
             headers=self._headers,
             params=params,
         )
@@ -679,7 +685,7 @@ def abort_run(self, run_id: str, reason: str) -> typing.Union[dict, list]:
         body: dict[str, str | None] = {"id": run_id, "reason": reason}
 
         response = requests.put(
-            f"{self._config.server.url}/api/runs/abort",
+            f"{self._user_config.server.url}/api/runs/abort",
             headers=self._headers,
             json=body,
         )
@@ -873,7 +879,7 @@ def get_artifacts_as_files(
         params: dict[str, typing.Optional[str]] = {"category": category}
 
         response: requests.Response = requests.get(
-            f"{self._config.server.url}/api/runs/{run_id}/artifacts",
+            f"{self._user_config.server.url}/api/runs/{run_id}/artifacts",
             headers=self._headers,
             params=params,
         )
@@ -966,7 +972,7 @@ def get_folders(
         }
 
         response: requests.Response = requests.get(
-            f"{self._config.server.url}/api/folders",
+            f"{self._user_config.server.url}/api/folders",
             headers=self._headers,
             params=params,
         )
@@ -1013,7 +1019,7 @@ def get_metrics_names(self, run_id: str) -> list[str]:
         params = {"runs": json.dumps([run_id])}
 
         response: requests.Response = requests.get(
-            f"{self._config.server.url}/api/metrics/names",
+            f"{self._user_config.server.url}/api/metrics/names",
             headers=self._headers,
             params=params,
         )
@@ -1049,7 +1055,7 @@ def _get_run_metrics_from_server(
         }
 
         metrics_response: requests.Response = requests.get(
-            f"{self._config.server.url}/api/metrics",
+            f"{self._user_config.server.url}/api/metrics",
             headers=self._headers,
             params=params,
         )
@@ -1311,7 +1317,7 @@ def get_events(
         }
 
         response = requests.get(
-            f"{self._config.server.url}/api/events",
+            f"{self._user_config.server.url}/api/events",
             headers=self._headers,
             params=params,
         )
@@ -1368,7 +1374,7 @@ def get_alerts(
         params: dict[str, int] = {"count": count_limit or 0, "start": start_index or 0}
         if not run_id:
             response = requests.get(
-                f"{self._config.server.url}/api/alerts/",
+                f"{self._user_config.server.url}/api/alerts/",
                 headers=self._headers,
                 params=params,
             )
@@ -1380,7 +1386,7 @@ def get_alerts(
             )
         else:
             response = requests.get(
-                f"{self._config.server.url}/api/runs/{run_id}",
+                f"{self._user_config.server.url}/api/runs/{run_id}",
                 headers=self._headers,
                 params=params,
             )
@@ -1457,7 +1463,9 @@ def get_tags(
         """
         params = {"count": count_limit or 0, "start": start_index or 0}
         response = requests.get(
-            f"{self._config.server.url}/api/tags", headers=self._headers, params=params
+            f"{self._user_config.server.url}/api/tags",
+            headers=self._headers,
+            params=params,
         )
 
         json_response = self._get_json_from_response(
@@ -1491,7 +1499,7 @@ def delete_tag(self, tag_id: str) -> None:
         """
 
         response = requests.delete(
-            f"{self._config.server.url}/api/tags/{tag_id}",
+            f"{self._user_config.server.url}/api/tags/{tag_id}",
             headers=self._headers,
         )
 
@@ -1533,7 +1541,7 @@ def get_tag(self, tag_id: str) -> typing.Optional[dict[str, typing.Any]]:
         """
 
         response: requests.Response = requests.get(
-            f"{self._config.server.url}/api/tag/{tag_id}", headers=self._headers
+            f"{self._user_config.server.url}/api/tag/{tag_id}", headers=self._headers
         )
 
         json_response = self._get_json_from_response(

simvue/factory/proxy/remote.py

@@ -28,10 +28,10 @@ def __init__(
         config: "SimvueConfiguration",
         suppress_errors: bool = True,
     ) -> None:
-        self._config = config
+        self._user_config = config
 
         self._headers: dict[str, str] = {
-            "Authorization": f"Bearer {self._config.server.token}",
+            "Authorization": f"Bearer {self._user_config.server.token}",
             "User-Agent": f"Simvue Python client {__version__}",
         }
         self._headers_mp: dict[str, str] = self._headers | {
@@ -46,7 +46,7 @@ def list_tags(self) -> list[str]:
         logger.debug("Retrieving existing tags")
         try:
             response = get(
-                f"{self._config.server.url}/api/runs/{self._id}", self._headers
+                f"{self._user_config.server.url}/api/runs/{self._id}", self._headers
             )
         except Exception as err:
             self._error(f"Exception retrieving tags: {str(err)}")
@@ -80,7 +80,7 @@ def create_run(self, data) -> tuple[typing.Optional[str], typing.Optional[int]]:
             logger.debug("Creating folder %s if necessary", data.get("folder"))
             try:
                 response = post(
-                    f"{self._config.server.url}/api/folders",
+                    f"{self._user_config.server.url}/api/folders",
                     self._headers,
                     {"path": data.get("folder")},
                 )
@@ -104,7 +104,9 @@ def create_run(self, data) -> tuple[typing.Optional[str], typing.Optional[int]]:
         logger.debug('Creating run with data: "%s"', data)
 
         try:
-            response = post(f"{self._config.server.url}/api/runs", self._headers, data)
+            response = post(
+                f"{self._user_config.server.url}/api/runs", self._headers, data
+            )
         except Exception as err:
             self._error(f"Exception creating run: {str(err)}")
             return (None, None)
@@ -143,7 +145,9 @@ def update(
         logger.debug('Updating run with data: "%s"', data)
 
         try:
-            response = put(f"{self._config.server.url}/api/runs", self._headers, data)
+            response = put(
+                f"{self._user_config.server.url}/api/runs", self._headers, data
+            )
         except Exception as err:
             self._error(f"Exception updating run: {err}")
             return None
@@ -172,7 +176,7 @@ def set_folder_details(
 
         try:
             response = post(
-                f"{self._config.server.url}/api/folders", self._headers, data
+                f"{self._user_config.server.url}/api/folders", self._headers, data
             )
         except Exception as err:
             self._error(f"Exception creating folder: {err}")
@@ -191,7 +195,7 @@ def set_folder_details(
 
         try:
             response = put(
-                f"{self._config.server.url}/api/folders", self._headers, data
+                f"{self._user_config.server.url}/api/folders", self._headers, data
             )
         except Exception as err:
             self._error(f"Exception setting folder details: {err}")
@@ -223,7 +227,7 @@ def save_file(
         # Get presigned URL
         try:
             response = post(
-                f"{self._config.server.url}/api/artifacts",
+                f"{self._user_config.server.url}/api/artifacts",
                 self._headers,
                 prepare_for_api(data),
             )
@@ -307,7 +311,7 @@ def save_file(
                     return None
 
         if storage_id:
-            path = f"{self._config.server.url}/api/runs/{self._id}/artifacts"
+            path = f"{self._user_config.server.url}/api/runs/{self._id}/artifacts"
             data["storage"] = storage_id
 
             try:
@@ -338,7 +342,7 @@ def add_alert(self, data, run=None):
 
         try:
             response = post(
-                f"{self._config.server.url}/api/alerts", self._headers, data
+                f"{self._user_config.server.url}/api/alerts", self._headers, data
             )
         except Exception as err:
             self._error(f"Got exception when creating an alert: {str(err)}")
@@ -366,7 +370,7 @@ def set_alert_state(
         data = {"run": self._id, "alert": alert_id, "status": status}
         try:
             response = put(
-                f"{self._config.server.url}/api/alerts/status", self._headers, data
+                f"{self._user_config.server.url}/api/alerts/status", self._headers, data
             )
         except Exception as err:
             self._error(f"Got exception when setting alert state: {err}")
@@ -383,7 +387,7 @@ def list_alerts(self) -> list[dict[str, typing.Any]]:
         List alerts
         """
         try:
-            response = get(f"{self._config.server.url}/api/alerts", self._headers)
+            response = get(f"{self._user_config.server.url}/api/alerts", self._headers)
         except Exception as err:
             self._error(f"Got exception when listing alerts: {str(err)}")
             return []
@@ -412,7 +416,7 @@ def send_metrics(
 
         try:
             response = post(
-                f"{self._config.server.url}/api/metrics",
+                f"{self._user_config.server.url}/api/metrics",
                 self._headers_mp,
                 data,
                 is_json=False,
@@ -440,7 +444,7 @@ def send_event(
 
         try:
             response = post(
-                f"{self._config.server.url}/api/events",
+                f"{self._user_config.server.url}/api/events",
                 self._headers_mp,
                 data,
                 is_json=False,
@@ -466,7 +470,7 @@ def send_heartbeat(self) -> typing.Optional[dict[str, typing.Any]]:
 
         try:
             response = put(
-                f"{self._config.server.url}/api/runs/heartbeat",
+                f"{self._user_config.server.url}/api/runs/heartbeat",
                 self._headers,
                 {"id": self._id},
             )
@@ -488,7 +492,8 @@ def get_abort_status(self) -> bool:
 
         try:
             response = get(
-                f"{self._config.server.url}/api/runs/{self._id}/abort", self._headers_mp
+                f"{self._user_config.server.url}/api/runs/{self._id}/abort",
+                self._headers_mp,
             )
         except Exception as err:
             self._error(f"Exception retrieving abort status: {str(err)}")