Merge pull request #523 from l0b0/refactor/return-not-implemented-error-for-abstract-methods

refactor: Use `NotImplemented`/`NotImplementedError` as per docs

Author: Jon Duckworth

pystac/extensions/base.py

@@ -95,7 +95,7 @@ class ExtensionManagementMixin(Generic[S], ABC):
     @abstractmethod
     def get_schema_uri(cls) -> str:
         """Gets the schema URI associated with this extension."""
-        pass
+        raise NotImplementedError
 
     @classmethod
     def add_to(cls, obj: S) -> None:

pystac/extensions/hooks.py

@@ -14,7 +14,7 @@ class ExtensionHooks(ABC):
     @abstractmethod
     def schema_uri(self) -> str:
         """The schema_uri for the current version of this extension"""
-        pass
+        raise NotImplementedError
 
     @property
     @abstractmethod
@@ -24,13 +24,13 @@ def prev_extension_ids(self) -> Set[str]:
         property. Override with a class attribute so that the set of previous
         IDs is only created once.
         """
-        pass
+        raise NotImplementedError
 
     @property
     @abstractmethod
     def stac_object_types(self) -> Set[pystac.STACObjectType]:
         """A set of STACObjectType for which migration logic will be applied."""
-        pass
+        raise NotImplementedError
 
     @lru_cache()
     def _get_stac_object_types(self) -> Set[str]:

pystac/layout.py

@@ -249,17 +249,17 @@ def get_href(
     def get_catalog_href(
         self, cat: "Catalog_Type", parent_dir: str, is_root: bool
     ) -> str:
-        pass
+        raise NotImplementedError
 
     @abstractmethod
     def get_collection_href(
         self, col: "Collection_Type", parent_dir: str, is_root: bool
     ) -> str:
-        pass
+        raise NotImplementedError
 
     @abstractmethod
     def get_item_href(self, item: "Item_Type", parent_dir: str) -> str:
-        pass
+        raise NotImplementedError
 
 
 class CustomLayoutStrategy(HrefLayoutStrategy):

pystac/stac_io.py

@@ -62,7 +62,7 @@ def read_text(
         Returns:
             str: The text contained in the file at the location specified by the uri.
         """
-        raise NotImplementedError("read_text not implemented")
+        raise NotImplementedError
 
     @abstractmethod
     def write_text(
@@ -79,7 +79,7 @@ def write_text(
             dest : The destination to write to.
             txt : The text to write.
         """
-        raise NotImplementedError("write_text not implemented")
+        raise NotImplementedError
 
     def json_loads(self, txt: str, *args: Any, **kwargs: Any) -> Dict[str, Any]:
         """Method used internally by :class:`StacIO` instances to deserialize a

pystac/stac_object.py

@@ -424,7 +424,7 @@ def _object_links(self) -> List[str]:
         STACObjects linked to by this object (not including root, parent or self).
         This can include optional relations (which may not be present).
         """
-        pass
+        raise NotImplementedError
 
     @abstractmethod
     def to_dict(self, include_self_link: bool = True) -> Dict[str, Any]:
@@ -436,7 +436,7 @@ def to_dict(self, include_self_link: bool = True) -> Dict[str, Any]:
 
             dict: A serialization of the object that can be written out as JSON.
         """
-        pass
+        raise NotImplementedError
 
     @abstractmethod
     def clone(self) -> "STACObject":
@@ -450,7 +450,7 @@ def clone(self) -> "STACObject":
         Returns:
             STACObject: The clone of this object.
         """
-        pass
+        raise NotImplementedError
 
     @classmethod
     def from_file(
@@ -521,7 +521,7 @@ def from_dict(
         Returns:
             STACObject: The STACObject parsed from this dict.
         """
-        pass
+        raise NotImplementedError
 
     @classmethod
     @abstractmethod
@@ -532,6 +532,4 @@ def matches_object_type(cls, d: Dict[str, Any]) -> bool:
         Args:
             d : A dictionary to identify
         """
-        raise NotImplementedError(
-            "identify_dict must be implemented by the STACObject subclass."
-        )
+        raise NotImplementedError

pystac/summaries.py

@@ -35,7 +35,7 @@ class Comparable(Protocol):
 
     @abstractmethod
     def __lt__(self: "T", x: "T") -> bool:
-        pass
+        return NotImplemented
 
 
 T = TypeVar("T", bound=Comparable)

pystac/validation/schema_uri_map.py

@@ -28,7 +28,7 @@ def get_object_schema_uri(
         Returns:
             str: The URI of the schema, or None if not found.
         """
-        pass
+        raise NotImplementedError
 
 
 class DefaultSchemaUriMap(SchemaUriMap):

pystac/validation/stac_validator.py

@@ -44,7 +44,7 @@ def validate_core(
             stac_version : The version of STAC to validate the object against.
             href : Optional HREF of the STAC object being validated.
         """
-        pass
+        raise NotImplementedError
 
     @abstractmethod
     def validate_extension(
@@ -67,7 +67,7 @@ def validate_extension(
             extension_id : The extension ID of the extension to validate against.
             href : Optional HREF of the STAC object being validated.
         """
-        pass
+        raise NotImplementedError
 
     def validate(
         self,