Fix links to files when pdb or trace is activated. (#183)

Author: tobiasraabe

docs/source/changes.rst

@@ -28,6 +28,7 @@ all releases are available on `PyPI <https://pypi.org/project/pytask>`_ and
 - :gh:`181` adds correct formatting of running tasks.
 - :gh:`182` introduces that only the starting year is displayed in the license following
   https://hynek.me/til/copyright-years.
+- :gh:`183` enables tracing down the source of a function through decorators.
 
 
 0.1.3 - 2021-11-30

src/_pytask/console.py

@@ -9,6 +9,7 @@
 from typing import Callable
 from typing import Dict
 from typing import Iterable
+from typing import List
 from typing import Optional
 from typing import Type
 from typing import TYPE_CHECKING
@@ -50,6 +51,12 @@
 _HORIZONTAL_PADDING = (0, 1, 0, 1)
 
 
+_SKIPPED_PATHS = [Path(__file__).parent.joinpath("debugging.py")]
+"""List[Path]: List of paths to skip when tracing down the path to the source of a task
+function.
+
+"""
+
 ARROW_DOWN_ICON = "|" if _IS_LEGACY_WINDOWS else "⬇"
 FILE_ICON = "" if _IS_LEGACY_WINDOWS else "📄 "
 PYTHON_ICON = "" if _IS_LEGACY_WINDOWS else "🐍 "
@@ -165,12 +172,26 @@ def create_url_style_for_path(path: Path, edtior_url_scheme: str) -> Style:
     )
 
 
-def _get_file(function: Callable[..., Any]) -> Path:
-    """Get path to module where the function is defined."""
+def _get_file(function: Callable[..., Any], skipped_paths: List[Path] = None) -> Path:
+    """Get path to module where the function is defined.
+
+    When the ``pdb`` or ``trace`` mode is activated, every task function is wrapped with
+    a decorator which we need to skip to get to the underlying task function. Thus, the
+    special case.
+
+    """
+    if skipped_paths is None:
+        skipped_paths = _SKIPPED_PATHS
+
     if isinstance(function, functools.partial):
         return _get_file(function.func)
+    elif (
+        hasattr(function, "__wrapped__")
+        and Path(inspect.getsourcefile(function)) in skipped_paths
+    ):
+        return _get_file(function.__wrapped__)  # type: ignore[attr-defined]
     else:
-        return Path(inspect.getfile(function))
+        return Path(inspect.getsourcefile(function))
 
 
 def _get_source_lines(function: Callable[..., Any]) -> int:

tests/_test_console_helpers.py

@@ -0,0 +1,9 @@
+import functools
+
+
+def empty_decorator(func):
+    @functools.wraps(func)
+    def wrapped():
+        return func()
+
+    return wrapped

tests/test_console.py

@@ -3,6 +3,8 @@
 
 import attr
 import pytest
+from _pytask.console import _get_file
+from _pytask.console import _get_source_lines
 from _pytask.console import console
 from _pytask.console import create_summary_panel
 from _pytask.console import create_url_style_for_path
@@ -19,6 +21,8 @@
 from rich.text import Span
 from rich.text import Text
 
+from tests._test_console_helpers import empty_decorator
+
 
 def task_func():
     ...
@@ -185,3 +189,36 @@ def test_format_task_id(
 
     result = format_task_id(task, editor_url_scheme, use_short_name, relative_to)
     assert result == expected
+
+
+@pytest.mark.parametrize(
+    "task_func, skipped_paths, expected",
+    [
+        (task_func, [], _THIS_FILE),
+        (
+            empty_decorator(task_func),
+            [],
+            _THIS_FILE.parent.joinpath("_test_console_helpers.py"),
+        ),
+        (
+            empty_decorator(task_func),
+            [_THIS_FILE.parent.joinpath("_test_console_helpers.py")],
+            _THIS_FILE,
+        ),
+    ],
+)
+def test_get_file(task_func, skipped_paths, expected):
+    result = _get_file(task_func, skipped_paths)
+    assert result == expected
+
+
+@pytest.mark.parametrize(
+    "task_func, expected",
+    [
+        (task_func, _SOURCE_LINE_TASK_FUNC),
+        (empty_decorator(task_func), _SOURCE_LINE_TASK_FUNC),
+    ],
+)
+def test_get_source_lines(task_func, expected):
+    result = _get_source_lines(task_func)
+    assert result == expected