eodag 2.12.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

eodag/api/search_result.py

@@ -18,9 +18,10 @@
 from __future__ import annotations
 
 from collections import UserList
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
+from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple, Union
 
 from shapely.geometry import GeometryCollection, shape
+from typing_extensions import Doc
 
 from eodag.api.product import EOProduct
 from eodag.plugins.crunch.filter_date import FilterDate
@@ -28,6 +29,7 @@ from eodag.plugins.crunch.filter_latest_intersect import FilterLatestIntersect
 from eodag.plugins.crunch.filter_latest_tpl_name import FilterLatestByName
 from eodag.plugins.crunch.filter_overlap import FilterOverlap
 from eodag.plugins.crunch.filter_property import FilterProperty
+from eodag.utils import Annotated
 
 if TYPE_CHECKING:
     from shapely.geometry.base import BaseGeometry
@@ -39,23 +41,34 @@ class SearchResult(UserList):
     """An object representing a collection of :class:`~eodag.api.product._product.EOProduct` resulting from a search.
 
     :param products: A list of products resulting from a search
-    :type products: list(:class:`~eodag.api.product._product.EOProduct`)
+    :param number_matched: (optional) the estimated total number of matching results
+
+    :cvar data: List of products
+    :ivar number_matched: Estimated total number of matching results
     """
 
     data: List[EOProduct]
 
-    def __init__(self, products: List[EOProduct]) -> None:
-        super(SearchResult, self).__init__(products)
+    errors: Annotated[
+        List[Tuple[str, Exception]], Doc("Tuple of provider name, exception")
+    ]
+
+    def __init__(
+        self,
+        products: List[EOProduct],
+        number_matched: Optional[int] = None,
+        errors: List[Tuple[str, Exception]] = [],
+    ) -> None:
+        super().__init__(products)
+        self.number_matched = number_matched
+        self.errors = errors
 
     def crunch(self, cruncher: Crunch, **search_params: Any) -> SearchResult:
         """Do some crunching with the underlying EO products.
 
         :param cruncher: The plugin instance to use to work on the products
-        :type cruncher: subclass of :class:`~eodag.plugins.crunch.base.Crunch`
         :param search_params: The criteria that have been used to produce this result
-        :type search_params: dict
         :returns: The result of the application of the crunching method to the EO products
-        :rtype: :class:`~eodag.api.search_result.SearchResult`
         """
         crunched_results = cruncher.proceed(self.data, **search_params)
         return SearchResult(crunched_results)
