SOURCE CODE panpath.exceptions DOCS

"""Exception classes for panpath."""


class PanPathError(Exception):DOCS
    """Base exception for panpath errors."""

    pass


class MissingDependencyError(PanPathError, ImportError):DOCS
    """Raised when a required dependency is not installed."""

    def __init__(self, backend: str, package: str, extra: str):
        self.backend = backend
        self.package = package
        self.extra = extra
        super().__init__(
            f"The {backend} backend requires '{package}' which is not installed. "
            f"Install it with: pip install panpath[{extra}]"
        )


class CloudPathError(PanPathError):DOCS
    """Base exception for cloud path errors."""

    pass


class NoStatError(CloudPathError):DOCS
    """Raised when stat information cannot be retrieved."""

    pass