pre-commit.

Author: rhysrevans3

stac_fastapi/core/stac_fastapi/core/models/patch.py

@@ -20,6 +20,11 @@ class ElasticPath(BaseModel):
     index: Optional[int] = None
 
     def __init__(self, *, path: str):
+        """Convert JSON path to Elasticsearch script path.
+
+        Args:
+            path (str): initial JSON path
+        """
         self.path = path.lstrip("/").replace("/", ".")
 
         self.nest, self.partition, self.key = path.rpartition(".")
@@ -29,7 +34,12 @@ def __init__(self, *, path: str):
             self.path = f"{self.nest}[{self.index}]"
             self.nest, self.partition, self.key = self.nest.rpartition(".")
 
-    @computed_field
+    @computed_field  # type: ignore[misc]
     @property
     def location(self) -> str:
+        """Compute location of path.
+
+        Returns:
+            str: path location
+        """
         return self.nest + self.partition + self.key

stac_fastapi/core/stac_fastapi/core/utilities.py

@@ -45,7 +45,9 @@ def filter_fields(  # noqa: C901
         return item
 
     # Build a shallow copy of included fields on an item, or a sub-tree of an item
-    def include_fields(source: Dict[str, Any], fields: Optional[Set[str]]) -> Dict[str, Any]:
+    def include_fields(
+        source: Dict[str, Any], fields: Optional[Set[str]]
+    ) -> Dict[str, Any]:
         if not fields:
             return source
 
@@ -58,7 +60,9 @@ def include_fields(source: Dict[str, Any], fields: Optional[Set[str]]) -> Dict[s
                     # The root of this key path on the item is a dict, and the
                     # key path indicates a sub-key to be included. Walk the dict
                     # from the root key and get the full nested value to include.
-                    value = include_fields(source[key_root], fields={".".join(key_path_parts[1:])})
+                    value = include_fields(
+                        source[key_root], fields={".".join(key_path_parts[1:])}
+                    )
 
                     if isinstance(clean_item.get(key_root), dict):
                         # A previously specified key and sub-keys may have been included
@@ -89,7 +93,9 @@ def exclude_fields(source: Dict[str, Any], fields: Optional[Set[str]]) -> None:
             if key_root in source:
                 if isinstance(source[key_root], dict) and len(key_path_part) > 1:
                     # Walk the nested path of this key to remove the leaf-key
-                    exclude_fields(source[key_root], fields={".".join(key_path_part[1:])})
+                    exclude_fields(
+                        source[key_root], fields={".".join(key_path_part[1:])}
+                    )
                     # If, after removing the leaf-key, the root is now an empty
                     # dict, remove it entirely
                     if not source[key_root]:
@@ -121,7 +127,11 @@ def dict_deep_update(merge_to: Dict[str, Any], merge_from: Dict[str, Any]) -> No
     merge_from values take precedence over existing values in merge_to.
     """
     for k, v in merge_from.items():
-        if k in merge_to and isinstance(merge_to[k], dict) and isinstance(merge_from[k], dict):
+        if (
+            k in merge_to
+            and isinstance(merge_to[k], dict)
+            and isinstance(merge_from[k], dict)
+        ):
             dict_deep_update(merge_to[k], merge_from[k])
         else:
             merge_to[k] = v
@@ -168,7 +178,10 @@ def add_script_checks(source: str, op: str, path: ElasticPath) -> str:
         Dict: update source of Elasticsearch script
     """
     if path.nest:
-        source += f"if (!ctx._source.containsKey('{path.nest}'))" f"{{Debug.explain('{path.nest} does not exist');}}"
+        source += (
+            f"if (!ctx._source.containsKey('{path.nest}'))"
+            f"{{Debug.explain('{path.nest} does not exist');}}"
+        )
 
     if path.index or op != "add":
         source += (
@@ -219,7 +232,9 @@ def operations_to_script(operations: List) -> Dict:
             remove_path = from_path if operation.op == "move" else op_path
 
             if remove_path.index:
-                source += f"ctx._source.{remove_path.location}.remove('{remove_path.index}');"
+                source += (
+                    f"ctx._source.{remove_path.location}.remove('{remove_path.index}');"
+                )
 
             else:
                 source += f"ctx._source.remove('{remove_path.location}');"

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/database_logic.py

@@ -336,7 +336,9 @@ class DatabaseLogic:
     sync_client = SyncElasticsearchSettings().create_client
 
     item_serializer: Type[ItemSerializer] = attr.ib(default=ItemSerializer)
-    collection_serializer: Type[CollectionSerializer] = attr.ib(default=CollectionSerializer)
+    collection_serializer: Type[CollectionSerializer] = attr.ib(
+        default=CollectionSerializer
+    )
 
     extensions: List[str] = attr.ib(default=attr.Factory(list))
 
@@ -370,9 +372,15 @@ class DatabaseLogic:
                 "size": 10000,
             }
         },
-        "sun_elevation_frequency": {"histogram": {"field": "properties.view:sun_elevation", "interval": 5}},
-        "sun_azimuth_frequency": {"histogram": {"field": "properties.view:sun_azimuth", "interval": 5}},
-        "off_nadir_frequency": {"histogram": {"field": "properties.view:off_nadir", "interval": 5}},
+        "sun_elevation_frequency": {
+            "histogram": {"field": "properties.view:sun_elevation", "interval": 5}
+        },
+        "sun_azimuth_frequency": {
+            "histogram": {"field": "properties.view:sun_azimuth", "interval": 5}
+        },
+        "off_nadir_frequency": {
+            "histogram": {"field": "properties.view:off_nadir", "interval": 5}
+        },
         "centroid_geohash_grid_frequency": {
             "geohash_grid": {
                 "field": "properties.proj:centroid",
@@ -469,7 +477,9 @@ async def get_one_item(self, collection_id: str, item_id: str) -> Dict:
                 id=mk_item_id(item_id, collection_id),
             )
         except exceptions.NotFoundError:
-            raise NotFoundError(f"Item {item_id} does not exist in Collection {collection_id}")
+            raise NotFoundError(
+                f"Item {item_id} does not exist in Collection {collection_id}"
+            )
         return item["_source"]
 
     @staticmethod
@@ -499,10 +509,16 @@ def apply_datetime_filter(search: Search, datetime_search):
             Search: The filtered search object.
         """
         if "eq" in datetime_search:
-            search = search.filter("term", **{"properties__datetime": datetime_search["eq"]})
+            search = search.filter(
+                "term", **{"properties__datetime": datetime_search["eq"]}
+            )
         else:
-            search = search.filter("range", properties__datetime={"lte": datetime_search["lte"]})
-            search = search.filter("range", properties__datetime={"gte": datetime_search["gte"]})
+            search = search.filter(
+                "range", properties__datetime={"lte": datetime_search["lte"]}
+            )
+            search = search.filter(
+                "range", properties__datetime={"gte": datetime_search["gte"]}
+            )
         return search
 
     @staticmethod
@@ -596,7 +612,9 @@ def apply_free_text_filter(search: Search, free_text_queries: Optional[List[str]
         """Database logic to perform query for search endpoint."""
         if free_text_queries is not None:
             free_text_query_string = '" OR properties.\\*:"'.join(free_text_queries)
-            search = search.query("query_string", query=f'properties.\\*:"{free_text_query_string}"')
+            search = search.query(
+                "query_string", query=f'properties.\\*:"{free_text_query_string}"'
+            )
 
         return search
 
@@ -709,7 +727,11 @@ async def execute_search(
             if hits and (sort_array := hits[limit - 1].get("sort")):
                 next_token = urlsafe_b64encode(json.dumps(sort_array).encode()).decode()
 
-        matched = es_response["hits"]["total"]["value"] if es_response["hits"]["total"]["relation"] == "eq" else None
+        matched = (
+            es_response["hits"]["total"]["value"]
+            if es_response["hits"]["total"]["relation"] == "eq"
+            else None
+        )
         if count_task.done():
             try:
                 matched = count_task.result().get("count")
@@ -789,7 +811,9 @@ async def check_collection_exists(self, collection_id: str):
         if not await self.client.exists(index=COLLECTIONS_INDEX, id=collection_id):
             raise NotFoundError(f"Collection {collection_id} does not exist")
 
-    async def prep_create_item(self, item: Item, base_url: str, exist_ok: bool = False) -> Item:
+    async def prep_create_item(
+        self, item: Item, base_url: str, exist_ok: bool = False
+    ) -> Item:
         """
         Preps an item for insertion into the database.
 
@@ -811,11 +835,15 @@ async def prep_create_item(self, item: Item, base_url: str, exist_ok: bool = Fal
             index=index_alias_by_collection_id(item["collection"]),
             id=mk_item_id(item["id"], item["collection"]),
         ):
-            raise ConflictError(f"Item {item['id']} in collection {item['collection']} already exists")
+            raise ConflictError(
+                f"Item {item['id']} in collection {item['collection']} already exists"
+            )
 
         return self.item_serializer.stac_to_db(item, base_url)
 
-    def sync_prep_create_item(self, item: Item, base_url: str, exist_ok: bool = False) -> Item:
+    def sync_prep_create_item(
+        self, item: Item, base_url: str, exist_ok: bool = False
+    ) -> Item:
         """
         Prepare an item for insertion into the database.
 
@@ -844,7 +872,9 @@ def sync_prep_create_item(self, item: Item, base_url: str, exist_ok: bool = Fals
             index=index_alias_by_collection_id(collection_id),
             id=mk_item_id(item_id, collection_id),
         ):
-            raise ConflictError(f"Item {item_id} in collection {collection_id} already exists")
+            raise ConflictError(
+                f"Item {item_id} in collection {collection_id} already exists"
+            )
 
         return self.item_serializer.stac_to_db(item, base_url)
 
@@ -872,7 +902,9 @@ async def create_item(self, item: Item, refresh: bool = False):
         )
 
         if (meta := es_resp.get("meta")) and meta.get("status") == 409:
-            raise ConflictError(f"Item {item_id} in collection {collection_id} already exists")
+            raise ConflictError(
+                f"Item {item_id} in collection {collection_id} already exists"
+            )
 
     async def merge_patch_item(
         self,
@@ -929,7 +961,10 @@ async def json_patch_item(
         script_operations = []
 
         for operation in operations:
-            if operation.path in ["collection", "id"] and operation.op in ["add", "replace"]:
+            if operation.path in ["collection", "id"] and operation.op in [
+                "add",
+                "replace",
+            ]:
 
                 if operation.path == "collection" and collection_id != operation.value:
                     await self.check_collection_exists(collection_id=operation.value)
@@ -992,7 +1027,9 @@ async def json_patch_item(
 
         return item
 
-    async def delete_item(self, item_id: str, collection_id: str, refresh: bool = False):
+    async def delete_item(
+        self, item_id: str, collection_id: str, refresh: bool = False
+    ):
         """Delete a single item from the database.
 
         Args:
@@ -1010,7 +1047,9 @@ async def delete_item(self, item_id: str, collection_id: str, refresh: bool = Fa
                 refresh=refresh,
             )
         except exceptions.NotFoundError:
-            raise NotFoundError(f"Item {item_id} in collection {collection_id} not found")
+            raise NotFoundError(
+                f"Item {item_id} in collection {collection_id} not found"
+            )
 
     async def create_collection(self, collection: Collection, refresh: bool = False):
         """Create a single collection in the database.
@@ -1057,13 +1096,17 @@ async def find_collection(self, collection_id: str) -> Collection:
             collection as a `Collection` object. If the collection is not found, a `NotFoundError` is raised.
         """
         try:
-            collection = await self.client.get(index=COLLECTIONS_INDEX, id=collection_id)
+            collection = await self.client.get(
+                index=COLLECTIONS_INDEX, id=collection_id
+            )
         except exceptions.NotFoundError:
             raise NotFoundError(f"Collection {collection_id} not found")
 
         return collection["_source"]
 
-    async def update_collection(self, collection_id: str, collection: Collection, refresh: bool = False):
+    async def update_collection(
+        self, collection_id: str, collection: Collection, refresh: bool = False
+    ):
         """Update a collection from the database.
 
         Args:
@@ -1208,10 +1251,14 @@ async def delete_collection(self, collection_id: str, refresh: bool = False):
             function also calls `delete_item_index` to delete the index for the items in the collection.
         """
         await self.find_collection(collection_id=collection_id)
-        await self.client.delete(index=COLLECTIONS_INDEX, id=collection_id, refresh=refresh)
+        await self.client.delete(
+            index=COLLECTIONS_INDEX, id=collection_id, refresh=refresh
+        )
         await delete_item_index(collection_id)
 
-    async def bulk_async(self, collection_id: str, processed_items: List[Item], refresh: bool = False) -> None:
+    async def bulk_async(
+        self, collection_id: str, processed_items: List[Item], refresh: bool = False
+    ) -> None:
         """Perform a bulk insert of items into the database asynchronously.
 
         Args:
@@ -1233,7 +1280,9 @@ async def bulk_async(self, collection_id: str, processed_items: List[Item], refr
             raise_on_error=False,
         )
 
-    def bulk_sync(self, collection_id: str, processed_items: List[Item], refresh: bool = False) -> None:
+    def bulk_sync(
+        self, collection_id: str, processed_items: List[Item], refresh: bool = False
+    ) -> None:
         """Perform a bulk insert of items into the database synchronously.
 
         Args: