fix: query in get requests

Author: gadomski

pystac_client/item_search.py

@@ -329,6 +329,8 @@ def _clean_params_for_get_request(self) -> Dict[str, Any]:
             params["collections"] = ",".join(params["collections"])
         if "intersects" in params:
             params["intersects"] = json.dumps(params["intersects"])
+        if "query" in params:
+            params["query"] = json.dumps(params["query"], separators=(",", ":"))
         if "sortby" in params:
             params["sortby"] = self._sortby_dict_to_str(params["sortby"])
         if "fields" in params:

pystac_client/stac_api_io.py

@@ -3,7 +3,7 @@
 import re
 from copy import deepcopy
 from typing import TYPE_CHECKING, Any, Callable, Dict, Iterator, List, Optional, Union
-from urllib.parse import urlparse
+from urllib.parse import quote_plus, urlparse
 
 import pystac
 from pystac.link import Link
@@ -156,6 +156,8 @@ def request(
             params = deepcopy(parameters) or {}
             if "intersects" in params:
                 params["intersects"] = json.dumps(params["intersects"])
+            if "query" in params:
+                params["query"] = quote_plus(params["query"])
             request = Request(method="GET", url=href, headers=headers, params=params)
         try:
             modified = self._req_modifier(request) if self._req_modifier else None

tests/cassettes/test_item_search/TestItemSearch.test_get_with_query.yaml

@@ -0,0 +1,39 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      User-Agent:
+      - python-requests/2.28.1
+    method: GET
+    uri: https://planetarycomputer.microsoft.com/api/stac/v1/search?limit=1&query=%257B%2522eo%253Acloud_cover%2522%253A%257B%2522gte%2522%253A0%252C%2522lte%2522%253A10%257D%257D
+  response:
+    body:
+      string: '{"code":"JSONDecodeError","description":"expected value at line 1 column
+        1: line 1 column 1 (char 0)"}'
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - '*'
+      Content-Length:
+      - '102'
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 28 Nov 2022 21:53:33 GMT
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains
+      X-Azure-Ref:
+      - 03S2FYwAAAABLnSOpJunVSqWWSDOh2Pv9REVOMzAxMDAwMTEwMDExADkyN2FiZmE2LTE5ZjYtNGFmMS1hMDlkLWM5NTlkOWExZTY0NA==
+      X-Cache:
+      - CONFIG_NOCACHE
+    status:
+      code: 500
+      message: Internal Server Error
+version: 1

tests/test_item_search.py

@@ -619,6 +619,19 @@ def __geo_interface__(self) -> Dict[str, Any]:
         new_results = search.items()
         assert all(isinstance(item, pystac.Item) for item in new_results)
 
+    @pytest.mark.vcr
+    def test_get_with_query(self) -> None:
+        items = list(
+            ItemSearch(
+                url=SEARCH_URL,
+                method="GET",
+                query={"eo:cloud_cover": {"gte": 0, "lte": 10}},
+                limit=1,
+                max_items=1,
+            ).items()
+        )
+        assert len(items) == 1
+
     @pytest.mark.vcr
     def test_result_paging(self) -> None:
         search = ItemSearch(