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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: beautiful-traceback
-Version: 0.4.0
+Version: 0.5.0
 Summary: Beautiful, readable Python tracebacks with colors and formatting
 Keywords: traceback,error,debugging,formatting
 Author: Michael Bianco
@@ -142,6 +142,9 @@ Customize the plugin in your `pytest.ini` or `pyproject.toml`:
 [tool.pytest.ini_options]
 enable_beautiful_traceback = true                    # Enable/disable the plugin
 enable_beautiful_traceback_local_stack_only = true   # Show only local code (filter libraries)
+beautiful_traceback_exclude_patterns = [             # Regex patterns to drop frames
+  "click/core\\.py",
+]
 ```
 
 Or in `pytest.ini`:
@@ -150,8 +153,29 @@ Or in `pytest.ini`:
 [pytest]
 enable_beautiful_traceback = true
 enable_beautiful_traceback_local_stack_only = true
+beautiful_traceback_exclude_patterns =
+    click/core\.py
 ```
 
+Example: filter out pytest, pluggy, and playwright frames from CI tracebacks:
+
+```toml
+[tool.pytest.ini_options]
+beautiful_traceback_exclude_patterns = [
+  "^_pytest/",
+  "^pluggy/",
+  "^playwright/",
+]
+```
+
+**Pattern Matching:** Patterns are tested against multiple representations of each frame:
+- `_pytest/runner.py` (short module path)
+- `/path/to/site-packages/_pytest/runner.py` (full module path)
+- `<site> _pytest/runner.py:353 from_call result: ...` (formatted line with short path)
+- `<site> /path/to/.../runner.py:353 from_call result: ...` (formatted line with full path)
+
+This allows you to write simpler patterns like `^_pytest/` instead of needing to match the full site-packages path.
+
 ## Examples
 
 Check out the [examples/](examples/) directory for detailed usage examples including basic usage, exception chaining, logging integration, and more.
@@ -176,6 +200,7 @@ beautiful_traceback.install(
     only_tty=True,                         # Only activate for TTY output
     only_hook_if_default_excepthook=True,  # Only install if default hook
     local_stack_only=False,                # Filter to show only local code
+    exclude_patterns=["click/core\\.py"],  # Regex patterns to drop frames
     envvar='ENABLE_BEAUTIFUL_TRACEBACK'    # Optional environment variable gate
 )
 ```

{beautiful_traceback-0.4.0 → beautiful_traceback-0.5.0}/README.md

@@ -130,6 +130,9 @@ Customize the plugin in your `pytest.ini` or `pyproject.toml`:
 [tool.pytest.ini_options]
 enable_beautiful_traceback = true                    # Enable/disable the plugin
 enable_beautiful_traceback_local_stack_only = true   # Show only local code (filter libraries)
+beautiful_traceback_exclude_patterns = [             # Regex patterns to drop frames
+  "click/core\\.py",
+]
 ```
 
 Or in `pytest.ini`:
@@ -138,8 +141,29 @@ Or in `pytest.ini`:
 [pytest]
 enable_beautiful_traceback = true
 enable_beautiful_traceback_local_stack_only = true
+beautiful_traceback_exclude_patterns =
+    click/core\.py
 ```
 
+Example: filter out pytest, pluggy, and playwright frames from CI tracebacks:
+
+```toml
+[tool.pytest.ini_options]
+beautiful_traceback_exclude_patterns = [
+  "^_pytest/",
+  "^pluggy/",
+  "^playwright/",
+]
+```
+
+**Pattern Matching:** Patterns are tested against multiple representations of each frame:
+- `_pytest/runner.py` (short module path)
+- `/path/to/site-packages/_pytest/runner.py` (full module path)
+- `<site> _pytest/runner.py:353 from_call result: ...` (formatted line with short path)
+- `<site> /path/to/.../runner.py:353 from_call result: ...` (formatted line with full path)
+
+This allows you to write simpler patterns like `^_pytest/` instead of needing to match the full site-packages path.
+
 ## Examples
 
 Check out the [examples/](examples/) directory for detailed usage examples including basic usage, exception chaining, logging integration, and more.
@@ -164,6 +188,7 @@ beautiful_traceback.install(
     only_tty=True,                         # Only activate for TTY output
     only_hook_if_default_excepthook=True,  # Only install if default hook
     local_stack_only=False,                # Filter to show only local code
+    exclude_patterns=["click/core\\.py"],  # Regex patterns to drop frames
     envvar='ENABLE_BEAUTIFUL_TRACEBACK'    # Optional environment variable gate
 )
 ```

{beautiful_traceback-0.4.0 → beautiful_traceback-0.5.0}/beautiful_traceback/formatting.py

@@ -129,6 +129,46 @@ TEST_PATHS: typ.List[str] = []
 PWD = os.getcwd()
 
 
