Fix interaction with --pdb, --trace and tasks that return. (#579)

Author: tobiasraabe

docs/source/changes.md

@@ -23,6 +23,8 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
 - {pull}`571` removes redundant calls to `PNode.state()` which causes a high penalty for
   remote files.
 - {pull}`573` removes the `pytask_execute_create_scheduler` hook.
+- {pull}`579` fixes an interaction with `--pdb` and `--trace` and task that return. The
+  debugging modes swallowed the return and `None` was returned. Closes {issue}`574`.
 
 ## 0.4.6 - 2024-03-13
 

src/_pytask/debugging.py

@@ -332,7 +332,7 @@ def wrapper(*args: Any, **kwargs: Any) -> None:
         capman = session.config["pm"].get_plugin("capturemanager")
         live_manager = session.config["pm"].get_plugin("live_manager")
         try:
-            task_function(*args, **kwargs)
+            return task_function(*args, **kwargs)
 
         except Exception:
             # Order is important! Pausing the live object before the capturemanager
@@ -413,11 +413,13 @@ def wrapper(*args: Any, **kwargs: Any) -> None:
             console.rule("Captured stderr", style="default")
             console.print(err)
 
-        _pdb.runcall(task_function, *args, **kwargs)
+        out = _pdb.runcall(task_function, *args, **kwargs)
 
         live_manager.resume()
         capman.resume()
 
+        return out
+
     task.function = wrapper
 
 

tests/test_debugging.py

@@ -20,6 +20,12 @@
     IS_PEXPECT_INSTALLED = True
 
 
+def _escape_ansi(line):
+    """Escape ANSI sequences produced by rich."""
+    ansi_escape = re.compile(r"(?:\x1B[@-_]|[\x80-\x9F])[0-?]*[ -/]*[@-~]")
+    return ansi_escape.sub("", line)
+
+
 @pytest.mark.unit()
 @pytest.mark.parametrize(
     ("value", "expected", "expectation"),
@@ -482,7 +488,40 @@ def test_function():
     _flush(child)
 
 
-def _escape_ansi(line):
-    """Escape ANSI sequences produced by rich."""
-    ansi_escape = re.compile(r"(?:\x1B[@-_]|[\x80-\x9F])[0-?]*[ -/]*[@-~]")
-    return ansi_escape.sub("", line)
+@pytest.mark.end_to_end()
+@pytest.mark.skipif(not IS_PEXPECT_INSTALLED, reason="pexpect is not installed.")
+@pytest.mark.skipif(sys.platform == "win32", reason="pexpect cannot spawn on Windows.")
+def test_pdb_with_task_that_returns(tmp_path, runner):
+    source = """
+    from typing_extensions import Annotated
+    from pathlib import Path
+
+    def task_example() -> Annotated[str, Path("data.txt")]:
+        return "1"
+    """
+    tmp_path.joinpath("task_module.py").write_text(textwrap.dedent(source))
+
+    result = runner.invoke(cli, [tmp_path.as_posix(), "--pdb"])
+    assert result.exit_code == ExitCode.OK
+    assert tmp_path.joinpath("data.txt").read_text() == "1"
+
+
+@pytest.mark.end_to_end()
+@pytest.mark.skipif(not IS_PEXPECT_INSTALLED, reason="pexpect is not installed.")
+@pytest.mark.skipif(sys.platform == "win32", reason="pexpect cannot spawn on Windows.")
+def test_trace_with_task_that_returns(tmp_path):
+    source = """
+    from typing_extensions import Annotated
+    from pathlib import Path
+
+    def task_example() -> Annotated[str, Path("data.txt")]:
+        return "1"
+    """
+    tmp_path.joinpath("task_module.py").write_text(textwrap.dedent(source))
+
+    child = pexpect.spawn(f"pytask {tmp_path.as_posix()}")
+    child.sendline("c")
+    rest = child.read().decode("utf8")
+    assert "1  Succeeded" in _escape_ansi(rest)
+    assert tmp_path.joinpath("data.txt").read_text() == "1"
+    _flush(child)