fix: add and edit comments, error messages and docstrings

Author: anesson-cs

eodag/api/product/metadata_mapping.py

@@ -1284,6 +1284,11 @@ def format_query_params(
         config.metadata_mapping,
         **config.products.get(product_type, {}).get("metadata_mapping", {}),
     )
+    # Initialize the configuration parameter which indicates if an error must be raised while there is a search
+    # parameter which is not queryable. It is useful when the provider does not return any result if the search
+    # parameter is not a queryable without raising an error by itself.
+    # This parameter is set to False by default and the configuration at product type level has priority over the
+    # one at provider level
     raise_mtd_discovery_error = (
         getattr(config, "discover_metadata", {})
         .get("search_param", {})
@@ -1457,10 +1462,11 @@ def _get_queryables(
     for eodag_search_key, user_input in search_params.items():
         if user_input is not None:
             md_mapping = metadata_mapping.get(eodag_search_key, (None, NOT_MAPPED))
-            # raise an eodag error if the provider prevent from having result with a metadata
-            # which is not supposed to be a queryable without raising an error by itself
+            # raise an error when a query param not allowed by the provider is found
             if not isinstance(md_mapping, list) and raise_mtd_discovery_error:
-                raise ValidationError("Unknown parameters not allowed")
+                raise ValidationError(
+                    f"Search parameters which are not queryable are disallowed: {eodag_search_key}"
+                )
             _, md_value = md_mapping
             # query param from defined metadata_mapping
             if md_mapping is not None and isinstance(md_mapping, list):

eodag/config.py

@@ -255,8 +255,8 @@ class DiscoverMetadata(TypedDict):
         auto_discovery: bool
         #: Metadata regex pattern used for discovery in search result properties
         metadata_pattern: str
-        #: Configuration/template that will be used to query for a discovered parameter,
-        #: or indication whether metadata discovery may fail the search request or not
+        #: Configuration/template that will be used to query for a discovered parameter, or indication if
+        #: using a search parameter which is not queryable will fail the search request or not
         search_param: str | dict[str, Any]
         #: Path to the metadata in search result
         metadata_path: str

eodag/plugins/search/data_request_search.py

@@ -32,6 +32,7 @@
 )
 from eodag.plugins.search import PreparedSearch
 from eodag.plugins.search.base import Search
+from eodag.types.queryables import Queryables
 from eodag.utils import (
     DEFAULT_ITEMS_PER_PAGE,
     DEFAULT_MISSION_START_DATE,
@@ -363,9 +364,13 @@ def _create_data_request(
                 request_body = format_query_params(
                     eodag_product_type, self.config, kwargs
                 )
-            except ValidationError:
+            except ValidationError as context:
+                not_queryable_search_param = Queryables.get_queryable_from_alias(
+                    str(context.message).split(":")[-1].strip()
+                )
                 raise ValidationError(
-                    f"Unknown parameters not allowed for {self.provider} with {product_type}"
+                    f"Search parameters which are not queryable are disallowed for {product_type} with "
+                    f"{self.provider}: please remove '{not_queryable_search_param}' from your search parameters"
                 )
             logger.debug(
                 f"Sending search job request to {url} with {str(request_body)}"

eodag/plugins/search/qssearch.py

@@ -71,6 +71,7 @@
 from eodag.plugins.search import PreparedSearch
 from eodag.plugins.search.base import Search
 from eodag.types import json_field_definition_to_python, model_fields_to_annotated
+from eodag.types.queryables import Queryables
 from eodag.types.search_args import SortByList
 from eodag.utils import (
     DEFAULT_MISSION_START_DATE,
@@ -533,7 +534,7 @@ def discover_product_types_per_page(
 
             prep.info_message = "Fetching product types: {}".format(prep.url)
             prep.exception_message = (
-                "Skipping error while fetching product types for " "{} {} instance:"
+                "Skipping error while fetching product types for {} {} instance:"
             ).format(self.provider, self.__class__.__name__)
 
             # Query using appropriate method
@@ -815,9 +816,13 @@ def build_query_string(
         logger.debug("Building the query string that will be used for search")
         try:
             query_params = format_query_params(product_type, self.config, kwargs)
-        except ValidationError:
+        except ValidationError as context:
+            not_queryable_search_param = Queryables.get_queryable_from_alias(
+                str(context.message).split(":")[-1].strip()
+            )
             raise ValidationError(
-                f"Unknown parameters not allowed for {self.provider} with {product_type}"
+                f"Search parameters which are not queryable are disallowed for {product_type} with "
+                f"{self.provider}: please remove '{not_queryable_search_param}' from your search parameters"
             )
 
         # Build the final query string, in one go without quoting it
@@ -1865,9 +1870,13 @@ def build_query_string(
 
         try:
             query_params = format_query_params(product_type, self.config, kwargs)
-        except ValidationError:
+        except ValidationError as context:
+            not_queryable_search_param = Queryables.get_queryable_from_alias(
+                str(context.message).split(":")[-1].strip()
+            )
             raise ValidationError(
-                f"Unknown parameters not allowed for {self.provider} with {product_type}"
+                f"Search parameters which are not queryable are disallowed for {product_type} with "
+                f"{self.provider}: please remove '{not_queryable_search_param}' from your search parameters"
             )
 
         # Build the final query string, in one go without quoting it

tests/units/test_search_plugins.py

@@ -401,7 +401,8 @@ def test_plugins_search_querystringsearch_search_cloudcover_peps(
         self.assertNotIn("cloudCover", mock__request.call_args_list[-1][0][1].url)
 
     def test_plugins_search_querystringsearch_search_peps_ko(self):
-        """A query with an unknown parameter must raise an error if the provider does not allow it"""  # noqa
+        """A query with a parameter which is not queryable must
+        raise an error if the provider does not allow it"""  # noqa
         # with raising error parameter in the global config of the provider
         provider_search_plugin_config = deepcopy(self.peps_search_plugin.config)
         self.peps_search_plugin.config.discover_metadata = {
@@ -418,8 +419,9 @@ def test_plugins_search_querystringsearch_search_peps_ko(self):
                 **{**self.search_criteria_s2_msi_l1c, **{"foo": "bar"}},
             )
         self.assertEqual(
-            f"Unknown parameters not allowed for {self.peps_search_plugin.provider} "
-            f"with {self.search_criteria_s2_msi_l1c['productType']}",
+            "Search parameters which are not queryable are disallowed for "
+            f"{self.search_criteria_s2_msi_l1c['productType']} with {self.peps_search_plugin.provider}: "
+            "please remove 'foo' from your search parameters",
             str(context.exception),
         )
 
@@ -446,8 +448,9 @@ def test_plugins_search_querystringsearch_search_peps_ko(self):
                 **{**self.search_criteria_s2_msi_l1c, **{"foo": "bar"}},
             )
         self.assertEqual(
-            f"Unknown parameters not allowed for {self.peps_search_plugin.provider} "
-            f"with {self.search_criteria_s2_msi_l1c['productType']}",
+            "Search parameters which are not queryable are disallowed for "
+            f"{self.search_criteria_s2_msi_l1c['productType']} with {self.peps_search_plugin.provider}: "
+            "please remove 'foo' from your search parameters",
             str(context.exception),
         )
 
@@ -3299,7 +3302,8 @@ def test_plugins_search_postjsonsearchwithstacqueryables_search_wekeomain(
         mock_build_qs_stacsearch.assert_not_called()
 
     def test_plugins_search_postjsonsearchwithstacqueryables_search_wekeomain_ko(self):
-        """A query with an unknown parameter must raise an error if the provider does not allow it"""  # noqa
+        """A query with a parameter which is not queryable must
+        raise an error if the provider does not allow it"""  # noqa
         # with raising error parameter in the global config of the provider
         provider_search_plugin_config = deepcopy(self.wekeomain_search_plugin.config)
         self.wekeomain_search_plugin.config.discover_metadata = {
@@ -3316,8 +3320,9 @@ def test_plugins_search_postjsonsearchwithstacqueryables_search_wekeomain_ko(sel
                 **{**self.search_criteria_s2_msi_l1c, **{"foo": "bar"}},
             )
         self.assertEqual(
-            f"Unknown parameters not allowed for {self.wekeomain_search_plugin.provider} "
-            f"with {self.search_criteria_s2_msi_l1c['productType']}",
+            "Search parameters which are not queryable are disallowed for "
+            f"{self.search_criteria_s2_msi_l1c['productType']} with {self.wekeomain_search_plugin.provider}: "
+            "please remove 'foo' from your search parameters",
             str(context.exception),
         )
 
@@ -3344,8 +3349,9 @@ def test_plugins_search_postjsonsearchwithstacqueryables_search_wekeomain_ko(sel
                 **{**self.search_criteria_s2_msi_l1c, **{"foo": "bar"}},
             )
         self.assertEqual(
-            f"Unknown parameters not allowed for {self.wekeomain_search_plugin.provider} "
-            f"with {self.search_criteria_s2_msi_l1c['productType']}",
+            "Search parameters which are not queryable are disallowed for "
+            f"{self.search_criteria_s2_msi_l1c['productType']} with {self.wekeomain_search_plugin.provider}: "
+            "please remove 'foo' from your search parameters",
             str(context.exception),
         )