forked from stac-utils/pystac
-
Notifications
You must be signed in to change notification settings - Fork 0
/
table.py
297 lines (229 loc) · 9.91 KB
/
table.py
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
"""Implements the :stac-ext:`Table Extension <table>.`"""
from typing import Any, Dict, Generic, List, Optional, TypeVar, Union, cast
import pystac
from pystac.extensions.base import (
ExtensionManagementMixin,
PropertiesExtension,
)
from pystac.extensions.hooks import ExtensionHooks
from pystac.utils import get_required
T = TypeVar("T", pystac.Collection, pystac.Item, pystac.Asset)
SCHEMA_URI = "https://stac-extensions.github.io/table/v1.2.0/schema.json"
PREFIX: str = "table:"
COLUMNS_PROP = PREFIX + "columns"
PRIMARY_GEOMETRY_PROP = PREFIX + "primary_geometry"
ROW_COUNT_PROP = PREFIX + "row_count"
STORAGE_OPTIONS_PROP = PREFIX + "storage_options"
TABLES_PROP = PREFIX + "tables"
# Column properties
COL_NAME_PROP = "name"
COL_DESCRIPTION_PROP = "description"
COL_TYPE_PROP = "type"
# Table properties
TBL_NAME_PROP = "name"
TBL_DESCRIPTION_PROP = "description"
class Column:
"""Object representing a column of a table."""
properties: Dict[str, Any]
def __init__(self, properties: Dict[str, Any]):
self.properties = properties
@property
def name(self) -> str:
"""The column name"""
return get_required(
self.properties.get(COL_NAME_PROP), "table:column", COL_NAME_PROP
)
@name.setter
def name(self, v: str) -> None:
self.properties[COL_NAME_PROP] = v
@property
def description(self) -> Optional[str]:
"""Detailed multi-line description to explain the column. `CommonMark 0.29
<http://commonmark.org/>`__ syntax MAY be used for rich text representation."""
return self.properties.get(COL_DESCRIPTION_PROP)
@description.setter
def description(self, v: Optional[str]) -> None:
if v is None:
self.properties.pop(COL_DESCRIPTION_PROP, None)
else:
self.properties[COL_DESCRIPTION_PROP] = v
@property
def col_type(self) -> Optional[str]:
"""Data type of the column. If using a file format with a type system (like Parquet),
we recommend you use those types"""
return self.properties.get(COL_TYPE_PROP)
@col_type.setter
def col_type(self, v: Optional[str]) -> None:
if v is None:
self.properties.pop(COL_TYPE_PROP, None)
else:
self.properties[COL_TYPE_PROP] = v
def to_dict(self) -> Dict[str, Any]:
"""Returns a JSON-like dictionary representing this ``Column``."""
return self.properties
class Table:
"""Object containing a high-level summary about a table"""
properties: Dict[str, Any]
def __init__(self, properties: Dict[str, Any]):
self.properties = properties
@property
def name(self) -> str:
"""The table name"""
return get_required(self.properties.get(TBL_NAME_PROP), self, TBL_NAME_PROP)
@name.setter
def name(self, v: str) -> None:
self.properties[COL_NAME_PROP] = v
@property
def description(self) -> Optional[str]:
"""Detailed multi-line description to explain the table. `CommonMark 0.29
<http://commonmark.org/>`__ syntax MAY be used for rich text representation."""
return self.properties.get(COL_DESCRIPTION_PROP)
@description.setter
def description(self, v: Optional[str]) -> None:
if v is None:
self.properties.pop(COL_DESCRIPTION_PROP, None)
else:
self.properties[COL_DESCRIPTION_PROP] = v
def to_dict(self) -> Dict[str, Any]:
"""Returns a JSON-like dictionary representing this ``Table``."""
return self.properties
class TableExtension(
Generic[T],
PropertiesExtension,
ExtensionManagementMixin[Union[pystac.Collection, pystac.Item]],
):
"""An abstract class that can be used to extend the properties of a
:class:`~pystac.Collection`, :class:`~pystac.Item`, or :class:`~pystac.Asset` with
properties from the :stac-ext:`Datacube Extension <datacube>`. This class is
generic over the type of STAC Object to be extended (e.g. :class:`~pystac.Item`,
:class:`~pystac.Asset`).
To create a concrete instance of :class:`TableExtension`, use the
:meth:`TableExtension.ext` method. For example:
.. code-block:: python
>>> item: pystac.Item = ...
>>> tbl_ext = TableExtension.ext(item)
"""
@classmethod
def get_schema_uri(cls) -> str:
return SCHEMA_URI
@classmethod
def ext(cls, obj: T, add_if_missing: bool = False) -> "TableExtension[T]":
"""Extend the given STAC Object with properties from the
:stac-ext:`Table Extension <table>`.
This extension can be applied to instances of :class:`~pystac.Collection`,
:class:`~pystac.Item` or :class:`~pystac.Asset`.
Raises:
pystac.ExtensionTypeError : If an invalid object type is passed.
"""
if isinstance(obj, pystac.Collection):
cls.validate_has_extension(obj, add_if_missing)
return cast(TableExtension[T], CollectionTableExtension(obj))
if isinstance(obj, pystac.Item):
cls.validate_has_extension(obj, add_if_missing)
return cast(TableExtension[T], ItemTableExtension(obj))
if isinstance(obj, pystac.Asset):
cls.validate_owner_has_extension(obj, add_if_missing)
return cast(TableExtension[T], AssetTableExtension(obj))
else:
raise pystac.ExtensionTypeError(
f"Table extension does not apply to type '{type(obj).__name__}'"
)
@property
def columns(self) -> Optional[List[Column]]:
"""A list of :class:`Column` objects describing each column"""
return self.properties.get(COLUMNS_PROP)
@columns.setter
def columns(self, v: List[Column]) -> None:
if v is None:
self.properties.pop(COLUMNS_PROP, None)
else:
self.properties[COLUMNS_PROP] = v
@property
def primary_geometry(self) -> Optional[str]:
"""The primary geometry column name"""
return self._get_property(PRIMARY_GEOMETRY_PROP, str)
@primary_geometry.setter
def primary_geometry(self, v: Optional[str]) -> None:
if v is None:
self.properties.pop(PRIMARY_GEOMETRY_PROP, None)
else:
self.properties[PRIMARY_GEOMETRY_PROP] = v
@property
def row_count(self) -> Optional[int]:
"""The number of rows in the dataset"""
return self._get_property(ROW_COUNT_PROP, int)
@row_count.setter
def row_count(self, v: Optional[int]) -> None:
if v is None:
self.properties.pop(ROW_COUNT_PROP, None)
else:
self.properties[ROW_COUNT_PROP] = v
class CollectionTableExtension(TableExtension[pystac.Collection]):
"""A concrete implementation of :class:`TableExtension` on a
:class:`~pystac.Collection` that extends the properties of the Item to include
properties defined in the :stac-ext:`Table Extension <table>`.
This class should generally not be instantiated directly. Instead, call
:meth:`TableExtension.ext` on an :class:`~pystac.Collection` to extend it.
"""
collection: pystac.Collection
properties: Dict[str, Any]
def __init__(self, collection: pystac.Collection):
self.collection = collection
self.properties = collection.extra_fields
@property
def tables(self) -> Dict[str, Table]:
"""A mapping of table names to table objects"""
return get_required(self.properties.get(TABLES_PROP), self, TABLES_PROP)
@tables.setter
def tables(self, v: Dict[str, Table]) -> None:
self.properties[TABLES_PROP] = v
def __repr__(self) -> str:
return "<CollectionTableExtension Item id={}>".format(self.collection.id)
class ItemTableExtension(TableExtension[pystac.Item]):
"""A concrete implementation of :class:`TableExtension` on an
:class:`~pystac.Item` that extends the properties of the Item to include properties
defined in the :stac-ext:`Table Extension <table>`.
This class should generally not be instantiated directly. Instead, call
:meth:`TableExtension.ext` on an :class:`~pystac.Item` to extend it.
"""
item: pystac.Item
properties: Dict[str, Any]
def __init__(self, item: pystac.Item):
self.item = item
self.properties = item.properties
def __repr__(self) -> str:
return "<ItemTableExtension Item id={}>".format(self.item.id)
class AssetTableExtension(TableExtension[pystac.Asset]):
"""A concrete implementation of :class:`TableExtension` on an
:class:`~pystac.Asset` that extends the Asset fields to include properties defined
in the :stac-ext:`Table Extension <table>`.
This class should generally not be instantiated directly. Instead, call
:meth:`TableExtension.ext` on an :class:`~pystac.Asset` to extend it.
"""
asset_href: str
properties: Dict[str, Any]
additional_read_properties: Optional[List[Dict[str, Any]]]
def __init__(self, asset: pystac.Asset):
self.asset_href = asset.href
self.properties = asset.extra_fields
if asset.owner and isinstance(asset.owner, pystac.Item):
self.additional_read_properties = [asset.owner.properties]
else:
self.additional_read_properties = None
@property
def storage_options(self) -> Optional[Dict[str, Any]]:
"""Additional keywords for opening the dataset"""
return self.properties.get(STORAGE_OPTIONS_PROP)
@storage_options.setter
def storage_options(self, v: Optional[Dict[str, Any]]) -> Any:
if v is None:
self.properties.pop(STORAGE_OPTIONS_PROP, None)
else:
self.properties[STORAGE_OPTIONS_PROP] = v
def __repr__(self) -> str:
return "<AssetTableExtension Item id={}>".format(self.asset_href)
class TableExtensinoHooks(ExtensionHooks):
schema_uri: str = SCHEMA_URI
prev_extension_ids = {"table"}
stac_object_types = {pystac.STACObjectType.COLLECTION, pystac.STACObjectType.ITEM}
TABLE_EXTENSION_HOOKS: ExtensionHooks = TableExtensinoHooks()