Skip to content

Exceptions

ErrorCode0

Bases: Exception

Raised when the server returns an error code 0, it being a generic error.

ErrorCode10

Bases: Exception

Raised when the server returns an error code 10, meaning that a parameter for the requested endpoint is missing. Should never be raised because Knuckles takes care for enforcing mandatory parameters, if you have encountered this exception the server may have broke the OpenSubsonic API.

If you suspect that this is an issue caused by Knuckles itself, please report it to upstream.

ErrorCode20

Bases: Exception

Raised when the server returns an error code 20, meaning that the client has a lower RESP API version than the server. Should never be raised given that Knuckles supports up to the latest Subsonic REST API version.

ErrorCode30

Bases: Exception

Raised when the server returns an error code 30, meaning that the server has a lower RESP API version than the client.

ErrorCode40

Bases: Exception

Raised when the server returns an error code 40, meaning that the given user doesn't exists or the password is incorrect.

ErrorCode41

Bases: Exception

Raised when the server returns an error code 42, meaning that token authentication is not available.

ErrorCode50

Bases: Exception

Raised when the server returns an error code 50, meaning that the authenticated user is no authorized for the requested action.

ErrorCode60

Bases: Exception

Raised when the server return an error code 60, meaning that the Subsonic trial period has ended.

ErrorCode70

Bases: Exception

Raised when the server returns an error code 70, meaning that the requested data wasn't found.

InvalidRatingNumber

Bases: ValueError

Raised when input an invalid rating weight in a method of the API.

MissingRequiredProperty

Bases: Exception

Raised when a property required to call a method is missing.

ResourceNotFound(message='Unable to generate the model as it does not exist in the server', *args)

Bases: Exception

Raised when a resource could not be retrieve to generate a model using a previous one.

Source code in .venv/lib/python3.11/site-packages/knuckles/exceptions.py 
20
21
22
23
24
25
26
27
def __init__(
    self,
    message: str = (
        "Unable to generate the model as it does not exist in the server"
    ),
    *args: str,
) -> None:
    super().__init__(message, *args)

ShareInvalidSongList

Bases: ValueError

Raised when a method in a share is called with an invalid song list.

UnknownErrorCode

Bases: Exception

Raised when the server returns an error code that doesn't have a specific core error exception.

get_error_code_exception(error_code)

Converts a numeric error code to its corresponding error code exception

Parameters:

Name Type Description Default
error_code int

The number of the error to get its exception.

 required

Returns: The exception of the given error code

Source code in .venv/lib/python3.11/site-packages/knuckles/exceptions.py 
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
def get_error_code_exception(
    error_code: int,
) -> ERROR_CODE_EXCEPTION:
    """Converts a numeric error code to its corresponding error code exception

    Args:
        error_code: The number of the error to get its exception.

    Returns: The exception of the given error code
    """
    match error_code:
        case 0:
            return ErrorCode0
        case 10:
            return ErrorCode10
        case 20:
            return ErrorCode20
        case 30:
            return ErrorCode30
        case 40:
            return ErrorCode40
        case 41:
            return ErrorCode41
        case 50:
            return ErrorCode50
        case 60:
            return ErrorCode60
        case 70:
            return ErrorCode70
        case _:
            return UnknownErrorCode