Add MLM extension (stac-utils#1542)

* added missing Classification parameter title

* added changes to changelog

* added missing parameters to test_classification_object: title, nodata, percentage, count

* added ml extension

* added stac:mlm extension tests

* added collection and asset extension

* removed TODO

* added documentation

* added docstring to classes

* renamed asset extension classes

* added mlm extension classes

* added mlm extension

* removed todos

* added extension migration

* removed useless code

* fixed docstrings

* fixed __eq__ NotImplemented

* fixed repr strings

* improved test coverage

* improved test coverage

* changed exceptions

* fixed docstring

* Update CHANGELOG.md

Co-authored-by: Pete Gadomski <[email protected]>

* fixed typo

Co-authored-by: Pete Gadomski <[email protected]>

* fixed typo

Co-authored-by: Pete Gadomski <[email protected]>

* fixed typo

Co-authored-by: Pete Gadomski <[email protected]>

* fixed typo

Co-authored-by: Pete Gadomski <[email protected]>

* fixed typo

Co-authored-by: Pete Gadomski <[email protected]>

* line break to satisfy line length requirement

* fixed typo in ENTRYPOINT_ASSET_PROP

* fixed typo in COMPILE_METHOD_ASSET_PROP

* removed dummy docstring

* fixed Enum tuples

* added mlm to CollectionExt

* added mlm to Asset and ItemAssetDefinition mlm accessor

* Update CHANGELOG.md

---------

Co-authored-by: Pete Gadomski <[email protected]>

Author: 2 people

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Added
 
 - `Collection.from_items` for creating a `pystac.Collection` from an `ItemCollection` ([#1522](https://github.com/stac-utils/pystac/pull/1522))
+- `extensions.mlm` for supporting the [MLM](https://github.com/stac-extensions/mlm) extension ([#1542](https://github.com/stac-utils/pystac/pull/1542))
 
 ### Fixed
 

docs/api/extensions.rst

@@ -20,6 +20,9 @@ pystac.extensions
     grid.GridExtension
     item_assets.ItemAssetsExtension
     mgrs.MgrsExtension
+    mlm.MLMExtension
+    mlm.AssetGeneralMLMExtension
+    mlm.AssetDetailedMLMExtension
     pointcloud.PointcloudExtension
     projection.ProjectionExtension
     raster.RasterExtension

docs/api/extensions/mlm.rst

@@ -0,0 +1,8 @@
+pystac.extensions.mlm
+============================
+
+.. automodule:: pystac.extensions.mlm
+   :members:
+   :inherited-members: StringEnum, Generic, PropertiesExtension, ExtensionManagementMixin
+   :undoc-members:
+

pystac/__init__.py

@@ -100,6 +100,7 @@
     warnings.filterwarnings("ignore", category=DeprecationWarning)
     import pystac.extensions.label
 import pystac.extensions.mgrs
+import pystac.extensions.mlm
 import pystac.extensions.pointcloud
 import pystac.extensions.projection
 import pystac.extensions.raster
@@ -124,6 +125,7 @@
         pystac.extensions.item_assets.ITEM_ASSETS_EXTENSION_HOOKS,
         pystac.extensions.label.LABEL_EXTENSION_HOOKS,
         pystac.extensions.mgrs.MGRS_EXTENSION_HOOKS,
+        pystac.extensions.mlm.MLM_EXTENSION_HOOKS,
         pystac.extensions.pointcloud.POINTCLOUD_EXTENSION_HOOKS,
         pystac.extensions.projection.PROJECTION_EXTENSION_HOOKS,
         pystac.extensions.raster.RASTER_EXTENSION_HOOKS,

pystac/extensions/ext.py

@@ -19,6 +19,11 @@
 from pystac.extensions.grid import GridExtension
 from pystac.extensions.item_assets import ItemAssetsExtension
 from pystac.extensions.mgrs import MgrsExtension
+from pystac.extensions.mlm import (
+    AssetDetailedMLMExtension,
+    AssetGeneralMLMExtension,
+    MLMExtension,
+)
 from pystac.extensions.pointcloud import PointcloudExtension
 from pystac.extensions.projection import ProjectionExtension
 from pystac.extensions.raster import RasterExtension
@@ -49,6 +54,7 @@
     "grid",
     "item_assets",
     "mgrs",
+    "mlm",
     "pc",
     "proj",
     "raster",
@@ -73,6 +79,7 @@
     GridExtension.name: GridExtension,
     ItemAssetsExtension.name: ItemAssetsExtension,
     MgrsExtension.name: MgrsExtension,
+    MLMExtension.name: MLMExtension,
     PointcloudExtension.name: PointcloudExtension,
     ProjectionExtension.name: ProjectionExtension,
     RasterExtension.name: RasterExtension,
@@ -156,6 +163,10 @@ def cube(self) -> DatacubeExtension[Collection]:
     def item_assets(self) -> dict[str, ItemAssetDefinition]:
         return ItemAssetsExtension.ext(self.stac_object).item_assets
 
+    @property
+    def mlm(self) -> MLMExtension[Collection]:
+        return MLMExtension.ext(self.stac_object)
+
     @property
     def render(self) -> dict[str, Render]:
         return RenderExtension.ext(self.stac_object).renders
@@ -232,6 +243,10 @@ def grid(self) -> GridExtension:
     def mgrs(self) -> MgrsExtension:
         return MgrsExtension.ext(self.stac_object)
 
+    @property
+    def mlm(self) -> MLMExtension[Item]:
+        return MLMExtension.ext(self.stac_object)
+
     @property
     def pc(self) -> PointcloudExtension[Item]:
         return PointcloudExtension.ext(self.stac_object)
@@ -404,6 +419,13 @@ class AssetExt(_AssetExt[Asset]):
     def file(self) -> FileExtension[Asset]:
         return FileExtension.ext(self.stac_object)
 
+    @property
+    def mlm(self) -> AssetGeneralMLMExtension[Asset] | AssetDetailedMLMExtension:
+        if "mlm:name" in self.stac_object.extra_fields:
+            return AssetDetailedMLMExtension.ext(self.stac_object)
+        else:
+            return AssetGeneralMLMExtension.ext(self.stac_object)
+
     @property
     def timestamps(self) -> TimestampsExtension[Asset]:
         return TimestampsExtension.ext(self.stac_object)
@@ -425,6 +447,10 @@ class ItemAssetExt(_AssetExt[ItemAssetDefinition]):
 
     stac_object: ItemAssetDefinition
 
+    @property
+    def mlm(self) -> MLMExtension[ItemAssetDefinition]:
+        return MLMExtension.ext(self.stac_object)
+
 
 @dataclass
 class LinkExt(_AssetsExt[Link]):