eodag 4.0.0a3__py3-none-any.whl → 4.0.0a5__py3-none-any.whl

eodag/api/product/_product.py

@@ -22,6 +22,7 @@ import logging
 import os
 import re
 import tempfile
+from datetime import datetime
 from typing import TYPE_CHECKING, Any, Optional, Union
 
 import requests
@@ -60,6 +61,7 @@ from eodag.utils.exceptions import DownloadError, MisconfiguredError, Validation
 from eodag.utils.repr import dict_to_html_table
 
 if TYPE_CHECKING:
+    from concurrent.futures import ThreadPoolExecutor
     from shapely.geometry.base import BaseGeometry
 
     from eodag.api.product.drivers.base import DatasetDriver
@@ -119,6 +121,10 @@ class EOProduct:
     filename: str
     #: Product search keyword arguments, stored during search
     search_kwargs: Any
+    #: Datetime for download next try
+    next_try: datetime
+    #: Stream for requests
+    _stream: requests.Response
 
     def __init__(
         self, provider: str, properties: dict[str, Any], **kwargs: Any
@@ -334,6 +340,7 @@ class EOProduct:
     def download(
         self,
         progress_callback: Optional[ProgressCallback] = None,
+        executor: Optional[ThreadPoolExecutor] = None,
         wait: float = DEFAULT_DOWNLOAD_WAIT,
         timeout: float = DEFAULT_DOWNLOAD_TIMEOUT,
         **kwargs: Unpack[DownloadConf],
@@ -350,6 +357,8 @@ class EOProduct:
                                   size as inputs and handle progress bar
                                   creation and update to give the user a
                                   feedback on the download progress
+        :param executor: (optional) An executor to download assets of the product in parallel if it has any. If ``None``
+                         , a default executor will be created
         :param wait: (optional) If download fails, wait time in minutes between
                      two download tries
         :param timeout: (optional) If download fails, maximum time in minutes
@@ -374,17 +383,26 @@ class EOProduct:
         )
 
         progress_callback, close_progress_callback = self._init_progress_bar(
-            progress_callback
+            progress_callback, executor
         )
+
         fs_path = self.downloader.download(
             self,
             auth=auth,
             progress_callback=progress_callback,
+            executor=executor,
             wait=wait,
             timeout=timeout,
             **kwargs,
         )
 
+        # shutdown executor if it was not created during parallel product downloads
+        if (
+            executor is not None
+            and executor._thread_name_prefix != "eodag-download-all"
+        ):
+            executor.shutdown(wait=True)
+
         # close progress bar if needed
         if close_progress_callback:
             progress_callback.close()
@@ -405,15 +423,22 @@ class EOProduct:
         return fs_path
 
     def _init_progress_bar(
-        self, progress_callback: Optional[ProgressCallback]
+        self,
+        progress_callback: Optional[ProgressCallback],
+        executor: Optional[ThreadPoolExecutor],
     ) -> tuple[ProgressCallback, bool]:
+        # determine position of the progress bar with a counter of executor passings
+        # to avoid bar overwriting in case of parallel downloads
+        count = executor._counter() if executor is not None else 1  # type: ignore
+
         # progress bar init
         if progress_callback is None:
-            progress_callback = ProgressCallback(position=1)
+            progress_callback = ProgressCallback(position=count)
             # one shot progress callback to close after download
             close_progress_callback = True
         else:
             close_progress_callback = False
+            progress_callback.pos = count
             # update units as bar may have been previously used for extraction
             progress_callback.unit = "B"
             progress_callback.unit_scale = True
@@ -428,7 +453,6 @@ class EOProduct:
         ssl_verify: Optional[bool] = None,
         auth: Optional[AuthBase] = None,
     ):
-
         """Download the quicklook image from the EOProduct's quicklook URL.
 
         This method performs an HTTP GET request to retrieve the quicklook image and saves it
@@ -528,7 +552,6 @@ class EOProduct:
         )
 
         if not os.path.isfile(quicklook_file):
-
             # progress bar init
             if progress_callback is None:
                 progress_callback = ProgressCallback()
@@ -571,7 +594,6 @@ class EOProduct:
                     quicklook_file, progress_callback, ssl_verify, auth
                 )
             except RequestException as e:
-
                 logger.debug(
                     f"Error while getting resource with authentication. {e} \nTrying without authentication..."
                 )