feat: add ResultType for validation of operator output

src/fasthep_flow/operators/base.py

@@ -1,6 +1,8 @@
 """Definition of the Operator protocol."""
+
 from __future__ import annotations
 
+from dataclasses import dataclass
 from typing import Any, Protocol
 
 
@@ -18,3 +20,21 @@ def __repr__(self) -> str:
 
     def configure(self, **kwargs: Any) -> None:
         """General function to configure the operator."""
+
+
+@dataclass
+class ResultType:
+    """The result type of an operator. Can add validation here if needed."""
+
+    result: Any
+    stdout: str
+    stderr: str
+    exit_code: int
+
+    def to_dict(self) -> dict[str, Any]:
+        return {
+            "result": self.result,
+            "stdout": self.stdout,
+            "stderr": self.stderr,
+            "exit_code": self.exit_code,
+        }

src/fasthep_flow/operators/bash.py

@@ -3,7 +3,7 @@
 
 from typing import Any
 
-from .base import Operator
+from .base import Operator, ResultType
 
 try:
     # try to import plumbum
@@ -31,7 +31,9 @@ def configure(self, **kwargs: Any) -> None:
     def __call__(self, **kwargs: Any) -> dict[str, Any]:
         command = plumbum.local[self.bash_command]
         exit_code, stdout, stderr = command.run(*self.arguments)
-        return {"stdout": stdout, "stderr": stderr, "exit_code": exit_code}
+        return ResultType(
+            result=None, stdout=stdout, stderr=stderr, exit_code=exit_code
+        ).to_dict()
 
     def __repr__(self) -> str:
         return f'LocalBashOperator(bash_command="{self.bash_command}", arguments={self.arguments})'

src/fasthep_flow/operators/py_call.py

@@ -1,12 +1,13 @@
 """Python related operators."""
+
 from __future__ import annotations
 
 import io
 from collections.abc import Callable
 from contextlib import redirect_stderr, redirect_stdout
 from typing import Any
 
-from .base import Operator
+from .base import Operator, ResultType
 
 
 class PythonOperator(Operator):
@@ -26,11 +27,12 @@ def __call__(self, **kwargs: Any) -> dict[str, Any]:
         with redirect_stdout(stdout), redirect_stderr(stderr):
             result = self.python_callable(*self.arguments)
         result = self.python_callable(*self.arguments)
-        return {
-            "result": result,
-            "stdout": stdout.getvalue(),
-            "stderr": stderr.getvalue(),
-        }
+        return ResultType(
+            result=result,
+            stdout=stdout.getvalue(),
+            stderr=stderr.getvalue(),
+            exit_code=0,
+        ).to_dict()
 
     def __repr__(self) -> str:
         return f"PythonOperator(python_callable={self.python_callable}, arguments={self.arguments})"