Add a TypeVar bounded to UQMetadataClass; Fix some space in docstrings; Narrowing the type as a List of np.ndarray for realization_otput

Author: BeneBr

src/alfasim_sdk/result_reader/aggregator.py

@@ -4,7 +4,7 @@
 from collections import namedtuple
 from contextlib import contextmanager
 from pathlib import Path
-from typing import Any, Type
+from typing import Any, Type, TypeVar
 from typing import Callable
 from typing import DefaultDict
 from typing import Dict
@@ -110,6 +110,7 @@ class ResultsNeedFullReloadError(RuntimeError):
 class BaseUQMetaData:
     """
     Base class for UQ metadata analysis.
+
     :ivar property_id:
         The property name (holdup, total mass flow rate).
     :ivar trend_id:
@@ -151,6 +152,7 @@ class UncertaintyPropagationAnalysesMetaData:
     class UPItem(BaseUQMetaData):
         """
         A class that hold each uncertainty propagation analyses metadata.
+
         :ivar samples:
             The total samples generate to construct the result.
         :ivar result_index:
@@ -280,10 +282,18 @@ class UPResult:
     """
     category: str = attr.ib(validator=attr.validators.optional(attr.validators.instance_of(str)))
     unit: str = attr.ib(validator=attr.validators.optional(attr.validators.instance_of(str)))
-    realization_output: List = attr.ib(default=attr.Factory(List))
+    realization_output: List[np.ndarray] = attr.ib(default=attr.Factory(List))
     std_result: np.ndarray = attr.ib(default=attr.Factory(lambda: np.array([])))
     mean_result: np.ndarray = attr.ib(default=attr.Factory(lambda: np.array([])))
-def read_results_file(result_directory: Path, metadata_class: Type[UQMetadataClass], map_data: Callable, meta_data_attrs: str) -> UQMetadataClass:
+
+
+MetadataClassType = TypeVar("MetadataClassType", bound=UQMetadataClass)
+def read_results_file(
+    result_directory: Path,
+    metadata_class: Type[MetadataClassType],
+    map_data: Callable,
+    meta_data_attrs: str) -> MetadataClassType:
+
     with open_result_file(
         result_directory, result_filename="result"
     ) as result_file: