Source code for tiatoolbox.utils.exceptions

"""Custom Errors and Exceptions for TIAToolbox."""

from __future__ import annotations




class FileNotSupportedError(Exception):
    """Raise No supported file found error.

    Args:
        message (str) : Display message for the error.

    """

    def __init__(
        self: FileNotSupportedError,
        message: str = "File format is not supported",
    ) -> None:
        """Initialize :class:`FileNotSupportedError`."""
        super().__init__(message)





class MethodNotSupportedError(Exception):
    """Raise No supported file found error.

    Args:
        message (str) : Display message for the error.

    """

    def __init__(
        self: MethodNotSupportedError,
        message: str = "Method is not supported",
    ) -> None:
        """Initialize :class:`MethodNotSupportedError`."""
        super().__init__(message)





class DimensionMismatchError(Exception):
    """Raise dimension mismatch error.

    Args:
        expected_dims (list or tuple) : Expected dimensions.
        actual_dims (list or tuple) : Actual dimensions.

    """

    def __init__(
        self: DimensionMismatchError,
        expected_dims: list | tuple,
        actual_dims: list | tuple,
    ) -> None:
        """Initialize :class:`DimensionMismatchError`."""
        self.expected_dims = expected_dims
        self.actual_dims = actual_dims
        super().__init__(f"Expected dimensions {expected_dims}, but got {actual_dims}.")