Move Provider to separate module

Author: duckontheweb

pystac/__init__.py

@@ -30,15 +30,13 @@
     Extent,
     SpatialExtent,
     TemporalExtent,
-    Provider,
-    ProviderRole,
     Summaries,
 )
 from pystac.common_metadata import CommonMetadata
 from pystac.summaries import RangeSummary
 from pystac.item import Item, Asset
 from pystac.item_collection import ItemCollection
-
+from pystac.provider import ProviderRole, Provider
 import pystac.validation
 
 import pystac.extensions.hooks

pystac/collection.py

@@ -1,6 +1,5 @@
 from copy import deepcopy
 from datetime import datetime
-from enum import Enum
 from pystac.errors import STACTypeError
 from typing import (
     Any,
@@ -34,6 +33,7 @@
 
 if TYPE_CHECKING:
     from pystac.item import Item as Item_Type
+    from pystac.provider import Provider as Provider_Type
 
 T = TypeVar("T")
 
@@ -409,108 +409,6 @@ def from_items(
         return Extent(spatial=spatial, temporal=temporal, extra_fields=extra_fields)
 
 
-class ProviderRole(str, Enum):
-    """Enumerates the allows values of the Provider "role" field."""
-
-    LICENSOR = "licensor"
-    PRODUCER = "producer"
-    PROCESSOR = "processor"
-    HOST = "host"
-
-
-class Provider:
-    """Provides information about a provider of STAC data. A provider is any of the
-    organizations that captured or processed the content of the collection and therefore
-    influenced the data offered by this collection. May also include information about
-    the final storage provider hosting the data.
-
-    Args:
-        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.
-    """
-
-    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[ProviderRole]]
-    """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[ProviderRole]] = 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.
-
-        Returns:
-            dict: A serialization of the Provider that can be written out as JSON.
-        """
-        d: Dict[str, Any] = {"name": self.name}
-        if self.description is not None:
-            d["description"] = self.description
-        if self.roles is not None:
-            d["roles"] = self.roles
-        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:
-            Provider: The Provider deserialized from the JSON dict.
-        """
-        return Provider(
-            name=d["name"],
-            description=d.get("description"),
-            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"}
-            },
-        )
-
-
 class Collection(Catalog):
     """A Collection extends the Catalog spec with additional metadata that helps
     enable discovery.
@@ -583,7 +481,7 @@ def __init__(
         catalog_type: Optional[CatalogType] = None,
         license: str = "proprietary",
         keywords: Optional[List[str]] = None,
-        providers: Optional[List[Provider]] = None,
+        providers: Optional[List["Provider_Type"]] = None,
         summaries: Optional[Summaries] = None,
     ):
         super().__init__(
@@ -695,7 +593,7 @@ def from_dict(
         keywords = d.get("keywords")
         providers = d.get("providers")
         if providers is not None:
-            providers = list(map(lambda x: Provider.from_dict(x), providers))
+            providers = list(map(lambda x: pystac.Provider.from_dict(x), providers))
         summaries = d.get("summaries")
         if summaries is not None:
             summaries = Summaries(summaries)

pystac/common_metadata.py

@@ -5,7 +5,7 @@
 from pystac import utils
 
 if TYPE_CHECKING:
-    from pystac.collection import Provider
+    from pystac.provider import Provider
     from pystac.asset import Asset
 
 
@@ -91,11 +91,15 @@ def set_start_datetime(
         """
         if asset is None:
             self.properties["start_datetime"] = (
-                None if start_datetime is None else utils.datetime_to_str(start_datetime)
+                None
+                if start_datetime is None
+                else utils.datetime_to_str(start_datetime)
             )
         else:
             asset.extra_fields["start_datetime"] = (
-                None if start_datetime is None else utils.datetime_to_str(start_datetime)
+                None
+                if start_datetime is None
+                else utils.datetime_to_str(start_datetime)
             )
 
     @property
@@ -206,7 +210,9 @@ def providers(self) -> Optional[List["Provider"]]:
     def providers(self, v: Optional[List["Provider"]]) -> None:
         self.set_providers(v)
 
-    def get_providers(self, asset: Optional["Asset"] = None) -> Optional[List["Provider"]]:
+    def get_providers(
+        self, asset: Optional["Asset"] = None
+    ) -> Optional[List["Provider"]]:
         """Gets an Item or an Asset providers.
 
         If an Asset is supplied and the Item property exists on the Asset,

pystac/provider.py

@@ -0,0 +1,103 @@
+from enum import Enum
+from typing import Any, Dict, List, Optional
+
+class ProviderRole(str, Enum):
+    """Enumerates the allows values of the Provider "role" field."""
+
+    LICENSOR = "licensor"
+    PRODUCER = "producer"
+    PROCESSOR = "processor"
+    HOST = "host"
+
+
+class Provider:
+    """Provides information about a provider of STAC data. A provider is any of the
+    organizations that captured or processed the content of the collection and therefore
+    influenced the data offered by this collection. May also include information about
+    the final storage provider hosting the data.
+
+    Args:
+        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.
+    """
+
+    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[ProviderRole]]
+    """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[ProviderRole]] = 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.
+
+        Returns:
+            dict: A serialization of the Provider that can be written out as JSON.
+        """
+        d: Dict[str, Any] = {"name": self.name}
+        if self.description is not None:
+            d["description"] = self.description
+        if self.roles is not None:
+            d["roles"] = self.roles
+        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:
+            Provider: The Provider deserialized from the JSON dict.
+        """
+        return Provider(
+            name=d["name"],
+            description=d.get("description"),
+            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"}
+            },
+        )