Function format_exception

python/ray/_common/retry.py:21–52

Format ``exc`` as ``"ClassName: message"`` for substring/regex matching. Uses `traceback.format_exception_only` so the class name is preserved and callers can match on either the class name or the message. Args: exc: The exception to format. include_cause: If True and `

(exc: BaseException, include_cause: bool = False)

def format_exception(exc: BaseException, include_cause: bool = False) -> str:
    """Format ``exc`` as ``"ClassName: message"`` for substring/regex matching.

    Uses `traceback.format_exception_only` so the class name is preserved
    and callers can match on either the class name or the message.

    Args:
        exc: The exception to format.
        include_cause: If True and ``exc.__cause__`` is set (``raise X from Y``),
            append the cause exception after the base exception. This is useful when
            we want to match on an exception encountered in the UDF (e.g. ``RateLimitError``)
            which is wrapped in a ``UserCodeException`` by Ray Data.

    Returns:
        A single-string representation of ``exc`` in the form
        ``"ClassName: message"``. When ``include_cause`` is True and
        ``exc.__cause__`` is set, the cause's formatted form is appended
        after a single space. See the example below.

    Example:
        For a ``UserCodeException`` wrapping a ``RateLimitError``, calling ``format_exception(e, include_cause=True)``
        returns::

            ray.exceptions.UserCodeException: UDF failed to process a data block. RateLimitError: Error code: 429 - rate limited
    """
    s = "".join(traceback.format_exception_only(type(exc), exc)).rstrip("\n")
    if include_cause and exc.__cause__:
        cause = exc.__cause__
        s += " " + "".join(traceback.format_exception_only(type(cause), cause)).rstrip(
            "\n"
        )
    return s


def matches_error(pattern: str, error_str: str) -> bool: