File: test_item_collection.py

package info (click to toggle)
pystac 1.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 19,904 kB
  • sloc: python: 24,370; makefile: 124; sh: 7
file content (206 lines) | stat: -rw-r--r-- 6,624 bytes parent folder | download
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
import json
from copy import deepcopy
from os.path import relpath
from typing import Any, cast

import pytest

import pystac
from pystac import Item, StacIO
from pystac.item_collection import ItemCollection
from tests.utils import TestCases
from tests.utils.stac_io_mock import MockDefaultStacIO

SIMPLE_ITEM = TestCases.get_path("data-files/examples/1.0.0-RC1/simple-item.json")
CORE_ITEM = TestCases.get_path("data-files/examples/1.0.0-RC1/core-item.json")
EXTENDED_ITEM = TestCases.get_path("data-files/examples/1.0.0-RC1/extended-item.json")

ITEM_COLLECTION = TestCases.get_path(
    "data-files/item-collection/sample-item-collection.json"
)


@pytest.fixture
def item_collection_dict() -> dict[str, Any]:
    with open(ITEM_COLLECTION) as src:
        return cast(dict[str, Any], json.load(src))


@pytest.fixture
def items(item_collection_dict: dict[str, Any]) -> list[Item]:
    return [Item.from_dict(f) for f in item_collection_dict["features"]]


@pytest.fixture
def stac_io() -> StacIO:
    return StacIO.default()


def test_item_collection_length(
    item_collection_dict: dict[str, Any], items: list[Item]
) -> None:
    item_collection = pystac.ItemCollection(items=items)

    assert len(item_collection) == len(items)


def test_item_collection_iter(items: list[Item]) -> None:
    expected_ids = [item.id for item in items]
    item_collection = pystac.ItemCollection(items=items)

    actual_ids = [item.id for item in item_collection]

    assert expected_ids == actual_ids


def test_item_collection_get_item_by_index(items: list[Item]) -> None:
    expected_id = items[0].id
    item_collection = pystac.ItemCollection(items=items)

    assert item_collection[0].id == expected_id


def test_item_collection_contains() -> None:
    item = pystac.Item.from_file(SIMPLE_ITEM)
    item_collection = pystac.ItemCollection(items=[item], clone_items=False)

    assert item in item_collection


def test_item_collection_extra_fields(items: list[Item]) -> None:
    item_collection = pystac.ItemCollection(
        items=items, extra_fields={"custom_field": "My value"}
    )

    assert item_collection.extra_fields.get("custom_field") == "My value"


def test_item_collection_to_dict(items: list[Item]) -> None:
    item_collection = pystac.ItemCollection(
        items=items, extra_fields={"custom_field": "My value"}
    )

    d = item_collection.to_dict()

    assert len(d["features"]) == len(items)
    assert d.get("custom_field") == "My value"


def test_item_collection_from_dict(items: list[Item]) -> None:
    features = [item.to_dict(transform_hrefs=False) for item in items]
    d = {
        "type": "FeatureCollection",
        "features": features,
        "custom_field": "My value",
    }
    item_collection = pystac.ItemCollection.from_dict(d)
    expected = len(features)
    assert expected == len(item_collection.items)
    assert item_collection.extra_fields.get("custom_field") == "My value"


def test_clone_item_collection() -> None:
    item_collection_1 = pystac.ItemCollection.from_file(ITEM_COLLECTION)
    item_collection_2 = item_collection_1.clone()

    item_ids_1 = [item.id for item in item_collection_1]
    item_ids_2 = [item.id for item in item_collection_2]

    # All items from the original collection should be in the clone...
    assert item_ids_1 == item_ids_2
    # ... but they should not be the same objects
    assert item_collection_1[0] is not item_collection_2[0]


def test_raise_error_for_invalid_object(stac_io: StacIO) -> None:
    item_dict = stac_io.read_json(SIMPLE_ITEM)

    with pytest.raises(pystac.STACTypeError):
        _ = pystac.ItemCollection.from_dict(item_dict)


def test_from_relative_path() -> None:
    _ = pystac.ItemCollection.from_file(
        relpath(
            TestCases.get_path("data-files/item-collection/sample-item-collection.json")
        )
    )


def test_from_list_of_dicts(stac_io: StacIO) -> None:
    item_dict = stac_io.read_json(SIMPLE_ITEM)
    item_collection = pystac.ItemCollection(items=[item_dict], clone_items=True)

    assert item_collection[0].id == item_dict.get("id")


def test_add_item_collections() -> None:
    item_1 = pystac.Item.from_file(SIMPLE_ITEM)
    item_2 = pystac.Item.from_file(EXTENDED_ITEM)
    item_3 = pystac.Item.from_file(CORE_ITEM)

    item_collection_1 = pystac.ItemCollection(items=[item_1, item_2])
    item_collection_2 = pystac.ItemCollection(items=[item_2, item_3])

    combined = item_collection_1 + item_collection_2

    assert len(combined) == 4


def test_add_other_raises_error() -> None:
    item_collection = pystac.ItemCollection.from_file(ITEM_COLLECTION)

    with pytest.raises(TypeError):
        _ = item_collection + 2


def test_identify_0_8_itemcollection_type(stac_io: StacIO) -> None:
    itemcollection_path = TestCases.get_path(
        "data-files/examples/0.8.1/item-spec/examples/itemcollection-sample-full.json"
    )
    itemcollection_dict = stac_io.read_json(itemcollection_path)

    assert pystac.ItemCollection.is_item_collection(itemcollection_dict), (
        "Did not correctly identify valid STAC 0.8 ItemCollection."
    )


def test_identify_0_9_itemcollection(stac_io: StacIO) -> None:
    itemcollection_path = TestCases.get_path(
        "data-files/examples/0.9.0/item-spec/examples/itemcollection-sample-full.json"
    )
    itemcollection_dict = stac_io.read_json(itemcollection_path)

    assert pystac.ItemCollection.is_item_collection(itemcollection_dict), (
        "Did not correctly identify valid STAC 0.9 ItemCollection."
    )


def test_from_dict_preserves_dict(item_collection_dict: dict[str, Any]) -> None:
    param_dict = deepcopy(item_collection_dict)

    # test that the parameter is preserved
    _ = ItemCollection.from_dict(param_dict)
    assert param_dict == item_collection_dict

    # assert that the parameter is preserved regardless of
    # preserve_dict
    _ = ItemCollection.from_dict(param_dict, preserve_dict=False)
    assert param_dict == item_collection_dict


def test_from_dict_sets_root(item_collection_dict: dict[str, Any]) -> None:
    param_dict = deepcopy(item_collection_dict)
    catalog = pystac.Catalog(id="test", description="test desc")
    item_collection = ItemCollection.from_dict(param_dict, root=catalog)
    for item in item_collection.items:
        assert item.get_root() == catalog


def test_to_dict_does_not_read_root_link_of_items() -> None:
    with MockDefaultStacIO() as mock_stac_io:
        item_collection = pystac.ItemCollection.from_file(ITEM_COLLECTION)

        item_collection.to_dict()

        assert mock_stac_io.mock.read_text.call_count == 1