Errors

All exceptions raised by the library.

Base Exception

kickpy.errors.KickpyException

Bases: Exception

Base exception class for Kickpy errors.

Argument Errors

kickpy.errors.MissingArgument

Bases: KickpyException

Raised when a required argument is missing.

kickpy.errors.NoClientId

Bases: KickpyException

Raised when no client_id is provided.

kickpy.errors.NoClientSecret

Bases: KickpyException

Raised when no client_secret is provided.

HTTP Errors

Every HTTP error exposes status, the API message, and code, a machine-readable error code some endpoints return (for example CHANNEL_IS_NOT_LIVE from create_ad_break()).

kickpy.errors.HTTPException(response, message=None, code=None)

Bases: KickpyException

Base exception class for HTTP errors.

Exposes status, the API message and code, a machine-readable error code returned by some endpoints (e.g. CHANNEL_IS_NOT_LIVE).

kickpy.errors.BadRequest(response, message=None, code=None)

Bases: HTTPException

Raised when a request is bad.

kickpy.errors.Unauthorized(response, message=None, code=None)

Bases: HTTPException

Raised when a request is unauthorized.

kickpy.errors.Forbidden(response, message=None, code=None)

Bases: HTTPException

Raised when a request is forbidden.

kickpy.errors.NotFound(response, message=None, code=None)

Bases: HTTPException

Raised when a resource is not found.

kickpy.errors.Conflict(response, message=None, code=None)

Bases: HTTPException

Raised when a request conflicts with the current state (e.g. an ad break is already active).

kickpy.errors.Ratelimited(response, message=None, code=None)

Bases: HTTPException

Raised when a request is ratelimited.

kickpy.errors.InternalServerError(response, message=None, code=None)

Bases: HTTPException

Raised when a server error occurs.