Rework reports and tracebacks. (#474)

Author: tobiasraabe

docs/source/reference_guides/api.md

@@ -359,7 +359,8 @@ outcome.
 
 ## Reports
 
-There are some classes to handle different kinds of reports.
+Reports are classes that handle successes and errors during the collection, dag
+resolution and execution.
 
 ```{eval-rst}
 .. autoclass:: pytask.CollectionReport
@@ -393,10 +394,8 @@ There are some classes to handle different kinds of reports.
 ## Tracebacks
 
 ```{eval-rst}
-.. autofunction:: pytask.format_exception_without_traceback
 .. autofunction:: pytask.remove_internal_traceback_frames_from_exc_info
-.. autofunction:: pytask.remove_traceback_from_exc_info
-.. autofunction:: pytask.render_exc_info
+.. autoclass:: pytask.Traceback
 ```
 
 ## Warnings

environment.yml

@@ -32,7 +32,6 @@ dependencies:
   - pygraphviz
   - pytest
   - pytest-cov
-  - pytest-env
   - pytest-xdist
   - ruff
   - syrupy

pyproject.toml

@@ -160,7 +160,6 @@ filterwarnings = [
     "ignore:'@pytask.mark.*. is deprecated:FutureWarning",
     "ignore:The --rsyncdir command line argument:DeprecationWarning",
 ]
-env = ["PYDEVD_DISABLE_FILE_VALIDATION=1"]
 
 [tool.mypy]
 files = ["src", "tests"]

src/_pytask/clean.py

@@ -29,7 +29,7 @@
 from _pytask.pluginmanager import get_plugin_manager
 from _pytask.session import Session
 from _pytask.shared import to_list
-from _pytask.traceback import render_exc_info
+from _pytask.traceback import Traceback
 from _pytask.tree_util import tree_leaves
 from attrs import define
 
@@ -108,7 +108,7 @@ def clean(**raw_config: Any) -> NoReturn:  # noqa: C901, PLR0912
 
     except Exception:  # noqa: BLE001
         session = Session(exit_code=ExitCode.CONFIGURATION_FAILED)
-        console.print(render_exc_info(*sys.exc_info()))
+        console.print(Traceback(sys.exc_info()))
 
     else:
         try:
@@ -161,8 +161,7 @@ def clean(**raw_config: Any) -> NoReturn:  # noqa: C901, PLR0912
             console.rule(style="failed")
 
         except Exception:  # noqa: BLE001
-            exc_info = sys.exc_info()
-            console.print(render_exc_info(*exc_info, show_locals=config["show_locals"]))
+            console.print(Traceback(sys.exc_info()))
             console.rule(style="failed")
             session.exit_code = ExitCode.FAILED
 

src/_pytask/collect.py

@@ -19,8 +19,6 @@
 from _pytask.config import IS_FILE_SYSTEM_CASE_SENSITIVE
 from _pytask.console import console
 from _pytask.console import create_summary_panel
-from _pytask.console import format_node_name
-from _pytask.console import format_task_name
 from _pytask.console import get_file
 from _pytask.console import is_jupyter
 from _pytask.exceptions import CollectionError
@@ -38,10 +36,9 @@
 from _pytask.path import find_case_sensitive_path
 from _pytask.path import import_path
 from _pytask.path import shorten_path
-from _pytask.report import CollectionReport
+from _pytask.reports import CollectionReport
 from _pytask.shared import find_duplicates
 from _pytask.task_utils import task as task_decorator
-from _pytask.traceback import render_exc_info
 from _pytask.typing import is_task_function
 from rich.text import Text
 
@@ -464,41 +461,7 @@ def pytask_collect_log(
         )
 
         for report in failed_reports:
-            if report.node is None:
-                header = "Error"
-            else:
-                if isinstance(report.node, PTask):
-                    short_name = format_task_name(
-                        report.node, editor_url_scheme="no_link"
-                    ).plain
-                elif isinstance(report.node, PNode):
-                    short_name = format_node_name(
-                        report.node, session.config["paths"]
-                    ).plain
-                else:
-                    msg = (
-                        "Requires a 'PTask' or a 'PNode' and not "
-                        f"{type(report.node)!r}."
-                    )
-                    raise TypeError(msg)
-
-                header = f"Could not collect {short_name}"
-
-            console.rule(
-                Text(header, style=CollectionOutcome.FAIL.style),
-                style=CollectionOutcome.FAIL.style,
-            )
-
-            console.print()
-
-            assert report.exc_info
-            console.print(
-                render_exc_info(
-                    *report.exc_info, show_locals=session.config["show_locals"]
-                )
-            )
-
-            console.print()
+            console.print(report)
 
         panel = create_summary_panel(
             counts, CollectionOutcome, "Collected errors and tasks"

src/_pytask/console.py

@@ -14,7 +14,6 @@
 from typing import Sequence
 from typing import TYPE_CHECKING
 
-import rich
 from _pytask.node_protocols import PNode
 from _pytask.node_protocols import PPathNode
 from _pytask.node_protocols import PTaskWithPath
@@ -109,9 +108,9 @@
 
 
 def render_to_string(
-    text: RenderableType,
+    renderable: RenderableType,
+    console: Console,
     *,
-    console: Console | None = None,
     strip_styles: bool = False,
 ) -> str:
     """Render text with rich to string including ANSI codes, etc..
@@ -120,31 +119,10 @@ def render_to_string(
     example, render warnings with colors or text in exceptions.
 
     """
-    if console is None:
-        console = rich.get_console()
-
-    segments = console.render(text)
-
-    output = []
-    if console.no_color and console._color_system:
-        segments = Segment.remove_color(segments)
-
+    buffer = console.render(renderable)
     if strip_styles:
-        segments = Segment.strip_styles(segments)
-
-    for segment in segments:
-        if segment.style:
-            output.append(
-                segment.style.render(
-                    segment.text,
-                    color_system=console._color_system,
-                    legacy_windows=console.legacy_windows,
-                )
-            )
-        else:
-            output.append(segment.text)
-
-    return "".join(output)
+        buffer = Segment.strip_styles(buffer)
+    return console._render_buffer(buffer)
 
 
 def format_task_name(task: PTask, editor_url_scheme: str) -> Text:

src/_pytask/dag.py

@@ -28,9 +28,8 @@
 from _pytask.node_protocols import PNode
 from _pytask.node_protocols import PTask
 from _pytask.nodes import PythonNode
-from _pytask.report import DagReport
+from _pytask.reports import DagReport
 from _pytask.shared import reduce_names_of_multiple_nodes
-from _pytask.traceback import render_exc_info
 from _pytask.tree_util import tree_map
 from rich.text import Text
 from rich.tree import Tree
@@ -43,14 +42,7 @@
 
 @hookimpl
 def pytask_dag(session: Session) -> bool | None:
-    """Create a directed acyclic graph (DAG) capturing dependencies between functions.
-
-    Parameters
-    ----------
-    session : _pytask.session.Session
-        Dictionary containing tasks.
-
-    """
+    """Create a directed acyclic graph (DAG) for the workflow."""
     try:
         session.dag = session.hook.pytask_dag_create_dag(
             session=session, tasks=session.tasks
@@ -337,18 +329,13 @@ def _check_if_tasks_have_the_same_products(dag: nx.DiGraph, paths: list[Path]) -
 
 
 @hookimpl
-def pytask_dag_log(session: Session, report: DagReport) -> None:
+def pytask_dag_log(report: DagReport) -> None:
     """Log errors which happened while resolving dependencies."""
     console.print()
     console.rule(
-        Text("Failures during resolving dependencies", style="failed"),
-        style="failed",
+        Text("Failures during resolving dependencies", style="failed"), style="failed"
     )
-
     console.print()
-    console.print(
-        render_exc_info(*report.exc_info, show_locals=session.config["show_locals"])
-    )
-
+    console.print(report)
     console.print()
     console.rule(style="failed")

src/_pytask/debugging.py

@@ -14,8 +14,7 @@
 from _pytask.console import console
 from _pytask.node_protocols import PTask
 from _pytask.outcomes import Exit
-from _pytask.traceback import remove_internal_traceback_frames_from_exc_info
-from _pytask.traceback import render_exc_info
+from _pytask.traceback import Traceback
 
 
 if TYPE_CHECKING:
@@ -351,13 +350,11 @@ def wrapper(*args: Any, **kwargs: Any) -> None:
                 console.rule("Captured stderr", style="default")
                 console.print(err)
 
-            exc_info = remove_internal_traceback_frames_from_exc_info(sys.exc_info())
+            exc_info = sys.exc_info()
 
             console.print()
             console.rule("Traceback", characters=">", style="default")
-            console.print(
-                render_exc_info(*exc_info, show_locals=session.config["show_locals"])
-            )
+            console.print(Traceback(exc_info))
 
             post_mortem(exc_info[2])  # type: ignore[arg-type]
 

src/_pytask/execute.py

@@ -13,12 +13,10 @@
 from _pytask.console import create_url_style_for_task
 from _pytask.console import format_node_name
 from _pytask.console import format_strings_as_flat_tree
-from _pytask.console import format_task_name
 from _pytask.console import unify_styles
 from _pytask.dag_utils import descending_tasks
 from _pytask.dag_utils import TopologicalSorter
 from _pytask.database_utils import update_states_in_database
-from _pytask.enums import ShowCapture
 from _pytask.exceptions import ExecutionError
 from _pytask.exceptions import NodeLoadError
 from _pytask.exceptions import NodeNotFoundError
@@ -31,10 +29,8 @@
 from _pytask.outcomes import Exit
 from _pytask.outcomes import TaskOutcome
 from _pytask.outcomes import WouldBeExecuted
-from _pytask.report import ExecutionReport
-from _pytask.traceback import format_exception_without_traceback
+from _pytask.reports import ExecutionReport
 from _pytask.traceback import remove_traceback_from_exc_info
-from _pytask.traceback import render_exc_info
 from _pytask.tree_util import tree_leaves
 from _pytask.tree_util import tree_map
 from _pytask.tree_util import tree_structure
@@ -274,10 +270,10 @@ class ShowErrorsImmediatelyPlugin:
 
     @staticmethod
     @hookimpl(tryfirst=True)
-    def pytask_execute_task_log_end(session: Session, report: ExecutionReport) -> None:
+    def pytask_execute_task_log_end(report: ExecutionReport) -> None:
         """Print the error report of a task."""
         if report.outcome == TaskOutcome.FAIL:
-            _print_errored_task_report(session, report)
+            console.print(report)
 
 
 @hookimpl
@@ -301,7 +297,7 @@ def pytask_execute_log_end(session: Session, reports: list[ExecutionReport]) ->
                 report.outcome == TaskOutcome.SKIP_PREVIOUS_FAILED
                 and session.config["verbose"] >= 2  # noqa: PLR2004
             ):
-                _print_errored_task_report(session, report)
+                console.print(report)
 
     console.rule(style="dim")
 
@@ -319,32 +315,3 @@ def pytask_execute_log_end(session: Session, reports: list[ExecutionReport]) ->
         raise ExecutionError
 
     return True
-
-
-def _print_errored_task_report(session: Session, report: ExecutionReport) -> None:
-    """Print the traceback and the exception of an errored report."""
-    task_name = format_task_name(
-        task=report.task, editor_url_scheme=session.config["editor_url_scheme"]
-    )
-    text = Text.assemble("Task ", task_name, " failed", style="failed")
-    console.rule(text, style=report.outcome.style)
-
-    console.print()
-
-    if report.exc_info and isinstance(report.exc_info[1], Exit):
-        console.print(format_exception_without_traceback(report.exc_info))
-    else:
-        assert report.exc_info
-        console.print(
-            render_exc_info(*report.exc_info, show_locals=session.config["show_locals"])
-        )
-
-    console.print()
-    show_capture = session.config["show_capture"]
-    for when, key, content in report.sections:
-        if key in ("stdout", "stderr") and show_capture in (
-            ShowCapture(key),
-            ShowCapture.ALL,
-        ):
-            console.rule(f"Captured {key} during {when}", style="default")
-            console.print(content)

src/_pytask/hookspecs.py

@@ -23,9 +23,9 @@
     from _pytask.session import Session
     from _pytask.outcomes import CollectionOutcome
     from _pytask.outcomes import TaskOutcome
-    from _pytask.report import CollectionReport
-    from _pytask.report import ExecutionReport
-    from _pytask.report import DagReport
+    from _pytask.reports import CollectionReport
+    from _pytask.reports import ExecutionReport
+    from _pytask.reports import DagReport
 
 
 hookspec = pluggy.HookspecMarker("pytask")