def logout(self) -> None:
"""Logs out of the REST-API.
Raises:
ValueError: Error when logging out.
ValueError: Wrong status code when logging out.
"""
url = self.get_url("/api/endeavour/session")
try:
response_logout: Response = delete(url, headers=self.__headers, verify=False)
except RequestException as error:
ExceptionUtils.exception_info(error=error)
raise ValueError("error when logging out")
if response_logout.status_code != 204:
raise ConnectionUtils.rest_response_error(response_logout, "Wrong Status code when logging out")
if(self.__verbose):
LOGGER.info("Rest-API logout successfull")
LOGGER.debug("Rest-API logout successfull")
def query_url(
self,
url: str,
params: Dict[str, Any] = None,
request_type: RequestType = RequestType.GET,
post_data: Dict[str, str] = None,
auth: HTTPBasicAuth = None) -> Tuple[Dict[str, Any], float]:
"""Sends a request to this endpoint. Repeats if timeout error occured. Adust the pagesize on timeout.
Arguments:
url {str} -- URL to be queried. Must contain the server-uri and Endpoint. Does not allow encoded parameters
post_data {str} -- additional data with filters/parameters. Only to be send with a POST-Request (default: {None})
auth {HTTPBasicAuth} -- Basic auth to be used to login into SPP via POST-Request(default: {None})
type {RequestType} -- What kind of Request should be made, defaults to GET
Raises:
ValueError: No URL specified
ValueError: Error when requesting endpoint
ValueError: Wrong status code
ValueError: failed to parse result
ValueError: Timeout when sending result
ValueError: No post-data/auth is allowed in a GET-Request
Returns:
Tuple[Dict[str, Any], float] -- Result of the request with the required send time
"""
if(not url):
raise ValueError("no url specified")
if((post_data or auth) and request_type == RequestType.GET):
raise ValueError("No post-data/auth is allowed in a GET-Request")
LOGGER.debug(f"query url: {url}, type: {type}, post_data: {post_data} auth: {True if auth else False}")
if(not params):
params = {}
failed_tries: int = 0
response_query: Optional[Response] = None
send_time: float = -1 # prevent unbound var
# avoid unset pageSize to not get into SPP defaults
if("pageSize" not in params):
LOGGER.debug(f"setting pageSize to {self.__page_size} from unset value")
params["pageSize"] = self.__page_size
elif(params["pageSize"] is None):
params.pop("pageSize")
while(response_query is None):
# send the query
try:
if(request_type == RequestType.GET):
response_query = get(
url=url, headers=self.__headers, verify=False,
params=params,
timeout=(self.__initial_connection_timeout, self.__timeout))
elif(request_type == RequestType.POST):
response_query = post(
url=url, headers=self.__headers, verify=False,
params=params, json=post_data, auth=auth,
timeout=(self.__initial_connection_timeout, self.__timeout))
send_time = response_query.elapsed.total_seconds()
except ReadTimeout as timeout_error:
# timeout occured, increasing failed trys
failed_tries += 1
url_params = ConnectionUtils.get_url_params(url)
# #### Aborting cases ######
if(failed_tries > self.__max_send_retries):
ExceptionUtils.exception_info(error=timeout_error)
# read start index for debugging
start_index = url_params.get("pageStartIndex", None)
page_size = url_params.get("pageSize", None)
# report timeout with full information
raise ValueError("timeout after repeating a maximum ammount of times.",
timeout_error, failed_tries, page_size, start_index)
if(self.__page_size == self.__min_page_size):
ExceptionUtils.exception_info(error=timeout_error)
# read start index for debugging
start_index = url_params.get("pageStartIndex", None)
page_size = url_params.get("pageSize", None)
# report timeout with full information
raise ValueError("timeout after using minumum pagesize. repeating the request is of no use.",
timeout_error, failed_tries, page_size, start_index)
# #### continuing cases ######
if(failed_tries == self.__max_send_retries): # last try
LOGGER.debug(f"Timeout error when requesting, now last try of total {self.__max_send_retries}. Reducing pagesize to minimum for url: {url}")
if(self.__verbose):
LOGGER.info(f"Timeout error when requesting, now last try of total {self.__max_send_retries}. Reducing pagesize to minimum for url: {url}")
# persist reduced size for further requests
self.__page_size = self.__min_page_size
# repeat with minimal possible size
LOGGER.debug(f"setting pageSize from {params.get('pageSize', None)} to {self.__page_size}")
params["pageSize"] = self.__page_size
else: # (failed_tries < self.__max_send_retries): # more then 1 try left
LOGGER.debug(f"Timeout error when requesting, now on try {failed_tries} of {self.__max_send_retries}. Reducing pagesizefor url: {url}")
if(self.__verbose):
LOGGER.info(f"Timeout error when requesting, now on try {failed_tries} of {self.__max_send_retries}. Reducing pagesize for url: {url}")
# persist reduced size for further requests
self.__page_size = ConnectionUtils.adjust_page_size(
page_size=params["pageSize"],
min_page_size=self.__min_page_size,
timeout=True)
# repeat with reduced page size
LOGGER.debug(f"setting pageSize from {params.get('pageSize', None)} to {self.__page_size}")
params["pageSize"] = self.__page_size
except RequestException as error:
ExceptionUtils.exception_info(error=error)
raise ValueError("error when requesting endpoint", error)
if( not response_query.ok):
raise ConnectionUtils.rest_response_error( response_query,
"Wrong Status code when requesting endpoint data",
url)
try:
response_json: Dict[str, Any] = response_query.json()
except (json.decoder.JSONDecodeError, ValueError) as error:
raise ValueError("failed to parse query in restAPI request", response_query)
return (response_json, send_time)