Remove ITEMCOLLECTION from STACObjectTypes

Author: duckontheweb

pystac/item_collection.py

@@ -140,7 +140,7 @@ def from_dict(cls, d: Dict[str, Any]) -> "ItemCollection":
         Arguments:
             d : The dictionary from which the :class:`~ItemCollection` will be created
         """
-        if identify_stac_object_type(d) != pystac.STACObjectType.ITEMCOLLECTION:
+        if not cls.is_item_collection(d):
             raise STACTypeError("Dict is not a valid ItemCollection")
 
         items = [pystac.Item.from_dict(item) for item in d.get("features", [])]
@@ -184,3 +184,29 @@ def save_object(
             stac_io = pystac.StacIO.default()
 
         stac_io.save_json(dest_href, self.to_dict())
+
+    @staticmethod
+    def is_item_collection(d: Dict[str, Any]) -> bool:
+        """Checks if the given dictionary represents a valid :class:`ItemCollection`.
+
+        Args:
+            d : Dictionary to check
+        """
+        typ = d.get("type")
+
+        # All ItemCollections are GeoJSON FeatureCollections
+        if typ != "FeatureCollection":
+            return False
+
+        # If it is a FeatureCollection and has a "stac_version" field, then it is an
+        #  ItemCollection. This will cover ItemCollections from STAC 0.9 to
+        #  <1.0.0-beta.1, when ItemCollections were removed from the core STAC Spec
+        if "stac_version" in d:
+            return True
+
+        # Prior to STAC 0.9 ItemCollections did not have a stac_version field and could
+        #  only be identified by the fact that all of their 'features' are STAC Items.
+        return all(
+            identify_stac_object_type(feature) == pystac.STACObjectType.ITEM
+            for feature in d.get("features", [])
+        )

pystac/serialization/identify.py

@@ -1,6 +1,6 @@
 from enum import Enum
 from functools import total_ordering
-from typing import Any, Dict, List, Optional, Set, TYPE_CHECKING, Union, cast
+from typing import Any, Dict, Optional, Set, TYPE_CHECKING, Union
 
 import pystac
 from pystac.version import STACVersion
@@ -165,44 +165,6 @@ def __repr__(self) -> str:
         )
 
 
-def _identify_stac_extensions(
-    object_type: str, d: Dict[str, Any], version_range: STACVersionRange
-) -> List[str]:
-    """Identifies extensions for STAC Objects that don't list their
-    extensions in a 'stac_extensions' property.
-
-    Returns a list of stac_extensions. May mutate the version_range to update
-    min or max version.
-    """
-    stac_extensions: Set[str] = set([])
-
-    # assets (collection assets)
-
-    if object_type == pystac.STACObjectType.ITEMCOLLECTION:
-        if "assets" in d:
-            stac_extensions.add("assets")
-            version_range.set_min(STACVersionID("0.8.0"))
-
-    # checksum
-    if "links" in d:
-        for link in d["links"]:
-            link_props = cast(Dict[str, Any], link).keys()
-
-            if any(prop.startswith("checksum:") for prop in link_props):
-                stac_extensions.add(OldExtensionShortIDs.CHECKSUM.value)
-                version_range.set_min(STACVersionID("0.6.2"))
-
-    # Single File STAC
-    if object_type == pystac.STACObjectType.ITEMCOLLECTION:
-        if "collections" in d:
-            stac_extensions.add(OldExtensionShortIDs.SINGLE_FILE_STAC.value)
-            version_range.set_min(STACVersionID("0.8.0"))
-            if "stac_extensions" not in d:
-                version_range.set_max(STACVersionID("0.8.1"))
-
-    return list(stac_extensions)
-
-
 def identify_stac_object_type(
     json_dict: Dict[str, Any]
 ) -> Optional["STACObjectType_Type"]:
@@ -227,15 +189,11 @@ def identify_stac_object_type(
 
     obj_type = json_dict.get("type")
 
-    # For pre-1.0 objects for version 0.8.* or later 'stac_version' must be present,
-    # except for in ItemCollections (which are handled in the else clause)
+    # For pre-1.0 objects for version 0.8.* or later 'stac_version' must be present
     if "stac_version" in json_dict:
         # Pre-1.0 STAC objects with 'type' == "Feature" are Items
         if obj_type == "Feature":
             return pystac.STACObjectType.ITEM
-        # Pre-1.0 STAC objects with 'type' == "FeatureCollection" are ItemCollections
-        if obj_type == "FeatureCollection":
-            return pystac.STACObjectType.ITEMCOLLECTION
         # Anything else with a 'type' field is not a STAC object
         if obj_type is not None:
             return None
@@ -246,16 +204,8 @@ def identify_stac_object_type(
         # Everything else that has a stac_version is a Catalog
         else:
             return pystac.STACObjectType.CATALOG
-    else:
-        # Prior to STAC 0.9 ItemCollections did not have a stac_version field and could
-        # only be identified by the fact that all of their 'features' are STAC Items
-        if obj_type == "FeatureCollection":
-            if all(
-                identify_stac_object_type(feat) == pystac.STACObjectType.ITEM
-                for feat in json_dict.get("features", [])
-            ):
-                return pystac.STACObjectType.ITEMCOLLECTION
-        return None
+
+    return None
 
 
 def identify_stac_object(json_dict: Dict[str, Any]) -> STACJSONDescription:
@@ -287,19 +237,7 @@ def identify_stac_object(json_dict: Dict[str, Any]) -> STACJSONDescription:
         version_range.set_min(STACVersionID("0.8.0"))
 
     if stac_extensions is None:
-        # If this is post-0.8, we can assume there are no extensions
-        # if the stac_extensions property doesn't exist for everything
-        # but ItemCollection (except after 0.9.0, when ItemCollection also got
-        # the stac_extensions property).
-        if (
-            object_type == pystac.STACObjectType.ITEMCOLLECTION
-            and not version_range.is_later_than("0.8.1")
-        ):
-            stac_extensions = _identify_stac_extensions(
-                object_type, json_dict, version_range
-            )
-        else:
-            stac_extensions = []
+        stac_extensions = []
 
         # Between 1.0.0-beta.2 and 1.0.0-RC1, STAC extensions changed from
         # being split between 'common' and custom extensions, with common

pystac/serialization/migrate.py

@@ -33,16 +33,7 @@ def _migrate_item(
     pass
 
 
-def _migrate_itemcollection(
-    d: Dict[str, Any], version: STACVersionID, info: STACJSONDescription
-) -> None:
-    if version < "0.9.0":
-        d["stac_extensions"] = list(info.extensions)
-
-
 # Extensions
-
-
 def _migrate_item_assets(
     d: Dict[str, Any], version: STACVersionID, info: STACJSONDescription
 ) -> Optional[Set[str]]:
@@ -83,7 +74,6 @@ def _get_object_migrations() -> Dict[
         pystac.STACObjectType.CATALOG: _migrate_catalog,
         pystac.STACObjectType.COLLECTION: _migrate_collection,
         pystac.STACObjectType.ITEM: _migrate_item,
-        pystac.STACObjectType.ITEMCOLLECTION: _migrate_itemcollection,
     }
 
 

pystac/stac_object.py

@@ -18,7 +18,6 @@ def __str__(self) -> str:
     CATALOG = "CATALOG"
     COLLECTION = "COLLECTION"
     ITEM = "ITEM"
-    ITEMCOLLECTION = "ITEMCOLLECTION"
 
 
 class STACObject(ABC):

pystac/validation/schema_uri_map.py

@@ -71,13 +71,6 @@ class DefaultSchemaUriMap(SchemaUriMap):
             None,
         ),
         STACObjectType.ITEM: ("item-spec/json-schema/item.json", None),
-        STACObjectType.ITEMCOLLECTION: (
-            None,
-            [
-                STACVersionRange(min_version="v0.8.0-rc1", max_version="0.9.0"),
-                "item-spec/json-schema/itemcollection.json",
-            ],
-        ),
     }
 
     @classmethod

tests/serialization/test_identify.py

@@ -68,47 +68,11 @@ def test_identify_non_stac_raises_error(self) -> None:
 
         self.assertIn("JSON does not represent a STAC object", str(ctx.exception))
 
-    def test_identify_0_8_itemcollection_type(self) -> None:
-        itemcollection_path = TestCases.get_path(
-            "data-files/examples/0.8.1/item-spec/"
-            "examples/itemcollection-sample-full.json"
-        )
-        itemcollection_dict = pystac.StacIO.default().read_json(itemcollection_path)
-
-        self.assertEqual(
-            identify_stac_object_type(itemcollection_dict),
-            pystac.STACObjectType.ITEMCOLLECTION,
-        )
-
-    def test_identify_0_9_itemcollection(self) -> None:
-        itemcollection_path = TestCases.get_path(
-            "data-files/examples/0.9.0/item-spec/"
-            "examples/itemcollection-sample-full.json"
-        )
-        itemcollection_dict = pystac.StacIO.default().read_json(itemcollection_path)
-
-        self.assertEqual(
-            identify_stac_object_type(itemcollection_dict),
-            pystac.STACObjectType.ITEMCOLLECTION,
-        )
-
     def test_identify_invalid_with_stac_version(self) -> None:
         not_stac = {"stac_version": "0.9.0", "type": "Custom"}
 
         self.assertIsNone(identify_stac_object_type(not_stac))
 
-    def test_identify_0_8_itemcollection(self) -> None:
-        itemcollection_path = TestCases.get_path(
-            "data-files/examples/0.8.1/item-spec/"
-            "examples/itemcollection-sample-full.json"
-        )
-        itemcollection_dict = pystac.StacIO.default().read_json(itemcollection_path)
-
-        actual = identify_stac_object(itemcollection_dict)
-
-        self.assertEqual(actual.object_type, pystac.STACObjectType.ITEMCOLLECTION)
-        self.assertTrue(actual.version_range.contains("0.8.1"))
-
 
 class VersionTest(unittest.TestCase):
     def test_version_ordering(self) -> None:

tests/serialization/test_migrate.py

@@ -49,12 +49,6 @@ def test_migrate(self) -> None:
                         e_id.endswith(".json"), f"{e_id} is not a JSON schema URI"
                     )
 
-                # Test that PySTAC can read it without errors.
-                if info.object_type != pystac.STACObjectType.ITEMCOLLECTION:
-                    self.assertIsInstance(
-                        pystac.read_dict(migrated_d, href=path), pystac.STACObject
-                    )
-
     def test_migrates_removed_extension(self) -> None:
         item = pystac.Item.from_file(
             TestCases.get_path(

tests/test_item_collection.py

@@ -125,3 +125,27 @@ def test_add_other_raises_error(self) -> None:
 
         with self.assertRaises(TypeError):
             _ = item_collection + 2
+
+    def test_identify_0_8_itemcollection_type(self) -> None:
+        itemcollection_path = TestCases.get_path(
+            "data-files/examples/0.8.1/item-spec/"
+            "examples/itemcollection-sample-full.json"
+        )
+        itemcollection_dict = pystac.StacIO.default().read_json(itemcollection_path)
+
+        self.assertTrue(
+            pystac.ItemCollection.is_item_collection(itemcollection_dict),
+            msg="Did not correctly identify valid STAC 0.8 ItemCollection.",
+        )
+
+    def test_identify_0_9_itemcollection(self) -> None:
+        itemcollection_path = TestCases.get_path(
+            "data-files/examples/0.9.0/item-spec/"
+            "examples/itemcollection-sample-full.json"
+        )
+        itemcollection_dict = pystac.StacIO.default().read_json(itemcollection_path)
+
+        self.assertTrue(
+            pystac.ItemCollection.is_item_collection(itemcollection_dict),
+            msg="Did not correctly identify valid STAC 0.9 ItemCollection.",
+        )