Add CPDResult as abstract result container super class

src/cpdbench/control/CPDFullResult.py

@@ -1,8 +1,10 @@
 from cpdbench.control.CPDDatasetResult import CPDDatasetResult
 import datetime
 
+from cpdbench.control.CPDResult import CPDResult
 
-class CPDFullResult: #TODO Oberklasse für Results
+
+class CPDFullResult(CPDResult):
     """Container for a complete run result with all datasets"""
 
     def __init__(self, datasets: list[str], algorithms: list[str], metrics: list[str]):

src/cpdbench/control/CPDResult.py

@@ -0,0 +1,10 @@
+from abc import ABC, abstractmethod
+
+
+class CPDResult(ABC):
+    """Abstract class for result containers for bench runs"""
+
+    @abstractmethod
+    def get_result_as_dict(self) -> dict:
+        """Returns the result of the bench run as python dict"""
+        pass

src/cpdbench/control/CPDValidationResult.py

@@ -1,8 +1,10 @@
 import datetime
 import traceback
 
+from cpdbench.control.CPDResult import CPDResult
 
-class CPDValidationResult:
+
+class CPDValidationResult(CPDResult):
     """Container for a validation run result."""
 
     def __init__(self, errors: list, datasets: list[str], algorithms: list[str], metrics: list[str]):

src/cpdbench/control/ExecutionController.py

@@ -1,5 +1,6 @@
 from abc import ABC, abstractmethod
 
+from cpdbench.control.CPDResult import CPDResult
 from cpdbench.exception.UserParameterDoesNotExistException import UserParameterDoesNotExistException
 from cpdbench.exception.ValidationException import ValidationException
 from cpdbench.task.Task import TaskType
@@ -16,7 +17,7 @@ def __init__(self, logger):
         self._logger = logger
 
     @abstractmethod
-    def execute_run(self, methods: dict) -> any:
+    def execute_run(self, methods: dict) -> CPDResult:
         """Executes the run implemented by this class.
         :param methods: dictionary with all given input functions, grouped by function type.
         :return: A result object which can be handed to the user

src/cpdbench/control/TestrunController.py

@@ -5,6 +5,7 @@
 from concurrent.futures import ProcessPoolExecutor
 
 from cpdbench.control.CPDFullResult import CPDFullResult
+from cpdbench.control.CPDResult import CPDResult
 from cpdbench.control.DatasetExecutor import DatasetExecutor
 from cpdbench.control.ExecutionController import ExecutionController
 from cpdbench.utils import Logger, BenchConfig
@@ -43,7 +44,7 @@ def __init__(self):
         self._logger = Logger.get_application_logger()
         super().__init__(self._logger)
 
-    def execute_run(self, methods: dict) -> any:
+    def execute_run(self, methods: dict) -> CPDResult:
         self._logger.info('Creating tasks...')
         tasks = self._create_tasks(methods)
         self._logger.info(f"{len(tasks['datasets']) + len(tasks['algorithms']) + len(tasks['metrics'])} tasks created")

src/cpdbench/control/ValidationRunController.py

@@ -1,3 +1,4 @@
+from cpdbench.control.CPDResult import CPDResult
 from cpdbench.control.CPDValidationResult import CPDValidationResult
 from cpdbench.control.ExecutionController import ExecutionController
 from cpdbench.exception.ValidationException import DatasetValidationException, AlgorithmValidationException, \
@@ -15,7 +16,7 @@ def __init__(self):
         self._logger = Logger.get_application_logger()
         super().__init__(self._logger)
 
-    def execute_run(self, methods: dict) -> any:
+    def execute_run(self, methods: dict) -> CPDResult:
         self._logger.info('Creating tasks...')
         tasks = self._create_tasks(methods)
         self._logger.info(f"{len(tasks['datasets']) + len(tasks['algorithms']) + len(tasks['metrics'])} tasks created")