Congegni
/
libretime
mirror of https://github.com/libretime/libretime.git
7
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

refactorapi-client): fix linting errors

This commit is contained in:
jo 2022-08-09 17:16:48 +02:00 committed by Kyle Robbertze
parent 313898137c
commit 5782e10250
3 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
api-client/libretime_api_client/_utils.py
View File

@ -16,6 +16,7 @@ class UrlException(Exception):
class IncompleteUrl(UrlException): class IncompleteUrl(UrlException):
def __init__(self, url): def __init__(self, url):
super().__init__()
self.url = url self.url = url
def __str__(self): def __str__(self):
@ -24,6 +25,7 @@ class IncompleteUrl(UrlException):
class UrlBadParam(UrlException): class UrlBadParam(UrlException):
def __init__(self, url, param): def __init__(self, url, param):
super().__init__()
self.url = url self.url = url
self.param = param self.param = param
@ -31,6 +33,7 @@ class UrlBadParam(UrlException):
return f"Bad param '{self.param}' passed into url: '{self.url}'" return f"Bad param '{self.param}' passed into url: '{self.url}'"
# pylint: disable=too-few-public-methods
class KeyAuth(AuthBase): class KeyAuth(AuthBase):
def __init__(self, key): def __init__(self, key):
self.key = key self.key = key
@ -49,9 +52,9 @@ class ApcUrl:
def params(self, **params): def params(self, **params):
temp_url = self.base_url temp_url = self.base_url
for k, v in params.items(): for k in params:
wrapped_param = "{" + k + "}" wrapped_param = "{" + k + "}"
if not wrapped_param in temp_url: if wrapped_param not in temp_url:
raise UrlBadParam(self.base_url, k) raise UrlBadParam(self.base_url, k)
temp_url = temp_url.format_map(UrlParamDict(**params)) temp_url = temp_url.format_map(UrlParamDict(**params))
return ApcUrl(temp_url) return ApcUrl(temp_url)
@ -59,8 +62,7 @@ class ApcUrl:
def url(self): def url(self):
if "{" in self.base_url: if "{" in self.base_url:
raise IncompleteUrl(self.base_url) raise IncompleteUrl(self.base_url)
else: return self.base_url
return self.base_url
class ApiRequest: class ApiRequest:
@ -123,13 +125,13 @@ class ApiRequest:
self.__req = lambda: self(*args, **kwargs) self.__req = lambda: self(*args, **kwargs)
return self return self
def retry(self, n, delay=5): def retry(self, count, delay=5):
"""Try to send request n times. If after n times it fails then """Try to send request n times. If after n times it fails then
we finally raise exception""" we finally raise exception"""
for i in range(0, n - 1): for _ in range(0, count - 1):
try: try:
return self.__req() return self.__req()
except Exception: except requests.exceptions.RequestException:
sleep(delay) sleep(delay)
return self.__req() return self.__req()
@ -161,5 +163,5 @@ class RequestProvider:
def __getattr__(self, attr): def __getattr__(self, attr):
if attr in self: if attr in self:
return self.requests[attr] return self.requests[attr]
else:
return super().__getattribute__(attr) return super().__getattribute__(attr)

42
api-client/libretime_api_client/v1.py
View File

@ -93,26 +93,26 @@ class ApiClient:
return -1 return -1
def is_server_compatible(self, verbose=True): def is_server_compatible(self, verbose=True):
logger = self.logger
api_version = self.__get_api_version() api_version = self.__get_api_version()
if api_version == -1: if api_version == -1:
if verbose: if verbose:
logger.info("Unable to get Airtime API version number.\n") self.logger.info("Unable to get Airtime API version number.\n")
return False return False
elif api_version[0:3] != AIRTIME_API_VERSION[0:3]:
if api_version[0:3] != AIRTIME_API_VERSION[0:3]:
if verbose: if verbose:
logger.info("Airtime API version found: " + str(api_version)) self.logger.info("Airtime API version found: " + str(api_version))
logger.info( self.logger.info(
"pypo is only compatible with API version: " + AIRTIME_API_VERSION "pypo is only compatible with API version: " + AIRTIME_API_VERSION
) )
return False return False
else:
if verbose: if verbose:
logger.info("Airtime API version found: " + str(api_version)) self.logger.info("Airtime API version found: " + str(api_version))
logger.info( self.logger.info(
"pypo is only compatible with API version: " + AIRTIME_API_VERSION "pypo is only compatible with API version: " + AIRTIME_API_VERSION
) )
return True return True
def notify_liquidsoap_started(self): def notify_liquidsoap_started(self):
try: try:
@ -140,7 +140,6 @@ class ApiClient:
return None return None
def upload_recorded_show(self, files, show_id): def upload_recorded_show(self, files, show_id):
logger = self.logger
response = "" response = ""
retries = self.UPLOAD_RETRIES retries = self.UPLOAD_RETRIES
@ -148,19 +147,19 @@ class ApiClient:
url = self.construct_rest_url("upload_file_url") url = self.construct_rest_url("upload_file_url")
logger.debug(url) self.logger.debug(url)
for i in range(0, retries): for i in range(0, retries):
logger.debug("Upload attempt: %s", i + 1) self.logger.debug("Upload attempt: %s", i + 1)
logger.debug(files) self.logger.debug(files)
logger.debug(ApiRequest.API_HTTP_REQUEST_TIMEOUT) self.logger.debug(ApiRequest.API_HTTP_REQUEST_TIMEOUT)
try: try:
request = requests.post( request = requests.post(
url, files=files, timeout=float(ApiRequest.API_HTTP_REQUEST_TIMEOUT) url, files=files, timeout=float(ApiRequest.API_HTTP_REQUEST_TIMEOUT)
) )
response = request.json() response = request.json()
logger.debug(response) self.logger.debug(response)
# FIXME: We need to tell LibreTime that the uploaded track was recorded # FIXME: We need to tell LibreTime that the uploaded track was recorded
# for a specific show # for a specific show
@ -184,11 +183,11 @@ class ApiClient:
break break
except requests.exceptions.HTTPError as exception: except requests.exceptions.HTTPError as exception:
logger.error(f"Http error code: {exception.response.status_code}") self.logger.error(f"Http error code: {exception.response.status_code}")
logger.exception(exception) self.logger.exception(exception)
except requests.exceptions.ConnectionError as exception: except requests.exceptions.ConnectionError as exception:
logger.exception(f"Server is down: {exception}") self.logger.exception(f"Server is down: {exception}")
except Exception as exception: except Exception as exception:
self.logger.exception(exception) self.logger.exception(exception)
@ -229,7 +228,6 @@ class ApiClient:
return self.services.register_component(component=component) return self.services.register_component(component=component)
def notify_liquidsoap_status(self, msg, stream_id, time): def notify_liquidsoap_status(self, msg, stream_id, time):
logger = self.logger
try: try:
# encoded_msg is no longer used server_side!! # encoded_msg is no longer used server_side!!
encoded_msg = urllib.parse.quote("dummy") encoded_msg = urllib.parse.quote("dummy")

4
api-client/tests/utils_test.py
View File

@ -42,8 +42,8 @@ def test_apc_url_incomplete():
def test_api_request_init(): def test_api_request_init():
u = ApiRequest("request_name", ApcUrl("/test/ing")) req = ApiRequest("request_name", ApcUrl("/test/ing"))
assert u.name == "request_name" assert req.name == "request_name"
def test_api_request_call_json(): def test_api_request_call_json():