pystac-ext-table 1.2.0__py3-none-any.whl

pystac/extensions/table.py

@@ -0,0 +1,324 @@
+"""Implements the :stac-ext:`Table Extension <table>`."""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+from typing import Any, Generic, Literal, TypeVar, cast
+
+import pystac
+from pystac.extensions.base import ExtensionManagementMixin, PropertiesExtension
+from pystac.extensions.hooks import ExtensionHooks
+from pystac.utils import get_required
+
+#: Generalized version of :class:`~pystac.Collection`, :class:`~pystac.Item`,
+#: :class:`~pystac.Asset` or :class:`~pystac.ItemAssetDefinition`
+T = TypeVar(
+    "T", pystac.Collection, pystac.Item, pystac.Asset, pystac.ItemAssetDefinition
+)
+
+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 cast(
+            str,
+            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) -> str | None:
+        """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: str | None) -> None:
+        if v is None:
+            self.properties.pop(COL_DESCRIPTION_PROP, None)
+        else:
+            self.properties[COL_DESCRIPTION_PROP] = v
+
+    @property
+    def col_type(self) -> str | None:
+        """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: str | None) -> 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 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 cast(
+            str, 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) -> str | None:
+        """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: str | None) -> 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 dictionary representing this ``Table``."""
+        return self.properties
+
+
+class TableExtension(
+    Generic[T],
+    PropertiesExtension,
+    ExtensionManagementMixin[pystac.Item | pystac.Collection],
+):
+    """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)
+
+    """
+
+    name: Literal["table"] = "table"
+
+    @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.ensure_has_extension(obj, add_if_missing)
+            return cast(TableExtension[T], CollectionTableExtension(obj))
+        if isinstance(obj, pystac.Item):
+            cls.ensure_has_extension(obj, add_if_missing)
+            return cast(TableExtension[T], ItemTableExtension(obj))
+        if isinstance(obj, pystac.Asset):
+            cls.ensure_owner_has_extension(obj, add_if_missing)
+            return cast(TableExtension[T], AssetTableExtension(obj))
+        elif isinstance(obj, pystac.ItemAssetDefinition):
+            cls.ensure_owner_has_extension(obj, add_if_missing)
+            return cast(TableExtension[T], ItemAssetsTableExtension(obj))
+        else:
+            raise pystac.ExtensionTypeError(cls._ext_error_message(obj))
+
+    @property
+    def columns(self) -> list[Column] | None:
+        """A list of :class:`Column` objects describing each column"""
+        v = self.properties.get(COLUMNS_PROP)
+        if v is None:
+            return None
+        return [Column(x) for x in v]
+
+    @columns.setter
+    def columns(self, v: list[Column] | None) -> None:
+        self._set_property(COLUMNS_PROP, v)
+
+    @property
+    def primary_geometry(self) -> str | None:
+        """The primary geometry column name"""
+        return self._get_property(PRIMARY_GEOMETRY_PROP, str)
+
+    @primary_geometry.setter
+    def primary_geometry(self, v: str | None) -> None:
+        if v is None:
+            self.properties.pop(PRIMARY_GEOMETRY_PROP, None)
+        else:
+            self.properties[PRIMARY_GEOMETRY_PROP] = v
+
+    @property
+    def row_count(self) -> int | None:
+        """The number of rows in the dataset"""
+        return self._get_property(ROW_COUNT_PROP, int)
+
+    @row_count.setter
+    def row_count(self, v: int | None) -> 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 f"<CollectionTableExtension Item id={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 f"<ItemTableExtension Item id={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: Iterable[dict[str, Any]] | None
+
+    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) -> dict[str, Any] | None:
+        """Additional keywords for opening the dataset"""
+        return self.properties.get(STORAGE_OPTIONS_PROP)
+
+    @storage_options.setter
+    def storage_options(self, v: dict[str, Any] | None) -> Any:
+        if v is None:
+            self.properties.pop(STORAGE_OPTIONS_PROP, None)
+        else:
+            self.properties[STORAGE_OPTIONS_PROP] = v
+
+    def __repr__(self) -> str:
+        return f"<AssetTableExtension Item id={self.asset_href}>"
+
+
+class ItemAssetsTableExtension(TableExtension[pystac.ItemAssetDefinition]):
+    properties: dict[str, Any]
+    asset_defn: pystac.ItemAssetDefinition
+
+    def __init__(self, item_asset: pystac.ItemAssetDefinition):
+        self.asset_defn = item_asset
+        self.properties = item_asset.properties
+
+
+class TableExtensinoHooks(ExtensionHooks):
+    schema_uri: str = SCHEMA_URI
+    prev_extension_ids = {
+        "table",
+        "https://stac-extensions.github.io/table/v1.0.0/schema.json",
+        "https://stac-extensions.github.io/table/v1.0.1/schema.json",
+        "https://stac-extensions.github.io/table/v1.1.0/schema.json",
+    }
+    stac_object_types = {pystac.STACObjectType.COLLECTION, pystac.STACObjectType.ITEM}
+
+
+TABLE_EXTENSION_HOOKS: ExtensionHooks = TableExtensinoHooks()

pystac_ext_table-1.2.0.dist-info/METADATA

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: pystac-ext-table
+Version: 1.2.0
+Summary: Table extension for PySTAC
+Project-URL: Documentation, https://pystac.readthedocs.io
+Project-URL: Repository, https://github.com/stac-utils/pystac
+Project-URL: Issues, https://github.com/stac-utils/pystac/issues
+Project-URL: Changelog, https://github.com/stac-utils/pystac/blob/main/CHANGELOG.md
+Project-URL: Discussions, https://github.com/radiantearth/stac-spec/discussions/categories/stac-software
+License: Apache-2.0
+Keywords: STAC,catalog,imagery,pystac,raster,table
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: pystac-core
+Description-Content-Type: text/markdown
+
+# pystac-ext-table
+
+[PySTAC](https://pypi.org/project/pystac/) extension package for the [Table Extension](https://github.com/stac-extensions/table).
+This extension provides fields for describing tabular data assets, including column definitions, row counts, primary/foreign keys, and storage formats.
+
+## Supported versions
+
+- [v1.2.0](https://stac-extensions.github.io/table/v1.2.0/schema.json)
+
+## Versioning
+
+This package's version corresponds to the version of the extension specification it targets.
+When we release updates to the package code without changing the target extension version, we use [post releases](https://packaging.python.org/en/latest/discussions/versioning/#post-releases), e.g. `1.2.0.post1`.

pystac_ext_table-1.2.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+pystac/extensions/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pystac/extensions/table.py,sha256=MEamMU8cYTUKFvb4Cm7cY5Pqar71kZYWoZGnCqmevaY,11050
+pystac_ext_table-1.2.0.dist-info/METADATA,sha256=hZ29XA34ml8x7eaoOmDF7OVYM1LJv3Idmx5NPKUoqVM,1807
+pystac_ext_table-1.2.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+pystac_ext_table-1.2.0.dist-info/RECORD,,

pystac_ext_table-1.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any