Source code for xdoctest.exceptions

"""
Define errors that may be raised by xdoctest
"""

from __future__ import annotations

import typing




class MalformedDocstr(Exception):
    """
    Exception raised when the docstring itself does not conform to the expected
    style (e.g. google / numpy).
    """





class ExistingEventLoopError(Exception):
    """
    Exception raised when the docstring uses a top level await and the test is
    already running in an event loop.
    """





class DoctestParseError(Exception):
    """
    Exception raised when doctest code has an error.
    """

    def __init__(
        self,
        msg: str,
        string: str | None = None,
        info: typing.Any | None = None,
        orig_ex: Exception | None = None,
    ):
        """
        Args:
            msg (str): error message
            string (str | None): the string that failed
            info (Any | None): extra information
            orig_ex (Exception | None): The underlying exceptoin
        """
        super(DoctestParseError, self).__init__(msg)
        self.msg = msg
        self.string = string
        self.info = info
        self.orig_ex = orig_ex





class ExitTestException(Exception):
    pass





class IncompleteParseError(SyntaxError):
    """
    Used when something goes wrong in the xdoctest parser
    """





def _resolve_skipped_exception_class():
    try:
        from _pytest.outcomes import Skipped as pytest_skipped
    except ImportError:  # nocover

        class LocalSkipped(Exception):
            pass

        return LocalSkipped
    else:
        return pytest_skipped



Skipped = _resolve_skipped_exception_class()