+def _compile_exclude_patterns(
+    exclude_patterns: typ.Sequence[str],
+) -> list[re.Pattern[str]]:
+    if not exclude_patterns:
+        return []
+
+    return [re.compile(pattern) for pattern in exclude_patterns]
+
+
+def _row_matches_exclude_patterns(
+    row: Row, exclude_patterns: typ.Sequence[re.Pattern[str]]
+) -> bool:
+    if not exclude_patterns:
+        return False
+
+    # Try multiple representations so patterns can match different parts:
+    # 1. short_module: "_pytest/runner.py" (aliased path without prefix)
+    # 2. full_module: "/path/to/site-packages/_pytest/runner.py" (absolute path)
+    # 3. haystack_full: "<site> /path/to/site-packages/_pytest/runner.py:353 from_call result: ..."
+    # 4. haystack_short: "<site> _pytest/runner.py:353 from_call result: ..."
+    haystack_full = (
+        f"{row.alias} {row.full_module}:{row.lineno} {row.call} {row.context}"
+    )
+    haystack_short = (
+        f"{row.alias} {row.short_module}:{row.lineno} {row.call} {row.context}"
+    )
+    candidates = [
+        row.short_module,
+        row.full_module,
+        haystack_full,
+        haystack_short,
+    ]
+    for pattern in exclude_patterns:
+        for candidate in candidates:
+            if pattern.search(candidate):
+                return True
+
+    return False
+
+
 def _py_paths() -> typ.List[str]:
     if TEST_PATHS:
         return TEST_PATHS
@@ -227,7 +267,9 @@ def _iter_entry_rows(
 
 
 def _init_entries_context(
-    entries: StackFrameEntryList, term_width: typ.Optional[int] = None
+    entries: StackFrameEntryList,
+    term_width: typ.Optional[int] = None,
+    exclude_patterns: typ.Sequence[str] = (),
 ) -> Context:
     if term_width is None:
         _term_width = _get_terminal_width()
@@ -246,6 +288,19 @@ def _init_entries_context(
     max_row_width = _term_width - 10
 
     rows = list(_iter_entry_rows(aliases, entry_paths, entries))
+    compiled_exclude_patterns = _compile_exclude_patterns(exclude_patterns)
+    if compiled_exclude_patterns:
+        rows = [
+            row
+            for row in rows
+            if not _row_matches_exclude_patterns(row, compiled_exclude_patterns)
+        ]
+
+    used_aliases = {row.alias for row in rows if row.alias}
+    if used_aliases:
+        aliases = [alias for alias in aliases if alias[0] in used_aliases]
+    else:
+        aliases = []
 
     if rows:
         max_short_module_len = max(
@@ -426,9 +481,15 @@ def _format_traceback(
 
 
 def format_traceback(
-    traceback: ExceptionTraceback, color: bool = False, local_stack_only: bool = False
+    traceback: ExceptionTraceback,
+    color: bool = False,
+    local_stack_only: bool = False,
+    exclude_patterns: typ.Sequence[str] = (),
 ) -> str:
-    ctx = _init_entries_context(traceback.stack_frames)
+    ctx = _init_entries_context(
+        traceback.stack_frames,
+        exclude_patterns=exclude_patterns,
+    )
     return _format_traceback(ctx, traceback, color, local_stack_only)
 
 
@@ -436,6 +497,7 @@ def format_tracebacks(
     tracebacks: typ.List[ExceptionTraceback],
     color: bool = False,
     local_stack_only: bool = False,
+    exclude_patterns: typ.Sequence[str] = (),
 ) -> str:
     traceback_strs: typ.List[str] = []
 
@@ -447,7 +509,12 @@ def format_tracebacks(
             # traceback_strs.append("vvv happend after ^^^ - ")
             traceback_strs.append(CONTEXT_HEAD + os.linesep)
 
-        traceback_str = format_traceback(tb_tup, color, local_stack_only)
+        traceback_str = format_traceback(
+            tb_tup,
+            color,
+            local_stack_only,
+            exclude_patterns=exclude_patterns,
+        )
         traceback_strs.append(traceback_str)
 
     return os.linesep.join(traceback_strs).strip()
@@ -463,6 +530,7 @@ def exc_to_traceback_str(
     color: bool = False,
     local_stack_only: bool = False,
     exc_msg_override: str | None = None,
+    exclude_patterns: typ.Sequence[str] = (),
 ) -> str:
     # NOTE (mb 2020-08-13): wrt. cause vs context see
     #   https://www.python.org/dev/peps/pep-3134/#enhanced-reporting
@@ -511,7 +579,12 @@ def exc_to_traceback_str(
 
     tracebacks = list(reversed(tracebacks))
 
-    return format_tracebacks(tracebacks, color, local_stack_only)
+    return format_tracebacks(
+        tracebacks,
+        color,
+        local_stack_only,
+        exclude_patterns=exclude_patterns,
+    )
 
 
 class LoggingFormatterMixin:

{beautiful_traceback-0.4.0 → beautiful_traceback-0.5.0}/beautiful_traceback/hook.py

@@ -8,7 +8,11 @@ import colorama
 from beautiful_traceback import formatting
 
 
-def init_excepthook(color: bool, local_stack_only: bool) -> typ.Callable:
+def init_excepthook(
+    color: bool,
+    local_stack_only: bool,
+    exclude_patterns: typ.Sequence[str],
+) -> typ.Callable:
     def excepthook(
         exc_type: typ.Type[BaseException],
         exc_value: BaseException,
@@ -17,7 +21,11 @@ def init_excepthook(color: bool, local_stack_only: bool) -> typ.Callable:
         # pylint:disable=unused-argument
         tb_str = (
             formatting.exc_to_traceback_str(
-                exc_value, traceback, color, local_stack_only
+                exc_value,
+                traceback,
+                color,
+                local_stack_only,
+                exclude_patterns=exclude_patterns,
             )
             + "\n"
         )
@@ -39,6 +47,7 @@ def install(
     only_tty: bool = True,
     only_hook_if_default_excepthook: bool = True,
     local_stack_only: bool = False,
+    exclude_patterns: typ.Sequence[str] = (),
 ) -> None:
     """Hook the current excepthook to the beautiful_traceback.
 
@@ -68,7 +77,11 @@ def install(
     if only_hook_if_default_excepthook and not is_default_exepthook:
         return
 
-    sys.excepthook = init_excepthook(color=color, local_stack_only=local_stack_only)
+    sys.excepthook = init_excepthook(
+        color=color,
+        local_stack_only=local_stack_only,
+        exclude_patterns=exclude_patterns,
+    )
 
 
 def uninstall() -> None:

{beautiful_traceback-0.4.0 → beautiful_traceback-0.5.0}/beautiful_traceback/json_formatting.py

@@ -46,6 +46,7 @@ def exc_to_json(
     exc_value: BaseException,
     traceback: types.TracebackType | None,
     local_stack_only: bool = False,
+    exclude_patterns: typ.Sequence[str] = (),
 ) -> dict[str, typ.Any]:
     """Convert an exception to a JSON-serializable dictionary.
 
@@ -112,7 +113,11 @@ def exc_to_json(
             "frames": [],
         }
     else:
-        ctx = fmt._init_entries_context(entries, term_width=fmt.DEFAULT_COLUMNS)
+        ctx = fmt._init_entries_context(
+            entries,
+            term_width=fmt.DEFAULT_COLUMNS,
+            exclude_patterns=exclude_patterns,
+        )
         result = _format_traceback_json(
             ctx.rows,
             main_tb.exc_name,
@@ -132,7 +137,11 @@ def exc_to_json(
                     "frames": [],
                 }
             else:
-                ctx = fmt._init_entries_context(entries, term_width=fmt.DEFAULT_COLUMNS)
+                ctx = fmt._init_entries_context(
+                    entries,
+                    term_width=fmt.DEFAULT_COLUMNS,
+                    exclude_patterns=exclude_patterns,
+                )
                 chain_item = _format_traceback_json(
                     ctx.rows,
                     tb.exc_name,

beautiful_traceback-0.5.0/beautiful_traceback/pytest_assertion.py

@@ -0,0 +1,94 @@
+"""Helpers for extracting pytest's rewritten assertion details."""
+
+import os
+
+import pytest
+
+
+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 pytest's rewritten assertion lines for AssertionError.
+
+    Pytest only provides left/right diffs when a module is rewritten during
+    import. For helper modules, call pytest.register_assert_rewrite before
+    importing them, otherwise the assertion message is plain and there are no
+    diff lines to extract.
+    """
+    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
+
+    lines = []
+    for line in entry_lines:
+        stripped = line.lstrip()
+        if stripped.startswith("E"):
+            lines.append(stripped)
+            continue
+
+        if stripped.startswith(">"):
+            lines.append(stripped)
+
+    if not lines:
+        return None
+
+    return os.linesep.join(lines)

beautiful_traceback-0.5.0/beautiful_traceback/pytest_plugin.py

@@ -0,0 +1,103 @@
+"""Pytest plugin that preserves rewritten assertion details in tracebacks.
+
+Pytest rewrites assert statements at import time for test modules (and any
+modules registered via pytest.register_assert_rewrite). The rewritten asserts
+raise AssertionError instances that include rich explanation text and left/right
+diffs inside pytest's repr objects, not on the exception itself. This plugin
+extracts those repr details and appends them to beautiful_traceback output.
+"""
+
+import os
+from typing import Any, Generator
+
+import pytest
+from pytest import Config
+
+from . import formatting
+from .pytest_assertion import get_exception_message_override
+from .pytest_assertion import get_pytest_assertion_details
+
+
+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 _format_traceback(excinfo: pytest.ExceptionInfo, config: Config) -> str:
+    """Format a traceback with beautiful_traceback styling and pytest details."""
+    message_override = get_exception_message_override(excinfo)
+    assertion_details = get_pytest_assertion_details(excinfo)
+    exclude_patterns = _get_option(config, "beautiful_traceback_exclude_patterns")
+
+    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,
+        exclude_patterns=exclude_patterns,
+    )
+
+    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,
+    )
+
+    parser.addini(
+        "beautiful_traceback_exclude_patterns",
+        "Exclude traceback frames that match regex patterns",
+        type="linelist",
+        default=[],
+    )
+
+
+@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.4.0 → beautiful_traceback-0.5.0}/pyproject.toml

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

beautiful_traceback-0.4.0/beautiful_traceback/pytest_plugin.py

@@ -1,169 +0,0 @@
-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)