formatting and linting

Author: jamesfisher-geo

data_loader/data_loader.py

@@ -7,8 +7,8 @@
 import requests
 
 if len(sys.argv) != 2:
-        print("Usage: python data_loader.py <opensearch|elasticsearch>")
-        sys.exit(1)
+    print("Usage: python data_loader.py <opensearch|elasticsearch>")
+    sys.exit(1)
 
 DATA_DIR = os.path.join(os.path.dirname(__file__), "setup_data/")
 
@@ -18,7 +18,7 @@
 elif backend == "elasticsearch":
     STAC_API_BASE_URL = "http://localhost:8080"
 else:
-    print("Invalid backend tag. Enter either 'opensearch' or 'elasticsearch'.")  
+    print("Invalid backend tag. Enter either 'opensearch' or 'elasticsearch'.")
 
 
 def load_data(filename):

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/app.py

@@ -1,4 +1,6 @@
 """FastAPI application."""
+import os
+
 from stac_fastapi.api.app import StacApi
 from stac_fastapi.api.models import create_get_request_model, create_post_request_model
 from stac_fastapi.elasticsearch.core import (
@@ -7,15 +9,17 @@
     EsAsyncBaseFiltersClient,
     TransactionsClient,
 )
-import os
 
-backend = os.getenv("BACKEND", "elasticsearch").lower()
-if backend == "opensearch":
+if os.getenv("BACKEND", "elasticsearch").lower() == "opensearch":
     from stac_fastapi.elasticsearch.config.config_opensearch import SearchSettings
-    from stac_fastapi.elasticsearch.database_logic.database_logic_opensearch import create_collection_index
+    from stac_fastapi.elasticsearch.database_logic.database_logic_opensearch import (
+        create_collection_index,
+    )
 else:
     from stac_fastapi.elasticsearch.config.config_elasticsearch import SearchSettings
-    from stac_fastapi.elasticsearch.database_logic.database_logic_elasticsearch import create_collection_index
+    from stac_fastapi.elasticsearch.database_logic.database_logic_elasticsearch import (
+        create_collection_index,
+    )
 
 from stac_fastapi.elasticsearch.extensions import QueryExtension
 from stac_fastapi.elasticsearch.session import Session

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/config/config_opensearch.py

@@ -4,6 +4,7 @@
 from typing import Any, Dict, Set
 
 from opensearchpy import AsyncOpenSearch, OpenSearch
+
 from stac_fastapi.types.config import ApiSettings
 
 

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/core.py

@@ -1,7 +1,7 @@
 """Item crud client."""
 import logging
-import re
 import os
+import re
 from base64 import urlsafe_b64encode
 from datetime import datetime as datetime_type
 from datetime import timezone
@@ -19,15 +19,17 @@
 from stac_pydantic.links import Relations
 from stac_pydantic.shared import MimeTypes
 
-backend = os.getenv("BACKEND", "elasticsearch").lower()
-if backend == "opensearch":
-    from stac_fastapi.elasticsearch.database_logic.database_logic_opensearch import DatabaseLogic
+if os.getenv("BACKEND", "elasticsearch").lower() == "opensearch":
     from stac_fastapi.elasticsearch.config.config_opensearch import SearchSettings
+    from stac_fastapi.elasticsearch.database_logic.database_logic_opensearch import (
+        DatabaseLogic,
+    )
 else:
-    from stac_fastapi.elasticsearch.database_logic.database_logic_elasticsearch import DatabaseLogic
+    from stac_fastapi.elasticsearch.database_logic.database_logic_elasticsearch import (
+        DatabaseLogic,
+    )
     from stac_fastapi.elasticsearch.config.config_elasticsearch import SearchSettings
 
-
 from stac_fastapi.elasticsearch import serializers
 from stac_fastapi.elasticsearch.models.links import PagingLinks
 from stac_fastapi.elasticsearch.serializers import CollectionSerializer, ItemSerializer

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/database_logic/database_logic_elasticsearch.py

@@ -15,9 +15,9 @@
     SearchSettings as SyncSearchSettings,
 )
 from stac_fastapi.elasticsearch.extensions import filter
+from stac_fastapi.elasticsearch.utilities import bbox2polygon
 from stac_fastapi.types.errors import ConflictError, NotFoundError
 from stac_fastapi.types.stac import Collection, Item
-from stac_fastapi.elasticsearch.utilities import bbox2polygon
 
 logger = logging.getLogger(__name__)
 

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/database_logic/database_logic_opensearch.py

@@ -6,20 +6,20 @@
 from typing import Any, Dict, Iterable, List, Optional, Protocol, Tuple, Type, Union
 
 import attr
-from opensearchpy.helpers.search import Search
-from opensearchpy.helpers.query import Q
-from opensearchpy import helpers, exceptions
+from opensearchpy import exceptions, helpers
 from opensearchpy.exceptions import TransportError
+from opensearchpy.helpers.query import Q
+from opensearchpy.helpers.search import Search
 
 from stac_fastapi.elasticsearch import serializers
 from stac_fastapi.elasticsearch.config.config_opensearch import AsyncSearchSettings
 from stac_fastapi.elasticsearch.config.config_opensearch import (
     SearchSettings as SyncSearchSettings,
 )
 from stac_fastapi.elasticsearch.extensions import filter
+from stac_fastapi.elasticsearch.utilities import bbox2polygon
 from stac_fastapi.types.errors import ConflictError, NotFoundError
 from stac_fastapi.types.stac import Collection, Item
