move Client-specific get_queryables implementation to Client class

Author: ircwaves

pystac_client/client.py

@@ -38,7 +38,7 @@
     QueryLike,
     SortbyLike,
 )
-from pystac_client.mixins import QueryablesMixin
+from pystac_client.mixins import QUERYABLES_ENDPOINT, QueryablesMixin
 from pystac_client.stac_api_io import StacApiIO, Timeout
 from pystac_client.warnings import DoesNotConformTo, FallbackToPystac, NoConformsTo
 
@@ -335,6 +335,47 @@ def _warn_about_fallback(self, *args: str) -> None:
             warnings.warn(DoesNotConformTo(*args), stacklevel=2)
         warnings.warn(FallbackToPystac(), stacklevel=2)
 
+    def get_merged_queryables(self, collections: List[str]) -> Dict[str, Any]:
+        """Return the set of queryables in common to the specified collections.
+
+        Queryables from multiple collections are unioned together, except in the case
+        when the same queryable key has a different definition, in which case that key
+        is dropped.
+
+        Output is a dictionary that can be used in ``jsonshema.validate``
+
+        Args:
+            collections List[str]: The IDs of the collections to inspect.
+
+        Return:
+            Dict[str, Any]: Dictionary containing queryable fields
+        """
+        if not collections:
+            raise ValueError("cannot get_merged_queryables from empty Iterable")
+
+        if not self.conforms_to(ConformanceClasses.FILTER):
+            raise DoesNotConformTo(ConformanceClasses.FILTER.name)
+        response = self.get_queryables_from(
+            self._get_collection_queryables_href(collections[0])
+        )
+        response.pop("$id")
+        addl_props = response.get("additionalProperties", False)
+        for collection in collections[1:]:
+            resp = self.get_queryables_from(
+                self._get_collection_queryables_href(collection)
+            )
+
+            # additionalProperties is false if any collection doesn't support queryables
+            addl_props &= resp.get("additionalProperties", False)
+
+            # drop queryables if their keys match, but the descriptions differ
+            for k in set(resp["properties"]).intersection(response["properties"]):
+                if resp["properties"][k] != response["properties"][k]:
+                    resp["properties"].pop(k)
+                    response["properties"].pop(k)
+            response["properties"].update(resp["properties"])
+        return response
+
     @lru_cache()
     def get_collection(self, collection_id: str) -> Union[Collection, CollectionClient]:
         """Get a single collection from this Catalog/API
@@ -598,3 +639,9 @@ def _collections_href(self, collection_id: Optional[str] = None) -> str:
         if collection_id is not None:
             return f"{href.rstrip('/')}/{collection_id}"
         return href
+
+    def _get_collection_queryables_href(
+        self, collection_id: Optional[str] = None
+    ) -> str:
+        href = self._collections_href(collection_id)
+        return f"{href.rstrip('/')}/{QUERYABLES_ENDPOINT}"

pystac_client/mixins.py

@@ -1,10 +1,10 @@
-from typing import Optional, Dict, Any, Union
 import warnings
+from typing import Any, Dict, Optional, Union
 
 import pystac
 
-from pystac_client.exceptions import APIError
 from pystac_client.conformance import ConformanceClasses
+from pystac_client.exceptions import APIError
 from pystac_client.stac_api_io import StacApiIO
 from pystac_client.warnings import DoesNotConformTo, MissingLink
 
@@ -32,34 +32,21 @@ def _get_href(self, rel: str, link: Optional[pystac.Link], endpoint: str) -> str
 class QueryablesMixin(BaseMixin):
     """Mixin for adding support for /queryables endpoint"""
 
-    def get_queryables(self, *collections: Optional[str]) -> Dict[str, Any]:
-        """Return all queryables, or limit to those of specified collections.
-        
-        Queryables from multiple collections are unioned together, except in the case when the same queryable key has a different definition, in which case that key is dropped.
+    def get_queryables_from(self, url: str) -> Dict[str, Any]:
+        """Return all queryables.
 
         Output is a dictionary that can be used in ``jsonshema.validate``
+
         Args:
-            *collections: The IDs of the items to include.
+            url: a queryables url
 
         Return:
             Dict[str, Any]: Dictionary containing queryable fields
         """
