exceptions.py

class MinerException(Exception):
    """
    Base exception class for this application.
    """
    def __init__(self, *args: object):
        if args:
            super().__init__(*args)
        else:
            super().__init__("Unknown miner error")


class ExitRequest(MinerException):
    """
    Raised when the application is requested to exit from outside of the main loop.

    Intended for internal use only.
    """
    def __init__(self):
        super().__init__("Application was requested to exit")


class ReloadRequest(MinerException):
    """
    Raised when the application is requested to reload entirely, without closing the GUI.

    Intended for internal use only.
    """
    def __init__(self):
        super().__init__("Application was requested to reload entirely")


class RequestInvalid(MinerException):
    """
    Raised when a request becomes no longer valid inside its retry loop.

    Intended for internal use only.
    """
    def __init__(self):
        super().__init__("Request became invalid during its retry loop")


class RequestException(MinerException):
    """
    Raised for cases where a web request doesn't return what we wanted it to.
    """
    def __init__(self, *args: object):
        if args:
            super().__init__(*args)
        else:
            super().__init__("Unknown error during request")


class WebsocketClosed(RequestException):
    """
    Raised when the websocket connection has been closed.

    Attributes:
    -----------
    received: bool
        `True` if the closing was caused by our side receiving a close frame, `False` otherwise.
    """
    def __init__(self, *args: object, received: bool = False):
        if args:
            super().__init__(*args)
        else:
            super().__init__("Websocket has been closed")
        self.received: bool = received


class LoginException(RequestException):
    """
    Raised when an exception occurs during login phase.
    """
    def __init__(self, *args: object):
        if args:
            super().__init__(*args)
        else:
            super().__init__("Unknown error during login")


class CaptchaRequired(LoginException):
    """
    The most dreaded thing about automated scripts...
    """
    def __init__(self):
        super().__init__("Captcha is required")