eodag 3.0.0b1__py3-none-any.whl → 3.0.0b3__py3-none-any.whl

eodag/resources/user_conf_template.yml

@@ -20,7 +20,7 @@ peps:
     search:  # Search parameters configuration
     download:
         extract:  # whether to extract the downloaded products, only applies to archived products (true or false, Default: true).
-        outputs_prefix: # where to store downloaded products, as an absolute file path (Default: local temporary directory)
+        output_dir: # where to store downloaded products, as an absolute file path (Default: local temporary directory)
         dl_url_params:  # additional parameters to pass over to the download url as an url parameter
         delete_archive: # whether to delete the downloaded archives (true or false, Default: true).
     auth:
@@ -32,7 +32,7 @@ theia:
     search:   # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
         dl_url_params:
     auth:
         credentials:
@@ -42,7 +42,7 @@ usgs:
     priority: # Lower value means lower priority (Default: 0)
     api:
         extract:
-        outputs_prefix:
+        output_dir:
         dl_url_params:
         product_location_scheme:
         credentials:
@@ -58,13 +58,13 @@ aws_eos:
             aws_secret_access_key:
             aws_profile:
     download:
-        outputs_prefix:
+        output_dir:
 creodias:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
@@ -75,7 +75,7 @@ onda:
     search:   # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
@@ -89,7 +89,7 @@ astraea_eod:
             aws_secret_access_key:
             aws_profile:
     download:
-        outputs_prefix:
+        output_dir:
 usgs_satapi_aws:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
@@ -99,7 +99,7 @@ usgs_satapi_aws:
             aws_secret_access_key:
             aws_profile:
     download:
-        outputs_prefix:
+        output_dir:
 earth_search:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
@@ -109,12 +109,12 @@ earth_search:
             aws_secret_access_key:
             aws_profile:
     download:
-        outputs_prefix:
+        output_dir:
 earth_search_cog:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
     download:
-        outputs_prefix:
+        output_dir:
 earth_search_gcs:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
@@ -123,11 +123,11 @@ earth_search_gcs:
             aws_access_key_id:
             aws_secret_access_key:
     download:
-        outputs_prefix:
+        output_dir:
 ecmwf:
     priority: # Lower value means lower priority (Default: 0)
     api:
-        outputs_prefix:
+        output_dir:
         credentials:
             username:
             password:
@@ -136,7 +136,7 @@ cop_ads:
     search:   # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
@@ -146,7 +146,7 @@ cop_cds:
     search:   # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
@@ -156,7 +156,7 @@ sara:
     search:  # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
         delete_archive:
     auth:
         credentials:
@@ -169,13 +169,13 @@ meteoblue:
         credentials:
             apikey:
     download:
-        outputs_prefix:
+        output_dir:
 cop_dataspace:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
@@ -187,7 +187,7 @@ planetary_computer:
         credentials:
             apikey:
     download:
-        outputs_prefix:
+        output_dir:
 hydroweb_next:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
@@ -195,12 +195,12 @@ hydroweb_next:
         credentials:
             apikey:
     download:
-        outputs_prefix:
+        output_dir:
 wekeo:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
     download:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
@@ -209,7 +209,7 @@ wekeo_cmems:
     priority: # Lower value means lower priority (Default: 0)
     search:
     download:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
@@ -218,7 +218,7 @@ creodias_s3:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
     download:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
           aws_access_key_id:
@@ -227,7 +227,7 @@ dedt_lumi:
     priority: # Lower value means lower priority (Default: 0)
     search:
     download:
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
@@ -236,7 +236,7 @@ dedl:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
     download:
-        outputs_prefix:
+        output_dir:
     auth:
       credentials:
         username:
@@ -244,16 +244,16 @@ dedl:
 eumetsat_ds:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
-        outputs_prefix:
+        output_dir:
     auth:
         credentials:
             username:
             password:
     download:
-        outputs_prefix:
+        output_dir:
 cop_marine:
     priority: # Lower value means lower priority (Default: 0)
     search:   # Search parameters configuration
     download:
         extract:
-        outputs_prefix:
+        output_dir:

eodag/rest/core.py

@@ -80,7 +80,7 @@ from eodag.utils.exceptions import (
 )
 
 if TYPE_CHECKING:
-    from typing import Any, Callable, Dict, List, Optional, Tuple, Union
+    from typing import Any, Dict, List, Optional, Tuple, Union
 
     from fastapi import Request
     from requests.auth import AuthBase
@@ -105,9 +105,7 @@ def get_home_page_content(base_url: str, ipp: Optional[int] = None) -> str:
     """Compute eodag service home page content
 
     :param base_url: The service root URL
-    :type base_url: str
     :param ipp: (optional) Items per page number
-    :type ipp: int
     """
     base_url = base_url.rstrip("/") + "/"
     content = f"""<h1>EODAG Server</h1><br />
@@ -125,7 +123,6 @@ def format_product_types(product_types: List[Dict[str, Any]]) -> str:
     """Format product_types
 
     :param product_types: A list of EODAG product types as returned by the core api
-    :type product_types: list
     """
     result: List[str] = []
     for pt in product_types:
@@ -145,13 +142,9 @@ def search_stac_items(
     dictionary of STAC items.
 
     :param request: The incoming HTTP request with state information.
-    :type request: Request
     :param search_request: The search criteria for STAC items.
-    :type search_request: SearchPostRequest
     :param catalogs: (optional) A list of catalogs to search within. Defaults to None.
-    :type catalogs: Optional[List[str]]
     :returns: A dictionary containing the STAC items and related metadata.
-    :rtype: Dict[str, Any]
 
     The function handles the conversion of search criteria into STAC and EODAG compatible formats, validates the input
     using pydantic, and constructs the appropriate URLs for querying the STAC API. It also manages pagination and the
@@ -215,7 +208,7 @@ def search_stac_items(
         }
 
         search_results = eodag_api.search(count=True, **criteria)
-        total = search_results.number_matched
+        total = search_results.number_matched or 0
         if search_request.crunch:
             search_results = crunch_products(
                 search_results, search_request.crunch, **criteria
@@ -259,15 +252,10 @@ def download_stac_item(
     """Download item
 
     :param catalogs: Catalogs list (only first is used as product_type)
-    :type catalogs: list
     :param item_id: Product ID
-    :type item_id: str
     :param provider: (optional) Chosen provider
-    :type provider: str
     :param kwargs: additional download parameters
-    :type kwargs: Any
     :returns: a stream of the downloaded data (zip file)
-    :rtype: Response
     """
     product_type = catalogs[0]
 
@@ -350,11 +338,13 @@ def _order_and_update(
     if (
         product.properties.get("storageStatus") != ONLINE_STATUS
         and NOT_AVAILABLE in product.properties.get("orderStatusLink", "")
-        and hasattr(product.downloader, "orderDownload")
+        and hasattr(product.downloader, "order_download")
     ):
         # first order
         logger.debug("Order product")
-        order_status_dict = product.downloader.orderDownload(product=product, auth=auth)
+        order_status_dict = product.downloader.order_download(
+            product=product, auth=auth
+        )
         query_args.update(order_status_dict or {})
 
     if (
@@ -365,11 +355,11 @@ def _order_and_update(
         product.properties["storageStatus"] = STAGING_STATUS
 
     if product.properties.get("storageStatus") == STAGING_STATUS and hasattr(
-        product.downloader, "orderDownloadStatus"
+        product.downloader, "order_download_status"
     ):
         # check order status if needed
         logger.debug("Checking product order status")
-        product.downloader.orderDownloadStatus(product=product, auth=auth)
+        product.downloader.order_download_status(product=product, auth=auth)
 
     if product.properties.get("storageStatus") != ONLINE_STATUS:
         raise NotAvailableError("Product is not available yet")
@@ -381,7 +371,6 @@ def get_detailled_collections_list() -> List[Dict[str, Any]]:
     config dicts
 
     :returns: List of config dicts
-    :rtype: list
     """
     return eodag_api.list_product_types(fetch_providers=False)
 
@@ -398,15 +387,10 @@ async def all_collections(
     """Build STAC collections
 
     :param url: Requested URL
-    :type url: str
     :param root: The API root
-    :type root: str
     :param filters: Search collections filters
-    :type filters: CollectionsSearchRequest
     :param provider: (optional) Chosen provider
-    :type provider: str
     :returns: Collections dictionnary
-    :rtype: dict
     """
 
     async def _fetch() -> Dict[str, Any]:
@@ -450,15 +434,10 @@ async def get_collection(
     """Build STAC collection by id
 
     :param url: Requested URL
-    :type url: str
     :param root: API root
-    :type root: str
     :param collection_id: Product_type as ID of the collection
-    :type collection_id: str
     :param provider: (optional) Chosen provider
-    :type provider: str
     :returns: Collection dictionary
-    :rtype: dict
     """
 
     async def _fetch() -> Dict[str, Any]:
@@ -489,15 +468,10 @@ async def get_stac_catalogs(
     """Build STAC catalog
 
     :param url: Requested URL
-    :type url: str
     :param root: (optional) API root
-    :type root: str
     :param catalogs: (optional) Catalogs list
-    :type catalogs: list
     :param provider: (optional) Chosen provider
-    :type provider: str
     :returns: Catalog dictionary
-    :rtype: dict
     """
 
     async def _fetch() -> Dict[str, Any]:
@@ -564,7 +538,6 @@ def get_stac_conformance() -> Dict[str, str]:
     """Build STAC conformance
 
     :returns: conformance dictionnary
-    :rtype: dict
     """
     return stac_config["conformance"]
 
@@ -573,7 +546,6 @@ def get_stac_api_version() -> str:
     """Get STAC API version
 
     :returns: STAC API version
-    :rtype: str
     """
     return stac_config["stac_api_version"]
 
@@ -583,14 +555,12 @@ def get_stac_extension_oseo(url: str) -> Dict[str, str]:
     """Build STAC OGC / OpenSearch Extension for EO
 
     :param url: Requested URL
-    :type url: str
     :returns: Catalog dictionnary
-    :rtype: dict
     """
 
-    apply_method: Callable[[str, str], str] = lambda _, x: str(x).replace(
-        "$.product.", "$."
-    )
+    def apply_method(_: str, x: str) -> str:
+        return str(x).replace("$.product.", "$.")
+
     item_mapping = dict_items_recursive_apply(stac_config["item"], apply_method)
 
     # all properties as string type by default
@@ -616,9 +586,7 @@ async def get_queryables(
     """Fetch the queryable properties for a collection.
 
     :param collection_id: The ID of the collection.
-    :type collection_id: str
     :returns: A set containing the STAC standardized queryable properties for a collection.
-    :rtype Dict[str, StacQueryableProperty]: set
     """
 
     async def _fetch() -> Dict[str, Any]:

eodag/rest/server.py

@@ -223,7 +223,7 @@ async def forward_middleware(
 
 @app.exception_handler(StarletteHTTPException)
 async def default_exception_handler(
-    request: Request, error: Exception
+    request: Request, error: HTTPException
 ) -> ORJSONResponse:
     """Default errors handle"""
     description = (
@@ -519,11 +519,8 @@ async def list_collection_queryables(
     that can be filtered using comparison operators.
 
     :param request: The incoming request object.
-    :type request: fastapi.Request
     :param collection_id: The identifier of the collection for which to retrieve queryable properties.
-    :type collection_id: str
     :returns: A json object containing the list of available queryable properties for the specified collection.
-    :rtype: Any
     """
     logger.debug(f"URL: {request.url}")
     additional_params = dict(request.query_params)
@@ -757,9 +754,7 @@ async def list_queryables(request: Request) -> ORJSONResponse:
     operators.
 
     :param request: The incoming request object.
-    :type request: fastapi.Request
     :returns: A json object containing the list of available queryable terms.
-    :rtype: Any
     """
     logger.debug(f"URL: {request.url}")
     additional_params = dict(request.query_params.items())