eodag 3.0.1__py3-none-any.whl → 3.1.0__py3-none-any.whl

eodag/resources/stac_api.yml

@@ -799,7 +799,7 @@ components:
         description: |
           Sentinel-2 is a wide-swath, high-resolution, multi-spectral
           imaging mission...
-        license: proprietary
+        license: other
         keywords:
           - copernicus
           - esa
@@ -1416,7 +1416,7 @@ components:
       description: |-
         License(s) of the data as a SPDX
         [License identifier](https://spdx.org/licenses/). Alternatively, use
-        `proprietary` if the license is not on the SPDX license list or
+        `other` if the license is not on the SPDX license list or
         `various` if multiple licenses apply. In these two cases links to the
         license texts SHOULD be added, see the `license` link relation type.
 

eodag/resources/user_conf_template.yml

@@ -157,15 +157,18 @@ geodes:
     download:
         extract:
         output_dir:
-hydroweb_next:
+geodes_s3:
     priority: # Lower value means lower priority (Default: 0)
     search: # Search parameters configuration
     auth:
         credentials:
-            apikey:
+            aws_access_key_id:
+            aws_secret_access_key:
+            aws_session_token:
     download:
+        extract:
         output_dir:
-meteoblue:
+hydroweb_next:
     priority: # Lower value means lower priority (Default: 0)
     search: # Search parameters configuration
     auth:
@@ -173,16 +176,14 @@ meteoblue:
             apikey:
     download:
         output_dir:
-onda:
+meteoblue:
     priority: # Lower value means lower priority (Default: 0)
     search: # Search parameters configuration
-    download:
-        extract:
-        output_dir:
     auth:
         credentials:
-            username:
-            password:
+            apikey:
+    download:
+        output_dir:
 peps:
     priority: # Lower value means lower priority (Default: 1)
     search: # Search parameters configuration

eodag/rest/cache.py

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import logging
-from typing import Any, Callable, Coroutine, Dict, TypeVar, cast
+from typing import Any, Callable, Coroutine, TypeVar, cast
 
 import orjson
 from cachetools import LRUCache
@@ -48,7 +48,7 @@ async def cached(
     host_cache_key = f"{cache_key}:{host}"
 
     try:
-        c: Dict[str, Any] = request.app.state.cache
+        c: dict[str, Any] = request.app.state.cache
 
         if cached := c.get(host_cache_key):
             logger.debug("Cache result hit")

eodag/rest/config.py

@@ -18,7 +18,7 @@
 from __future__ import annotations
 
 from functools import lru_cache
-from typing import Annotated, List, Union
+from typing import Annotated, Union
 
 from pydantic import Field
 from pydantic.functional_validators import BeforeValidator
@@ -28,7 +28,7 @@ from typing_extensions import Doc
 from eodag.rest.constants import DEFAULT_MAXSIZE, DEFAULT_TTL
 
 
-def str2liststr(raw: Union[str, List[str]]) -> List[str]:
+def str2liststr(raw: Union[str, list[str]]) -> list[str]:
     """Convert str to list[str]"""
     if isinstance(raw, list):
         return raw
@@ -49,7 +49,7 @@ class Settings(BaseSettings):
     stac_api_landing_id: str = "eodag-stac-api"
 
     origin_url_blacklist: Annotated[
-        Union[str, List[str]],
+        Union[str, list[str]],
         BeforeValidator(str2liststr),
         Doc(
             "Hide from clients items assets' alternative URLs starting with URLs from the list"

eodag/rest/core.py

@@ -33,7 +33,6 @@ from requests.models import Response as RequestsResponse
 import eodag
 from eodag import EOProduct
 from eodag.api.product.metadata_mapping import (
-    DEFAULT_METADATA_MAPPING,
     NOT_AVAILABLE,
     OFFLINE_STATUS,
     ONLINE_STATUS,
@@ -54,11 +53,7 @@ from eodag.rest.constants import (
 from eodag.rest.errors import ResponseSearchError
 from eodag.rest.stac import StacCatalog, StacCollection, StacCommon, StacItem
 from eodag.rest.types.eodag_search import EODAGSearch
-from eodag.rest.types.queryables import (
-    QueryablesGetParams,
-    StacQueryableProperty,
-    StacQueryables,
-)
+from eodag.rest.types.queryables import QueryablesGetParams, StacQueryables
 from eodag.rest.types.stac_search import SearchPostRequest
 from eodag.rest.utils import (
     Cruncher,
@@ -82,7 +77,7 @@ from eodag.utils.exceptions import (
 )
 
 if TYPE_CHECKING:
-    from typing import Any, Dict, List, Optional, Union
+    from typing import Any, Optional, Union
 
     from fastapi import Request
     from requests.auth import AuthBase
@@ -121,12 +116,12 @@ def get_home_page_content(base_url: str, ipp: Optional[int] = None) -> str:
     reason="Function internally used by get_home_page_content, also deprecated",
     version="2.6.1",
 )
-def format_product_types(product_types: List[Dict[str, Any]]) -> str:
+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
     """
-    result: List[str] = []
+    result: list[str] = []
     for pt in product_types:
         result.append(f'* *__{pt["ID"]}__*: {pt["abstract"]}')
     return "\n".join(sorted(result))
@@ -135,7 +130,7 @@ def format_product_types(product_types: List[Dict[str, Any]]) -> str:
 def search_stac_items(
     request: Request,
     search_request: SearchPostRequest,
-) -> Dict[str, Any]:
+) -> dict[str, Any]:
     """
     Search and retrieve STAC items based on the given search request.
 
@@ -193,28 +188,18 @@ def search_stac_items(
         results.number_matched = len(results)
         total = len(results)
 
-    elif time_interval_overlap(eodag_args, catalog):
-        criteria = {
-            **catalog.search_args,
-            **eodag_args.model_dump(exclude_none=True),
-        }
+    else:
+        criteria = eodag_args.model_dump(exclude_none=True)
         # remove provider prefixes
-        stac_extensions = stac_config["extensions"]
-        keys_to_update = {}
-        for key in criteria:
+        # quickfix for ecmwf fake extension to not impact items creation
+        stac_extensions = list(stac_config["extensions"].keys()) + ["ecmwf"]
+        for key in list(criteria):
             if ":" in key and key.split(":")[0] not in stac_extensions:
                 new_key = key.split(":")[1]
-                keys_to_update[key] = new_key
-        for key, new_key in keys_to_update.items():
-            criteria[new_key] = criteria[key]
-            criteria.pop(key)
+                criteria[new_key] = criteria.pop(key)
 
         results = eodag_api.search(count=True, **criteria)
         total = results.number_matched or 0
-    else:
-        # return empty results
-        results = SearchResult([], 0)
-        total = 0
 
     if len(results) == 0 and results.errors:
         raise ResponseSearchError(results.errors)
@@ -324,8 +309,8 @@ def download_stac_item(
 
 def _order_and_update(
     product: EOProduct,
-    auth: Union[AuthBase, Dict[str, str], None],
-    query_args: Dict[str, Any],
+    auth: Union[AuthBase, dict[str, str], None],
+    query_args: dict[str, Any],
 ) -> None:
     """Order product if needed and update given kwargs with order-status-dict"""
     if product.properties.get("storageStatus") != ONLINE_STATUS and hasattr(
@@ -342,13 +327,11 @@ def _order_and_update(
     if (
         product.properties.get("storageStatus") != ONLINE_STATUS
         and NOT_AVAILABLE in product.properties.get("orderStatusLink", "")
-        and hasattr(product.downloader, "order_download")
+        and hasattr(product.downloader, "_order")
     ):
         # first order
         logger.debug("Order product")
-        order_status_dict = product.downloader.order_download(
-            product=product, auth=auth
-        )
+        order_status_dict = product.downloader._order(product=product, auth=auth)
         query_args.update(order_status_dict or {})
 
     if (
@@ -359,18 +342,18 @@ def _order_and_update(
         product.properties["storageStatus"] = STAGING_STATUS
 
     if product.properties.get("storageStatus") == STAGING_STATUS and hasattr(
-        product.downloader, "order_download_status"
+        product.downloader, "_order_status"
     ):
         # check order status if needed
         logger.debug("Checking product order status")
-        product.downloader.order_download_status(product=product, auth=auth)
+        product.downloader._order_status(product=product, auth=auth)
 
     if product.properties.get("storageStatus") != ONLINE_STATUS:
         raise NotAvailableError("Product is not available yet")
 
 
 @lru_cache(maxsize=1)
-def get_detailled_collections_list() -> List[Dict[str, Any]]:
+def get_detailled_collections_list() -> list[dict[str, Any]]:
     """Returns detailled collections / product_types list as a list of
     config dicts
 
@@ -387,7 +370,7 @@ async def all_collections(
     instrument: Optional[str] = None,
     constellation: Optional[str] = None,
     datetime: Optional[str] = None,
-) -> Dict[str, Any]:
+) -> dict[str, Any]:
     """Build STAC collections
 
     :param url: Requested URL
@@ -397,7 +380,7 @@ async def all_collections(
     :returns: Collections dictionary
     """
 
-    async def _fetch() -> Dict[str, Any]:
+    async def _fetch() -> dict[str, Any]:
         stac_collection = StacCollection(
             url=request.state.url,
             stac_config=stac_config,
@@ -417,7 +400,10 @@ async def all_collections(
         # # parse f-strings
         format_args = deepcopy(stac_config)
         format_args["collections"].update(
-            {"url": stac_collection.url, "root": stac_collection.root}
+            {
+                "url": stac_collection.url,
+                "root": stac_collection.root,
+            }
         )
 
         collections["links"] = [
@@ -436,7 +422,7 @@ async def all_collections(
 
 async def get_collection(
     request: Request, collection_id: str, provider: Optional[str] = None
-) -> Dict[str, Any]:
+) -> dict[str, Any]:
     """Build STAC collection by id
 
     :param url: Requested URL
@@ -446,7 +432,7 @@ async def get_collection(
     :returns: Collection dictionary
     """
 
-    async def _fetch() -> Dict[str, Any]:
+    async def _fetch() -> dict[str, Any]:
         stac_collection = StacCollection(
             url=request.state.url,
             stac_config=stac_config,
@@ -469,7 +455,7 @@ async def get_stac_catalogs(
     request: Request,
     url: str,
     provider: Optional[str] = None,
-) -> Dict[str, Any]:
+) -> dict[str, Any]:
     """Build STAC catalog
 
     :param url: Requested URL
@@ -478,7 +464,7 @@ async def get_stac_catalogs(
     :returns: Catalog dictionary
     """
 
-    async def _fetch() -> Dict[str, Any]:
+    async def _fetch() -> dict[str, Any]:
         return StacCatalog(
             url=url,
             stac_config=stac_config,
@@ -495,7 +481,10 @@ def time_interval_overlap(eodag_args: EODAGSearch, catalog: StacCatalog) -> bool
     # check if time filtering appears both in search arguments and catalog
     # (for catalogs built by date: i.e. `year/2020/month/05`)
     if not set(["start", "end"]) <= set(eodag_args.model_dump().keys()) or not set(
-        ["start", "end"]
+        [
+            "start",
+            "end",
+        ]
     ) <= set(catalog.search_args.keys()):
         return True
 
@@ -534,7 +523,7 @@ def time_interval_overlap(eodag_args: EODAGSearch, catalog: StacCatalog) -> bool
 
 
 @lru_cache(maxsize=1)
-def get_stac_conformance() -> Dict[str, str]:
+def get_stac_conformance() -> dict[str, str]:
     """Build STAC conformance
 
     :returns: conformance dictionary
@@ -551,7 +540,7 @@ def get_stac_api_version() -> str:
 
 
 @lru_cache(maxsize=1)
-def get_stac_extension_oseo(url: str) -> Dict[str, str]:
+def get_stac_extension_oseo(url: str) -> dict[str, str]:
     """Build STAC OGC / OpenSearch Extension for EO
 
     :param url: Requested URL
@@ -582,60 +571,96 @@ async def get_queryables(
     request: Request,
     params: QueryablesGetParams,
     provider: Optional[str] = None,
-) -> Dict[str, Any]:
+) -> dict[str, Any]:
     """Fetch the queryable properties for a collection.
 
     :param collection_id: The ID of the collection.
     :returns: A set containing the STAC standardized queryable properties for a collection.
     """
 
-    async def _fetch() -> Dict[str, Any]:
+    async def _fetch() -> dict[str, Any]:
         python_queryables = eodag_api.list_queryables(
-            provider=provider, **params.model_dump(exclude_none=True, by_alias=True)
+            provider=provider,
+            fetch_providers=False,
+            **params.model_dump(exclude_none=True, by_alias=True),
         )
-        python_queryables.pop("start")
-        python_queryables.pop("end")
 
-        # productType and id are already default in stac collection and id
-        python_queryables.pop("productType", None)
-        python_queryables.pop("id", None)
-
-        stac_queryables: Dict[str, StacQueryableProperty] = deepcopy(
-            StacQueryables.default_properties
+        python_queryables_json = python_queryables.get_model().model_json_schema(
+            by_alias=True
         )
+
+        properties: dict[str, Any] = python_queryables_json["properties"]
+        required: list[str] = python_queryables_json.get("required") or []
+
+        # productType is either simply removed or replaced by collection later.
+        if "productType" in properties:
+            properties.pop("productType")
+        if "productType" in required:
+            required.remove("productType")
+
+        stac_properties: dict[str, Any] = {}
+
         # get stac default properties to set prefixes
         stac_item_properties = list(stac_config["item"]["properties"].values())
-        stac_item_properties.extend(list(stac_queryables.keys()))
-        ignore = stac_config["metadata_ignore"]
-        stac_item_properties.extend(ignore)
-        default_mapping = DEFAULT_METADATA_MAPPING.keys()
-        for param, queryable in python_queryables.items():
-            if param in default_mapping and not any(
+        stac_item_properties.extend(stac_config["metadata_ignore"])
+        for param, queryable in properties.items():
+            # convert key to STAC format
+            if param in OSEO_METADATA_MAPPING.keys() and not any(
                 param in str(prop) for prop in stac_item_properties
             ):
                 param = f"oseo:{param}"
             stac_param = EODAGSearch.to_stac(param, stac_item_properties, provider)
-            # only keep "datetime" queryable for dates
-            if stac_param in stac_queryables or stac_param in (
-                "start_datetime",
-                "end_datetime",
-            ):
-                continue
 
-            stac_queryables[
-                stac_param
-            ] = StacQueryableProperty.from_python_field_definition(
-                stac_param, queryable
-            )
+            queryable["title"] = stac_param.split(":")[-1]
+
+            # remove null default values
+            if not queryable.get("default"):
+                queryable.pop("default", None)
 
-        if params.collection:
-            stac_queryables.pop("collection")
+            stac_properties[stac_param] = queryable
+            required = list(map(lambda x: x.replace(param, stac_param), required))
+
+        # due to certain metadata mappings we might only get end_datetime but we can
+        # assume that start_datetime is also available
+        if (
+            "end_datetime" in stac_properties
+            and "start_datetime" not in stac_properties
+        ):
+            stac_properties["start_datetime"] = deepcopy(
+                stac_properties["end_datetime"]
+            )
+            stac_properties["start_datetime"]["title"] = "start_datetime"
+        # if we can search by start_datetime we can search by datetime
+        if "start_datetime" in stac_properties:
+            stac_properties["datetime"] = StacQueryables.possible_properties[
+                "datetime"
+            ].model_dump()
+
+        # format spatial extend properties to STAC format.
+        if "geometry" in stac_properties:
+            stac_properties["bbox"] = StacQueryables.possible_properties[
+                "bbox"
+            ].model_dump()
+            stac_properties["geometry"] = StacQueryables.possible_properties[
+                "geometry"
+            ].model_dump()
+
+        if not params.collection:
+            stac_properties["collection"] = StacQueryables.default_properties[
+                "collection"
+            ].model_dump()
+
+        additional_properties = python_queryables.additional_properties
+        description = "Queryable names for the EODAG STAC API Item Search filter. "
+        description += python_queryables.additional_information
 
         return StacQueryables(
             q_id=request.state.url,
-            additional_properties=bool(not params.collection),
-            properties=stac_queryables,
-        ).model_dump(mode="json", by_alias=True)
+            additional_properties=additional_properties,
+            properties=stac_properties,
+            required=required or None,
+            description=description,
+        ).model_dump(mode="json", by_alias=True, exclude_none=True)
 
     hashed_queryables = hash(params.model_dump_json())
     return await cached(
@@ -662,7 +687,7 @@ def crunch_products(
             f'Unknown crunch name. Use one of: {", ".join(crunchers.keys())}'
         )
 
-    cruncher_config: Dict[str, Any] = {}
+    cruncher_config: dict[str, Any] = {}
     for config_param in cruncher.config_params:
         config_param_value = kwargs.get(config_param)
         if not config_param_value:
@@ -695,17 +720,22 @@ def eodag_api_init() -> None:
             ext_col = StacCollection.ext_stac_collections.get(key)
             if not ext_col:
                 continue
-            platform: Union[str, List[str]] = ext_col.get("summaries", {}).get(
+            platform: Union[str, list[str]] = ext_col.get("summaries", {}).get(
                 "platform"
             )
-            constellation: Union[str, List[str]] = ext_col.get("summaries", {}).get(
+            constellation: Union[str, list[str]] = ext_col.get("summaries", {}).get(
                 "constellation"
             )
+            processing_level: Union[str, list[str]] = ext_col.get("summaries", {}).get(
+                "processing:level"
+            )
             # Check if platform or constellation are lists and join them into a string if they are
             if isinstance(platform, list):
                 platform = ",".join(platform)
             if isinstance(constellation, list):
                 constellation = ",".join(constellation)
+            if isinstance(processing_level, list):
+                processing_level = ",".join(processing_level)
 
             update_fields = {
                 "title": ext_col.get("title"),
@@ -716,7 +746,7 @@ def eodag_api_init() -> None:
                 ),
                 "platform": constellation,
                 "platformSerialIdentifier": platform,
-                "processingLevel": ext_col.get("summaries", {}).get("processing:level"),
+                "processingLevel": processing_level,
                 "license": ext_col["license"],
                 "missionStartDate": ext_col["extent"]["temporal"]["interval"][0][0],
                 "missionEndDate": ext_col["extent"]["temporal"]["interval"][-1][1],

eodag/rest/errors.py

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import logging
-from typing import Dict, List, Tuple, Union
+from typing import Union
 
 from fastapi import FastAPI, Request
 from fastapi.responses import ORJSONResponse
@@ -56,16 +56,16 @@ logger = logging.getLogger("eodag.rest.server")
 class ResponseSearchError(Exception):
     """Represent a EODAG search error response"""
 
-    def __init__(self, errors: List[Tuple[str, Exception]]) -> None:
+    def __init__(self, errors: list[tuple[str, Exception]]) -> None:
         self._errors = errors
 
     @property
-    def errors(self) -> List[Dict[str, Union[str, int]]]:
+    def errors(self) -> list[dict[str, Union[str, int]]]:
         """return errors as a list of dict"""
-        error_list: List[Dict[str, Union[str, int]]] = []
+        error_list: list[dict[str, Union[str, int]]] = []
         for name, exception in self._errors:
 
-            error_dict: Dict[str, Union[str, int]] = {
+            error_dict: dict[str, Union[str, int]] = {
                 "provider": name,
                 "error": exception.__class__.__name__,
             }

eodag/rest/server.py

@@ -23,15 +23,7 @@ import re
 from contextlib import asynccontextmanager
 from importlib.metadata import version
 from json import JSONDecodeError
-from typing import (
-    TYPE_CHECKING,
-    Any,
-    AsyncGenerator,
-    Awaitable,
-    Callable,
-    Dict,
-    Optional,
-)
+from typing import TYPE_CHECKING, Any, AsyncGenerator, Awaitable, Callable, Optional
 
 from fastapi import APIRouter as FastAPIRouter
 from fastapi import FastAPI, HTTPException, Request
@@ -61,7 +53,12 @@ from eodag.rest.core import (
 from eodag.rest.errors import add_exception_handlers
 from eodag.rest.types.queryables import QueryablesGetParams
 from eodag.rest.types.stac_search import SearchPostRequest, sortby2list
-from eodag.rest.utils import format_pydantic_error, str2json, str2list
+from eodag.rest.utils import (
+    LIVENESS_PROBE_PATH,
+    format_pydantic_error,
+    str2json,
+    str2list,
+)
 from eodag.utils import parse_header, update_nested_dict
 
 if TYPE_CHECKING:
@@ -120,10 +117,21 @@ app = FastAPI(lifespan=lifespan, title="EODAG", docs_url="/api.html")
 stac_api_config = load_stac_api_config()
 
 
+@router.api_route(
+    methods=["GET", "HEAD"],
+    path=LIVENESS_PROBE_PATH,
+    include_in_schema=False,
+    status_code=200,
+)
+async def liveness_probe(request: Request) -> dict[str, bool]:
+    "Endpoint meant to be used as liveness probe by deployment platforms"
+    return {"success": True}
+
+
 @router.api_route(
     methods=["GET", "HEAD"], path="/api", tags=["Capabilities"], include_in_schema=False
 )
-async def eodag_openapi(request: Request) -> Dict[str, Any]:
+async def eodag_openapi(request: Request) -> dict[str, Any]:
     """Customized openapi"""
     logger.debug("URL: /api")
     if app.openapi_schema:
@@ -375,13 +383,24 @@ async def list_collection_queryables(
     :returns: A json object containing the list of available queryable properties for the specified collection.
     """
     logger.info(f"{request.method} {request.state.url}")
-    additional_params = dict(request.query_params)
+    # split by `,` to handle list of parameters
+    additional_params = {k: v.split(",") for k, v in dict(request.query_params).items()}
     provider = additional_params.pop("provider", None)
 
+    datetime = additional_params.pop("datetime", None)
+
     queryables = await get_queryables(
         request,
-        QueryablesGetParams(collection=collection_id, **additional_params),
-        provider=provider,
+        QueryablesGetParams.model_validate(
+            {
+                **additional_params,
+                **{
+                    "collection": collection_id,
+                    "datetime": datetime[0] if datetime else None,
+                },
+            }
+        ),
+        provider=provider[0] if provider else None,
     )
 
     return ORJSONResponse(queryables)