Source code for sentinelhub.download.sentinelhub_client

"""
Module implementing a rate-limited multi-threaded download client for downloading from Sentinel Hub service
"""
import logging
import warnings
import time
from threading import Lock

import requests

from .handlers import fail_user_errors, retry_temporary_errors
from .client import DownloadClient
from ..sentinelhub_session import SentinelHubSession
from ..sentinelhub_rate_limit import SentinelHubRateLimit
from ..exceptions import SHRateLimitWarning


LOGGER = logging.getLogger(__name__)


[docs]class SentinelHubDownloadClient(DownloadClient): """ Download client specifically configured for download from Sentinel Hub service """ _CACHED_SESSIONS = {} def __init__(self, *, session=None, **kwargs): """ :param session: An OAuth2 session with Sentinel Hub service :type session: SentinelHubSession or None :param kwargs: Optional parameters from DownloadClient """ super().__init__(**kwargs) if session is not None and not isinstance(session, SentinelHubSession): raise ValueError(f'A session parameter has to be an instance of {SentinelHubSession.__name__} or None, but ' f'{session} was given') self.session = session self.rate_limit = SentinelHubRateLimit(num_processes=self.config.number_of_download_processes) self.lock = None
[docs] def download(self, *args, **kwargs): """ The main download method :param args: Passed to DownloadClient.download :param kwargs: Passed to DownloadClient.download """ # Because the Lock object cannot be pickled we create it only here and remove it afterward self.lock = Lock() try: return super().download(*args, **kwargs) finally: self.lock = None
@retry_temporary_errors @fail_user_errors def _execute_download(self, request): """ Executes the download with a single thread and uses a rate limit object, which is shared between all threads """ while True: sleep_time = self._execute_thread_safe(self.rate_limit.register_next) if sleep_time == 0: LOGGER.debug('Sending %s request to %s. Hash of sent request is %s', request.request_type.value, request.url, request.get_hashed_name()) response = self._do_download(request) self._execute_thread_safe(self.rate_limit.update, response.headers) if response.status_code == requests.status_codes.codes.TOO_MANY_REQUESTS: warnings.warn('Download rate limit hit', category=SHRateLimitWarning) continue response.raise_for_status() LOGGER.debug('Successful %s request to %s', request.request_type.value, request.url) return response.content LOGGER.debug('Request needs to wait. Sleeping for %0.2f', sleep_time) time.sleep(sleep_time) def _execute_thread_safe(self, thread_unsafe_function, *args, **kwargs): """ Executes a function inside a thread lock and handles potential errors """ if self.lock is None: return thread_unsafe_function(*args, **kwargs) with self.lock: return thread_unsafe_function(*args, **kwargs) def _do_download(self, request): """ Runs the download """ return requests.request( request.request_type.value, url=request.url, json=request.post_values, headers=self._prepare_headers(request), timeout=self.config.download_timeout_seconds ) def _prepare_headers(self, request): """ Prepares final headers by potentially joining them with session headers """ if not request.use_session: return request.headers session_headers = self._execute_thread_safe(self._get_session_headers) return { **session_headers, **request.headers } def _get_session_headers(self): """ Provides up-to-date session headers Note that calling session_headers property triggers update if session has expired therefore this has to be called in a thread-safe way """ return self.get_session().session_headers
[docs] def get_session(self): """ Provides the session object used by the client :return: A Sentinel Hub session object :rtype: SentinelHubSession """ if self.session: return self.session cache_key = self.config.sh_client_id, self.config.sh_client_secret, self.config.get_sh_oauth_url() if cache_key in SentinelHubDownloadClient._CACHED_SESSIONS: session = SentinelHubDownloadClient._CACHED_SESSIONS[cache_key] else: session = SentinelHubSession(config=self.config) SentinelHubDownloadClient._CACHED_SESSIONS[cache_key] = session self.session = session return session