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
|
"""Tests creating a custom extension"""
from collections.abc import Generator
from datetime import datetime
from typing import Any, Generic, TypeVar, cast
import pytest
import pystac
from pystac import (
Asset,
Catalog,
Collection,
Extent,
Item,
SpatialExtent,
TemporalExtent,
)
from pystac.errors import ExtensionTypeError
from pystac.extensions.base import ExtensionManagementMixin, PropertiesExtension
from pystac.extensions.hooks import ExtensionHooks
from pystac.serialization.identify import STACJSONDescription, STACVersionID
T = TypeVar("T", pystac.Catalog, pystac.Collection, pystac.Item, pystac.Asset)
SCHEMA_URI = "https://example.com/v2.0/custom-schema.json"
TEST_PROP = "test:prop"
class CustomExtension(
Generic[T],
PropertiesExtension,
ExtensionManagementMixin[pystac.Catalog | pystac.Collection | pystac.Item],
):
def __init__(self, obj: pystac.STACObject | None) -> None:
self.obj = obj
def apply(self, test_prop: str | None) -> None:
self.test_prop = test_prop
@property
def test_prop(self) -> str | None:
return self._get_property(TEST_PROP, str)
@test_prop.setter
def test_prop(self, v: str | None) -> None:
self._set_property(TEST_PROP, v)
@classmethod
def get_schema_uri(cls) -> str:
return SCHEMA_URI
@classmethod
def ext(cls, obj: T, add_if_missing: bool = False) -> "CustomExtension[T]":
if isinstance(obj, pystac.Asset):
cls.ensure_owner_has_extension(obj, add_if_missing)
return cast(CustomExtension[T], AssetCustomExtension(obj))
if isinstance(obj, pystac.Item):
cls.ensure_has_extension(obj, add_if_missing)
return cast(CustomExtension[T], ItemCustomExtension(obj))
if isinstance(obj, pystac.Collection):
cls.ensure_has_extension(obj, add_if_missing)
return cast(CustomExtension[T], CollectionCustomExtension(obj))
if isinstance(obj, pystac.Catalog):
cls.ensure_has_extension(obj, add_if_missing)
return cast(CustomExtension[T], CatalogCustomExtension(obj))
raise pystac.ExtensionTypeError(cls._ext_error_message(obj))
class CatalogCustomExtension(CustomExtension[pystac.Catalog]):
def __init__(self, catalog: pystac.Catalog) -> None:
self.properties = catalog.extra_fields
super().__init__(catalog)
class CollectionCustomExtension(CustomExtension[pystac.Collection]):
def __init__(self, collection: pystac.Collection) -> None:
self.properties = collection.extra_fields
super().__init__(collection)
class ItemCustomExtension(CustomExtension[pystac.Item]):
def __init__(self, item: pystac.Item) -> None:
self.properties = item.properties
super().__init__(item)
class AssetCustomExtension(CustomExtension[pystac.Asset]):
def __init__(self, asset: pystac.Asset) -> None:
self.properties = asset.extra_fields
if asset.owner:
if isinstance(asset.owner, pystac.Item):
self.additional_read_properties = [asset.owner.properties]
elif isinstance(asset.owner, pystac.Collection):
self.additional_read_properties = [asset.owner.extra_fields]
super().__init__(None)
class CustomExtensionHooks(ExtensionHooks):
schema_uri: str = SCHEMA_URI
prev_extension_ids: set[str] = {
"custom",
"https://example.com/v1.0/custom-schema.json",
}
stac_object_types: set[pystac.STACObjectType] = {
pystac.STACObjectType.CATALOG,
pystac.STACObjectType.COLLECTION,
pystac.STACObjectType.ITEM,
}
def migrate(
self, obj: dict[str, Any], version: STACVersionID, info: STACJSONDescription
) -> None:
if version < "1.0.0-rc2" and info.object_type == pystac.STACObjectType.ITEM:
if "test:old-prop-name" in obj["properties"]:
obj["properties"][TEST_PROP] = obj["properties"]["test:old-prop-name"]
super().migrate(obj, version, info)
@pytest.fixture
def add_extension_hooks() -> Generator[None]:
pystac.EXTENSION_HOOKS.add_extension_hooks(CustomExtensionHooks())
yield
pystac.EXTENSION_HOOKS.remove_extension_hooks(SCHEMA_URI)
def test_add_to_item_asset(add_extension_hooks: None) -> None:
item = Item("an-id", None, None, datetime.now(), {})
item.add_asset("foo", Asset("http://pystac.test/asset.tif"))
custom = CustomExtension.ext(item.assets["foo"], add_if_missing=True)
assert CustomExtension.has_extension(item)
custom.apply("bar")
item_as_dict = item.to_dict()
assert item_as_dict["assets"]["foo"]["test:prop"] == "bar"
def test_add_to_item(add_extension_hooks: None) -> None:
item = Item("an-id", None, None, datetime.now(), {})
custom = CustomExtension.ext(item, add_if_missing=True)
assert CustomExtension.has_extension(item)
custom.test_prop = "foo"
item_as_dict = item.to_dict()
assert item_as_dict["properties"]["test:prop"] == "foo"
def test_add_to_catalog(add_extension_hooks: None) -> None:
catalog = Catalog("an-id", "a description")
custom = CustomExtension.ext(catalog, add_if_missing=True)
assert CustomExtension.has_extension(catalog)
custom.test_prop = "foo"
catalog_as_dict = catalog.to_dict()
assert catalog_as_dict["test:prop"] == "foo"
def test_add_to_collection(add_extension_hooks: None) -> None:
collection = Collection(
"an-id",
"a description",
extent=Extent(
spatial=SpatialExtent([-180.0, -90.0, 180.0, 90.0]),
temporal=TemporalExtent([[datetime.now(), None]]),
),
)
custom = CustomExtension.ext(collection, add_if_missing=True)
assert CustomExtension.has_extension(collection)
custom.test_prop = "foo"
collection_as_dict = collection.to_dict()
assert collection_as_dict["test:prop"] == "foo"
def test_add_to_collection_asset(add_extension_hooks: None) -> None:
collection = Collection(
"an-id",
"a description",
extent=Extent(
spatial=SpatialExtent([-180.0, -90.0, 180.0, 90.0]),
temporal=TemporalExtent([[datetime.now(), None]]),
),
)
collection.add_asset("foo", Asset("http://pystac.test/asset.tif"))
custom = CustomExtension.ext(collection.assets["foo"], add_if_missing=True)
assert CustomExtension.has_extension(collection)
custom.test_prop = "bar"
collection_as_dict = collection.to_dict()
assert collection_as_dict["assets"]["foo"]["test:prop"] == "bar"
def test_ext_non_stac_object(add_extension_hooks: None) -> None:
with pytest.raises(ExtensionTypeError):
CustomExtension.ext({}) # type: ignore
def test_migrates(add_extension_hooks: None) -> None:
item = Item("an-id", None, None, datetime.now(), {})
item_as_dict = item.to_dict()
item_as_dict["stac_version"] = "1.0.0-rc.1"
item_as_dict["stac_extensions"] = ["https://example.com/v1.0/custom-schema.json"]
item_as_dict["properties"]["test:old-prop-name"] = "foo"
item = Item.from_dict(item_as_dict, migrate=True)
custom = CustomExtension.ext(item)
assert custom.test_prop == "foo"
|