-from stac_fastapi.elasticsearch.utilities import bbox2polygon
 
 logger = logging.getLogger(__name__)
 
@@ -184,22 +184,19 @@ async def create_collection_index() -> None:
 
     search_body = {
         "mappings": ES_COLLECTIONS_MAPPINGS,
-        "aliases":{COLLECTIONS_INDEX: {}}
+        "aliases": {COLLECTIONS_INDEX: {}},
     }
 
     index = f"{COLLECTIONS_INDEX}-000001"
 
     try:
-        await client.indices.create(
-            index=index,
-            body=search_body
-        )
+        await client.indices.create(index=index, body=search_body)
     except TransportError as e:
         if e.status_code == 400:
             pass  # Ignore 400 status codes
         else:
-            raise e 
-        
+            raise e
+
     await client.close()
 
 
@@ -217,22 +214,19 @@ async def create_item_index(collection_id: str):
     client = AsyncSearchSettings().create_client
     index_name = index_by_collection_id(collection_id)
     search_body = {
-        "aliases":{index_name: {}},
-        "mappings":ES_ITEMS_MAPPINGS,
-        "settings":ES_ITEMS_SETTINGS,
+        "aliases": {index_name: {}},
+        "mappings": ES_ITEMS_MAPPINGS,
+        "settings": ES_ITEMS_SETTINGS,
     }
 
     try:
-        await client.indices.create(
-            index=f"{index_name}-000001",
-            body=search_body
-        )
+        await client.indices.create(index=f"{index_name}-000001", body=search_body)
     except TransportError as e:
         if e.status_code == 400:
             pass  # Ignore 400 status codes
         else:
-            raise e 
-        
+            raise e
+
     await client.close()
 
 
@@ -317,7 +311,9 @@ class DatabaseLogic:
     """CORE LOGIC"""
 
     async def get_all_collections(
-        self, token: Optional[str], limit: int
+        self,
+        token: Optional[str],
+        limit: int,
     ) -> Iterable[Dict[str, Any]]:
         """Retrieve a list of all collections from the database.
 
@@ -333,16 +329,15 @@ async def get_all_collections(
             with the `COLLECTIONS_INDEX` as the target index and `size=limit` to retrieve records.
             The result is a generator of dictionaries containing the source data for each collection.
         """
-        search_body = {}
+        search_body: Dict[str, Any] = {}
         if token:
             search_after = urlsafe_b64decode(token.encode()).decode().split(",")
             search_body["search_after"] = search_after
+
         search_body["sort"] = {"id": {"order": "asc"}}
-        
+
         collections = await self.client.search(
-            index=COLLECTIONS_INDEX,
-            body=search_body,
-            size=limit
+            index=COLLECTIONS_INDEX, body=search_body, size=limit
         )
         hits = collections["hits"]["hits"]
         return hits
@@ -545,14 +540,14 @@ async def execute_search(
         Raises:
             NotFoundError: If the collections specified in `collection_ids` do not exist.
         """
-        search_body = {}
+        search_body: Dict[str, Any] = {}
         query = search.query.to_dict() if search.query else None
         if query:
-            search_body["query"] = query 
+            search_body["query"] = query
         if token:
             search_after = urlsafe_b64decode(token.encode()).decode().split(",")
             search_body["search_after"] = search_after
-        search_body["sort"]  = sort if sort else DEFAULT_SORT
+        search_body["sort"] = sort if sort else DEFAULT_SORT
 
         index_param = indices(collection_ids)
 
@@ -561,7 +556,7 @@ async def execute_search(
                 index=index_param,
                 ignore_unavailable=ignore_unavailable,
                 body=search_body,
-                size=limit
+                size=limit,
             )
         )
 

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/utilities.py

@@ -1,5 +1,11 @@
+"""Module for geospatial processing functions.
+
+This module contains functions for transforming geospatial coordinates,
+such as converting bounding boxes to polygon representations.
+"""
 from typing import List
 
+
 def bbox2polygon(b0: float, b1: float, b2: float, b3: float) -> List[List[List[float]]]:
     """Transform a bounding box represented by its four coordinates `b0`, `b1`, `b2`, and `b3` into a polygon.
 

stac_fastapi/elasticsearch/tests/conftest.py

@@ -11,13 +11,18 @@
 from stac_fastapi.api.app import StacApi
 from stac_fastapi.api.models import create_get_request_model, create_post_request_model
 
-backend = os.getenv("BACKEND", "elasticsearch").lower()
-if backend == "opensearch":
+if os.getenv("BACKEND", "elasticsearch").lower() == "opensearch":
     from stac_fastapi.elasticsearch.config.config_opensearch import AsyncSearchSettings
-    from stac_fastapi.elasticsearch.database_logic.database_logic_opensearch import create_collection_index
+    from stac_fastapi.elasticsearch.database_logic.database_logic_opensearch import (
+        create_collection_index,
+    )
 else:
-    from stac_fastapi.elasticsearch.config.config_elasticsearch import AsyncSearchSettings
-    from stac_fastapi.elasticsearch.database_logic.database_logic_elasticsearch import create_collection_index
+    from stac_fastapi.elasticsearch.config.config_elasticsearch import (
+        AsyncSearchSettings,
+    )
+    from stac_fastapi.elasticsearch.database_logic.database_logic_elasticsearch import (
+        create_collection_index,
+    )
 
 from stac_fastapi.elasticsearch.core import (
     BulkTransactionsClient,