Addressed review comments

Author: kzscisoft

simvue/api/objects/artifact/base.py

@@ -42,7 +42,7 @@ class ArtifactBase(SimvueObject):
     def __init__(
         self, identifier: str | None = None, _read_only: bool = True, **kwargs
     ) -> None:
-        """Initialise a artifact connection.
+        """Initialise an artifact connection.
 
         Parameters
         ----------
@@ -246,7 +246,7 @@ def uploaded(self) -> bool:
 
         Returns
         -------
-        datetime.datetime | None
+        bool
         """
         return self._get_attribute("uploaded")
 

simvue/api/objects/events.py

@@ -19,6 +19,11 @@
 from simvue.models import DATETIME_FORMAT, EventSet
 from simvue.api.request import get as sv_get, get_json_from_response
 
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
 __all__ = ["Events"]
 
 
@@ -58,7 +63,9 @@ def get(
 
     @classmethod
     @pydantic.validate_call
-    def new(cls, *, run: str, offline: bool = False, events: list[EventSet], **kwargs):
+    def new(
+        cls, *, run: str, offline: bool = False, events: list[EventSet], **kwargs
+    ) -> Self:
         """Create a new Events entry on the Simvue server"""
         return Events(
             run=run,
@@ -109,6 +116,13 @@ def histogram(
         return _json_response.get("data")
 
     def delete(self, **kwargs) -> dict[str, typing.Any]:
+        """Event set deletion not implemented.
+
+        Raises
+        ------
+        NotImplementedError
+            as event set deletion not supported
+        """
         raise NotImplementedError("Cannot delete event set")
 
     def on_reconnect(self, id_mapping: dict[str, str]):

simvue/api/objects/folder.py

@@ -19,6 +19,14 @@
 from .base import SimvueObject, staging_check, write_only
 from simvue.models import FOLDER_REGEX, DATETIME_FORMAT
 
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+
+__all__ = ["Folder"]
+
 
 class Folder(SimvueObject):
     """
@@ -56,7 +64,7 @@ def new(
         path: typing.Annotated[str, pydantic.Field(pattern=FOLDER_REGEX)],
         offline: bool = False,
         **kwargs,
-    ):
+    ) -> Self:
         """Create a new Folder on the Simvue server with the given path"""
         return Folder(path=path, _read_only=False, _offline=offline, **kwargs)
 

simvue/api/objects/metrics.py

@@ -18,6 +18,11 @@
 from simvue.models import MetricSet
 from simvue.api.request import get as sv_get, get_json_from_response
 
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
 __all__ = ["Metrics"]
 
 
@@ -39,7 +44,7 @@ def __init__(
     @pydantic.validate_call
     def new(
         cls, *, run: str, metrics: list[MetricSet], offline: bool = False, **kwargs
-    ):
+    ) -> Self:
         """Create a new Metrics entry on the Simvue server.
 
         Parameters

simvue/api/objects/tag.py

@@ -13,6 +13,11 @@
 from .base import SimvueObject, staging_check, write_only
 from simvue.models import DATETIME_FORMAT
 
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
 __all__ = ["Tag"]
 
 
@@ -21,7 +26,7 @@ class Tag(SimvueObject):
 
     @classmethod
     @pydantic.validate_call
-    def new(cls, *, name: str, offline: bool = False, **kwargs):
+    def new(cls, *, name: str, offline: bool = False, **kwargs) -> Self:
         """Create a new Tag on the Simvue server.
 
         Parameters

simvue/run.py

@@ -630,7 +630,7 @@ def init(
         folder : str, optional
             folder within which to store the run, by default "/"
         notification: typing.Literal["none", "all", "error", "lost"], optional
-            email notification settings
+            email notification on completion settings
                 * none - do not notify (default).
                 * all - notify for all updates.
                 * error - notify on errors.
@@ -1890,7 +1890,7 @@ def create_metric_threshold_alert(
                 * all - returns if all values in window satisfy condition.
         notification : Literal['email', 'none'], optional
             whether to notify on trigger
-                * email - send email to user on notify.
+                * email - send email to user on alert.
                 * none - send no notifications (default).
         trigger_abort : bool, optional
             whether this alert can trigger a run abort, default False
@@ -1949,7 +1949,7 @@ def create_event_alert(
             frequency at which to check alert condition in seconds, by default None
         notification : Literal['email', 'none'], optional
             whether to notify on trigger
-                * email - send email to user on notify.
+                * email - send email to user on alert.
                 * none - send no notifications (default).
         trigger_abort : bool, optional
             whether this alert can trigger a run abort