Exceptions

exceptions

PokeLanceException

PokeLanceException(message: str, route: Route)

Bases: Exception

Base exception class for PokeLance.

Parameters:

Name	Type	Description	Default
message	str	The message to display.	required
route	Route	The route that caused the exception.	required

Attributes:

Name	Type	Description
message	str	The message to display.
route	Route	The route that caused the exception.

Source code in pokelance/exceptions.py

def __init__(self, message: str, route: "Route") -> None:
    self.message = message
    self.route = route
    super().__init__(message)

HTTPException

HTTPException(message: str, route: Route, status: int)

Bases: PokeLanceException

Base exception class for HTTP exceptions.

Parameters:

Name	Type	Description	Default
message	str	The message to display.	required
route	Route	The route that caused the exception.	required
status	int	The status code of the exception.	required

Attributes:

Name	Type	Description
message	str	The message to display.
route	Route	The route that caused the exception.
status	int	The status code of the exception.

Source code in pokelance/exceptions.py

def __init__(self, message: str, route: "Route", status: int) -> None:
    self.status = status
    super().__init__(message, route)

create

create() -> HTTPException

Creates an exception from the status code.

Source code in pokelance/exceptions.py

def create(self) -> "HTTPException":
    """Creates an exception from the status code."""
    return get_exception(self.status)(self.message, self.route, self.status)

BadRequest

BadRequest(message: str, route: Route, status: int)

Bases: HTTPException

Exception raised when a bad request is made. [HTTP 400]

Source code in pokelance/exceptions.py

def __init__(self, message: str, route: "Route", status: int) -> None:
    self.status = status
    super().__init__(message, route)

Unauthorized

Unauthorized(message: str, route: Route, status: int)

Bases: HTTPException

Exception raised when unauthorized. [HTTP 401]

Source code in pokelance/exceptions.py

def __init__(self, message: str, route: "Route", status: int) -> None:
    self.status = status
    super().__init__(message, route)

Forbidden

Forbidden(message: str, route: Route, status: int)

Bases: HTTPException

Exception raised when forbidden. [HTTP 403]

Source code in pokelance/exceptions.py

def __init__(self, message: str, route: "Route", status: int) -> None:
    self.status = status
    super().__init__(message, route)

NotFound

NotFound(message: str, route: Route, status: int)

Bases: HTTPException

Exception raised when a resource is not found. [HTTP 404]

Source code in pokelance/exceptions.py

def __init__(self, message: str, route: "Route", status: int) -> None:
    self.status = status
    super().__init__(message, route)

MethodNotAllowed

MethodNotAllowed(message: str, route: Route, status: int)

Bases: HTTPException

Exception raised when a method is not allowed. [HTTP 405]

Source code in pokelance/exceptions.py

def __init__(self, message: str, route: "Route", status: int) -> None:
    self.status = status
    super().__init__(message, route)

UnknownError

UnknownError(message: str, route: Route, status: int)

Bases: HTTPException

Exception raised when an unknown error occurs.

Source code in pokelance/exceptions.py

def __init__(self, message: str, route: "Route", status: int) -> None:
    self.status = status
    super().__init__(message, route)

ResourceNotFound

ResourceNotFound(
    message: str,
    route: Route,
    status: int,
    suggestions: list[str] | None = None,
)

Bases: NotFound

Exception raised when a resource is not found.

Parameters:

Name	Type	Description	Default
message	str	The message to display.	required
route	Route	The route that caused the exception.	required
status	int	The status code of the exception.	required
suggestions	list[str] | None	Possible suggestions for the resource.	None

Source code in pokelance/exceptions.py

def __init__(self, message: str, route: "Route", status: int, suggestions: list[str] | None = None) -> None:
    self.suggestions = suggestions or []
    super().__init__(message, route, status)

ImageNotFound

ImageNotFound(message: str, route: Route, status: int)

Bases: NotFound

Exception raised when an image is not found.

Parameters:

Name	Type	Description	Default
message	str	The message to display.	required
route	Route	The route that caused the exception.	required
status	int	The status code of the exception.	required

Source code in pokelance/exceptions.py

def __init__(self, message: str, route: "Route", status: int) -> None:
    super().__init__(message, route, status)

AudioNotFound

AudioNotFound(message: str, route: Route, status: int)

Bases: NotFound

Exception raised when an audio is not found.

Parameters:

Name	Type	Description	Default
message	str	The message to display.	required
route	Route	The route that caused the exception.	required
status	int	The status code of the exception.	required

Source code in pokelance/exceptions.py

def __init__(self, message: str, route: "Route", status: int) -> None:
    super().__init__(message, route, status)

get_exception

get_exception(status: int) -> type[HTTPException]

Gets an exception from the status code.

Parameters:

Name	Type	Description	Default
status	int	The status code.	required

Returns:

Type	Description
HTTPException	The exception.

Source code in pokelance/exceptions.py

def get_exception(status: int) -> type[HTTPException]:
    """Gets an exception from the status code.

    Parameters
    ----------
    status: int
        The status code.

    Returns
    -------
    pokelance.exceptions.HTTPException
        The exception.
    """
    return CODES.get(status, UnknownError)

Comments