pystac-ext-xarray-assets 1.0.0__tar.gz

pystac_ext_xarray_assets-1.0.0/.gitignore

@@ -0,0 +1,163 @@
+*.pyc
+*.egg-info
+*.eggs
+.DS_Store
+data
+config.json
+stdout*
+/integration*
+.idea
+.vscode
+.actrc
+
+
+# Sphinx documentation
+.ipynb_checkpoints/
+
+docs/tutorials/pystac-example*
+docs/tutorials/spacenet-stac/
+docs/tutorials/spacenet-cog-stac/
+docs/tutorials/data/
+docs/quickstart_stac/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# asv environments
+.asv

pystac_ext_xarray_assets-1.0.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: pystac-ext-xarray-assets
+Version: 1.0.0
+Summary: Xarray Assets 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,xarray-assets
+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-xarray-assets
+
+[PySTAC](https://pypi.org/project/pystac/) extension package for the [Xarray Assets Extension](https://github.com/stac-extensions/xarray-assets).
+This extension provides fields for describing how assets can be opened with [xarray](https://xarray.dev/), including storage options, open parameters, and engine configuration.
+
+## Supported versions
+
+- [v1.0.0](https://stac-extensions.github.io/xarray-assets/v1.0.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.0.0.post1`.

pystac_ext_xarray_assets-1.0.0/README.md

@@ -0,0 +1,13 @@
+# pystac-ext-xarray-assets
+
+[PySTAC](https://pypi.org/project/pystac/) extension package for the [Xarray Assets Extension](https://github.com/stac-extensions/xarray-assets).
+This extension provides fields for describing how assets can be opened with [xarray](https://xarray.dev/), including storage options, open parameters, and engine configuration.
+
+## Supported versions
+
+- [v1.0.0](https://stac-extensions.github.io/xarray-assets/v1.0.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.0.0.post1`.

pystac_ext_xarray_assets-1.0.0/pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "pystac-ext-xarray-assets"
+description = "Xarray Assets extension for PySTAC"
+readme = "README.md"
+version = "1.0.0"
+authors = []
+maintainers = []
+keywords = ["pystac", "imagery", "raster", "catalog", "STAC", "xarray-assets"]
+license = { text = "Apache-2.0" }
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+requires-python = ">=3.10"
+dependencies = ["pystac-core"]
+
+[project.urls]
+Documentation = "https://pystac.readthedocs.io"
+Repository = "https://github.com/stac-utils/pystac"
+Issues = "https://github.com/stac-utils/pystac/issues"
+Changelog = "https://github.com/stac-utils/pystac/blob/main/CHANGELOG.md"
+Discussions = "https://github.com/radiantearth/stac-spec/discussions/categories/stac-software"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["pystac"]

pystac_ext_xarray_assets-1.0.0/pystac/extensions/xarray_assets.py

@@ -0,0 +1,167 @@
+"""Implements the :stac-ext:`Xarray Assets Extension <xarray>`."""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+from typing import Any, Generic, Literal, TypeVar
+
+import pystac
+from pystac.extensions.base import ExtensionManagementMixin, PropertiesExtension
+from pystac.extensions.hooks import ExtensionHooks
+
+#: Generalized version of :class:`~pystac.Collection`,
+#: :class:`~pystac.Item`, or :class:`~pystac.Asset`
+T = TypeVar("T", pystac.Collection, pystac.Item, pystac.Asset)
+
+SCHEMA_URI = "https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json"
+
+PREFIX: str = "xarray:"
+OPEN_KWARGS_PROP = PREFIX + "open_kwargs"
+STORAGE_OPTIONS_PROP = PREFIX + "storage_options"
+
+
+class XarrayAssetsExtension(
+    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:`Xarray Assets Extension <xarray>`. 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:`XarrayAssetsExtension`, use the
+    :meth:`XarrayAssetsExtension.ext` method. For example:
+
+    .. code-block:: python
+
+        >>> item: pystac.Item = ...
+        >>> xr_ext = XarrayAssetsExtension.ext(item)
+
+    """
+
+    name: Literal["xarray"] = "xarray"
+
+    @classmethod
+    def get_schema_uri(cls) -> str:
+        return SCHEMA_URI
+
+    @classmethod
+    def ext(cls, obj: T, add_if_missing: bool = False) -> XarrayAssetsExtension[T]:
+        """Extend the given STAC Object with properties from the
+        :stac-ext:`XarrayAssets Extension <xarray>`.
+
+        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 CollectionXarrayAssetsExtension(obj)
+        if isinstance(obj, pystac.Item):
+            cls.ensure_has_extension(obj, add_if_missing)
+            return ItemXarrayAssetsExtension(obj)
+        if isinstance(obj, pystac.Asset):
+            cls.ensure_owner_has_extension(obj, add_if_missing)
+            return AssetXarrayAssetsExtension(obj)
+        else:
+            raise pystac.ExtensionTypeError(cls._ext_error_message(obj))
+
+
+class CollectionXarrayAssetsExtension(XarrayAssetsExtension[pystac.Collection]):
+    """A concrete implementation of :class:`XarrayAssetsExtension` on a
+    :class:`~pystac.Collection` that extends the properties of the Item to include
+    properties defined in the :stac-ext:`XarrayAssets Extension <xarray>`.
+
+    This class should generally not be instantiated directly. Instead, call
+    :meth:`XarrayAssetsExtension.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
+
+    def __repr__(self) -> str:
+        return f"<CollectionXarrayAssetsExtension Item id={self.collection.id}>"
+
+
+class ItemXarrayAssetsExtension(XarrayAssetsExtension[pystac.Item]):
+    """A concrete implementation of :class:`XarrayAssetsExtension` on an
+    :class:`~pystac.Item` that extends the properties of the Item to include properties
+    defined in the :stac-ext:`XarrayAssets Extension <xarray>`.
+
+    This class should generally not be instantiated directly. Instead, call
+    :meth:`XarrayAssetsExtension.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"<ItemXarrayAssetsExtension Item id={self.item.id}>"
+
+
+class AssetXarrayAssetsExtension(XarrayAssetsExtension[pystac.Asset]):
+    """A concrete implementation of :class:`XarrayAssetsExtension` on an
+    :class:`~pystac.Asset` that extends the Asset fields to include properties defined
+    in the :stac-ext:`XarrayAssets Extension <xarray>`.
+
+    This class should generally not be instantiated directly. Instead, call
+    :meth:`XarrayAssetsExtension.ext` on an :class:`~pystac.Asset` to extend it.
+    """
+
+    asset: pystac.Asset
+    properties: dict[str, Any]
+    additional_read_properties: Iterable[dict[str, Any]] | None = None
+
+    def __init__(self, asset: pystac.Asset):
+        self.asset = asset
+        self.properties = asset.extra_fields
+        if asset.owner and isinstance(asset.owner, pystac.Item):
+            self.additional_read_properties = [asset.owner.properties]
+
+    @property
+    def storage_options(self) -> dict[str, Any] | None:
+        """Additional keywords for accessing the dataset from remote storage"""
+        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
+
+    @property
+    def open_kwargs(self) -> dict[str, Any] | None:
+        """Additional keywords for opening the dataset"""
+        return self.properties.get(OPEN_KWARGS_PROP)
+
+    @open_kwargs.setter
+    def open_kwargs(self, v: dict[str, Any] | None) -> Any:
+        if v is None:
+            self.properties.pop(OPEN_KWARGS_PROP, None)
+        else:
+            self.properties[OPEN_KWARGS_PROP] = v
+
+    def __repr__(self) -> str:
+        return f"<AssetXarrayAssetsExtension Asset href={self.asset.href}>"
+
+
+class XarrayAssetsExtensionHooks(ExtensionHooks):
+    schema_uri: str = SCHEMA_URI
+    prev_extension_ids = {"xarray"}
+    stac_object_types = {pystac.STACObjectType.COLLECTION, pystac.STACObjectType.ITEM}
+
+
+XARRAY_ASSETS_EXTENSION_HOOKS: ExtensionHooks = XarrayAssetsExtensionHooks()

pystac_ext_xarray_assets-1.0.0/tests/cassettes/test_xarray_assets/test_collection_validate.yaml

@@ -0,0 +1,54 @@
+interactions:
+- request:
+    body: null
+    headers: {}
+    method: GET
+    uri: https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json
+  response:
+    body:
+      string: "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"$id\":
+        \"https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json#\",\n
+        \ \"title\": \"xarray Assets Extension\",\n  \"description\": \"xarray Assets
+        Extension for STAC Items and STAC Collections.\",\n  \"oneOf\": [\n    {\n
+        \     \"$comment\": \"This is the schema for STAC Items. Remove this object
+        if this extension only applies to Collections.\",\n      \"allOf\": [\n        {\n
+        \         \"type\": \"object\",\n          \"required\": [\n            \"type\",\n
+        \           \"properties\",\n            \"assets\"\n          ],\n          \"properties\":
+        {\n            \"type\": {\n              \"const\": \"Feature\"\n            },\n
+        \           \"properties\": {\n              \"allOf\": [\n                {\n
+        \                 \"$comment\": \"Require fields here for item properties.\"\n
+        \               },\n                {\n                  \"$ref\": \"#/definitions/fields\"\n
+        \               }\n              ]\n            },\n            \"assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       }\n      ]\n    },\n    {\n      \"$comment\": \"This is the schema
+        for STAC Collections. Remove this object if this extension does not define
+        top-level fields for Collections AND can't be used in collection assets or
+        item asset defintions.\",\n      \"allOf\": [\n        {\n          \"type\":
+        \"object\",\n          \"required\": [\n            \"type\"\n          ],\n
+        \         \"properties\": {\n            \"type\": {\n              \"const\":
+        \"Collection\"\n            },\n            \"assets\": {\n              \"type\":
+        \"object\",\n              \"additionalProperties\": {\n                \"$ref\":
+        \"#/definitions/fields\"\n              }\n            },\n            \"item_assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       },\n        {\n          \"$comment\": \"Remove this object if this
+        extension does not define top-level fields for Collections.\",\n          \"$ref\":
+        \"#/definitions/fields\"\n        }\n      ]\n    }\n  ],\n  \"definitions\":
+        {\n    \"stac_extensions\": {\n      \"type\": \"object\",\n      \"required\":
+        [\n        \"stac_extensions\"\n      ],\n      \"properties\": {\n        \"stac_extensions\":
+        {\n          \"type\": \"array\",\n          \"contains\": {\n            \"const\":
+        \"https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json\"\n          }\n
+        \       }\n      }\n    },\n    \"fields\": {\n      \"type\": \"object\",\n
+        \     \"properties\": {\n        \"xarray:open_kwargs\": {\n          \"type\":
+        \"object\"\n        },\n        \"xarray:storage_options\": {\n          \"type\":
+        \"object\"\n        }\n      },\n      \"patternProperties\": {\n        \"^(?!xarray:)\":
+        {\n          \"$comment\": \"\"\n        }\n      },\n      \"additionalProperties\":
+        false\n    }\n  }\n}"
+    headers: {}
+    status:
+      code: 200
+      message: OK
+version: 1

pystac_ext_xarray_assets-1.0.0/tests/cassettes/test_xarray_assets/test_item_validate.yaml

@@ -0,0 +1,54 @@
+interactions:
+- request:
+    body: null
+    headers: {}
+    method: GET
+    uri: https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json
+  response:
+    body:
+      string: "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"$id\":
+        \"https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json#\",\n
+        \ \"title\": \"xarray Assets Extension\",\n  \"description\": \"xarray Assets
+        Extension for STAC Items and STAC Collections.\",\n  \"oneOf\": [\n    {\n
+        \     \"$comment\": \"This is the schema for STAC Items. Remove this object
+        if this extension only applies to Collections.\",\n      \"allOf\": [\n        {\n
+        \         \"type\": \"object\",\n          \"required\": [\n            \"type\",\n
+        \           \"properties\",\n            \"assets\"\n          ],\n          \"properties\":
+        {\n            \"type\": {\n              \"const\": \"Feature\"\n            },\n
+        \           \"properties\": {\n              \"allOf\": [\n                {\n
+        \                 \"$comment\": \"Require fields here for item properties.\"\n
+        \               },\n                {\n                  \"$ref\": \"#/definitions/fields\"\n
+        \               }\n              ]\n            },\n            \"assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       }\n      ]\n    },\n    {\n      \"$comment\": \"This is the schema
+        for STAC Collections. Remove this object if this extension does not define
+        top-level fields for Collections AND can't be used in collection assets or
+        item asset defintions.\",\n      \"allOf\": [\n        {\n          \"type\":
+        \"object\",\n          \"required\": [\n            \"type\"\n          ],\n
+        \         \"properties\": {\n            \"type\": {\n              \"const\":
+        \"Collection\"\n            },\n            \"assets\": {\n              \"type\":
+        \"object\",\n              \"additionalProperties\": {\n                \"$ref\":
+        \"#/definitions/fields\"\n              }\n            },\n            \"item_assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       },\n        {\n          \"$comment\": \"Remove this object if this
+        extension does not define top-level fields for Collections.\",\n          \"$ref\":
+        \"#/definitions/fields\"\n        }\n      ]\n    }\n  ],\n  \"definitions\":
+        {\n    \"stac_extensions\": {\n      \"type\": \"object\",\n      \"required\":
+        [\n        \"stac_extensions\"\n      ],\n      \"properties\": {\n        \"stac_extensions\":
+        {\n          \"type\": \"array\",\n          \"contains\": {\n            \"const\":
+        \"https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json\"\n          }\n
+        \       }\n      }\n    },\n    \"fields\": {\n      \"type\": \"object\",\n
+        \     \"properties\": {\n        \"xarray:open_kwargs\": {\n          \"type\":
+        \"object\"\n        },\n        \"xarray:storage_options\": {\n          \"type\":
+        \"object\"\n        }\n      },\n      \"patternProperties\": {\n        \"^(?!xarray:)\":
+        {\n          \"$comment\": \"\"\n        }\n      },\n      \"additionalProperties\":
+        false\n    }\n  }\n}"
+    headers: {}
+    status:
+      code: 200
+      message: OK
+version: 1

pystac_ext_xarray_assets-1.0.0/tests/cassettes/test_xarray_assets/test_set_field[open_kwargs-value1].yaml

@@ -0,0 +1,54 @@
+interactions:
+- request:
+    body: null
+    headers: {}
+    method: GET
+    uri: https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json
+  response:
+    body:
+      string: "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"$id\":
+        \"https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json#\",\n
+        \ \"title\": \"xarray Assets Extension\",\n  \"description\": \"xarray Assets
+        Extension for STAC Items and STAC Collections.\",\n  \"oneOf\": [\n    {\n
+        \     \"$comment\": \"This is the schema for STAC Items. Remove this object
+        if this extension only applies to Collections.\",\n      \"allOf\": [\n        {\n
+        \         \"type\": \"object\",\n          \"required\": [\n            \"type\",\n
+        \           \"properties\",\n            \"assets\"\n          ],\n          \"properties\":
+        {\n            \"type\": {\n              \"const\": \"Feature\"\n            },\n
+        \           \"properties\": {\n              \"allOf\": [\n                {\n
+        \                 \"$comment\": \"Require fields here for item properties.\"\n
+        \               },\n                {\n                  \"$ref\": \"#/definitions/fields\"\n
+        \               }\n              ]\n            },\n            \"assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       }\n      ]\n    },\n    {\n      \"$comment\": \"This is the schema
+        for STAC Collections. Remove this object if this extension does not define
+        top-level fields for Collections AND can't be used in collection assets or
+        item asset defintions.\",\n      \"allOf\": [\n        {\n          \"type\":
+        \"object\",\n          \"required\": [\n            \"type\"\n          ],\n
+        \         \"properties\": {\n            \"type\": {\n              \"const\":
+        \"Collection\"\n            },\n            \"assets\": {\n              \"type\":
+        \"object\",\n              \"additionalProperties\": {\n                \"$ref\":
+        \"#/definitions/fields\"\n              }\n            },\n            \"item_assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       },\n        {\n          \"$comment\": \"Remove this object if this
+        extension does not define top-level fields for Collections.\",\n          \"$ref\":
+        \"#/definitions/fields\"\n        }\n      ]\n    }\n  ],\n  \"definitions\":
+        {\n    \"stac_extensions\": {\n      \"type\": \"object\",\n      \"required\":
+        [\n        \"stac_extensions\"\n      ],\n      \"properties\": {\n        \"stac_extensions\":
+        {\n          \"type\": \"array\",\n          \"contains\": {\n            \"const\":
+        \"https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json\"\n          }\n
+        \       }\n      }\n    },\n    \"fields\": {\n      \"type\": \"object\",\n
+        \     \"properties\": {\n        \"xarray:open_kwargs\": {\n          \"type\":
+        \"object\"\n        },\n        \"xarray:storage_options\": {\n          \"type\":
+        \"object\"\n        }\n      },\n      \"patternProperties\": {\n        \"^(?!xarray:)\":
+        {\n          \"$comment\": \"\"\n        }\n      },\n      \"additionalProperties\":
+        false\n    }\n  }\n}"
+    headers: {}
+    status:
+      code: 200
+      message: OK
+version: 1

pystac_ext_xarray_assets-1.0.0/tests/cassettes/test_xarray_assets/test_set_field[storage_options-value0].yaml

@@ -0,0 +1,54 @@
+interactions:
+- request:
+    body: null
+    headers: {}
+    method: GET
+    uri: https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json
+  response:
+    body:
+      string: "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"$id\":
+        \"https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json#\",\n
+        \ \"title\": \"xarray Assets Extension\",\n  \"description\": \"xarray Assets
+        Extension for STAC Items and STAC Collections.\",\n  \"oneOf\": [\n    {\n
+        \     \"$comment\": \"This is the schema for STAC Items. Remove this object
+        if this extension only applies to Collections.\",\n      \"allOf\": [\n        {\n
+        \         \"type\": \"object\",\n          \"required\": [\n            \"type\",\n
+        \           \"properties\",\n            \"assets\"\n          ],\n          \"properties\":
+        {\n            \"type\": {\n              \"const\": \"Feature\"\n            },\n
+        \           \"properties\": {\n              \"allOf\": [\n                {\n
+        \                 \"$comment\": \"Require fields here for item properties.\"\n
+        \               },\n                {\n                  \"$ref\": \"#/definitions/fields\"\n
+        \               }\n              ]\n            },\n            \"assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       }\n      ]\n    },\n    {\n      \"$comment\": \"This is the schema
+        for STAC Collections. Remove this object if this extension does not define
+        top-level fields for Collections AND can't be used in collection assets or
+        item asset defintions.\",\n      \"allOf\": [\n        {\n          \"type\":
+        \"object\",\n          \"required\": [\n            \"type\"\n          ],\n
+        \         \"properties\": {\n            \"type\": {\n              \"const\":
+        \"Collection\"\n            },\n            \"assets\": {\n              \"type\":
+        \"object\",\n              \"additionalProperties\": {\n                \"$ref\":
+        \"#/definitions/fields\"\n              }\n            },\n            \"item_assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       },\n        {\n          \"$comment\": \"Remove this object if this
+        extension does not define top-level fields for Collections.\",\n          \"$ref\":
+        \"#/definitions/fields\"\n        }\n      ]\n    }\n  ],\n  \"definitions\":
+        {\n    \"stac_extensions\": {\n      \"type\": \"object\",\n      \"required\":
+        [\n        \"stac_extensions\"\n      ],\n      \"properties\": {\n        \"stac_extensions\":
+        {\n          \"type\": \"array\",\n          \"contains\": {\n            \"const\":
+        \"https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json\"\n          }\n
+        \       }\n      }\n    },\n    \"fields\": {\n      \"type\": \"object\",\n
+        \     \"properties\": {\n        \"xarray:open_kwargs\": {\n          \"type\":
+        \"object\"\n        },\n        \"xarray:storage_options\": {\n          \"type\":
+        \"object\"\n        }\n      },\n      \"patternProperties\": {\n        \"^(?!xarray:)\":
+        {\n          \"$comment\": \"\"\n        }\n      },\n      \"additionalProperties\":
+        false\n    }\n  }\n}"
+    headers: {}
+    status:
+      code: 200
+      message: OK
+version: 1

pystac_ext_xarray_assets-1.0.0/tests/data-files/collection.json

@@ -0,0 +1,61 @@
+{
+  "stac_version": "1.1.0",
+  "stac_extensions": [
+    "https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json"
+  ],
+  "type": "Collection",
+  "id": "collection",
+  "title": "A title",
+  "description": "A description",
+  "license": "Apache-2.0",
+  "extent": {
+    "spatial": {
+      "bbox": [
+        [
+          172.9,
+          1.3,
+          173,
+          1.4
+        ]
+      ]
+    },
+    "temporal": {
+      "interval": [
+        [
+          "2015-06-23T00:00:00Z",
+          null
+        ]
+      ]
+    }
+  },
+  "assets": {
+    "example": {
+      "href": "abfs://cpdata/raw/terraclimate/4000m/raster.zarr",
+      "type": "application/vnd+zarr",
+      "xarray:storage_options": {
+        "account_name": "cpdataeuwest"
+      },
+      "xarray:open_kwargs": {
+        "consolidated": true
+      }
+    }
+  },
+  "summaries": {
+    "datetime": {
+      "minimum": "2015-06-23T00:00:00Z",
+      "maximum": "2019-07-10T13:44:56Z"
+    }
+  },
+  "links": [
+    {
+      "href": "./collection.json",
+      "rel": "root",
+      "title": "A title",
+      "type": "application/json"
+    },
+    {
+      "href": "./item.json",
+      "rel": "item"
+    }
+  ]
+}

pystac_ext_xarray_assets-1.0.0/tests/data-files/item.json

@@ -0,0 +1,56 @@
+{
+  "stac_version": "1.1.0",
+  "stac_extensions": [
+    "https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json"
+  ],
+  "type": "Feature",
+  "id": "item",
+  "bbox": [
+    172.9,
+    1.3,
+    173,
+    1.4
+  ],
+  "geometry": {
+    "type": "Polygon",
+    "coordinates": [
+      [
+        [
+          172.9,
+          1.3
+        ],
+        [
+          173,
+          1.3
+        ],
+        [
+          173,
+          1.4
+        ],
+        [
+          172.9,
+          1.4
+        ],
+        [
+          172.9,
+          1.3
+        ]
+      ]
+    ]
+  },
+  "properties": {
+    "datetime": "2020-12-11T22:38:32Z"
+  },
+  "links": [],
+  "assets": {
+    "data": {
+      "href": "abfs://example.com/examples/file.zarr",
+      "xarray:storage_options": {
+        "account_name": "test-account"
+      },
+      "xarray:open_kwargs": {
+        "consolidated": true
+      }
+    }
+  }
+}

pystac_ext_xarray_assets-1.0.0/tests/test_xarray_assets.py

@@ -0,0 +1,162 @@
+"""Tests for pystac.tests.extensions.xarray_assets"""
+
+import json
+from pathlib import Path
+
+import pytest
+
+import pystac
+from pystac.extensions.xarray_assets import XarrayAssetsExtension
+
+DATA_FILES = Path(__file__).resolve().parent / "data-files"
+
+
+@pytest.fixture
+def ext_collection_uri() -> str:
+    return str(DATA_FILES / "collection.json")
+
+
+@pytest.fixture
+def ext_collection(ext_collection_uri: str) -> pystac.Collection:
+    return pystac.Collection.from_file(ext_collection_uri)
+
+
+@pytest.fixture
+def ext_item_uri() -> str:
+    return str(DATA_FILES / "item.json")
+
+
+@pytest.fixture
+def ext_item(ext_item_uri: str) -> pystac.Item:
+    return pystac.Item.from_file(ext_item_uri)
+
+
+@pytest.fixture
+def ext_asset(ext_item: pystac.Item) -> pystac.Asset:
+    return ext_item.assets["data"]
+
+
+def test_item_stac_extensions(ext_item: pystac.Item) -> None:
+    assert XarrayAssetsExtension.has_extension(ext_item)
+
+
+def test_collection_stac_extensions(ext_collection: pystac.Collection) -> None:
+    assert XarrayAssetsExtension.has_extension(ext_collection)
+
+
+def test_item_get_schema_uri(ext_item: pystac.Item) -> None:
+    assert XarrayAssetsExtension.get_schema_uri() in ext_item.stac_extensions
+
+
+def test_collection_get_schema_uri(ext_collection: pystac.Collection) -> None:
+    assert XarrayAssetsExtension.get_schema_uri() in ext_collection.stac_extensions
+
+
+def test_ext_raises_if_item_does_not_conform(item: pystac.Item) -> None:
+    with pytest.raises(pystac.errors.ExtensionNotImplemented):
+        XarrayAssetsExtension.ext(item)
+
+
+def test_ext_raises_if_collection_does_not_conform(
+    collection: pystac.Collection,
+) -> None:
+    with pytest.raises(pystac.errors.ExtensionNotImplemented):
+        XarrayAssetsExtension.ext(collection)
+
+
+def test_ext_raises_on_catalog(catalog: pystac.Catalog) -> None:
+    with pytest.raises(
+        pystac.errors.ExtensionTypeError,
+        match="XarrayAssetsExtension does not apply to type 'Catalog'",
+    ):
+        XarrayAssetsExtension.ext(catalog)  # type: ignore
+
+
+def test_item_to_from_dict(ext_item_uri: str, ext_item: pystac.Item) -> None:
+    with open(ext_item_uri) as f:
+        d = json.load(f)
+    actual = ext_item.to_dict(include_self_link=False)
+    assert actual == d
+
+
+def test_collection_to_from_dict(
+    ext_collection_uri: str, ext_collection: pystac.Item
+) -> None:
+    with open(ext_collection_uri) as f:
+        d = json.load(f)
+    actual = ext_collection.to_dict(include_self_link=False)
+    assert actual == d
+
+
+def test_add_to_item(item: pystac.Item) -> None:
+    assert not XarrayAssetsExtension.has_extension(item)
+    XarrayAssetsExtension.add_to(item)
+
+    assert XarrayAssetsExtension.has_extension(item)
+
+
+def test_add_to_collection(collection: pystac.Collection) -> None:
+    assert not XarrayAssetsExtension.has_extension(collection)
+    XarrayAssetsExtension.add_to(collection)
+
+    assert XarrayAssetsExtension.has_extension(collection)
+
+
+@pytest.mark.vcr
+def test_item_validate(ext_item: pystac.Item) -> None:
+    assert ext_item.validate()
+
+
+@pytest.mark.vcr
+def test_collection_validate(ext_collection: pystac.Collection) -> None:
+    assert ext_collection.validate()
+
+
+def test_fields_are_not_on_item(ext_item: pystac.Item) -> None:
+    assert not hasattr(XarrayAssetsExtension.ext(ext_item), "storage_options")
+    assert not hasattr(XarrayAssetsExtension.ext(ext_item), "open_kwargs")
+
+
+def test_fields_are_not_on_collection(ext_collection: pystac.Item) -> None:
+    assert not hasattr(XarrayAssetsExtension.ext(ext_collection), "storage_options")
+    assert not hasattr(XarrayAssetsExtension.ext(ext_collection), "open_kwargs")
+
+
+@pytest.mark.parametrize("field", ["storage_options", "open_kwargs"])
+def test_get_field(ext_asset: pystac.Asset, field: str) -> None:
+    prop = ext_asset.extra_fields[f"xarray:{field}"]
+    attr = getattr(XarrayAssetsExtension.ext(ext_asset), field)
+
+    assert attr is not None
+    assert attr == prop
+
+
+@pytest.mark.parametrize(
+    "field,value",
+    [
+        ("storage_options", {"anon": True}),
+        ("open_kwargs", {"engine": "zarr"}),
+    ],
+)
+@pytest.mark.vcr
+def test_set_field(ext_asset: pystac.Asset, field: str, value) -> None:  # type: ignore
+    original = ext_asset.extra_fields[f"xarray:{field}"]
+    setattr(XarrayAssetsExtension.ext(ext_asset), field, value)
+    new = ext_asset.extra_fields[f"xarray:{field}"]
+
+    assert new != original
+    assert new == value
+
+    item = ext_asset.owner
+    assert item is not None
+    assert isinstance(item, pystac.Item)
+    assert item.validate()
+
+
+@pytest.mark.parametrize("field", ["storage_options", "open_kwargs"])
+def test_set_field_to_none_pops_from_dict(ext_asset: pystac.Asset, field: str) -> None:
+    prop_name = f"xarray:{field}"
+    assert prop_name in ext_asset.extra_fields
+
+    setattr(XarrayAssetsExtension.ext(ext_asset), field, None)
+    assert prop_name not in ext_asset.extra_fields