-        if collections and isinstance(self, pystac.Catalog):
-            response = self.get_collection(collections[0]).get_queryables()
-            response.pop("$id")
-            for collection in collections[1:]:
-                col_resp = self.get_collection(collection).get_queryables()
-                response["properties"].update(col_resp["properties"])
-            return response
 
         if self._stac_io is None:
             raise APIError("API access is not properly configured")
 
-        if not self.conforms_to(ConformanceClasses.FILTER):
-            raise DoesNotConformTo(ConformanceClasses.FILTER.name)
-
-        url = self._get_queryables_href()
-
         result = self._stac_io.read_json(url)
         if "properties" not in result:
             raise APIError(
@@ -69,7 +56,14 @@ def get_queryables(self, *collections: Optional[str]) -> Dict[str, Any]:
 
         return result
 
+    def get_queryables(self) -> Dict[str, Any]:
+        url = self._get_queryables_href()
+        return self.get_queryables_from(url)
+
     def _get_queryables_href(self) -> str:
+        if not self.conforms_to(ConformanceClasses.FILTER):
+            raise DoesNotConformTo(ConformanceClasses.FILTER.name)
+
         link = self.get_single_link(QUERYABLES_REL)
         href = self._get_href(QUERYABLES_REL, link, QUERYABLES_ENDPOINT)
         return href

tests/test_client.py

@@ -10,8 +10,6 @@
 import pytest
 from dateutil.tz import tzutc
 from pystac import MediaType
-from requests_mock import Mocker
-
 from pystac_client import Client, CollectionClient
 from pystac_client._utils import Modifiable
 from pystac_client.conformance import ConformanceClasses
@@ -25,6 +23,7 @@
     NoConformsTo,
     strict,
 )
+from requests_mock import Mocker
 
 from .helpers import STAC_URLS, TEST_DATA, read_data_file
 
@@ -587,11 +586,13 @@ def test_get_queryables(self) -> None:
     def test_get_queryables_collections(self) -> None:
         api = Client.open(STAC_URLS["PLANETARY-COMPUTER"])
         with pytest.warns(MissingLink, match="queryables"):
-            tdep_seamless_props = api.get_collection("3dep-seamless").get_queryables()[
-                "properties"
-            ]
-            fia_props = api.get_collection("fia").get_queryables()["properties"]
-            result = api.get_queryables("fia", "3dep-seamless")
+            col = api.get_collection("3dep-seamless")
+            assert isinstance(col, CollectionClient)
+            tdep_seamless_props = col.get_queryables()["properties"]
+            col = api.get_collection("fia")
+            assert isinstance(col, CollectionClient)
+            fia_props = col.get_queryables()["properties"]
+            result = api.get_merged_queryables(["fia", "3dep-seamless"])
         assert "properties" in result
         assert "id" in result["properties"]
         assert set(fia_props.keys()).issubset(result["properties"])
@@ -607,14 +608,17 @@ def test_get_queryables_errors(self, requests_mock: Mocker) -> None:
 
         assert api._stac_io is not None
         api.add_conforms_to("FILTER")
+        self_href = api.get_self_href()
         api.set_self_href(None)
         with pytest.warns(MissingLink, match="queryables"):
             with pytest.raises(ValueError, match="does not have a self_href set"):
                 api.get_queryables()
 
+        api.set_self_href(self_href)
         api._stac_io = None
-        with pytest.raises(APIError, match="API access is not properly configured"):
-            api.get_queryables()
+        with pytest.warns(MissingLink, match="queryables"):
+            with pytest.raises(APIError, match="API access is not properly configured"):
+                api.get_queryables()
 
 
 class TestConformsTo: