Handle extra fields in Provider object

Author: duckontheweb

pystac/collection.py

@@ -372,29 +372,44 @@ class Provider:
             licensor, producer, processor or host.
         url : Optional homepage on which the provider describes the dataset
             and publishes contact information.
-
-    Attributes:
-        name : The name of the organization or the individual.
-        description : Optional multi-line description to add further provider
-            information such as processing details for processors and producers,
-            hosting details for hosts or basic contact information.
-        roles : Optional roles of the provider. Any of
-            licensor, producer, processor or host.
-        url : Optional homepage on which the provider describes the dataset
-            and publishes contact information.
+        extra_fields : Optional dictionary containing additional top-level fields
+            defined on the Provider object.
+    object.
     """
 
+    name: str
+    """The name of the organization or the individual."""
+
+    description: Optional[str]
+    """Optional multi-line description to add further provider
+    information such as processing details for processors and producers,
+    hosting details for hosts or basic contact information."""
+
+    roles: Optional[List[str]]
+    """Optional roles of the provider. Any of
+    licensor, producer, processor or host."""
+
+    url: Optional[str]
+    """Optional homepage on which the provider describes the dataset
+    and publishes contact information."""
+
+    extra_fields: Dict[str, Any]
+    """Dictionary containing additional top-level fields defined on the Provider
+    object."""
+
     def __init__(
         self,
         name: str,
         description: Optional[str] = None,
         roles: Optional[List[str]] = None,
         url: Optional[str] = None,
+        extra_fields: Optional[Dict[str, Any]] = None,
     ):
         self.name = name
         self.description = description
         self.roles = roles
         self.url = url
+        self.extra_fields = extra_fields or {}
 
     def to_dict(self) -> Dict[str, Any]:
         """Generate a dictionary representing the JSON of this Provider.
@@ -410,20 +425,29 @@ def to_dict(self) -> Dict[str, Any]:
         if self.url is not None:
             d["url"] = self.url
 
+        d.update(self.extra_fields)
+
         return d
 
     @staticmethod
     def from_dict(d: Dict[str, Any]) -> "Provider":
         """Constructs an Provider from a dict.
 
         Returns:
-            TemporalExtent: The Provider deserialized from the JSON dict.
+            Provider: The Provider deserialized from the JSON dict.
         """
         return Provider(
             name=d["name"],
             description=d.get("description"),
-            roles=d.get("roles"),
+            roles=d.get(
+                "roles",
+            ),
             url=d.get("url"),
+            extra_fields={
+                k: v
+                for k, v in d.items()
+                if k not in {"name", "description", "roles", "url"}
+            },
         )
 
 

tests/test_collection.py

@@ -9,13 +9,43 @@
 import pystac
 from pystac.extensions.eo import EOExtension
 from pystac.validation import validate_dict
-from pystac import Collection, Item, Extent, SpatialExtent, TemporalExtent, CatalogType
+from pystac import (
+    Collection,
+    Item,
+    Extent,
+    SpatialExtent,
+    TemporalExtent,
+    CatalogType,
+    Provider,
+)
 from pystac.utils import datetime_to_str, get_required
 from tests.utils import TestCases, ARBITRARY_GEOM, ARBITRARY_BBOX
 
 TEST_DATETIME = datetime(2020, 3, 14, 16, 32)
 
 
+class ProviderTest(unittest.TestCase):
+    def test_to_from_dict(self) -> None:
+        provider_dict = {
+            "name": "Remote Data, Inc",
+            "description": "Producers of awesome spatiotemporal assets",
+            "roles": ["producer", "processor"],
+            "url": "http://remotedata.io",
+            "extension:field": "some value",
+        }
+        expected_extra_fields = {"extension:field": provider_dict["extension:field"]}
+
+        provider = Provider.from_dict(provider_dict)
+
+        self.assertEqual(provider_dict["name"], provider.name)
+        self.assertEqual(provider_dict["description"], provider.description)
+        self.assertEqual(provider_dict["roles"], provider.roles)
+        self.assertEqual(provider_dict["url"], provider.url)
+        self.assertDictEqual(expected_extra_fields, provider.extra_fields)
+
+        self.assertDictEqual(provider_dict, provider.to_dict())
+
+
 class CollectionTest(unittest.TestCase):
     def test_spatial_extent_from_coordinates(self) -> None:
         extent = SpatialExtent.from_coordinates(ARBITRARY_GEOM["coordinates"])