feat: Don't allow returning Any from result typed function

Author: l0b0

mypy.ini

@@ -5,3 +5,4 @@ ignore_missing_imports = True
 no_implicit_optional = True
 show_error_codes = True
 warn_redundant_casts = True
+warn_return_any = True

pystac/extensions/base.py

@@ -58,14 +58,14 @@ class PropertiesExtension(ABC):
     """
 
     def _get_property(self, prop_name: str, typ: Type[P]) -> Optional[P]:
-        result = self.properties.get(prop_name)
-        if result is not None:
-            return result
+        maybe_property: Optional[P] = self.properties.get(prop_name)
+        if maybe_property is not None:
+            return maybe_property
         if self.additional_read_properties is not None:
             for props in self.additional_read_properties:
-                result = props.get(prop_name)
-                if result is not None:
-                    return result
+                maybe_additional_property: Optional[P] = props.get(prop_name)
+                if maybe_additional_property is not None:
+                    return maybe_additional_property
         return None
 
     def _set_property(

pystac/extensions/label.py

@@ -97,7 +97,9 @@ def classes(self) -> Union[List[str], List[int], List[float]]:
         Returns:
             List[str] or List[int] or List[float]
         """
-        result = self.properties.get("classes")
+        result: Optional[
+            Union[List[str], List[int], List[float]]
+        ] = self.properties.get("classes")
         if result is None:
             raise pystac.STACError(
                 f"LabelClasses does not contain classes property: {self.properties}"
@@ -179,7 +181,7 @@ def name(self) -> str:
         Returns:
             str
         """
-        result = self.properties.get("name")
+        result: Optional[str] = self.properties.get("name")
         if result is None:
             raise pystac.STACError(
                 f"Label count has no name property: {self.properties}"
@@ -197,7 +199,7 @@ def count(self) -> int:
         Returns:
             int
         """
-        result = self.properties.get("count")
+        result: Optional[int] = self.properties.get("count")
         if result is None:
             raise pystac.STACError(
                 f"Label count has no count property: {self.properties}"
@@ -255,7 +257,7 @@ def name(self) -> str:
         Returns:
             str
         """
-        result = self.properties.get("name")
+        result: Optional[str] = self.properties.get("name")
         if result is None:
             raise pystac.STACError(
                 f"Label statistics has no name property: {self.properties}"
@@ -273,7 +275,7 @@ def value(self) -> float:
         Returns:
             float
         """
-        result = self.properties.get("value")
+        result: Optional[float] = self.properties.get("value")
         if result is None:
             raise pystac.STACError(
                 f"Label statistics has no value property: {self.properties}"
@@ -529,7 +531,7 @@ def label_description(self) -> str:
         Returns:
             str
         """
-        result = self.obj.properties.get("label:description")
+        result: Optional[str] = self.obj.properties.get("label:description")
         if result is None:
             raise pystac.STACError(f"label:description not set for item {self.obj.id}")
         return result

pystac/extensions/pointcloud.py

@@ -72,7 +72,7 @@ def size(self) -> int:
         Returns:
             int
         """
-        result = self.properties.get("size")
+        result: Optional[int] = self.properties.get("size")
         if result is None:
             raise pystac.STACError(
                 f"Pointcloud schema does not have size property: {self.properties}"
@@ -93,7 +93,7 @@ def name(self) -> str:
         Returns:
             str
         """
-        result = self.properties.get("name")
+        result: Optional[str] = self.properties.get("name")
         if result is None:
             raise pystac.STACError(
                 f"Pointcloud schema does not have name property: {self.properties}"
@@ -111,7 +111,7 @@ def type(self) -> str:
         Returns:
             str
         """
-        result = self.properties.get("type")
+        result: Optional[str] = self.properties.get("type")
         if result is None:
             raise pystac.STACError(
                 f"Pointcloud schema has no type property: {self.properties}"
@@ -226,7 +226,7 @@ def name(self) -> str:
         Returns:
             str
         """
-        result = self.properties.get("name")
+        result: Optional[str] = self.properties.get("name")
         if result is None:
             raise pystac.STACError(
                 f"Pointcloud statistics does not have name property: {self.properties}"

pystac/item.py

@@ -87,10 +87,10 @@ def get_start_datetime(self, asset: Optional[Asset] = None) -> Optional[Datetime
         else:
             start_datetime = asset.properties.get("start_datetime")
 
-        if start_datetime:
-            start_datetime = str_to_datetime(start_datetime)
+        if start_datetime is None:
+            return None
 
-        return start_datetime
+        return str_to_datetime(start_datetime)
 
     def set_start_datetime(
         self, start_datetime: Optional[Datetime], asset: Optional[Asset] = None
@@ -138,10 +138,10 @@ def get_end_datetime(self, asset: Optional[Asset] = None) -> Optional[Datetime]:
         else:
             end_datetime = asset.properties.get("end_datetime")
 
-        if end_datetime:
-            end_datetime = str_to_datetime(end_datetime)
+        if end_datetime is None:
+            return None
 
-        return end_datetime
+        return str_to_datetime(end_datetime)
 
     def set_end_datetime(
         self, end_datetime: Optional[Datetime], asset: Optional[Asset] = None
@@ -231,10 +231,10 @@ def get_providers(self, asset: Optional[Asset] = None) -> Optional[List[Provider
         else:
             providers = asset.properties.get("providers")
 
-        if providers is not None:
-            providers = [Provider.from_dict(d) for d in providers]
+        if providers is None:
+            return None
 
-        return providers
+        return [Provider.from_dict(d) for d in providers]
 
     def set_providers(
         self, providers: Optional[List[Provider]], asset: Optional[Asset] = None
@@ -494,10 +494,10 @@ def get_created(self, asset: Optional[Asset] = None) -> Optional[Datetime]:
         else:
             created = asset.properties.get("created")
 
-        if created:
-            created = str_to_datetime(created)
+        if created is None:
+            return None
 
-        return created
+        return str_to_datetime(created)
 
     def set_created(
         self, created: Optional[Datetime], asset: Optional[Asset] = None
@@ -560,10 +560,10 @@ def get_updated(self, asset: Optional[Asset] = None) -> Optional[Datetime]:
         else:
             updated = asset.properties.get("updated")
 
-        if updated:
-            updated = str_to_datetime(updated)
+        if updated is None:
+            return None
 
-        return updated
+        return str_to_datetime(updated)
 
     def set_updated(
         self, updated: Optional[Datetime], asset: Optional[Asset] = None

pystac/serialization/identify.py

@@ -52,16 +52,16 @@ def __str__(self) -> str:
         return self.version_string
 
     def __eq__(self, other: Any) -> bool:
-        if type(other) is str:
-            other = STACVersionID(other)
-        return self.version_string == other.version_string
+        if not isinstance(other, STACVersionID):
+            other = STACVersionID(str(other))
+        return str(self) == str(other)
 
-    def __ne__(self, other: Any) -> bool:
+    def __ne__(self, other: object) -> bool:
         return not self.__eq__(other)
 
-    def __lt__(self, other: Any) -> bool:
-        if type(other) is str:
-            other = STACVersionID(other)
+    def __lt__(self, other: object) -> bool:
+        if not isinstance(other, STACVersionID):
+            other = STACVersionID(str(other))
         if self.version_core < other.version_core:
             return True
         elif self.version_core > other.version_core:

pystac/stac_io.py

@@ -74,10 +74,12 @@ def write_text(
         raise NotImplementedError("write_text not implemented")
 
     def _json_loads(self, txt: str, source: Union[str, "Link_Type"]) -> Dict[str, Any]:
+        result: Dict[str, Any]
         if orjson is not None:
-            return orjson.loads(txt)
+            result = orjson.loads(txt)
         else:
-            return json.loads(txt)
+            result = json.loads(txt)
+        return result
 
     def _json_dumps(
         self, json_dict: Dict[str, Any], source: Union[str, "Link_Type"]
@@ -181,15 +183,18 @@ def read_text(
 
     def read_text_from_href(self, href: str, *args: Any, **kwargs: Any) -> str:
         parsed = urlparse(href)
+        href_contents: str
         if parsed.scheme != "":
             try:
                 with urlopen(href) as f:
-                    return f.read().decode("utf-8")
+                    href_contents = f.read().decode("utf-8")
             except HTTPError as e:
                 raise Exception("Could not read uri {}".format(href)) from e
         else:
             with open(href) as f:
-                return f.read()
+                href_contents = f.read()
+
+        return href_contents
 
     def write_text(
         self, dest: Union[str, "Link_Type"], txt: str, *args: Any, **kwargs: Any
@@ -225,9 +230,10 @@ class DuplicateKeyReportingMixin(StacIO):
     """
 
     def _json_loads(self, txt: str, source: Union[str, "Link_Type"]) -> Dict[str, Any]:
-        return json.loads(
+        result: Dict[str, Any] = json.loads(
             txt, object_pairs_hook=self.duplicate_object_names_report_builder(source)
         )
+        return result
 
     @staticmethod
     def duplicate_object_names_report_builder(
@@ -349,7 +355,8 @@ def read_json(cls, uri: str) -> Dict[str, Any]:
             STAC_IO in order to enable additional URI types, replace that member
             with your own implementation.
         """
-        return json.loads(STAC_IO.read_text(uri))
+        result: Dict[str, Any] = json.loads(STAC_IO.read_text(uri))
+        return result
 
     @classmethod
     def read_stac_object(

tests/test_item.py

@@ -18,7 +18,7 @@ class ItemTest(unittest.TestCase):
     def get_example_item_dict(self) -> Dict[str, Any]:
         m = TestCases.get_path("data-files/item/sample-item.json")
         with open(m) as f:
-            item_dict = json.load(f)
+            item_dict: Dict[str, Any] = json.load(f)
         return item_dict
 
     def test_to_from_dict(self) -> None: