lastfmget.errors

"""
Custom Exception subclasses for lastfmget.
"""
from enum import Enum

class __LastFmErrorCodes(Enum):
    """Last.fm response error codes."""
    InvalidParams = 6
    InvalidApiKey = 10
    Offline       = 11
    RateLimit     = 29

def raise_lastfm_error(code, msg=''):
    """
    Raises a LastFmError exception.

    Arguments:
      * code (int) -- Error code
      * msg (str) -- Error message
    """
    match code:
        case __LastFmErrorCodes.InvalidParams.value: raise ParamError(msg)
        case __LastFmErrorCodes.InvalidApiKey.value: raise ApiKeyError
        case __LastFmErrorCodes.Offline.value:       raise OfflineError
        case __LastFmErrorCodes.RateLimit.value:     raise RateLimitError
        case _:                                      raise LastFmError(code, msg)

class LastFmGetError(Exception):
    """Generic lastfmget error."""

    def __init__(self, msg='Generic lastfmget error'):
        """Calls Exception(msg)"""
        super().__init__(f'LastFmGetError: {msg}')

class NotConfiguredError(LastFmGetError):
    """lastfmget not configured - must call lastfmget.init() first."""

    def __init__(self, msg='lastfmget not configured'):
        """Calls LastFmGetError(msg)"""
        super().__init__(f'NotConfiguredError: {msg}')


class LastFmError(LastFmGetError):
    """Generic Last.fm response error."""

    def __init__(self, msg='Generic Last.fm response error', code=None):
        """Calls LastFmGetError(msg)"""
        codestr = f'[{code}]' if code else ''
        super().__init__(f'LastFmError{codestr}: {msg}')

class ParamError(LastFmError):
    """Invalid parameters provided - example: user not found."""

    def __init__(self, msg):
        """Calls LastFmError(msg)"""
        super().__init__(f'ParamError: {msg}')

class ApiKeyError(LastFmError):
    """Last.fm API key is invalid."""

    def __init__(self, msg='Invalid API key provided'):
        """Calls LastFmError(msg)"""
        super().__init__(f'ApiKeyError: {msg}')

class OfflineError(LastFmError):
    """Last.fm offline."""

    def __init__(self, msg='Last.fm is offline'):
        """Calls LastFmError(msg)"""
        super().__init__(f'OfflineError: {msg}')

class RateLimitError(LastFmError):
    """Last.fm API rate limit exceeded - decrease api_cfg.call_rate."""

    def __init__(self, msg='Last.fm API rate limit exceeded'):
        """Calls LastFmError(msg)"""
        super().__init__(f'RateLimitError: {msg}')

def raise_lastfm_error(code, msg=''):
    """
    Raises a LastFmError exception.

    Arguments:
      * code (int) -- Error code
      * msg (str) -- Error message
    """
    match code:
        case __LastFmErrorCodes.InvalidParams.value: raise ParamError(msg)
        case __LastFmErrorCodes.InvalidApiKey.value: raise ApiKeyError
        case __LastFmErrorCodes.Offline.value:       raise OfflineError
        case __LastFmErrorCodes.RateLimit.value:     raise RateLimitError
        case _:                                      raise LastFmError(code, msg)

class LastFmGetError(Exception):
    """Generic lastfmget error."""

    def __init__(self, msg='Generic lastfmget error'):
        """Calls Exception(msg)"""
        super().__init__(f'LastFmGetError: {msg}')

class NotConfiguredError(LastFmGetError):
    """lastfmget not configured - must call lastfmget.init() first."""

    def __init__(self, msg='lastfmget not configured'):
        """Calls LastFmGetError(msg)"""
        super().__init__(f'NotConfiguredError: {msg}')

class LastFmError(LastFmGetError):
    """Generic Last.fm response error."""

    def __init__(self, msg='Generic Last.fm response error', code=None):
        """Calls LastFmGetError(msg)"""
        codestr = f'[{code}]' if code else ''
        super().__init__(f'LastFmError{codestr}: {msg}')

class ParamError(LastFmError):
    """Invalid parameters provided - example: user not found."""

    def __init__(self, msg):
        """Calls LastFmError(msg)"""
        super().__init__(f'ParamError: {msg}')

class ApiKeyError(LastFmError):
    """Last.fm API key is invalid."""

    def __init__(self, msg='Invalid API key provided'):
        """Calls LastFmError(msg)"""
        super().__init__(f'ApiKeyError: {msg}')

class OfflineError(LastFmError):
    """Last.fm offline."""

    def __init__(self, msg='Last.fm is offline'):
        """Calls LastFmError(msg)"""
        super().__init__(f'OfflineError: {msg}')

class RateLimitError(LastFmError):
    """Last.fm API rate limit exceeded - decrease api_cfg.call_rate."""

    def __init__(self, msg='Last.fm API rate limit exceeded'):
        """Calls LastFmError(msg)"""
        super().__init__(f'RateLimitError: {msg}')