docs

Author: Grzegorz Pustulka

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/database_logic.py

@@ -5,7 +5,7 @@
 import logging
 from base64 import urlsafe_b64decode, urlsafe_b64encode
 from copy import deepcopy
-from typing import Any, Dict, Iterable, List, Optional, Tuple, Type, Union
+from typing import Any, Dict, Iterable, List, Optional, Tuple, Type
 
 import attr
 import elasticsearch.helpers as helpers
@@ -29,18 +29,10 @@
     get_queryables_mapping_shared,
     index_alias_by_collection_id,
     index_by_collection_id,
-    indices,
     mk_item_id,
     populate_sort_shared,
-    return_date,
     validate_refresh,
 )
-from stac_fastapi.sfeos_helpers.search_engine import (
-    BaseIndexInserter,
-    IndexInsertionFactory,
-    IndexSelectionStrategy,
-    IndexSelectorFactory,
-)
 from stac_fastapi.sfeos_helpers.mappings import (
     AGGREGATION_MAPPING,
     COLLECTIONS_INDEX,
@@ -49,6 +41,12 @@
     ITEMS_INDEX_PREFIX,
     Geometry,
 )
+from stac_fastapi.sfeos_helpers.search_engine import (
+    BaseIndexInserter,
+    IndexInsertionFactory,
+    IndexSelectionStrategy,
+    IndexSelectorFactory,
+)
 from stac_fastapi.types.errors import ConflictError, NotFoundError
 from stac_fastapi.types.stac import Collection, Item
 
@@ -139,14 +137,18 @@ def __attrs_post_init__(self):
         """Initialize clients after the class is instantiated."""
         self.client = self.async_settings.create_client
         self.sync_client = self.sync_settings.create_client
