Fixes for typing and docs

Author: kzscisoft

simvue/client.py

@@ -197,7 +197,7 @@ def get_runs(
         start_index: pydantic.NonNegativeInt = 0,
         show_shared: bool = True,
         sort_by_columns: list[tuple[str, bool]] | None = None,
-    ) -> DataFrame | Generator[tuple[str, Run]] | None:
+    ) -> DataFrame | Generator[tuple[str, Run]] | dict[str, object] | None:
         """Retrieve all runs matching filters.
 
         Parameters
@@ -226,8 +226,9 @@ def get_runs(
         output_format : Literal['dict', objects', 'dataframe'], optional
             the structure of the response
                 * dict - dictionary of values.
-                * objects - a dictionary of objects (default).
+                * objects - a generator of (ID, object) pairs (default).
                 * dataframe - a dataframe (Pandas must be installed).
+            use of the generator is recommended.
         count_limit : int, optional
             maximum number of entries to return. Default is 100.
         start_index : int, optional
@@ -392,6 +393,7 @@ def delete_runs(
     def delete_folder(
         self,
         folder_path: typing.Annotated[str, pydantic.Field(pattern=FOLDER_REGEX)],
+        *,
         recursive: bool = False,
         remove_runs: bool = False,
         allow_missing: bool = False,
@@ -628,7 +630,8 @@ def get_artifacts_as_files(
             if there was a failure retrieving artifacts from the server
         """
         _artifacts: Generator[tuple[str, Artifact]] = Artifact.from_run(
-            run_id=run_id, category=category
+            run_id=run_id,
+            category=category,
         )
 
         with ThreadPoolExecutor(

simvue/handler.py

@@ -1,28 +1,44 @@
+"""Simvue logging handler."""
+
 import logging
+import typing
+
+if typing.TYPE_CHECKING:
+    from simvue import Run
+
+try:
+    from typing import override
+except ImportError:
+    from typing_extensions import override
 
 
 class Handler(logging.Handler):
-    """
-    Class for handling logging to Simvue
-    """
+    """Class for handling logging as events to a Simvue server."""
 
-    def __init__(self, client):
+    def __init__(self, simvue_run: "Run") -> None:
+        """Initialise a new Simvue logging handler.
+
+        Parameters
+        ----------
+        simvue_run: simvue.Run
+            run to attach this handler to
+        """
         logging.Handler.__init__(self)
-        self._client = client
+        self._run_object: Run = simvue_run
 
-    def emit(self, record):
+    @override
+    def emit(self, record: logging.LogRecord) -> None:
+        """Perform the logging action of sending to server."""
         if "simvue." in record.name:
             return
 
-        msg = self.format(record)
+        _msg: str = self.format(record)
 
         try:
-            self._client.log_event(msg)
+            self._run_object.log_event(_msg)
         except Exception:
             logging.Handler.handleError(self, record)
 
-    def flush(self):
-        pass
-
-    def close(self):
-        pass
+    @override
+    def close(self) -> None:
+        """Execute nothing on closure."""