# Copyright (C) 2019-2021 HERE Europe B.V.
# SPDX-License-Identifier: Apache-2.0
"""This module defines API exceptions."""
[docs]class ApiError(Exception):
"""Exception raised for API HTTP response status codes not in [200...300).
The exception value will be the response object returned by :mod:`requests`
which provides access to all its attributes, eg. :attr:`status_code`,
:attr:`reason` and :attr:`text`, etc.
"""
[docs] def __str__(self):
"""Return a string from the HTTP response causing the exception.
The string simply lists the repsonse's status code, reason and text
content, separated with commas.
"""
resp = self.args[0]
return f"{resp.status_code}, {resp.reason}, {resp.text}"
[docs]class ConfigException(Exception):
"""
This ``ConfigException`` is raised whenever there is any error related to
platform configuration.
"""
[docs]class AuthenticationException(Exception):
"""
This ``AuthenticationException`` is raised either authentication
or authorization on the platform fails.
"""
[docs] def __init__(self, resp):
"""
Instantiate AuthenticationException .
:param resp: response detail will be stored in this param
"""
self.resp = resp
[docs] def __str__(self) -> str:
"""
Return the message to be raised for this exception.
:return: error message
"""
return """An error occurred during authentication or authorization with HERE
platform: Status {status} -
Reason {reason}\n Response: {body}""".format(
status=self.resp.status_code,
reason=self.resp.reason,
body=self.resp.text,
)
[docs]class TooManyRequestsException(Exception):
"""Exception raised for API HTTP response status code 429.
The exception value will be the response object returned by :mod:`requests`
which provides access to all its attributes, eg. :attr:`status_code`,
:attr:`reason` and :attr:`text`, etc.
"""
[docs] def __init__(self, resp):
"""
Instantiate AuthenticationException .
:param resp: response detail will be stored in this param
"""
self.resp = resp
[docs] def __str__(self):
"""Return a string from the HTTP response causing the exception.
The string simply lists the response status code, reason and text
content, separated with commas.
"""
return "TooManyRequestsException: Status \
{status} - Reason {reason}\n\n" "Response: {body}".format(
status=self.resp.status_code,
reason=self.resp.reason,
body=self.resp.text,
)