1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
|
import operator
import urllib.parse
from datetime import datetime, timedelta
from typing import Any
import pystac
import pytest
import requests
from dateutil.tz import tzutc
from pytest_benchmark.fixture import BenchmarkFixture
from requests_mock import Mocker
from pystac_client import Client
from pystac_client.item_search import ItemSearch
from .helpers import STAC_URLS, read_data_file
SEARCH_URL = f"{STAC_URLS['PLANETARY-COMPUTER']}/search"
INTERSECTS_EXAMPLE = {
"type": "Polygon",
"coordinates": [
[
[-73.21, 43.99],
[-73.21, 44.05],
[-73.12, 44.05],
[-73.12, 43.99],
[-73.21, 43.99],
]
],
}
ITEM_EXAMPLE: dict[str, Any] = {"collections": "io-lulc", "ids": "60U-2020"}
class TestItemPerformance:
@pytest.fixture(scope="function")
def single_href(self) -> str:
item_href = (
"https://planetarycomputer.microsoft.com/api/stac/v1/collections/"
f"{ITEM_EXAMPLE['collections']}/items/{ITEM_EXAMPLE['ids']}"
)
return item_href
def test_requests(self, benchmark: BenchmarkFixture, single_href: str) -> None:
response = benchmark(requests.get, single_href)
assert response.status_code == 200
assert response.json()["id"] == ITEM_EXAMPLE["ids"]
def test_single_item(self, benchmark: BenchmarkFixture, single_href: str) -> None:
item = benchmark(pystac.Item.from_file, single_href)
assert item.id == ITEM_EXAMPLE["ids"]
def test_single_item_search(
self, benchmark: BenchmarkFixture, single_href: str
) -> None:
search = ItemSearch(url=SEARCH_URL, **ITEM_EXAMPLE)
item_collection = benchmark(search.item_collection())
assert len(item_collection.items) == 1
assert item_collection.items[0].id == ITEM_EXAMPLE["ids"]
class TestItemSearch:
@pytest.fixture(scope="function")
def astraea_api(self) -> Client:
api_content = read_data_file("astraea_api.json", parse_json=True)
return Client.from_dict(api_content)
def test_method(self) -> None:
# Default method should be POST...
search = ItemSearch(url=SEARCH_URL)
assert search.method == "POST"
# "method" argument should take precedence over presence of "intersects"
search = ItemSearch(url=SEARCH_URL, method="GET", intersects=INTERSECTS_EXAMPLE)
assert search.method == "GET"
def test_method_params(self) -> None:
params_in: dict[str, Any] = {
"bbox": (-72, 41, -71, 42),
"ids": (
"idone",
"idtwo",
),
"collections": ("collectionone",),
"intersects": INTERSECTS_EXAMPLE,
}
# For POST this is pass through
search = ItemSearch(url=SEARCH_URL, **params_in)
params = search.get_parameters()
assert params == search.get_parameters()
# For GET requests, parameters are in query string and must be serialized
search = ItemSearch(url=SEARCH_URL, method="GET", **params_in)
params = search.get_parameters()
assert all(key in params for key in params_in)
assert all(isinstance(params[key], str) for key in params_in)
@pytest.mark.vcr
def test_results(self) -> None:
search = ItemSearch(
url=SEARCH_URL,
collections="naip",
max_items=20,
limit=10,
)
results = search.items()
assert all(isinstance(item, pystac.Item) for item in results)
@pytest.mark.vcr
def test_ids_results(self) -> None:
ids = [
"S2B_MSIL2A_20210610T115639_N0212_R066_T33XXG_20210613T185024.SAFE",
"fl_m_2608004_nw_17_060_20191215_20200113",
]
search = ItemSearch(
url=SEARCH_URL,
collections=["naip"],
ids=ids,
)
results = list(search.items())
assert len(results) == 1
assert all(item.id in ids for item in results)
@pytest.mark.vcr
def test_datetime_results(self) -> None:
min_datetime = datetime(2019, 1, 1, 0, 0, 1, tzinfo=tzutc())
max_datetime = datetime(2019, 1, 1, 0, 0, 10, tzinfo=tzutc())
datetime_ = "2019-01-01T00:00:01Z/2019-01-01T00:00:10Z"
search = ItemSearch(url=SEARCH_URL, datetime=datetime_, max_items=20)
for item in search.items():
assert item.datetime is not None
assert (
min_datetime <= item.datetime <= (max_datetime + timedelta(seconds=1))
)
search = ItemSearch(
url=SEARCH_URL, datetime=(min_datetime, max_datetime), max_items=20
)
new_results = search.items()
for item in new_results:
assert item.datetime is not None
assert (
min_datetime <= item.datetime <= (max_datetime + timedelta(seconds=1))
)
@pytest.mark.vcr
def test_intersects_results(self) -> None:
# GeoJSON-like dict
intersects_dict = {
"type": "Polygon",
"coordinates": [
[
[-73.21, 43.99],
[-73.21, 44.05],
[-73.12, 44.05],
[-73.12, 43.99],
[-73.21, 43.99],
]
],
}
search = ItemSearch(
url=SEARCH_URL, intersects=intersects_dict, collections="naip"
)
results = list(search.items())
assert len(results) == 42
# Geo-interface object
class MockGeoObject:
@property
def __geo_interface__(self) -> dict[str, Any]:
return intersects_dict
intersects_obj = MockGeoObject()
search = ItemSearch(
url=SEARCH_URL, intersects=intersects_obj, collections="naip"
)
new_results = search.items()
assert all(isinstance(item, pystac.Item) for item in new_results)
def test_get_with_query(self, requests_mock: Mocker) -> None:
requests_mock.get(
(
f"{SEARCH_URL}?query=%7B%22eo%3Acloud_cover%22%3A%7B%22gte%22%3A0%2C%22lte%22%3A10%7D%7D"
),
status_code=200,
json={"features": [{"foo": "bar"}], "links": []},
)
items = list(
ItemSearch(
url=SEARCH_URL,
method="GET",
query={"eo:cloud_cover": {"gte": 0, "lte": 10}},
).items_as_dicts()
)
assert len(items) == 1
@pytest.mark.vcr
def test_result_paging(self) -> None:
search = ItemSearch(
url=SEARCH_URL,
bbox=(-73.21, 43.99, -73.12, 44.05),
collections="naip",
limit=10,
max_items=20,
)
# Check that the current page changes on the ItemSearch instance when a new page
# is requested
pages = list(search.pages())
assert pages[0] != pages[1]
assert pages[0].items != pages[1].items
@pytest.mark.vcr
def test_result_paging_max_items(self) -> None:
search = ItemSearch(
url=SEARCH_URL,
collections="naip",
limit=10,
max_items=25,
)
num_pages = 0
items = list()
for page in search.pages_as_dicts():
num_pages += 1
items.extend(page["features"])
assert num_pages == 3
assert len(items) == 25
@pytest.mark.vcr
def test_item_collection(self) -> None:
search = ItemSearch(
url=SEARCH_URL,
bbox=(-73.21, 43.99, -73.12, 44.05),
collections="naip",
limit=10,
max_items=20,
)
item_collection = search.item_collection()
assert isinstance(item_collection, pystac.ItemCollection)
assert len(item_collection) == 20
@pytest.mark.vcr
@pytest.mark.parametrize(
"method, alternative, is_sequence, is_pystac",
[
("get_item_collections", "pages", True, True),
("item_collections", "pages", True, True),
("get_items", "items", True, True),
("get_all_items", "item_collection", False, True),
("get_all_items_as_dict", "item_collection_as_dict", False, False),
],
)
def test_deprecations(
self, method: str, alternative: str, is_sequence: bool, is_pystac: bool
) -> None:
search = ItemSearch(
url=SEARCH_URL,
bbox=(-73.21, 43.99, -73.12, 44.05),
collections="naip",
limit=10,
max_items=20,
)
with pytest.warns(FutureWarning, match=method):
result = operator.methodcaller(method)(search)
expected = operator.methodcaller(alternative)(search)
if is_sequence:
result = list(result)
expected = list(expected)
if is_pystac:
result = [x.to_dict() for x in result]
expected = [x.to_dict() for x in expected]
else:
if is_pystac:
result = result.to_dict()
expected = expected.to_dict()
assert result == expected
@pytest.mark.vcr
def test_items_as_dicts(self) -> None:
search = ItemSearch(
url=SEARCH_URL,
bbox=(-73.21, 43.99, -73.12, 44.05),
collections="naip",
limit=10,
max_items=20,
)
assert len(list(search.items_as_dicts())) == 20
class TestItemSearchQuery:
@pytest.mark.vcr
def test_query_shortcut_syntax(self) -> None:
search = ItemSearch(
url=SEARCH_URL,
collections="naip",
bbox=(-73.21, 43.99, -73.12, 44.05),
query=["gsd=0.6"],
max_items=1,
)
items1 = list(search.items())
search = ItemSearch(
url=SEARCH_URL,
collections="naip",
bbox=(-73.21, 43.99, -73.12, 44.05),
query={"gsd": {"eq": 0.6}},
max_items=1,
)
items2 = list(search.items())
assert len(items1) == 1
assert len(items2) == 1
assert items1[0].id == items2[0].id
@pytest.mark.vcr
def test_query_json_syntax(self) -> None:
# with a list of json strs (format of CLI argument to ItemSearch)
search = ItemSearch(
url=SEARCH_URL,
collections="naip",
bbox=(-73.21, 43.99, -73.12, 44.05),
query=['{"gsd": { "gte": 0, "lte": 1 }}'],
max_items=1,
)
item1 = list(search.items())[0]
assert item1.properties["gsd"] <= 1
# with a single dict
search = ItemSearch(
url=SEARCH_URL,
collections="naip",
bbox=(-73.21, 43.99, -73.12, 44.05),
query={"gsd": {"gte": 0, "lte": 1}},
max_items=1,
)
item2 = list(search.items())[0]
assert item2.properties["gsd"] <= 1
assert item1.id == item2.id
def test_query_json_syntax() -> None:
item_search = ItemSearch("")
assert item_search._format_query(
['{"eo:cloud_cover": { "gte": 0, "lte": 1 }}']
) == {"eo:cloud_cover": {"gte": 0, "lte": 1}}
assert item_search._format_query({"eo:cloud_cover": {"gte": 0, "lte": 1}}) == {
"eo:cloud_cover": {"gte": 0, "lte": 1}
}
assert item_search._format_query(["eo:cloud_cover<=1"]) == {
"eo:cloud_cover": {"lte": "1"}
}
assert item_search._format_query(["eo:cloud_cover<=1", "eo:cloud_cover>0"]) == {
"eo:cloud_cover": {"lte": "1", "gt": "0"}
}
def test_url_with_query_parameter() -> None:
# https://github.com/stac-utils/pystac-client/issues/522
search = ItemSearch(
url="http://pystac-client.test", query={"eo:cloud_cover": {"lt": 42}}
)
url = urllib.parse.urlparse(search.url_with_parameters())
query = urllib.parse.parse_qs(url.query)
assert query["query"] == [r'{"eo:cloud_cover":{"lt":42}}']
@pytest.mark.vcr
def test_multiple_collections() -> None:
search = ItemSearch(
url="https://earth-search.aws.element84.com/v1/search",
collections=["sentinel-2-l2a", "landsat-c2-l2"],
intersects={"type": "Point", "coordinates": [-105.1019, 40.1672]},
datetime="2023-10-08",
)
collections = {item.collection_id for item in search.items()}
assert collections == {"sentinel-2-l2a", "landsat-c2-l2"}
def test_naive_datetime() -> None:
search = ItemSearch(
url="https://earth-search.aws.element84.com/v1/search",
datetime=datetime(2024, 5, 14, 4, 25, 42, tzinfo=None),
method="POST",
)
assert search.get_parameters()["datetime"] == "2024-05-14T04:25:42Z"
@pytest.mark.vcr
def test_fields() -> None:
search = ItemSearch(
url="https://earth-search.aws.element84.com/v1/search",
collections=["sentinel-2-c1-l2a"],
intersects={"type": "Point", "coordinates": [-105.1019, 40.1672]},
max_items=1,
fields=["-geometry", "-assets", "-links"],
)
item = next(search.items_as_dicts())
assert "geometry" not in item
assert "assets" not in item
assert "links" not in item
def test_feature() -> None:
search = ItemSearch(
url="https://earth-search.aws.element84.com/v1/search",
intersects={
"type": "Feature",
"geometry": {"type": "Point", "coordinates": [-105.1019, 40.1672]},
},
)
assert search.get_parameters()["intersects"] == {
"type": "Point",
"coordinates": [-105.1019, 40.1672],
}
|