beautiful-traceback 0.3.0__tar.gz → 0.4.0__tar.gz

{beautiful_traceback-0.3.0 → beautiful_traceback-0.4.0}/PKG-INFO

@@ -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.4.0/beautiful_traceback/__init__.py

@@ -0,0 +1,7 @@
+from ._extension import load_ipython_extension  # noqa: F401
+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

beautiful_traceback-0.4.0/beautiful_traceback/pytest_plugin.py

@@ -0,0 +1,169 @@
+import os
+from typing import Any, Generator
+
+from . import formatting
+import pytest
+
+from pytest import Config
+
+
+def _get_option(config: Config, key: str) -> Any:
+    val = None
+
+    # will throw an exception if option is not set
+    try:
+        val = config.getoption(key)
+    except Exception:
+        pass
+
+    if val is None:
+        val = config.getini(key)
+
+    return val
+
+
+def _get_exception_message_override(excinfo: pytest.ExceptionInfo) -> str | None:
+    """Return pytest's verbose exception message when rewriting adds detail.
+
+    The plugin overrides pytest's longrepr rendering, which skips the
+    ExceptionInfo repr where pytest stores rewritten assertion diffs. Without
+    this, AssertionError messages collapse to str(exc) and omit left/right
+    details. Pulling reprcrash.message preserves that verbose message when
+    pytest provides one.
+    """
+    try:
+        repr_info = excinfo.getrepr(style="long")
+    except Exception:
+        return None
+
+    reprcrash = getattr(repr_info, "reprcrash", None)
+    if reprcrash is None:
+        return None
+
+    message = getattr(reprcrash, "message", None)
+    if not message:
+        return None
+
+    exc_name = type(excinfo.value).__name__
+    prefix = f"{exc_name}: "
+    if message.startswith(prefix):
+        message = message.removeprefix(prefix)
+
+    if not message or message == exc_name:
+        return None
+
+    exc_message = str(excinfo.value)
+    if message == exc_message:
+        return None
+
+    return message
+
+
+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",
+        type="bool",
+        default=True,
+    )
+
+    parser.addini(
+        "enable_beautiful_traceback_local_stack_only",
+        "Show only local code (filter out library/framework internals)",
+        type="bool",
+        default=True,
+    )
+
+
+@pytest.hookimpl(hookwrapper=True)
+def pytest_runtest_makereport(item, call) -> Generator[None, None, None]:
+    """Format test execution tracebacks with beautiful_traceback.
+
+    This hook runs during the test execution phase and replaces pytest's
+    default traceback formatting with beautiful_traceback's output.
+    """
+    outcome = yield  # type: ignore[misc]
+    report = outcome.get_result()  # type: ignore[attr-defined]
+
+    if _get_option(item.config, "enable_beautiful_traceback") and report.failed:
+        report.longrepr = _format_traceback(call.excinfo, item.config)
+
+
+def pytest_exception_interact(node, call, report) -> None:
+    """Format collection-phase tracebacks with beautiful_traceback.
+
+    This hook runs during collection (e.g., import errors, fixture errors)
+    and ensures those errors also use beautiful_traceback formatting.
+    """
+    if _get_option(node.config, "enable_beautiful_traceback") and report.failed:
+        report.longrepr = _format_traceback(call.excinfo, node.config)

{beautiful_traceback-0.3.0 → beautiful_traceback-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "beautiful-traceback"
-version = "0.3.0"
+version = "0.4.0"
 description = "Beautiful, readable Python tracebacks with colors and formatting"
 keywords = ["traceback", "error", "debugging", "formatting"]
 readme = "README.md"

beautiful_traceback-0.3.0/beautiful_traceback/__init__.py

@@ -1,17 +0,0 @@
-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
-
-# retain typo for backward compatibility
-LoggingFormaterMixin = LoggingFormatterMixin
-
-
-__all__ = [
-    "install",
-    "uninstall",
-    "LoggingFormatter",
-    "LoggingFormatterMixin",
-    "LoggingFormaterMixin",
-    "exc_to_json",
-]

beautiful_traceback-0.3.0/beautiful_traceback/pytest_plugin.py

@@ -1,126 +0,0 @@
-from . import formatting
-import pytest
-
-from pytest import Config
-
-
-def _get_option(config: Config, key: str):
-    val = None
-
-    # will throw an exception if option is not set
-    try:
-        val = config.getoption(key)
-    except Exception:
-        pass
-
-    if val is None:
-        val = config.getini(key)
-
-    return val
-
-
-def _get_exception_message_override(excinfo: pytest.ExceptionInfo) -> str | None:
-    """Return pytest's verbose exception message when rewriting adds detail.
-
-    The plugin overrides pytest's longrepr rendering, which skips the
-    ExceptionInfo repr where pytest stores rewritten assertion diffs. Without
-    this, AssertionError messages collapse to str(exc) and omit left/right
-    details. Pulling reprcrash.message preserves that verbose message when
-    pytest provides one.
-    """
-    try:
-        repr_info = excinfo.getrepr(style="long")
-    except Exception:
-        return None
-
-    reprcrash = getattr(repr_info, "reprcrash", None)
-    if reprcrash is None:
-        return None
-
-    message = getattr(reprcrash, "message", None)
-    if not message:
-        return None
-
-    exc_name = type(excinfo.value).__name__
-    prefix = f"{exc_name}: "
-    if message.startswith(prefix):
-        message = message.removeprefix(prefix)
-
-    if not message or message == exc_name:
-        return None
-
-    exc_message = str(excinfo.value)
-    if message == exc_message:
-        return None
-
-    return message
-
-
-def pytest_addoption(parser):
-    parser.addini(
-        "enable_beautiful_traceback",
-        "Enable the beautiful traceback plugin",
-        type="bool",
-        default=True,
-    )
-
-    parser.addini(
-        "enable_beautiful_traceback_local_stack_only",
-        "Show only local code (filter out library/framework internals)",
-        type="bool",
-        default=True,
-    )
-
-
-@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.
-
-    This little piece of code was hard-won:
-
-    https://grok.com/share/bGVnYWN5_951be3b1-6811-4fda-b220-c1dd72dedc31
-    """
-    outcome = yield
-    report = outcome.get_result()  # Get the generated TestReport object
-
-    # 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)
-
-        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):
-    """
-    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.
-    """
-    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