Source code for panoptes.utils.error

import sys

from loguru import logger




class PanError(Exception):
    """Base class for Panoptes errors"""

    def __init__(self, msg=None, exit=False):
        """Initialize PanError exception.

        Args:
            msg (str, optional): Error message. Defaults to None.
            exit (bool, optional): Whether to exit program on error. Defaults to False.
        """
        self.msg = msg

        if self.msg:
            logger.error(str(self))

        if exit:
            self.exit_program(self.msg)



    def exit_program(self, msg=None):
        """Kills running program"""
        if not msg:
            self.msg = "No reason specified"

        # Show on current display.
        logger.add(sys.stderr, format="<red><b>{message}</></>")
        logger.critical(f"TERMINATING: {self.msg}")
        sys.exit(1)


    def __str__(self):
        """Return string representation of the error.

        Returns:
            str: Error class name and message if available.
        """
        error_str = str(self.__class__.__name__)
        if self.msg:
            error_str += f": {self.msg}"

        return error_str





class InvalidSystemCommand(PanError):
    """Error for a system level command malfunction"""

    def __init__(self, msg="Problem running system command", **kwargs):
        """Initialize InvalidSystemCommand exception.

        Args:
            msg (str): Error message. Defaults to "Problem running system command".
            **kwargs: Additional keyword arguments passed to parent class.
        """
        super().__init__(msg, **kwargs)





class InvalidDeserialization(PanError):
    """Error for serialization errors"""

    def __init__(self, msg="Problem deserializing", **kwargs):
        """Initialize InvalidDeserialization exception.

        Args:
            msg (str): Error message. Defaults to "Problem deserializing".
            **kwargs: Additional keyword arguments passed to parent class.
        """
        super().__init__(msg, **kwargs)





class InvalidSerialization(PanError):
    """Error for serialization errors"""

    def __init__(self, msg="Problem Serializing", **kwargs):
        """Initialize InvalidSerialization exception.

        Args:
            msg (str): Error message. Defaults to "Problem Serializing".
            **kwargs: Additional keyword arguments passed to parent class.
        """
        super().__init__(msg, **kwargs)





class Timeout(PanError):
    """Error called when an event times out"""

    def __init__(self, msg="Timeout waiting for event", **kwargs):
        """Initialize Timeout exception.

        Args:
            msg (str): Error message. Defaults to "Timeout waiting for event".
            **kwargs: Additional keyword arguments passed to parent class.
        """
        super().__init__(msg, **kwargs)





class NoObservation(PanError):
    """Generic no Observation"""

    def __init__(self, msg="No valid observations found.", **kwargs):
        """Initialize NoObservation exception.

        Args:
            msg (str): Error message. Defaults to "No valid observations found.".
            **kwargs: Additional keyword arguments passed to parent class.
        """
        super().__init__(msg, **kwargs)





class NotFound(PanError):
    """Generic not found class"""

    pass





class AlreadyExists(PanError):
    """Generic already exists class"""

    pass





class InvalidConfig(PanError):
    """PanError raised if config file is invalid"""

    pass





class InvalidCommand(PanError):
    """PanError raised if a system command does not run"""

    pass





class InvalidMountCommand(PanError):
    """PanError raised if attempting to send command that doesn't exist"""

    pass





class InvalidObservation(NotFound):
    """PanError raised if a field is invalid."""

    pass





class BadConnection(PanError):
    """PanError raised when a connection is bad"""

    pass





class BadSerialConnection(PanError):
    """PanError raised when serial command is bad"""

    pass





class ArduinoDataError(PanError):
    """PanError raised when there is something very wrong with Arduino information."""

    pass





class MountNotFound(NotFound):
    """Mount cannot be import"""

    def __init__(self, msg="Mount Not Found", **kwargs):
        """Initialize MountNotFound exception.

        Args:
            msg (str): Error message. Defaults to "Mount Not Found".
            **kwargs: Additional keyword arguments passed to parent class.
        """
        super().__init__(msg, **kwargs)





class CameraNotFound(NotFound):
    """Camera cannot be imported"""

    pass





class DomeNotFound(NotFound):
    """Dome device not found."""

    pass





class SolveError(NotFound):
    """Camera cannot be imported"""

    pass





class TheSkyXError(PanError):
    """Errors from TheSkyX"""

    pass





class TheSkyXKeyError(TheSkyXError):
    """Errors from TheSkyX because bad key passed"""

    pass





class TheSkyXTimeout(TheSkyXError):
    """Errors from TheSkyX because bad key passed"""

    pass





class GoogleCloudError(PanError):
    """Errors related to google cloud"""

    pass





class NotSupported(PanError, NotImplementedError):
    """Errors from trying to use hardware features not supported by a particular model"""

    pass





class IllegalValue(PanError, ValueError):
    """Errors from trying to hardware parameters to values not supported by a particular model"""

    pass