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

eodag/rest/stac.py

@@ -21,7 +21,7 @@ import logging
 import os
 from collections import defaultdict
 from datetime import datetime, timezone
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Tuple, cast
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, cast
 from urllib.parse import parse_qs, urlencode, urlparse, urlunparse
 
 import dateutil.parser
@@ -106,15 +106,10 @@ class StacCommon:
     """Stac common object
 
     :param url: Requested URL
-    :type url: str
     :param stac_config: STAC configuration from stac.yml conf file
-    :type stac_config: dict
     :param provider: (optional) Chosen provider
-    :type provider: str
     :param eodag_api: EODAG python API instance
-    :type eodag_api: :class:`eodag.api.core.EODataAccessGateway`
     :param root: (optional) API root
-    :type root: str
     """
 
     def __init__(
@@ -137,7 +132,6 @@ class StacCommon:
         """Updates data using given input STAC dict data
 
         :param data: Catalog data (parsed STAC dict)
-        :type data: dict
         """
         self.data.update(data)
 
@@ -149,16 +143,18 @@ class StacCommon:
         ):
             for i, bbox in enumerate(self.data["extent"]["spatial"]["bbox"]):
                 self.data["extent"]["spatial"]["bbox"][i] = [float(x) for x in bbox]
-        # "None" values to None
-        apply_method: Callable[[str, str], Optional[str]] = lambda _, v: (
-            None if v == "None" else v
-        )
-        self.data = dict_items_recursive_apply(self.data, apply_method)
-        # ids and titles as str
-        apply_method: Callable[[str, str], Optional[str]] = lambda k, v: (
-            str(v) if k in ["title", "id"] else v
-        )
-        self.data = dict_items_recursive_apply(self.data, apply_method)
+
+        def apply_method_none(_: str, v: str) -> Optional[str]:
+            """ "None" values to None"""
+            return None if v == "None" else v
+
+        self.data = dict_items_recursive_apply(self.data, apply_method_none)
+
+        def apply_method_ids(k, v):
+            """ids and titles as str"""
+            return str(v) if k in ["title", "id"] else v
+
+        self.data = dict_items_recursive_apply(self.data, apply_method_ids)
 
         # empty stac_extensions: "" to []
         if not self.data.get("stac_extensions", True):
@@ -171,15 +167,10 @@ class StacCommon:
         """Parse STAC extension from config and return as dict
 
         :param url: Requested URL
-        :type url: str
         :param stac_config: STAC configuration from stac.yml conf file
-        :type stac_config: dict
         :param extension: Extension name
-        :type extension: str
         :param kwargs: Additional variables needed for parsing extension
-        :type kwargs: Any
         :returns: STAC extension as dictionnary
-        :rtype: dict
         """
         extension_model = deepcopy(stac_config).get("extensions", {}).get(extension, {})
 
