Merge pull request stac-utils#20 from azavea/sk/add-item-collection-property

add collection property

Author: simonkassel

pystac/catalog.py

@@ -1,5 +1,6 @@
 import os
 import json
+from copy import (deepcopy, copy)
 
 from pystac import STACError
 from pystac import STAC_VERSION
@@ -135,7 +136,7 @@ def to_dict(self, include_self_link=True):
         if self.title is not None:
             d['title'] = self.title
 
-        return d
+        return deepcopy(d)
 
     def clone(self):
         clone = Catalog(id=self.id,

pystac/collection.py

@@ -2,7 +2,7 @@
 from datetime import datetime
 from datetime import timezone
 import dateutil.parser
-from copy import copy
+from copy import (copy, deepcopy)
 import json
 
 from pystac import STACError, STAC_IO
@@ -62,7 +62,7 @@ def to_dict(self, include_self_link=True):
         if self.summaries is not None:
             d['summaries'] = self.summaries
 
-        return d
+        return deepcopy(d)
 
     def clone(self):
         clone = Collection(id=self.id,
@@ -139,11 +139,13 @@ def __init__(self, spatial, temporal):
         self.temporal = temporal
 
     def to_dict(self):
-        return {
+        d = {
             'spatial': self.spatial.to_dict(),
             'temporal': self.temporal.to_dict()
         }
 
+        return deepcopy(d)
+
     def clone(self):
         return Extent(spatial=copy(self.spatial),
                       temporal=copy(self.temporal))
@@ -159,7 +161,8 @@ def __init__(self, bboxes):
         self.bboxes = bboxes
 
     def to_dict(self):
-        return { 'bbox' : self.bboxes }
+        d = { 'bbox' : self.bboxes }
+        return deepcopy(d)
 
     def clone(self):
         return SpatialExtent(self.bboxes)
@@ -214,7 +217,8 @@ def to_dict(self):
 
             encoded_intervals.append([start, end])
 
-        return { 'interval': encoded_intervals }
+        d = {'interval': encoded_intervals}
+        return deepcopy(d)
 
     def clone(self):
         return TemporalExtent(intervals=copy(self.intervals))
@@ -256,7 +260,7 @@ def to_dict(self):
         if self.url is not None:
             d['url'] = self.url
 
-        return d
+        return deepcopy(d)
 
     @staticmethod
     def from_dict(d):

pystac/item.py

@@ -18,13 +18,15 @@ def __init__(self,
                  datetime,
                  properties,
                  stac_extensions=None,
-                 href=None):
+                 href=None,
+                 collection=None):
         self.id = id
         self.geometry = geometry
         self.bbox = bbox
         self.datetime = datetime
         self.properties = properties
         self.stac_extensions = stac_extensions
+        self.collection = collection
 
         self.links = []
         self.assets = {}
@@ -62,6 +64,7 @@ def set_collection(self, collection, link_type=None):
                 link_type = LinkType.ABSOLUTE
         self.remove_links('collection')
         self.add_link(Link.collection(collection, link_type=link_type))
+        self.collection = collection.id
         return self
 
     def to_dict(self, include_self_link=True):
@@ -86,8 +89,11 @@ def to_dict(self, include_self_link=True):
 
         if self.stac_extensions is not None:
             d['stac_extensions'] = self.stac_extensions
+        
+        if self.collection:
+            d['collection'] = self.collection
 
-        return d
+        return deepcopy(d)
 
     def clone(self):
         clone = Item(id=self.id,
@@ -130,6 +136,9 @@ def from_dict(d):
         bbox = d['bbox']
         properties = d['properties']
         stac_extensions = d.get('stac_extensions')
+        collection = None
+        if 'collection' in d.keys():
+            collection = d['collection']
 
         datetime = properties.get('datetime')
         if datetime is None:
@@ -141,7 +150,8 @@ def from_dict(d):
                     bbox=bbox,
                     datetime=datetime,
                     properties=properties,
-                    stac_extensions=stac_extensions)
+                    stac_extensions=stac_extensions,
+                    collection=collection)
 
         for l in d['links']:
             item.add_link(Link.from_dict(l))
@@ -178,7 +188,7 @@ def __init__(self, href, title=None, media_type=None, properties=None):
         self.href = href
         self.title = title
         self.media_type = media_type
-        self.properties = None
+        self.properties = properties
 
         # The Item which owns this Asset.
         self.item = None
@@ -210,10 +220,10 @@ def to_dict(self):
             d['title'] = self.title
 
         if self.properties is not None:
-            for k in properties:
-                d[k] = properties[k]
+            for k, v in self.properties.items():
+                d[k] = v
 
-        return d
+        return deepcopy(d)
 
     def clone(self):
         return Asset(href=self.href,
@@ -229,7 +239,6 @@ def from_dict(d):
         href = d.pop('href')
         media_type = d.pop('type', None)
         title = d.pop('title', None)
-
         properties = None
         if any(d):
             properties = d

pystac/label.py

@@ -92,7 +92,7 @@ def to_dict(self, include_self_link=True):
         if self.label_overviews is not None:
             d['properties']['label:overviews'] = [ov.to_dict() for ov in self.label_overviews]
 
-        return d
+        return deepcopy(d)
 
     def add_source(self, source_item, title=None, assets=None):
         properties = None

pystac/link.py

@@ -1,5 +1,5 @@
 import os
-from copy import copy
+from copy import (copy, deepcopy)
 from urllib.parse import urlparse
 
 from pystac import STACError
@@ -127,7 +127,7 @@ def to_dict(self):
             for k, v in self.properties.items():
                 d[k] = v
 
-        return d
+        return deepcopy(d)
 
     def clone(self):
         return Link(rel=self.rel,

tests/data-files/itemcollections/sample-item-collection.json

@@ -0,0 +1,87 @@
+{
+    "type": "FeatureCollection",
+    "features": [
+      {
+        "stac_version": "0.8.0",
+        "stac_extensions": [],
+        "type": "Feature",
+        "id": "CS3-20160503_132131_05",
+        "bbox": [
+          -122.59750209,
+          37.48803556,
+          -122.2880486,
+          37.613537207
+        ],
+        "geometry": {
+          "type": "Polygon",
+          "coordinates": [
+            [
+              [
+                -122.308150179,
+                37.488035566
+              ],
+              [
+                -122.597502109,
+                37.538869539
+              ],
+              [
+                -122.576687533,
+                37.613537207
+              ],
+              [
+                -122.288048600,
+                37.562818007
+              ],
+              [
+                -122.308150179,
+                37.488035566
+              ]
+            ]
+          ]
+        },
+        "properties": {
+          "datetime": "2016-05-03T13:22:30.040Z",
+          "title": "A CS3 item",
+          "license": "PDDL-1.0",
+          "providers": [
+            {
+              "name": "CoolSat",
+              "roles": [
+                "producer",
+                "licensor"
+              ],
+              "url": "https://cool-sat.com/"
+            }
+          ]
+        },
+        "collection": "CS3",
+        "links": [
+          {
+            "rel": "self",
+            "href": "http://cool-sat.com/catalog/CS3-20160503_132130_04/CS3-20160503_132130_04.json"
+          },
+          {
+            "rel": "collection",
+            "href": "http://cool-sat.com/catalog/CS3-20160503_132130_04/catalog.json"
+          }
+        ],
+        "assets": {
+          "analytic": {
+            "href": "http://cool-sat.com/catalog/CS3-20160503_132130_04/analytic.tif",
+            "title": "4-Band Analytic",
+            "product": "http://cool-sat.com/catalog/products/analytic.json"
+          },
+          "thumbnail": {
+            "href": "http://cool-sat.com/catalog/CS3-20160503_132130_04/thumbnail.png",
+            "title": "Thumbnail"
+          }
+        }
+      }
+    ],
+    "links": [
+      {
+        "rel": "self",
+        "href": "./item-collection.json"
+      }
+    ]
+  }

tests/test_item.py

@@ -0,0 +1,28 @@
+import os
+import unittest
+import json
+from tempfile import TemporaryDirectory
+from datetime import datetime
+import dateutil
+
+from pystac import *
+from pystac.utils import is_absolute_href
+from tests.utils import (TestCases, RANDOM_GEOM, RANDOM_BBOX, test_to_from_dict)
+
+
+class ItemTest(unittest.TestCase):
+    def test_to_from_dict(self):
+        m = TestCases.get_path('data-files/itemcollections/sample-item-collection.json')
+        with open(m) as f:
+            item_dict = json.load(f)['features'][0]
+        
+        test_to_from_dict(self, Item, item_dict)
+        item = Item.from_dict(item_dict)
+        self.assertEqual(item.get_self_href(), 'http://cool-sat.com/catalog/CS3-20160503_132130_04/CS3-20160503_132130_04.json')
+
+        # test asset creation additional field(s)
+        self.assertEqual(item.assets['analytic'].properties['product'], 'http://cool-sat.com/catalog/products/analytic.json')
+        self.assertIsNone(item.assets['thumbnail'].properties)
+            
+        
+

tests/utils.py

@@ -1,7 +1,8 @@
 import os
 import json
 from datetime import datetime
-
+from copy import copy, deepcopy
+from dateutil.parser import parse
 import jsonschema
 from jsonschema.validators import RefResolver
 
@@ -162,3 +163,24 @@ def validate_dict(self, d, obj_type):
         except jsonschema.exceptions.ValidationError as e:
             print('Validation error in {}'.format(obj_type))
             raise e
+
+def test_to_from_dict(test_class, stac_object_class, d):
+    def _parse_times(a_dict):
+        for k, v in a_dict.items():
+            if isinstance(v, dict):
+                _parse_times(v)
+            elif isinstance(v, (tuple, list, set)):
+                for vv in v:
+                    if isinstance(vv, dict):
+                        _parse_times(vv)
+            else:
+                if k == 'datetime':
+                    if not isinstance(v, datetime):
+                        a_dict[k] = parse(v)
+                        a_dict[k] = a_dict[k].replace(microsecond=0)
+    
+    d1 = deepcopy(d)
+    d2 = stac_object_class.from_dict(d).to_dict()
+    _parse_times(d1)
+    _parse_times(d2)
+    test_class.assertDictEqual(d1, d2)