Skip to content

errors#

Errors.

All of the ongaku errors.

OngakuError #

Bases: Exception

The base ongaku error.

RestError #

Bases: OngakuError

The base rest error for all rest action errors.

RestStatusError #

RestStatusError(status: int, reason: str | None)

Bases: RestError

Raised when the status is 4XX or 5XX.

status property #

status: int

The status of the response.

reason property #

reason: str | None

The response of the error.

RestRequestError #

RestRequestError(
    timestamp: datetime.datetime,
    status: int,
    error: str,
    message: str,
    path: str,
    trace: str | None,
)

Bases: RestError

Raised when a rest error is received from the response.

timestamp property #

timestamp: datetime.datetime

The timestamp of the error in milliseconds since the Unix epoch.

status property #

status: int

The HTTP status code.

error property #

error: str

The HTTP status code message.

message property #

message: str

The error message.

path property #

path: str

The request path.

trace property #

trace: str | None

The stack trace of the error.

RestEmptyError #

Bases: RestError

Raised when the request was 204, but data was requested.

RestExceptionError #

RestExceptionError(
    message: str | None, severity: SeverityType, cause: str
)

Bases: RestError, errors_.ExceptionError

Raised when a track search results in a error result.

message property #

message: str | None

The message of the exception.

severity property #

severity: errors_.SeverityType

The severity of the exception.

cause property #

cause: str

The cause of the exception.

ClientError #

Bases: OngakuError

The base for all client errors.

ClientAliveError #

ClientAliveError(reason: str)

Bases: ClientError

Raised when the client is not currently alive, or has crashed.

reason property #

reason: str

The reason this error occurred.

SessionError #

Bases: OngakuError

The base session error for all session related errors.

SessionStartError #

Bases: SessionError

Raised when the session has not started. (has not received the ready payload).

SessionMissingError #

Bases: SessionError

Raised when the session could not be found.

SessionHandlerError #

Bases: OngakuError

The base for all session handler related errors.

NoSessionsError #

Bases: SessionHandlerError

Raised when there is no available sessions for the handler to return.

PlayerError #

Bases: OngakuError

The base for all player related errors.

PlayerConnectError #

PlayerConnectError(reason: str)

Bases: PlayerError

Raised when the player cannot connect to lavalink, or discord.

reason property #

reason: str

The reason for failure of connection.

PlayerQueueError #

PlayerQueueError(reason: str)

Bases: PlayerError

Raised when the players queue is empty.

reason property #

reason: str

Reason for the queue error.

PlayerMissingError #

Bases: PlayerError

Raised when the player could not be found.

BuildError #

BuildError(
    exception: Exception | None, reason: str | None = None
)

Bases: OngakuError

Raised when a abstract class fails to build.

exception property #

exception: Exception | None

The exception raised to receive the build error.

reason property #

reason: str | None

The reason this error occurred.

TimeoutError #

Bases: OngakuError

Raised when an event times out.

UniqueError #

UniqueError(reason: str | None)

Bases: OngakuError

Raised when a value should be unique, but is not.

reason property #

reason: str | None

The reason for the unique error.