Stdout/stderr as string outputs

Author: nx10

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "styxdefs"
-version = "0.3.1"
+version = "0.4.0"
 description = "Styx definitions and minimal runtime"
 authors = ["Florian Rupprecht <33600480+nx10@users.noreply.github.com>"]
 license = "MIT License"
@@ -14,8 +14,8 @@ python = ">=3.10"
 pytest = "^8.2.1"
 mypy = "^1.10.0"
 pre-commit = "^4.0.1"
-pytest-cov = ">=5,<7"
-ruff = ">=0.6.9,<0.8.0"
+pytest-cov = "^6.0.0"
+ruff = "^0.8.0"
 
 [tool.poetry.group.docs.dependencies]
 pdoc = "^15.0.0"

pyproject.toml

@@ -1,6 +1,7 @@
 """Dummy runner for debugging purposes."""
 
 import pathlib
+import typing
 
 from .types import Execution, InputPathType, Metadata, OutputPathType, Runner
 
@@ -31,7 +32,12 @@ def output_file(self, local_file: str, optional: bool = False) -> OutputPathType
         """Resolve output file."""
         return pathlib.Path(local_file)
 
-    def run(self, cargs: list[str]) -> None:
+    def run(
+        self,
+        cargs: list[str],
+        handle_stdout: typing.Callable[[str], None] | None,
+        handle_stderr: typing.Callable[[str], None] | None,
+    ) -> None:
         """Execute command (in this dry runner this only captures the outputs)."""
         self.last_cargs = cargs
 

src/styxdefs/dry_runner.py

@@ -4,6 +4,7 @@
 import os
 import pathlib
 import shlex
+import typing
 from collections import deque
 from concurrent.futures import ThreadPoolExecutor
 from datetime import datetime
@@ -56,15 +57,21 @@ def output_file(self, local_file: str, optional: bool = False) -> OutputPathType
         """Resolve local output files."""
         return self.output_dir / local_file
 
-    def run(self, cargs: list[str]) -> None:
+    def run(
+        self,
+        cargs: list[str],
+        handle_stdout: typing.Callable[[str], None] | None,
+        handle_stderr: typing.Callable[[str], None] | None,
+    ) -> None:
         """Run the command."""
         self.logger.debug(f"Running command: {shlex.join(cargs)}")
 
-        def _stdout_handler(line: str) -> None:
-            self.logger.info(line)
-
-        def _stderr_handler(line: str) -> None:
-            self.logger.error(line)
+        _stdout_handler = (
+            handle_stdout if handle_stdout else lambda line: self.logger.info(line)
+        )
+        _stderr_handler = (
+            handle_stderr if handle_stderr else lambda line: self.logger.error(line)
+        )
 
         time_start = datetime.now()
         with Popen(

src/styxdefs/local_runner.py

@@ -38,11 +38,20 @@ def input_file(
         """
         ...
 
-    def run(self, cargs: list[str]) -> None:
+    def run(
+        self,
+        cargs: list[str],
+        handle_stdout: typing.Callable[[str], None] | None,
+        handle_stderr: typing.Callable[[str], None] | None,
+    ) -> None:
         """Run the command.
 
         Args:
             cargs: A list of command arguments.
+            handle_stdout: If defined the runner must forward stdout output to this\
+                (may be called multiple times).
+            handle_stderr: If defined the runner must forward stderr output to this\
+                (may be called multiple times).
 
         Note:
             Called after all `Execution.input_file()`

src/styxdefs/types.py

@@ -20,7 +20,7 @@ def test_local_runner(tmp_path: pathlib.Path) -> None:
     input_file = x.input_file("abc")
     output_file = x.output_file("def")
     if os.name == "posix":
-        x.run(["ls"])
+        x.run(["ls"], None, None)
 
     assert pathlib.Path(input_file).name == "abc"
     assert output_file.is_relative_to(tmp_path / "xyz")