@@ -130,9 +143,7 @@ class SearchResult(UserList):
         """Builds an :class:`~eodag.api.search_result.SearchResult` object from its representation as geojson
 
         :param feature_collection: A collection representing a search result.
-        :type feature_collection: dict
         :returns: An eodag representation of a search result
-        :rtype: :class:`~eodag.api.search_result.SearchResult`
         """
         return SearchResult(
             [
@@ -149,7 +160,7 @@ class SearchResult(UserList):
         }
 
     def as_shapely_geometry_object(self) -> GeometryCollection:
-        """:class:`shapely.geometry.GeometryCollection` representation of SearchResult"""
+        """:class:`shapely.GeometryCollection` representation of SearchResult"""
         return GeometryCollection(
             [
                 shape(feature["geometry"]).buffer(0)
@@ -168,3 +179,51 @@ class SearchResult(UserList):
         See https://gist.github.com/sgillies/2217756
         """
         return self.as_geojson_object()
+
+    def _repr_html_(self):
+        total_count = f"/{self.number_matched}" if self.number_matched else ""
+        return (
+            f"""<table>
+                <thead><tr><td style='text-align: left; color: grey;'>
+                 {type(self).__name__}&ensp;({len(self)}{total_count})
+                </td></tr></thead>
+            """
+            + "".join(
+                [
+                    f"""<tr><td style='text-align: left;'>
+                <details><summary style='color: grey; font-family: monospace;'>
+                    {i}&ensp;
+                    {type(p).__name__}(id=<span style='color: black;'>{
+                        p.properties['id']
+                    }</span>, provider={p.provider})
+                </summary>
+                {p._repr_html_()}
+                </details>
+                </td></tr>
+                """
+                    for i, p in enumerate(self)
+                ]
+            )
+            + "</table>"
+        )
+
+    def extend(self, other: Iterable) -> None:
+        """override extend method to include errors"""
+        if isinstance(other, SearchResult):
+            self.errors.extend(other.errors)
+
+        return super().extend(other)
+
+
+class RawSearchResult(UserList):
+    """An object representing a collection of raw/unparsed search results obtained from a provider.
+
+    :param results: A list of raw/unparsed search results
+    """
+
+    data: List[Any]
+    query_params: Dict[str, Any]
+    product_type_def_params: Dict[str, Any]
+
+    def __init__(self, results: List[Any]) -> None:
+        super(RawSearchResult, self).__init__(results)

eodag/cli.py

@@ -39,6 +39,7 @@ Commands:
 
   noqa: D103
 """
+
 from __future__ import annotations
 
 import json
@@ -50,7 +51,6 @@ from importlib.metadata import metadata
 from typing import TYPE_CHECKING, Any, Dict, List, Mapping, Set
 
 import click
-import uvicorn
 
 from eodag.api.core import EODataAccessGateway
 from eodag.utils import DEFAULT_ITEMS_PER_PAGE, DEFAULT_PAGE, parse_qs
@@ -242,6 +242,11 @@ def version() -> None:
     "or a maximum value defined internally for the requested provider, or a default "
     "maximum value equals to 50.",
 )
+@click.option(
+    "--count",
+    is_flag=True,
+    help="Whether to run a query with a count request or not.",
+)
 @click.option(
     "--locations",
     type=str,
@@ -334,6 +339,8 @@ def search_crunch(ctx: Context, **kwargs: Any) -> None:
     if locs_file:
         locs_file = click.format_filename(locs_file)
 
+    count = kwargs.pop("count")
+
     # Process inputs for crunch
     cruncher_names: Set[Any] = set(kwargs.pop("cruncher") or [])
     cruncher_args = kwargs.pop("cruncher_args")
@@ -361,10 +368,13 @@ def search_crunch(ctx: Context, **kwargs: Any) -> None:
         items_per_page = (
             DEFAULT_ITEMS_PER_PAGE if items_per_page is None else items_per_page
         )
-        results, total = gateway.search(
-            page=page, items_per_page=items_per_page, **criteria
+        results = gateway.search(
+            count=count, page=page, items_per_page=items_per_page, **criteria
         )
-        click.echo("Found a total number of {} products".format(total))
+        if results.number_matched is not None:
+            click.echo(
+                "Found a total number of {} products".format(results.number_matched)
+            )
     click.echo("Returned {} products".format(len(results)))
 
     # Crunch !
@@ -446,8 +456,6 @@ def list_pt(ctx: Context, **kwargs: Any) -> None:
                     provider=provider, fetch_providers=fetch_providers
                 )
                 if pt["ID"] in guessed_product_types
-                or "alias" in pt
-                and pt["alias"] in guessed_product_types
             ]
         else:
             product_types = dag.list_product_types(
@@ -546,12 +554,13 @@ def download(ctx: Context, **kwargs: Any) -> None:
 
         for idx, product in enumerate(search_results):
             if product.downloader is None:
+                downloader = satim_api._plugins_manager.get_download_plugin(product)
                 auth = product.downloader_auth
                 if auth is None:
-                    auth = satim_api._plugins_manager.get_auth_plugin(product.provider)
-                search_results[idx].register_downloader(
-                    satim_api._plugins_manager.get_download_plugin(product), auth
-                )
+                    auth = satim_api._plugins_manager.get_auth_plugin(
+                        downloader, product
+                    )
+                search_results[idx].register_downloader(downloader, auth)
 
             downloaded_file = product.get_quicklook()
             if not downloaded_file:
@@ -566,12 +575,13 @@ def download(ctx: Context, **kwargs: Any) -> None:
         # register downloader
         for idx, product in enumerate(search_results):
             if product.downloader is None:
+                downloader = satim_api._plugins_manager.get_download_plugin(product)
                 auth = product.downloader_auth
                 if auth is None:
-                    auth = satim_api._plugins_manager.get_auth_plugin(product.provider)
-                search_results[idx].register_downloader(
-                    satim_api._plugins_manager.get_download_plugin(product), auth
-                )
+                    auth = satim_api._plugins_manager.get_auth_plugin(
+                        downloader, product
+                    )
+                search_results[idx].register_downloader(downloader, auth)
 
         downloaded_files = satim_api.download_all(search_results)
         if downloaded_files and len(downloaded_files) > 0:
@@ -645,6 +655,13 @@ def serve_rest(
 ) -> None:
     """Serve EODAG functionalities through a WEB interface"""
     setup_logging(verbose=ctx.obj["verbosity"])
+    try:
+        import uvicorn
+    except ImportError:
+        raise ImportError(
+            "Feature not available, please install eodag[server] or eodag[all]"
+        )
+
     # Set the settings of the app
     # IMPORTANT: the order of imports counts here (first we override the settings,
     # then we import the app so that the updated settings is taken into account in
@@ -670,19 +687,32 @@ def serve_rest(
         else:
             sys.exit(0)
     else:
+        import logging
+
         logging_config = uvicorn.config.LOGGING_CONFIG
-        if debug:
-            logging_config["loggers"]["uvicorn"]["level"] = "DEBUG"
-            logging_config["loggers"]["uvicorn.error"]["level"] = "DEBUG"
-            logging_config["loggers"]["uvicorn.access"]["level"] = "DEBUG"
-            logging_config["formatters"]["default"][
-                "fmt"
-            ] = "%(asctime)-15s %(name)-32s [%(levelname)-8s] (%(module)-17s) %(message)s"
-            logging_config["loggers"]["eodag"] = {
-                "handlers": ["default"],
-                "level": "DEBUG" if debug else "INFO",
-                "propagate": False,
+        uvicorn_fmt = "%(asctime)-15s %(name)-32s [%(levelname)-8s] %(message)s"
+        logging_config["formatters"]["access"]["fmt"] = uvicorn_fmt
+        logging_config["formatters"]["default"]["fmt"] = uvicorn_fmt
+
+        eodag_formatter = logging.Formatter(
+            "%(asctime)-15s %(name)-32s [%(levelname)-8s] (tid=%(thread)d) %(message)s"
+        )
+        logging.getLogger("eodag").handlers[0].setFormatter(eodag_formatter)
+
+        if ctx.obj["verbosity"] <= 1:
+            logging_config["handlers"]["null"] = {
+                "level": "DEBUG",
+                "class": "logging.NullHandler",
             }
+            logging_config["loggers"]["uvicorn"]["handlers"] = ["null"]
+            logging_config["loggers"]["uvicorn.error"]["handlers"] = ["null"]
+            logging_config["loggers"]["uvicorn.access"]["handlers"] = ["null"]
+        else:
+            log_level = "INFO" if ctx.obj["verbosity"] == 2 else "DEBUG"
+            logging_config["loggers"]["uvicorn"]["level"] = log_level
+            logging_config["loggers"]["uvicorn.error"]["level"] = log_level
+            logging_config["loggers"]["uvicorn.access"]["level"] = log_level
+
         uvicorn.run(
             "eodag.rest.server:app",
             host=bind_host,