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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
|
import json
from collections.abc import Iterator
from datetime import datetime
from typing import Any
import pytest
from dateutil.tz import gettz, tzutc
from pystac_client import Client
from pystac_client.item_search import BaseSearch
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 TestBaseSearchParams:
@pytest.fixture(scope="function")
def sample_client(self) -> Client:
api_content = read_data_file("planetary-computer-root.json", parse_json=True)
return Client.from_dict(api_content)
def test_tuple_bbox(self) -> None:
# Tuple input
search = BaseSearch(url=SEARCH_URL, bbox=(-104.5, 44.0, -104.0, 45.0))
assert search.get_parameters()["bbox"] == (-104.5, 44.0, -104.0, 45.0)
def test_list_bbox(self) -> None:
# List input
search = BaseSearch(url=SEARCH_URL, bbox=[-104.5, 44.0, -104.0, 45.0])
assert search.get_parameters()["bbox"] == (-104.5, 44.0, -104.0, 45.0)
def test_string_bbox(self) -> None:
# String Input
search = BaseSearch(url=SEARCH_URL, bbox="-104.5,44.0,-104.0,45.0")
assert search.get_parameters()["bbox"] == (-104.5, 44.0, -104.0, 45.0)
def test_generator_bbox(self) -> None:
# Generator Input
def bboxer() -> Iterator[float]:
yield from [-104.5, 44.0, -104.0, 45.0]
search = BaseSearch(url=SEARCH_URL, bbox=bboxer())
assert search.get_parameters()["bbox"] == (-104.5, 44.0, -104.0, 45.0)
def test_url_with_parameters(self) -> None:
# Single timestamp input
search = BaseSearch(
url=SEARCH_URL,
datetime="2020-02-01T00:00:00Z",
bbox=[-104.5, 44.0, -104.0, 45.0],
)
assert "bbox=-104.5%2C44.0%2C-104.0%2C45.0" in search.url_with_parameters()
# Motivating example: https://github.com/stac-utils/pystac-client/issues/299
search = BaseSearch(
url="https://planetarycomputer.microsoft.com/api/stac/v1/search",
collections=["cop-dem-glo-30"],
bbox=[88.214, 27.927, 88.302, 28.034],
)
assert (
search.url_with_parameters()
== "https://planetarycomputer.microsoft.com/api/stac/v1/search?"
"bbox=88.214%2C27.927%2C88.302%2C28.034&collections=cop-dem-glo-30"
)
def test_single_string_datetime(self) -> None:
# Single timestamp input
search = BaseSearch(url=SEARCH_URL, datetime="2020-02-01T00:00:00Z")
assert search.get_parameters()["datetime"] == "2020-02-01T00:00:00Z"
def test_range_string_datetime(self) -> None:
# Timestamp range input
search = BaseSearch(
url=SEARCH_URL, datetime="2020-02-01T00:00:00Z/2020-02-02T00:00:00Z"
)
assert (
search.get_parameters()["datetime"]
== "2020-02-01T00:00:00Z/2020-02-02T00:00:00Z"
)
def test_list_of_strings_datetime(self) -> None:
# Timestamp list input
search = BaseSearch(
url=SEARCH_URL, datetime=["2020-02-01T00:00:00Z", "2020-02-02T00:00:00Z"]
)
assert (
search.get_parameters()["datetime"]
== "2020-02-01T00:00:00Z/2020-02-02T00:00:00Z"
)
def test_open_range_string_datetime(self) -> None:
# Open timestamp range input
search = BaseSearch(url=SEARCH_URL, datetime="2020-02-01T00:00:00Z/..")
assert search.get_parameters()["datetime"] == "2020-02-01T00:00:00Z/.."
def test_single_datetime_object(self) -> None:
start = datetime(2020, 2, 1, 0, 0, 0, tzinfo=tzutc())
# Single datetime input
search = BaseSearch(url=SEARCH_URL, datetime=start)
assert search.get_parameters()["datetime"] == "2020-02-01T00:00:00Z"
def test_list_of_datetimes(self) -> None:
start = datetime(2020, 2, 1, 0, 0, 0, tzinfo=tzutc())
end = datetime(2020, 2, 2, 0, 0, 0, tzinfo=tzutc())
# Datetime range input
search = BaseSearch(url=SEARCH_URL, datetime=[start, end])
assert (
search.get_parameters()["datetime"]
== "2020-02-01T00:00:00Z/2020-02-02T00:00:00Z"
)
def test_open_list_of_datetimes(self) -> None:
start = datetime(2020, 2, 1, 0, 0, 0, tzinfo=tzutc())
# Open datetime range input
search = BaseSearch(url=SEARCH_URL, datetime=(start, None))
assert search.get_parameters()["datetime"] == "2020-02-01T00:00:00Z/.."
def test_localized_datetime_converted_to_utc(self) -> None:
# Localized datetime input (should be converted to UTC)
start_localized = datetime(2020, 2, 1, 0, 0, 0, tzinfo=gettz("US/Eastern"))
search = BaseSearch(url=SEARCH_URL, datetime=start_localized)
assert search.get_parameters()["datetime"] == "2020-02-01T05:00:00Z"
def test_single_year(self) -> None:
search = BaseSearch(url=SEARCH_URL, datetime="2020")
assert (
search.get_parameters()["datetime"]
== "2020-01-01T00:00:00Z/2020-12-31T23:59:59Z"
)
def test_range_of_years(self) -> None:
search = BaseSearch(url=SEARCH_URL, datetime="2019/2020")
assert (
search.get_parameters()["datetime"]
== "2019-01-01T00:00:00Z/2020-12-31T23:59:59Z"
)
def test_single_month(self) -> None:
search = BaseSearch(url=SEARCH_URL, datetime="2020-06")
assert (
search.get_parameters()["datetime"]
== "2020-06-01T00:00:00Z/2020-06-30T23:59:59Z"
)
def test_range_of_months(self) -> None:
search = BaseSearch(url=SEARCH_URL, datetime="2020-04/2020-06")
assert (
search.get_parameters()["datetime"]
== "2020-04-01T00:00:00Z/2020-06-30T23:59:59Z"
)
def test_single_date(self) -> None:
search = BaseSearch(url=SEARCH_URL, datetime="2020-06-10")
assert (
search.get_parameters()["datetime"]
== "2020-06-10T00:00:00Z/2020-06-10T23:59:59Z"
)
def test_range_of_dates(self) -> None:
search = BaseSearch(url=SEARCH_URL, datetime="2020-06-10/2020-06-20")
assert (
search.get_parameters()["datetime"]
== "2020-06-10T00:00:00Z/2020-06-20T23:59:59Z"
)
def test_mixed_simple_date_strings(self) -> None:
search = BaseSearch(url=SEARCH_URL, datetime="2019/2020-06-10")
assert (
search.get_parameters()["datetime"]
== "2019-01-01T00:00:00Z/2020-06-10T23:59:59Z"
)
def test_time(self) -> None:
search = BaseSearch(
url=SEARCH_URL, datetime="2019-01-01T00:00:00Z/2019-01-01T00:12:00"
)
assert (
search.get_parameters()["datetime"]
== "2019-01-01T00:00:00Z/2019-01-01T00:12:00Z"
)
def test_many_datetimes(self) -> None:
datetimes = [
"1985-04-12T23:20:50.52Z",
"1996-12-19T16:39:57-08:00",
"1990-12-31T23:59:60Z",
"1990-12-31T15:59:60-08:00",
"1937-01-01T12:00:27.87+01:00",
"1985-04-12T23:20:50.52Z",
"1937-01-01T12:00:27.8710+01:00",
"1937-01-01T12:00:27.8+01:00",
"1937-01-01T12:00:27.8Z",
"1985-04-12t23:20:50.5202020z",
"2020-07-23T00:00:00Z",
"2020-07-23T00:00:00.0Z",
"2020-07-23T00:00:00.01Z",
"2020-07-23T00:00:00.012Z",
"2020-07-23T00:00:00.0123Z",
"2020-07-23T00:00:00.01234Z",
"2020-07-23T00:00:00.012345Z",
"2020-07-23T00:00:00.000Z",
"2020-07-23T00:00:00.000+03:00",
"2020-07-23T00:00:00+03:00",
"2020-07-23T00:00:00.000+03:00",
"2020-07-23T00:00:00.000z",
"/2023-01-01T00:00:00Z",
"2023-01-01T00:00:00Z/",
]
for date_time in datetimes:
BaseSearch(url=SEARCH_URL, datetime=date_time)
def test_three_datetimes(self) -> None:
start = datetime(2020, 2, 1, 0, 0, 0, tzinfo=tzutc())
middle = datetime(2020, 2, 2, 0, 0, 0, tzinfo=tzutc())
end = datetime(2020, 2, 3, 0, 0, 0, tzinfo=tzutc())
with pytest.raises(Exception):
BaseSearch(url=SEARCH_URL, datetime=[start, middle, end])
def test_double_open_ended_interval(self) -> None:
with pytest.raises(Exception):
BaseSearch(url=SEARCH_URL, datetime=[None, None])
def test_datetime_list_of_one_none(self) -> None:
with pytest.raises(Exception):
BaseSearch(url=SEARCH_URL, datetime=[None])
def test_poorly_formed_datetimes(self) -> None:
with pytest.raises(Exception):
BaseSearch(url=SEARCH_URL, datetime="2020-7/2020-8")
def test_single_collection_string(self) -> None:
# Single ID string
search = BaseSearch(url=SEARCH_URL, collections="naip")
assert search.get_parameters()["collections"] == ("naip",)
def test_multiple_collection_string(self) -> None:
# Comma-separated ID string
search = BaseSearch(url=SEARCH_URL, collections="naip,landsat8_l1tp")
assert search.get_parameters()["collections"] == ("naip", "landsat8_l1tp")
def test_list_of_collection_strings(self) -> None:
# List of ID strings
search = BaseSearch(url=SEARCH_URL, collections=["naip", "landsat8_l1tp"])
assert search.get_parameters()["collections"] == ("naip", "landsat8_l1tp")
def test_generator_of_collection_strings(self) -> None:
# Generator of ID strings
def collectioner() -> Iterator[str]:
yield from ["naip", "landsat8_l1tp"]
search = BaseSearch(url=SEARCH_URL, collections=collectioner())
assert search.get_parameters()["collections"] == ("naip", "landsat8_l1tp")
def test_single_id_string(self) -> None:
# Single ID
search = BaseSearch(url=SEARCH_URL, ids="m_3510836_se_12_060_20180508_20190331")
assert search.get_parameters()["ids"] == (
"m_3510836_se_12_060_20180508_20190331",
)
def test_multiple_id_string(self) -> None:
# Comma-separated ID string
search = BaseSearch(
url=SEARCH_URL,
ids="m_3510836_se_12_060_20180508_20190331,m_3510840_se_12_060_20180504_20190331",
)
assert search.get_parameters()["ids"] == (
"m_3510836_se_12_060_20180508_20190331",
"m_3510840_se_12_060_20180504_20190331",
)
def test_list_of_id_strings(self) -> None:
# List of IDs
search = BaseSearch(
url=SEARCH_URL,
ids=[
"m_3510836_se_12_060_20180508_20190331",
"m_3510840_se_12_060_20180504_20190331",
],
)
assert search.get_parameters()["ids"] == (
"m_3510836_se_12_060_20180508_20190331",
"m_3510840_se_12_060_20180504_20190331",
)
def test_generator_of_id_string(self) -> None:
# Generator of IDs
def ids() -> Iterator[str]:
yield from [
"m_3510836_se_12_060_20180508_20190331",
"m_3510840_se_12_060_20180504_20190331",
]
search = BaseSearch(url=SEARCH_URL, ids=ids())
assert search.get_parameters()["ids"] == (
"m_3510836_se_12_060_20180508_20190331",
"m_3510840_se_12_060_20180504_20190331",
)
def test_intersects_dict(self) -> None:
# Dict input
search = BaseSearch(url=SEARCH_URL, intersects=INTERSECTS_EXAMPLE)
assert search.get_parameters()["intersects"] == INTERSECTS_EXAMPLE
def test_intersects_json_string(self) -> None:
# JSON string input
search = BaseSearch(url=SEARCH_URL, intersects=json.dumps(INTERSECTS_EXAMPLE))
assert search.get_parameters()["intersects"] == INTERSECTS_EXAMPLE
def test_intersects_non_geo_interface_object(self) -> None:
with pytest.raises(Exception):
BaseSearch(url=SEARCH_URL, intersects=object()) # type: ignore
def test_filter_lang_default_for_method_despite_filter_as_dict(self) -> None:
search = BaseSearch(url=SEARCH_URL, method="GET", filter={})
assert search.get_parameters()["filter-lang"] == "cql2-text"
def test_filter_lang_default_for_method_despite_filter_as_str(self) -> None:
search = BaseSearch(url=SEARCH_URL, method="POST", filter="")
assert search.get_parameters()["filter-lang"] == "cql2-json"
def test_filter_lang_cql2_text(self) -> None:
# Use specified filter_lang
search = BaseSearch(url=SEARCH_URL, filter_lang="cql2-text", filter={})
assert search.get_parameters()["filter-lang"] == "cql2-text"
def test_filter_lang_cql2_json(self) -> None:
# Use specified filter_lang
search = BaseSearch(url=SEARCH_URL, filter_lang="cql2-json", filter="")
assert search.get_parameters()["filter-lang"] == "cql2-json"
def test_filter_lang_without_filter(self) -> None:
# No filter provided
search = BaseSearch(url=SEARCH_URL)
assert "filter-lang" not in search.get_parameters()
def test_filter_conversion_to_cql2_json(self) -> None:
search = BaseSearch(url=SEARCH_URL, method="POST", filter="eo:cloud_cover<=10")
assert search.get_parameters()["filter-lang"] == "cql2-json"
assert search.get_parameters()["filter"] == {
"args": [{"property": "eo:cloud_cover"}, 10],
"op": "<=",
}
def test_filter_conversion_to_cql2_text(self) -> None:
search = BaseSearch(
url=SEARCH_URL,
method="GET",
filter={"op": "<=", "args": [{"property": "eo:cloud_cover"}, 10]},
)
assert search.get_parameters()["filter-lang"] == "cql2-text"
assert search.get_parameters()["filter"] == '("eo:cloud_cover" <= 10)'
def test_filter_conversion_does_not_happen_if_filter_lang_specified_json(
self,
) -> None:
search = BaseSearch(
url=SEARCH_URL,
method="GET",
filter={"op": "<=", "args": [{"property": "eo:cloud_cover"}, 10]},
filter_lang="cql2-json",
)
# assert search.get_parameters()["filter-lang"] == "cql2-json"
assert (
search.get_parameters()["filter"]
== '{"op": "<=", "args": [{"property": "eo:cloud_cover"}, 10]}'
)
def test_filter_conversion_does_not_happen_if_filter_lang_specified_text(
self,
) -> None:
search = BaseSearch(
url=SEARCH_URL,
method="POST",
filter="eo:cloud_cover<=10",
filter_lang="cql2-text",
)
# note that this is likely to fail when it hits the server
assert search.get_parameters()["filter-lang"] == "cql2-text"
assert search.get_parameters()["filter"] == "eo:cloud_cover<=10"
def test_sortby(self) -> None:
search = BaseSearch(url=SEARCH_URL, sortby="properties.datetime")
assert search.get_parameters()["sortby"] == [
{"direction": "asc", "field": "properties.datetime"}
]
search = BaseSearch(url=SEARCH_URL, sortby="+properties.datetime")
assert search.get_parameters()["sortby"] == [
{"direction": "asc", "field": "properties.datetime"}
]
search = BaseSearch(url=SEARCH_URL, sortby="-properties.datetime")
assert search.get_parameters()["sortby"] == [
{"direction": "desc", "field": "properties.datetime"}
]
search = BaseSearch(
url=SEARCH_URL, sortby="-properties.datetime,+id,collection"
)
assert search.get_parameters()["sortby"] == [
{"direction": "desc", "field": "properties.datetime"},
{"direction": "asc", "field": "id"},
{"direction": "asc", "field": "collection"},
]
search = BaseSearch(
url=SEARCH_URL,
sortby=[
{"direction": "desc", "field": "properties.datetime"},
{"direction": "asc", "field": "id"},
{"direction": "asc", "field": "collection"},
],
)
assert search.get_parameters()["sortby"] == [
{"direction": "desc", "field": "properties.datetime"},
{"direction": "asc", "field": "id"},
{"direction": "asc", "field": "collection"},
]
search = BaseSearch(
url=SEARCH_URL, sortby=["-properties.datetime", "id", "collection"]
)
assert search.get_parameters()["sortby"] == [
{"direction": "desc", "field": "properties.datetime"},
{"direction": "asc", "field": "id"},
{"direction": "asc", "field": "collection"},
]
search = BaseSearch(
url=SEARCH_URL,
method="GET",
sortby=["-properties.datetime", "id", "collection"],
)
assert (
search.get_parameters()["sortby"] == "-properties.datetime,+id,+collection"
)
search = BaseSearch(
url=SEARCH_URL, method="GET", sortby="-properties.datetime,id,collection"
)
assert (
search.get_parameters()["sortby"] == "-properties.datetime,+id,+collection"
)
with pytest.raises(Exception):
BaseSearch(url=SEARCH_URL, sortby=1) # type: ignore
with pytest.raises(Exception):
BaseSearch(url=SEARCH_URL, sortby=[1]) # type: ignore
def test_fields(self) -> None:
with pytest.raises(Exception):
BaseSearch(url=SEARCH_URL, fields=1) # type: ignore
with pytest.raises(Exception):
BaseSearch(url=SEARCH_URL, fields=[1]) # type: ignore
search = BaseSearch(url=SEARCH_URL, fields="id,collection,+foo,-bar")
assert search.get_parameters()["fields"] == {
"exclude": ["bar"],
"include": ["id", "collection", "foo"],
}
search = BaseSearch(url=SEARCH_URL, fields=["id", "collection", "+foo", "-bar"])
assert search.get_parameters()["fields"] == {
"exclude": ["bar"],
"include": ["id", "collection", "foo"],
}
search = BaseSearch(
url=SEARCH_URL,
fields={"exclude": ["bar"], "include": ["id", "collection"]},
)
assert search.get_parameters()["fields"] == {
"exclude": ["bar"],
"include": ["id", "collection"],
}
search = BaseSearch(
url=SEARCH_URL, method="GET", fields="id,collection,+foo,-bar"
)
assert search.get_parameters()["fields"] == "+id,+collection,+foo,-bar"
search = BaseSearch(
url=SEARCH_URL, method="GET", fields=["id", "collection", "+foo", "-bar"]
)
assert search.get_parameters()["fields"] == "+id,+collection,+foo,-bar"
search = BaseSearch(
url=SEARCH_URL,
method="GET",
fields={"exclude": ["bar"], "include": ["id", "collection"]},
)
assert search.get_parameters()["fields"] == "+id,+collection,-bar"
|