@@ -211,15 +202,10 @@ class StacItem(StacCommon):
     """Stac item object
 
     :param url: Requested URL
-    :type url: str
     :param stac_config: STAC configuration from stac.yml conf file
-    :type stac_config: dict
     :param provider: (optional) Chosen provider
-    :type provider: str
     :param eodag_api: EODAG python API instance
-    :type eodag_api: :class:`eodag.api.core.EODataAccessGateway`
     :param root: (optional) API root
-    :type root: str
     """
 
     def __init__(
@@ -244,11 +230,8 @@ class StacItem(StacCommon):
         """Build STAC items list from EODAG search results
 
         :param search_results: EODAG search results
-        :type search_results: :class:`~eodag.api.search_result.SearchResult`
         :param catalog: STAC catalog dict used for parsing item metadata
-        :type catalog: dict
         :returns: STAC item dicts list
-        :rtype: list
         """
         if len(search_results) <= 0:
             return []
@@ -464,11 +447,8 @@ class StacItem(StacCommon):
         """Build STAC items from EODAG search results
 
         :param search_results: EODAG search results
-        :type search_results: :class:`~eodag.api.search_result.SearchResult`
         :param catalog: STAC catalog dict used for parsing item metadata
-        :type catalog: dict
         :returns: Items dictionnary
-        :rtype: dict
         """
         items_model = deepcopy(self.stac_config["items"])
 
@@ -519,11 +499,8 @@ class StacItem(StacCommon):
         part of oseo extension.
 
         :param item_model: Item model from stac_config
-        :type item_model: dict
         :param product_type: Product type
-        :type product_type: str
         :returns: Filtered item model
-        :rtype: dict
         """
         try:
             product_type_dict = [
@@ -584,9 +561,7 @@ class StacItem(StacCommon):
         """Removes empty properties, unused extensions, and add missing extensions
 
         :param item: STAC item data
-        :type item: dict
         :returns: Filtered item model
-        :rtype: dict
         """
         all_extensions_dict: Dict[str, str] = deepcopy(
             self.stac_config["stac_extensions"]
@@ -617,9 +592,7 @@ class StacItem(StacCommon):
         """Build STAC item from EODAG product
 
         :param product: EODAG product
-        :type product: :class:`eodag.api.product._product.EOProduct`
         :returns: STAC item
-        :rtype: list
         """
         product_type = str(product.product_type)
 
@@ -668,15 +641,10 @@ class StacCollection(StacCommon):
     """Stac collection object
 
     :param url: Requested URL
-    :type url: str
     :param stac_config: STAC configuration from stac.yml conf file
-    :type stac_config: dict
     :param provider: (optional) Chosen provider
-    :type provider: str
     :param eodag_api: EODAG python API instance
-    :type eodag_api: :class:`eodag.api.core.EODataAccessGateway`
     :param root: (optional) API root
-    :type root: str
     """
 
     # External STAC collections
@@ -687,7 +655,6 @@ class StacCollection(StacCommon):
         """Load external STAC collections
 
         :param eodag_api: EODAG python API instance
-        :type eodag_api: :class:`eodag.api.core.EODataAccessGateway`
         """
         list_product_types = eodag_api.list_product_types(fetch_providers=False)
         for product_type in list_product_types:
@@ -727,9 +694,7 @@ class StacCollection(StacCommon):
         """Retrieve a list of providers for a given product type.
 
         :param product_type: Dictionary containing information about the product type.
-        :type product_type: dict
         :return: A list of provider names.
-        :rtype: list
         """
         if self.provider:
             return [self.provider]
@@ -747,11 +712,8 @@ class StacCollection(StacCommon):
         """Generate a STAC collection dictionary for a given product type.
 
         :param collection_model: The base model for the STAC collection.
-        :type collection_model: Any
         :param product_type: Dictionary containing information about the product type.
-        :type product_type: dict
         :return: A dictionary representing the STAC collection for the given product type.
-        :rtype: dict
         """
         providers = self.__list_product_type_providers(product_type)
 
@@ -837,9 +799,7 @@ class StacCollection(StacCommon):
         """Build STAC collections list
 
         :param filters: (optional) Additional filters for collections search
-        :type filters: dict
         :returns: STAC collection dicts list
-        :rtype: list
         """
         collection_model = deepcopy(self.stac_config["collection"])
 
@@ -884,17 +844,11 @@ class StacCatalog(StacCommon):
     """Stac Catalog object
 
     :param url: Requested URL
-    :type url: str
     :param stac_config: STAC configuration from stac.yml conf file
-    :type stac_config: dict
     :param provider: Chosen provider
-    :type provider: (optional) str
     :param eodag_api: EODAG python API instance
-    :type eodag_api: :class:`eodag.api.core.EODataAccessGateway`
     :param root: (optional) API root
-    :type root: str
     :param catalogs: (optional) Catalogs list
-    :type catalogs: list
     """
 
     def __init__(
@@ -937,7 +891,6 @@ class StacCatalog(StacCommon):
         """Updates configuration and data using given input catalog config
 
         :param catalog_config: Catalog config, from yml stac_config[catalogs]
-        :type catalog_config: dict
         """
         model = catalog_config["model"]
 
@@ -961,7 +914,6 @@ class StacCatalog(StacCommon):
         """Set catalog children / links
 
         :param children: (optional) Children list
-        :type children: list
         """
         self.children = children or []
         self.data["links"] = [
@@ -976,7 +928,6 @@ class StacCatalog(StacCommon):
         """Updates catalog with given product_type
 
         :param product_type: Product type
-        :type product_type: str
         """
         collections = StacCollection(
             url=self.url,
@@ -1013,7 +964,6 @@ class StacCatalog(StacCommon):
         """Get catalog available years list
 
         :returns: Years list
-        :rtype: list
         """
         extent_date_min, extent_date_max = self.get_datetime_extent()
 
@@ -1023,7 +973,6 @@ class StacCatalog(StacCommon):
         """Get catalog available months list
 
         :returns: Months list
-        :rtype: list
         """
         extent_date_min, extent_date_max = self.get_datetime_extent()
 
@@ -1038,7 +987,6 @@ class StacCatalog(StacCommon):
         """Get catalog available days list
 
         :returns: Days list
-        :rtype: list
         """
         extent_date_min, extent_date_max = self.get_datetime_extent()
 
@@ -1052,9 +1000,7 @@ class StacCatalog(StacCommon):
         """Updates and returns catalog with given year
 
         :param year: Year number
-        :type year: str
         :returns: Updated catalog
-        :rtype: dict
         """
         extent_date_min, extent_date_max = self.get_datetime_extent()
 
@@ -1079,9 +1025,7 @@ class StacCatalog(StacCommon):
         """Updates and returns catalog with given month
 
         :param month: Month number
-        :type month: str
         :returns: Updated catalog
-        :rtype: dict
         """
         extent_date_min, extent_date_max = self.get_datetime_extent()
         year = extent_date_min.year
@@ -1110,9 +1054,7 @@ class StacCatalog(StacCommon):
         """Updates and returns catalog with given day
 
         :param day: Day number
-        :type day: str
         :returns: Updated catalog
-        :rtype: dict
         """
         extent_date_min, extent_date_max = self.get_datetime_extent()
         year = extent_date_min.year
@@ -1142,7 +1084,6 @@ class StacCatalog(StacCommon):
         """Returns catalog temporal extent as datetime objs
 
         :returns: Start & stop dates
-        :rtype: tuple
         """
         extent_date_min = dateutil.parser.parse(DEFAULT_MISSION_START_DATE).replace(
             tzinfo=tz.UTC
@@ -1175,13 +1116,9 @@ class StacCatalog(StacCommon):
         """Updates catalog data using given dates
 
         :param datetime_min: Date min of interval
-        :type datetime_min: :class:`datetime`
         :param datetime_max: Date max of interval
-        :type datetime_max: :class:`datetime`
         :param catalog_model: Catalog model to use, from yml stac_config[catalogs]
-        :type catalog_model: dict
         :returns: Updated catalog
-        :rtype: dict
         """
         # parse f-strings
         format_args = deepcopy(self.stac_config)
@@ -1215,7 +1152,6 @@ class StacCatalog(StacCommon):
         """Get cloud_cover list
 
         :returns: cloud_cover list
-        :rtype: list
         """
         return list(range(0, 101, 10))
 
@@ -1223,9 +1159,7 @@ class StacCatalog(StacCommon):
         """Updates and returns catalog with given max cloud_cover
 
         :param cloud_cover: Cloud_cover number
-        :type cloud_cover: str
         :returns: Updated catalog
-        :rtype: dict
         """
         cat_model = deepcopy(self.stac_config["catalogs"]["cloud_cover"]["model"])
         # parse f-strings
@@ -1247,9 +1181,7 @@ class StacCatalog(StacCommon):
         """Get locations list using stac_conf & locations_config
 
         :param catalog_name: Catalog/location name
-        :type catalog_name: str
         :returns: Locations list
-        :rtype: list
         """
 
         if catalog_name not in self.stac_config["catalogs"]:
@@ -1282,11 +1214,8 @@ class StacCatalog(StacCommon):
         """Updates and returns catalog with given location
 
         :param location: Feature attribute value for shp filtering
-        :type location: str
         :param catalog_name: Catalog/location name
-        :type catalog_name: str
         :returns: Updated catalog
-        :rtype: dict
         """
         location_list_cat_key = catalog_name + "_list"
 
@@ -1339,7 +1268,6 @@ class StacCatalog(StacCommon):
         """Build locations config from stac_conf[locations_catalogs] & eodag_api.locations_config
 
         :returns: Locations configuration dict
-        :rtype: dict
         """
         user_config_locations_list = self.eodag_api.locations_config
 
@@ -1364,9 +1292,7 @@ class StacCatalog(StacCommon):
         """Build nested catalog from catalag list
 
         :param catalogs: (optional) Catalogs list
-        :type catalogs: list
         :returns: This catalog obj
-        :rtype: :class:`eodag.stac.StacCatalog`
         """
         settings = Settings.from_environment()
 

eodag/rest/types/eodag_search.py

@@ -49,10 +49,7 @@ from eodag.rest.utils.cql_evaluate import EodagEvaluator
 from eodag.utils import DEFAULT_ITEMS_PER_PAGE
 
 if TYPE_CHECKING:
-    try:
-        from typing import Self
-    except ImportError:
-        from _typeshed import Self
+    from typing_extensions import Self
 
 Geometry = Union[
     Dict[str, Any],
@@ -113,7 +110,7 @@ class EODAGSearch(BaseModel):
     illuminationAzimuthAngle: Optional[float] = Field(None, alias="view:sun_azimuth")
     page: Optional[int] = Field(1)
     items_per_page: int = Field(DEFAULT_ITEMS_PER_PAGE, alias="limit")
-    sortBy: Optional[List[Tuple[str, str]]] = Field(None, alias="sortby")
+    sort_by: Optional[List[Tuple[str, str]]] = Field(None, alias="sortby")
     raise_errors: bool = False
 
     _to_eodag_map: Dict[str, str]
@@ -314,14 +311,14 @@ class EODAGSearch(BaseModel):
             return ",".join(v)
         return v
 
-    @field_validator("sortBy", mode="before")
+    @field_validator("sort_by", mode="before")
     @classmethod
     def parse_sortby(
         cls,
         sortby_post_params: List[Dict[str, str]],
     ) -> List[Tuple[str, str]]:
         """
-        Convert STAC POST sortby to EODAG sortby
+        Convert STAC POST sortby to EODAG sort_by
         """
         special_fields = {
             "start": "startTimeFromAscendingNode",

eodag/rest/types/queryables.py

@@ -51,14 +51,16 @@ class QueryablesGetParams(BaseModel):
         dumped: Dict[str, Any] = handler(self)
         return {EODAGSearch.to_eodag(k): v for k, v in dumped.items()}
 
-    @computed_field
+    # use [prop-decorator] mypy error code when mypy==1.12 is released
+    @computed_field  # type: ignore[misc]
     @property
     def start_datetime(self) -> Optional[str]:
         """Extract start_datetime property from datetime"""
         start = str_to_interval(self.datetime)[0]
         return start.strftime("%Y-%m-%dT%H:%M:%SZ") if start else None
 
-    @computed_field
+    # use [prop-decorator] mypy error code when mypy==1.12 is released
+    @computed_field  # type: ignore[misc]
     @property
     def end_datetime(self) -> Optional[str]:
         """Extract end_datetime property from datetime"""
@@ -70,11 +72,8 @@ class StacQueryableProperty(BaseModel):
     """A class representing a queryable property.
 
     :param description: The description of the queryables property
-    :type description: str
     :param ref: (optional) A reference link to the schema of the property.
-    :type ref: str
     :param type: (optional) possible types of the property
-    :type type: list[str]
     """
 
     description: str
@@ -114,19 +113,12 @@ class StacQueryables(BaseModel):
     """A class representing queryable properties for the STAC API.
 
     :param json_schema: The URL of the JSON schema.
-    :type json_schema: str
     :param q_id: (optional) The identifier of the queryables.
-    :type q_id: str
     :param q_type: The type of the object.
-    :type q_type: str
     :param title: The title of the queryables.
-    :type title: str
     :param description: The description of the queryables
-    :type description: str
     :param properties: A dictionary of queryable properties.
-    :type properties: dict
     :param additional_properties: Whether additional properties are allowed.
-    :type additional_properties: bool
     """
 
     json_schema: str = Field(

eodag/rest/types/stac_search.py

@@ -16,6 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Model describing a STAC search POST request"""
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional, Tuple, Union
@@ -48,10 +49,7 @@ from eodag.rest.utils.rfc3339 import rfc3339_str_to_datetime, str_to_interval
 from eodag.utils.exceptions import ValidationError
 
 if TYPE_CHECKING:
-    try:
-        from typing import Self
-    except ImportError:
-        from _typeshed import Self
+    from typing_extensions import Self
 
 NumType = Union[float, int]
 
@@ -74,15 +72,13 @@ Geometry = Union[
 Direction = Annotated[Literal["asc", "desc"], StringConstraints(min_length=1)]
 
 
-class Sortby(BaseModel):
+class SortBy(BaseModel):
     """
     A class representing a parameter with which we want to sort results and its sorting order in a
     POST search
 
     :param field: The name of the parameter with which we want to sort results
-    :type field: str
     :param direction: The sorting order of the parameter
-    :type direction: str
     """
 
     __pydantic_config__ = ConfigDict(extra="forbid")
@@ -120,7 +116,7 @@ class SearchPostRequest(BaseModel):
         description="The language used for filtering.",
         validate_default=True,
     )
-    sortby: Optional[List[Sortby]] = None
+    sortby: Optional[List[SortBy]] = None
     crunch: Optional[str] = None
 
     @field_serializer("intersects")
@@ -262,16 +258,16 @@ class SearchPostRequest(BaseModel):
 
 def sortby2list(
     v: Optional[str],
-) -> Optional[List[Sortby]]:
+) -> Optional[List[SortBy]]:
     """
     Convert sortby filter parameter GET syntax to POST syntax
     """
     if not v:
         return None
-    sortby: List[Sortby] = []
+    sortby: List[SortBy] = []
     for sortby_param in v.split(","):
         sortby_param = sortby_param.strip()
         direction: Direction = "desc" if sortby_param.startswith("-") else "asc"
         field = sortby_param.lstrip("+-")
-        sortby.append(Sortby(field=field, direction=direction))
+        sortby.append(SortBy(field=field, direction=direction))
     return sortby

eodag/rest/utils/rfc3339.py

@@ -33,7 +33,6 @@ def str_to_interval(
 
     :param interval: The interval string to convert to a :class:`datetime.datetime`
         tuple.
-    :type interval: str
 
     :raises: :class:`ValueError`
     """

eodag/types/__init__.py

@@ -200,7 +200,7 @@ def python_field_definition_to_json(
             "%s must be an instance of Annotated" % python_field_definition
         )
 
-    json_field_definition = dict()
+    json_field_definition: Dict[str, Any] = dict()
 
     python_field_args = get_args(python_field_definition)
 
@@ -210,6 +210,10 @@ def python_field_definition_to_json(
         type_data = python_type_to_json(type(enum_args[0]))
         if isinstance(type_data, str):
             json_field_definition["type"] = type_data
+        elif type_data is None:
+            json_field_definition["type"] = json_field_definition[
+                "min"
+            ] = json_field_definition["max"] = None
         else:
             json_field_definition["type"] = [row["type"] for row in type_data]
             json_field_definition["min"] = [
@@ -224,6 +228,10 @@ def python_field_definition_to_json(
         field_type = python_type_to_json(python_field_args[0])
         if isinstance(field_type, str):
             json_field_definition["type"] = field_type
+        elif field_type is None:
+            json_field_definition["type"] = json_field_definition[
+                "min"
+            ] = json_field_definition["max"] = None
         else:
             json_field_definition["type"] = [row["type"] for row in field_type]
             json_field_definition["min"] = [
@@ -300,9 +308,7 @@ class ProviderSortables(TypedDict):
     maximum number of used sortable(s) in a search request with the provider
 
     :param sortables: The list of sortable parameter(s) of a provider
-    :type sortables: list[str]
     :param max_sort_params: (optional) The allowed maximum number of sortable(s) in a search request with the provider
-    :type max_sort_params: int
     """
 
     sortables: List[str]

eodag/types/download_args.py

@@ -17,15 +17,24 @@
 # limitations under the License.
 from __future__ import annotations
 
-from typing import Dict, TypedDict
+from typing import Dict, Optional, TypedDict
 
 
 class DownloadConf(TypedDict, total=False):
-    """Download configuration"""
+    """Download configuration
 
-    outputs_prefix: str
-    outputs_extension: str
+    :cvar output_prefix: where to store downloaded products, as an absolute file path
+                         (Default: local temporary directory)
+    :cvar output_extension: downloaded file extension
+    :cvar extract: whether to extract the downloaded products, only applies to archived products
+    :cvar dl_url_params: additional parameters to pass over to the download url as an url parameter
+    :cvar delete_archive: whether to delete the downloaded archives
+    :cvar asset: regex filter to identify assets to download
+    """
+
+    output_dir: str
+    output_extension: str
     extract: bool
     dl_url_params: Dict[str, str]
     delete_archive: bool
-    asset: str
+    asset: Optional[str]

eodag/types/search_args.py

@@ -51,7 +51,7 @@ class SearchArgs(BaseModel):
     locations: Optional[Dict[str, str]] = Field(None)
     page: Optional[int] = Field(DEFAULT_PAGE, gt=0)  # type: ignore
     items_per_page: Optional[PositiveInt] = Field(DEFAULT_ITEMS_PER_PAGE)  # type: ignore
-    sortBy: Optional[SortByList] = Field(None)  # type: ignore
+    sort_by: Optional[SortByList] = Field(None)  # type: ignore
 
     @field_validator("start", "end", mode="before")
     @classmethod
@@ -87,18 +87,17 @@ class SearchArgs(BaseModel):
 
         raise TypeError(f"Invalid geometry type: {type(v)}")
 
-    @field_validator("sortBy", mode="before")
+    @field_validator("sort_by", mode="before")
     @classmethod
     def check_sort_by_arg(
-        cls, sort_by_arg: Optional[SortByList]  # type: ignore
+        cls,
+        sort_by_arg: Optional[SortByList],  # type: ignore
     ) -> Optional[SortByList]:  # type: ignore
-        """Check if the sortBy argument is correct
+        """Check if the sort_by argument is correct
 
-        :param sort_by_arg: The sortBy argument
-        :type sort_by_arg: str
-        :returns: The sortBy argument with sorting order parsed (whitespace(s) are
+        :param sort_by_arg: The sort_by argument
+        :returns: The sort_by argument with sorting order parsed (whitespace(s) are
                   removed and only the 3 first letters in uppercase are kept)
-        :rtype: str
         """
         if sort_by_arg is None:
             return None

eodag/types/whoosh.py

@@ -56,9 +56,7 @@ class EODAGQueryParser(QueryParser):
         EODAG QueryParser initialization
 
         :param filters: list of fieldnames to filter on
-        :type filters: List[str]
         :param schema: Whoosh Schema
-        :type schma: :class:whoosh.fields.Schema
         """
         super().__init__(
             None,