-        self.async_index_inserter = IndexInsertionFactory.create_async_insertion_strategy(
-            self.client
+        self.async_index_inserter = (
+            IndexInsertionFactory.create_async_insertion_strategy(self.client)
         )
         self.sync_index_inserter = IndexInsertionFactory.create_sync_insertion_strategy(
             self.sync_client
         )
-        self.async_index_selector = IndexSelectorFactory.create_async_selector(self.client)
-        self.sync_index_selector = IndexSelectorFactory.create_sync_selector(self.sync_client)
+        self.async_index_selector = IndexSelectorFactory.create_async_selector(
+            self.client
+        )
+        self.sync_index_selector = IndexSelectorFactory.create_sync_selector(
+            self.sync_client
+        )
 
     item_serializer: Type[ItemSerializer] = attr.ib(default=ItemSerializer)
     collection_serializer: Type[CollectionSerializer] = attr.ib(
@@ -894,14 +896,8 @@ async def delete_item(self, item_id: str, collection_id: str, **kwargs: Any):
             # Perform the delete operation
             await self.client.delete_by_query(
                 index=index_alias_by_collection_id(collection_id),
-                body={
-                    "query": {
-                        "term": {
-                            "_id": mk_item_id(item_id, collection_id)
-                        }
-                    }
-                },
-                refresh=refresh
+                body={"query": {"term": {"_id": mk_item_id(item_id, collection_id)}}},
+                refresh=refresh,
             )
         except ESNotFoundError:
             # Raise a custom NotFoundError if the item does not exist

stac_fastapi/opensearch/stac_fastapi/opensearch/database_logic.py

@@ -28,30 +28,25 @@
     delete_item_index_shared,
     get_queryables_mapping_shared,
     index_alias_by_collection_id,
-    index_by_collection_id,
-    indices,
     mk_item_id,
     populate_sort_shared,
-    return_date,
     validate_refresh,
 )
-from stac_fastapi.sfeos_helpers.search_engine import (
-    BaseIndexInserter,
-    IndexInsertionFactory,
-    IndexSelectionStrategy,
-    IndexSelectorFactory,
-)
 from stac_fastapi.sfeos_helpers.mappings import (
     AGGREGATION_MAPPING,
     COLLECTIONS_INDEX,
     DEFAULT_SORT,
     ES_COLLECTIONS_MAPPINGS,
-    ES_ITEMS_MAPPINGS,
-    ES_ITEMS_SETTINGS,
     ITEM_INDICES,
     ITEMS_INDEX_PREFIX,
     Geometry,
 )
+from stac_fastapi.sfeos_helpers.search_engine import (
+    BaseIndexInserter,
+    IndexInsertionFactory,
+    IndexSelectionStrategy,
+    IndexSelectorFactory,
+)
 from stac_fastapi.types.errors import ConflictError, NotFoundError
 from stac_fastapi.types.stac import Collection, Item
 
@@ -126,14 +121,18 @@ def __attrs_post_init__(self):
         """Initialize clients after the class is instantiated."""
         self.client = self.async_settings.create_client
         self.sync_client = self.sync_settings.create_client
-        self.async_index_inserter = IndexInsertionFactory.create_async_insertion_strategy(
-            self.client
+        self.async_index_inserter = (
+            IndexInsertionFactory.create_async_insertion_strategy(self.client)
         )
         self.sync_index_inserter = IndexInsertionFactory.create_sync_insertion_strategy(
             self.sync_client
         )
-        self.async_index_selector = IndexSelectorFactory.create_async_selector(self.client)
-        self.sync_index_selector = IndexSelectorFactory.create_sync_selector(self.sync_client)
+        self.async_index_selector = IndexSelectorFactory.create_async_selector(
+            self.client
+        )
+        self.sync_index_selector = IndexSelectorFactory.create_sync_selector(
+            self.sync_client
+        )
 
     item_serializer: Type[ItemSerializer] = attr.ib(default=ItemSerializer)
     collection_serializer: Type[CollectionSerializer] = attr.ib(
@@ -880,14 +879,8 @@ async def delete_item(self, item_id: str, collection_id: str, **kwargs: Any):
         try:
             await self.client.delete_by_query(
                 index=index_alias_by_collection_id(collection_id),
-                body={
-                    "query": {
-                        "term": {
-                            "_id": mk_item_id(item_id, collection_id)
-                        }
-                    }
-                },
-                refresh=refresh
+                body={"query": {"term": {"_id": mk_item_id(item_id, collection_id)}}},
+                refresh=refresh,
             )
         except exceptions.NotFoundError:
             raise NotFoundError(

stac_fastapi/sfeos_helpers/stac_fastapi/sfeos_helpers/database/__init__.py

@@ -30,7 +30,7 @@
 """
 
 # Re-export all functions for backward compatibility
-from .datetime import extract_date, return_date, extract_first_date_from_index
+from .datetime import extract_date, extract_first_date_from_index, return_date
 from .document import mk_item_id
 from .index import (
     create_index_templates_shared,
@@ -71,4 +71,4 @@
     "return_date",
     "extract_date",
     "extract_first_date_from_index",
-]
+]

stac_fastapi/sfeos_helpers/stac_fastapi/sfeos_helpers/database/datetime.py

@@ -40,9 +40,13 @@ def return_date(
     if isinstance(interval, str):
         if "/" in interval:
             parts = interval.split("/")
-            result["gte"] = parts[0] if parts[0] != ".." else datetime_type.min.isoformat() + "Z"
+            result["gte"] = (
+                parts[0] if parts[0] != ".." else datetime_type.min.isoformat() + "Z"
+            )
             result["lte"] = (
-                parts[1] if len(parts) > 1 and parts[1] != ".." else datetime_type.max.isoformat() + "Z"
+                parts[1]
+                if len(parts) > 1 and parts[1] != ".."
+                else datetime_type.max.isoformat() + "Z"
             )
         else:
             converted_time = interval if interval != ".." else None
@@ -72,7 +76,7 @@ def extract_date(date_str: str) -> date:
     Returns:
         A date object extracted from the input string.
     """
-    date_str = date_str.replace('Z', '+00:00')
+    date_str = date_str.replace("Z", "+00:00")
     return datetime_type.fromisoformat(date_str).date()
 
 
@@ -89,6 +93,6 @@ def extract_first_date_from_index(index_name: str) -> date:
         A date object extracted from the first date pattern found in the index name.
 
     """
-    date_pattern = r'\d{4}-\d{2}-\d{2}'
+    date_pattern = r"\d{4}-\d{2}-\d{2}"
     match = re.search(date_pattern, index_name)
-    return datetime_type.strptime(match.group(0), "%Y-%m-%d").date()
+    return datetime_type.strptime(match.group(0), "%Y-%m-%d").date()

stac_fastapi/sfeos_helpers/stac_fastapi/sfeos_helpers/database/document.py

@@ -4,10 +4,7 @@
 including document ID generation and bulk action creation.
 """
 
-from typing import Any, Dict, List
-
 from stac_fastapi.sfeos_helpers.database.index import index_alias_by_collection_id
-from stac_fastapi.types.stac import Item
 
 
 def mk_item_id(item_id: str, collection_id: str) -> str:

stac_fastapi/sfeos_helpers/stac_fastapi/sfeos_helpers/database/index.py

@@ -6,6 +6,7 @@
 from datetime import datetime
 from functools import lru_cache
 from typing import Any, List, Optional
+
 from dateutil.parser import parse
 
 from stac_fastapi.sfeos_helpers.mappings import (
@@ -100,9 +101,13 @@ def extract_date_range_from_index(index_name: str) -> tuple:
             end_date = datetime.strptime(dates[1], "%Y-%m-%d")
             return start_date, end_date
 
-    def is_index_in_range(start_date: datetime, end_date: datetime, gte_dt: datetime, lte_dt: datetime) -> bool:
+    def is_index_in_range(
+        start_date: datetime, end_date: datetime, gte_dt: datetime, lte_dt: datetime
+    ) -> bool:
         """Check if index date range overlaps with filter range."""
-        return not (end_date.date() < gte_dt.date() or start_date.date() > lte_dt.date())
+        return not (
+            end_date.date() < gte_dt.date() or start_date.date() > lte_dt.date()
+        )
 
     gte_dt = parse_datetime(gte) if gte else datetime.min.replace(microsecond=0)
     lte_dt = parse_datetime(lte) if lte else datetime.max.replace(microsecond=0)

stac_fastapi/sfeos_helpers/stac_fastapi/sfeos_helpers/search_engine/__init__.py

@@ -1,3 +1,5 @@
+"""Search engine index management package."""
+
 from .adapters import (
     ElasticsearchAdapter,
     OpenSearchAdapter,
@@ -10,8 +12,8 @@
 from .managers import DatetimeIndexManager, IndexSizeManager
 from .selection import (
     AsyncDatetimeBasedIndexSelector,
-    IndexSelectorFactory,
     IndexSelectionStrategy,
+    IndexSelectorFactory,
     SyncDatetimeBasedIndexSelector,
     UnfilteredIndexSelector,
 )
@@ -39,4 +41,4 @@
     "SyncDatetimeBasedIndexSelector",
     "UnfilteredIndexSelector",
     "IndexSelectorFactory",
-]
+]