beautiful-traceback 0.3.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

beautiful_traceback/__init__.py

@@ -1,17 +1,7 @@
 from ._extension import load_ipython_extension  # noqa: F401
-from .formatting import LoggingFormatter, LoggingFormatterMixin
-from .hook import install, uninstall
-from .json_formatting import exc_to_json
+from .formatting import LoggingFormatter, LoggingFormatterMixin  # noqa: F401
+from .hook import install, uninstall  # noqa: F401
+from .json_formatting import exc_to_json  # noqa: F401
 
 # retain typo for backward compatibility
 LoggingFormaterMixin = LoggingFormatterMixin
-
-
-__all__ = [
-    "install",
-    "uninstall",
-    "LoggingFormatter",
-    "LoggingFormatterMixin",
-    "LoggingFormaterMixin",
-    "exc_to_json",
-]

beautiful_traceback/pytest_plugin.py

@@ -1,10 +1,13 @@
+import os
+from typing import Any, Generator
+
 from . import formatting
 import pytest
 
 from pytest import Config
 
 
-def _get_option(config: Config, key: str):
+def _get_option(config: Config, key: str) -> Any:
     val = None
 
     # will throw an exception if option is not set
@@ -56,7 +59,77 @@ def _get_exception_message_override(excinfo: pytest.ExceptionInfo) -> str | None
     return message
 
 
-def pytest_addoption(parser):
+def _get_pytest_assertion_details(excinfo: pytest.ExceptionInfo) -> str | None:
+    """Return the pytest assertion diff lines for AssertionError."""
+    if not isinstance(excinfo.value, AssertionError):
+        return None
+
+    try:
+        # pytest stores assertion diffs on its own repr object, not the exception.
+        # Reference: https://github.com/pytest-dev/pytest/blob/main/src/_pytest/_code/code.py
+        repr_info = excinfo.getrepr(style="long")
+    except Exception:
+        return None
+
+    reprtraceback = getattr(repr_info, "reprtraceback", None)
+    if reprtraceback is None:
+        chain = getattr(repr_info, "chain", None)
+        if chain:
+            reprtraceback = chain[-1][0]
+
+    if reprtraceback is None:
+        return None
+
+    reprentries = getattr(reprtraceback, "reprentries", None)
+    if not reprentries:
+        return None
+
+    last_entry = reprentries[-1]
+    entry_lines = getattr(last_entry, "lines", None)
+    if not entry_lines:
+        return None
+
+    # Keep only the assertion diff lines for concise appending.
+    lines = []
+    for line in entry_lines:
+        # Keep pytest's assertion diff lines and the failing expression.
+        stripped = line.lstrip()
+        if stripped.startswith("E"):
+            lines.append(stripped)
+            continue
+
+        # Include the source line marker when present.
+        if stripped.startswith(">"):
+            lines.append(stripped)
+
+    if not lines:
+        return None
+
+    return os.linesep.join(lines)
+
+
+def _format_traceback(excinfo: pytest.ExceptionInfo, config: Config) -> str:
+    """Format a traceback with beautiful_traceback styling and pytest assertion details."""
+    message_override = _get_exception_message_override(excinfo)
+    assertion_details = _get_pytest_assertion_details(excinfo)
+
+    formatted_traceback = formatting.exc_to_traceback_str(
+        excinfo.value,
+        excinfo.tb,
+        color=True,
+        local_stack_only=_get_option(
+            config, "enable_beautiful_traceback_local_stack_only"
+        ),
+        exc_msg_override=message_override,
+    )
+
+    if assertion_details:
+        formatted_traceback += os.linesep + assertion_details + os.linesep
+
+    return formatted_traceback
+
+
+def pytest_addoption(parser) -> None:
     parser.addini(
         "enable_beautiful_traceback",
         "Enable the beautiful traceback plugin",
@@ -73,54 +146,24 @@ def pytest_addoption(parser):
 
 
 @pytest.hookimpl(hookwrapper=True)
-def pytest_runtest_makereport(item, call):
-    """
-    Pytest stack traces are challenging to work with by default. This plugin allows beautiful_traceback to be used instead.
+def pytest_runtest_makereport(item, call) -> Generator[None, None, None]:
+    """Format test execution tracebacks with beautiful_traceback.
 
-    This little piece of code was hard-won:
-
-    https://grok.com/share/bGVnYWN5_951be3b1-6811-4fda-b220-c1dd72dedc31
+    This hook runs during the test execution phase and replaces pytest's
+    default traceback formatting with beautiful_traceback's output.
     """
-    outcome = yield
-    report = outcome.get_result()  # Get the generated TestReport object
+    outcome = yield  # type: ignore[misc]
+    report = outcome.get_result()  # type: ignore[attr-defined]
 
-    # Check if the report is for the 'call' phase (test execution) and if it failed
     if _get_option(item.config, "enable_beautiful_traceback") and report.failed:
-        value = call.excinfo.value
-        tb = call.excinfo.tb
-
-        message_override = _get_exception_message_override(call.excinfo)
+        report.longrepr = _format_traceback(call.excinfo, item.config)
 
-        formatted_traceback = formatting.exc_to_traceback_str(
-            value,
-            tb,
-            color=True,
-            local_stack_only=_get_option(
-                item.config, "enable_beautiful_traceback_local_stack_only"
-            ),
-            exc_msg_override=message_override,
-        )
-        report.longrepr = formatted_traceback
 
+def pytest_exception_interact(node, call, report) -> None:
+    """Format collection-phase tracebacks with beautiful_traceback.
 
-def pytest_exception_interact(node, call, report):
-    """
-    This can run during collection, not just test execution.
-
-    So, if there's an import or other pre-run error in pytest, this will apply the correct formatting.
+    This hook runs during collection (e.g., import errors, fixture errors)
+    and ensures those errors also use beautiful_traceback formatting.
     """
-    if report.failed:
-        value = call.excinfo.value
-        tb = call.excinfo.tb
-        message_override = _get_exception_message_override(call.excinfo)
-
-        formatted_traceback = formatting.exc_to_traceback_str(
-            value,
-            tb,
-            color=True,
-            local_stack_only=_get_option(
-                node.config, "enable_beautiful_traceback_local_stack_only"
-            ),
-            exc_msg_override=message_override,
-        )
-        report.longrepr = formatted_traceback
+    if _get_option(node.config, "enable_beautiful_traceback") and report.failed:
+        report.longrepr = _format_traceback(call.excinfo, node.config)

{beautiful_traceback-0.3.0.dist-info → beautiful_traceback-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: beautiful-traceback
-Version: 0.3.0
+Version: 0.4.0
 Summary: Beautiful, readable Python tracebacks with colors and formatting
 Keywords: traceback,error,debugging,formatting
 Author: Michael Bianco

{beautiful_traceback-0.3.0.dist-info → beautiful_traceback-0.4.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-beautiful_traceback/__init__.py,sha256=e6zDdmcyc3H2aAmY5_9hAeMtCU_b3xyXwGhqrbOa-qo,438
+beautiful_traceback/__init__.py,sha256=ZDE4AcfeeT420hCntDfdhnp4uhXm1YwCQHsTuvGc0L4,332
 beautiful_traceback/_extension.py,sha256=klyo3XL4q3-Wdy4Lt6JYdh-Cfh_SkRCI7jCcQCwfWTM,311
 beautiful_traceback/cli.py,sha256=M4EWW9SUNiGH2VCpssxRDMNXNjrVpy_8t9T7jf66RKE,2405
 beautiful_traceback/common.py,sha256=Dg6J4rLdX9uKM6LxJaqSwtLkUjggZk-KrR5kpAIA4uo,2208
@@ -6,8 +6,8 @@ beautiful_traceback/formatting.py,sha256=s4tjdejhYBXBmHlHiUa3bm9j0I6B2hka46JfHNd
 beautiful_traceback/hook.py,sha256=6vYpqA-mD4G32HkX5WSyCMzkvMwB4RXP6wbVEIU6oaY,2078
 beautiful_traceback/json_formatting.py,sha256=WcgA6rk6YkFDRLXOTk95yVrK_HxNjvHHUqgr2RlK_O4,6071
 beautiful_traceback/parsing.py,sha256=39GvHo6kx5dyzTMfRjUTc8H9tRGIhFT8RcjxUvbZBZY,3094
-beautiful_traceback/pytest_plugin.py,sha256=IwZh5yUUsbLpUWZuVxVqSIGUVPO30_0xIHThc3xor54,3672
-beautiful_traceback-0.3.0.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
-beautiful_traceback-0.3.0.dist-info/entry_points.txt,sha256=EXsu7N89wqDpZPEwLHgYVncZJ3y-lbCFZC5fKBZZDac,138
-beautiful_traceback-0.3.0.dist-info/METADATA,sha256=Z5pu8bStps0bEkS8f53AJ5I7krXVHpu2WVdibKPco_s,8558
-beautiful_traceback-0.3.0.dist-info/RECORD,,
+beautiful_traceback/pytest_plugin.py,sha256=6UtsNuFMMc2Ga5Uvl6ctNGoPNdzGKg9NFAwrz5LzPGk,5132
+beautiful_traceback-0.4.0.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+beautiful_traceback-0.4.0.dist-info/entry_points.txt,sha256=EXsu7N89wqDpZPEwLHgYVncZJ3y-lbCFZC5fKBZZDac,138
+beautiful_traceback-0.4.0.dist-info/METADATA,sha256=qVYJrlUdgW6lSpelAoujC8OHOy2pJ43COqEiGjXkiww,8558
+beautiful_traceback-0.4.0.dist-info/RECORD,,