Skip to content

Commit

Permalink
docs: docstring update
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrunato committed Jul 28, 2023
1 parent a2e42df commit 96a590d
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions eodag/plugins/download/http.py
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,29 @@ def _stream_download_dict(
timeout=DEFAULT_DOWNLOAD_TIMEOUT,
**kwargs,
):
r"""
Returns dictionnary of :class:`~fastapi.responses.StreamingResponse` keyword-arguments.
It contains a generator to streamed download chunks and the response headers.
:param product: The EO product to download
:type product: :class:`~eodag.api.product._product.EOProduct`
:param auth: (optional) The configuration of a plugin of type Authentication
:type auth: :class:`~eodag.config.PluginConfig`
:param progress_callback: (optional) A progress callback
:type progress_callback: :class:`~eodag.utils.ProgressCallback`
:param wait: (optional) If download fails, wait time in minutes between two download tries
:type wait: int
:param timeout: (optional) If download fails, maximum time in minutes before stop retrying
to download
:type timeout: int
:param kwargs: `outputs_prefix` (str), `extract` (bool), `delete_archive` (bool)
and `dl_url_params` (dict) can be provided as additional kwargs
and will override any other values defined in a configuration
file or with environment variables.
:type kwargs: Union[str, bool, dict]
:returns: Dictionnary of :class:`~fastapi.responses.StreamingResponse` keyword-arguments
:rtype: dict
"""
# download assets if exist instead of remote_location
if hasattr(product, "assets") and not getattr(
self.config, "ignore_assets", False
Expand Down

0 comments on commit 96a590d

Please sign in to comment.