-
This commit is contained in:
@@ -0,0 +1,81 @@
|
||||
# coding: utf-8
|
||||
#
|
||||
# Copyright (C) 2020, Team Kodi
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
"""Functions to interact with various web site APIs"""
|
||||
|
||||
from __future__ import absolute_import, unicode_literals
|
||||
|
||||
import json
|
||||
from urllib.request import Request, urlopen
|
||||
from urllib.error import URLError
|
||||
from urllib.parse import urlencode
|
||||
from pprint import pformat
|
||||
from .utils import logger
|
||||
try:
|
||||
from typing import Text, Optional, Union, List, Dict, Any # pylint: disable=unused-import
|
||||
InfoType = Dict[Text, Any] # pylint: disable=invalid-name
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
HEADERS = {}
|
||||
|
||||
|
||||
def set_headers(headers):
|
||||
# type: (Dict) -> None
|
||||
HEADERS.update(headers)
|
||||
|
||||
|
||||
def load_info(url, params=None, default=None, resp_type='json', verboselog=False):
|
||||
# type: (Text, Dict, Text, Text, bool) -> Optional[Text]
|
||||
"""
|
||||
Load info from external api
|
||||
|
||||
:param url: API endpoint URL
|
||||
:param params: URL query params
|
||||
:default: object to return if there is an error
|
||||
:resp_type: what to return to the calling function
|
||||
:return: API response or default on error
|
||||
"""
|
||||
if params:
|
||||
url = url + '?' + urlencode(params)
|
||||
logger.debug('Calling URL "{}"'.format(url))
|
||||
if HEADERS:
|
||||
logger.debug(str(HEADERS))
|
||||
req = Request(url, headers=HEADERS)
|
||||
try:
|
||||
response = urlopen(req)
|
||||
except URLError as e:
|
||||
if hasattr(e, 'reason'):
|
||||
logger.debug(
|
||||
'failed to reach the remote site\nReason: {}'.format(e.reason))
|
||||
elif hasattr(e, 'code'):
|
||||
logger.debug(
|
||||
'remote site unable to fulfill the request\nError code: {}'.format(e.code))
|
||||
response = None
|
||||
if response is None:
|
||||
resp = default
|
||||
elif resp_type.lower() == 'json':
|
||||
try:
|
||||
resp = json.loads(response.read().decode('utf-8'))
|
||||
except json.decoder.JSONDecodeError:
|
||||
logger.debug('remote site sent back bad JSON')
|
||||
resp = default
|
||||
else:
|
||||
resp = response.read().decode('utf-8')
|
||||
if verboselog:
|
||||
logger.debug('the api response:\n{}'.format(pformat(resp)))
|
||||
return resp
|
||||
Reference in New Issue
Block a user