stac-fastapi-core 4.0.0a1__py3-none-any.whl → 4.0.0a2__py3-none-any.whl

stac_fastapi/core/core.py

@@ -334,7 +334,7 @@ class CoreClient(AsyncBaseCoreClient):
             search=search,
             limit=limit,
             sort=None,
-            token=token,  # type: ignore
+            token=token,
             collection_ids=[collection_id],
         )
 
@@ -633,7 +633,7 @@ class CoreClient(AsyncBaseCoreClient):
         items, maybe_count, next_token = await self.database.execute_search(
             search=search,
             limit=limit,
-            token=search_request.token,  # type: ignore
+            token=search_request.token,
             sort=sort,
             collection_ids=search_request.collections,
         )
@@ -701,7 +701,10 @@ class TransactionsClient(AsyncBaseTransactionsClient):
                 database=self.database, settings=self.settings
             )
             processed_items = [
-                bulk_client.preprocess_item(item, base_url, BulkTransactionMethod.INSERT) for item in item["features"]  # type: ignore
+                bulk_client.preprocess_item(
+                    item, base_url, BulkTransactionMethod.INSERT
+                )
+                for item in item["features"]
             ]
 
             await self.database.bulk_async(

stac_fastapi/core/extensions/query.py

@@ -10,7 +10,7 @@ from enum import auto
 from types import DynamicClassAttribute
 from typing import Any, Callable, Dict, Optional
 
-from pydantic import BaseModel, root_validator
+from pydantic import BaseModel, model_validator
 from stac_pydantic.utils import AutoValueEnum
 
 from stac_fastapi.extensions.core.query import QueryExtension as QueryExtensionBase
@@ -63,7 +63,7 @@ class QueryExtensionPostRequest(BaseModel):
 
     query: Optional[Dict[str, Dict[Operator, Any]]] = None
 
-    @root_validator(pre=True)
+    @model_validator(mode="before")
     def validate_query_fields(cls, values: Dict) -> Dict:
         """Validate query fields."""
         ...

stac_fastapi/core/utilities.py

@@ -3,6 +3,8 @@
 This module contains functions for transforming geospatial coordinates,
 such as converting bounding boxes to polygon representations.
 """
+import logging
+import os
 from typing import Any, Dict, List, Optional, Set, Union
 
 from stac_fastapi.types.stac import Item
@@ -10,6 +12,33 @@ from stac_fastapi.types.stac import Item
 MAX_LIMIT = 10000
 
 
+def get_bool_env(name: str, default: bool = False) -> bool:
+    """
+    Retrieve a boolean value from an environment variable.
+
+    Args:
+        name (str): The name of the environment variable.
+        default (bool, optional): The default value to use if the variable is not set or unrecognized. Defaults to False.
+
+    Returns:
+        bool: The boolean value parsed from the environment variable.
+    """
+    value = os.getenv(name, str(default).lower())
+    true_values = ("true", "1", "yes", "y")
+    false_values = ("false", "0", "no", "n")
+    if value.lower() in true_values:
+        return True
+    elif value.lower() in false_values:
+        return False
+    else:
+        logger = logging.getLogger(__name__)
+        logger.warning(
+            f"Environment variable '{name}' has unrecognized value '{value}'. "
+            f"Expected one of {true_values + false_values}. Using default: {default}"
+        )
+        return default
+
+
 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/core/version.py

@@ -1,2 +1,2 @@
 """library version."""
-__version__ = "4.0.0a1"
+__version__ = "4.0.0a2"

{stac_fastapi_core-4.0.0a1.dist-info → stac_fastapi_core-4.0.0a2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi-core
-Version: 4.0.0a1
+Version: 4.0.0a2
 Summary: Core library for the Elasticsearch and Opensearch stac-fastapi backends.
 Home-page: https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch
 License: MIT
@@ -19,9 +19,9 @@ Requires-Dist: fastapi~=0.109.0
 Requires-Dist: attrs>=23.2.0
 Requires-Dist: pydantic<3.0.0,>=2.4.1
 Requires-Dist: stac-pydantic~=3.1.0
-Requires-Dist: stac-fastapi.api==5.1.1
-Requires-Dist: stac-fastapi.extensions==5.1.1
-Requires-Dist: stac-fastapi.types==5.1.1
+Requires-Dist: stac-fastapi.api==5.2.0
+Requires-Dist: stac-fastapi.extensions==5.2.0
+Requires-Dist: stac-fastapi.types==5.2.0
 Requires-Dist: orjson~=3.9.0
 Requires-Dist: overrides~=7.4.0
 Requires-Dist: geojson-pydantic~=1.0.0
@@ -60,8 +60,18 @@ Requires-Dist: slowapi~=0.1.9
 - There is [Postman](https://documenter.getpostman.com/view/12888943/2s8ZDSdRHA) documentation here for examples on how to run some of the API routes locally - after starting the elasticsearch backend via the compose.yml file.
 - The `/examples` folder shows an example of running stac-fastapi-elasticsearch from PyPI in docker without needing any code from the repository. There is also a Postman collection here that you can load into Postman for testing the API routes.
 
-- For changes, see the [Changelog](CHANGELOG.md)
-- We are always welcoming contributions. For the development notes: [Contributing](CONTRIBUTING.md)
+
+### Performance Note
+
+The `enable_direct_response` option is provided by the stac-fastapi core library (introduced in stac-fastapi 5.2.0) and is available in this project starting from v4.0.0.
+
+**You can now control this setting via the `ENABLE_DIRECT_RESPONSE` environment variable.**
+
+When enabled (`ENABLE_DIRECT_RESPONSE=true`), endpoints return Starlette Response objects directly, bypassing FastAPI's default serialization for improved performance. **However, all FastAPI dependencies (including authentication, custom status codes, and validation) are disabled for all routes.**
+
+This mode is best suited for public or read-only APIs where authentication and custom logic are not required. Default is `false` for safety.
+
+See: [issue #347](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/issues/347)
 
 
 ### To install from PyPI:
@@ -105,8 +115,9 @@ If you wish to use a different version, put the following in a
 file named `.env` in the same directory you run Docker Compose from:
 
 ```shell
-ELASTICSEARCH_VERSION=7.17.1
-OPENSEARCH_VERSION=2.11.0
+ELASTICSEARCH_VERSION=8.11.0
+OPENSEARCH_VERSION=2.11.1
+ENABLE_DIRECT_RESPONSE=false
 ```
 The most recent Elasticsearch 7.x versions should also work. See the [opensearch-py docs](https://github.com/opensearch-project/opensearch-py/blob/main/COMPATIBILITY.md) for compatibility information.
 
@@ -131,8 +142,9 @@ You can customize additional settings in your `.env` file:
 | `RELOAD`                     | Enable auto-reload for development.                                                  | `true`                   | Optional                                                                                    |
 | `STAC_FASTAPI_RATE_LIMIT`    | API rate limit per client.                                                           | `200/minute`             | Optional                                                                                    |
 | `BACKEND`                    | Tests-related variable                                                               | `elasticsearch` or `opensearch` based on the backend | Optional                                                                                    |
-| `ELASTICSEARCH_VERSION`      | ElasticSearch version                                                                | `7.17.1`                 | Optional                                                                                    |
-| `OPENSEARCH_VERSION`         | OpenSearch version                                                                   | `2.11.0`                 | Optional                                                                                    |
+| `ELASTICSEARCH_VERSION`          | Version of Elasticsearch to use.                                                         | `8.11.0`                      | Optional                                                                                    |
+| `ENABLE_DIRECT_RESPONSE`         | Enable direct response for maximum performance (disables all FastAPI dependencies, including authentication, custom status codes, and validation) | `false`                  | Optional                                                                                    |
+| `OPENSEARCH_VERSION`         | OpenSearch version                                                                   | `2.11.1`                 | Optional                                                                                    |
 
 > [!NOTE]
 > The variables `ES_HOST`, `ES_PORT`, `ES_USE_SSL`, and `ES_VERIFY_CERTS` apply to both Elasticsearch and OpenSearch backends, so there is no need to rename the key names to `OS_` even if you're using OpenSearch.

{stac_fastapi_core-4.0.0a1.dist-info → stac_fastapi_core-4.0.0a2.dist-info}/RECORD

@@ -2,24 +2,24 @@ stac_fastapi/core/__init__.py,sha256=8izV3IWRGdXmDOK1hIPQAanbWs9EI04PJCGgqG1ZGIs
 stac_fastapi/core/base_database_logic.py,sha256=GfxPMtg2gHAZM44haIgi_9J-IG1et_FYA5xRBosJpJA,1608
 stac_fastapi/core/base_settings.py,sha256=R3_Sx7n5XpGMs3zAwFJD7y008WvGU_uI2xkaabm82Kg,239
 stac_fastapi/core/basic_auth.py,sha256=RhFv3RVSHF6OaqnaaU2DO4ncJ_S5nB1q8UNpnVJJsrk,2155
-stac_fastapi/core/core.py,sha256=o2mcv6sZg9naELNHCX29G_VlRe-GekPJPJNMaJE1I88,39830
+stac_fastapi/core/core.py,sha256=v0Y5DTtvUS5MdXBf19_9CYsgn9yjT68n16g_Ny3I-5E,39836
 stac_fastapi/core/database_logic.py,sha256=2DDHZ0ja1emXmrRzoW_Me38FPb30GjRFz2Dhe9zMMpI,6904
 stac_fastapi/core/datetime_utils.py,sha256=ICUHPgvbH-xumIKdKVtcXogaCNEsxoaVqhWlVoCx-Ug,1481
 stac_fastapi/core/rate_limit.py,sha256=Gu8dAaJReGsj1L91U6m2tflU6RahpXDRs2-AYSKoybA,1318
 stac_fastapi/core/route_dependencies.py,sha256=zefYlfQTMW292vdqmtquW4UswtBHwH5Pm-8UynyZbJQ,5522
 stac_fastapi/core/serializers.py,sha256=pJjpwA6BOHjCXBCmwVTH7MOmTjY9NXF1-i_E0yB60Zg,6228
 stac_fastapi/core/session.py,sha256=Qr080UU_7qKtIv0qZAuOV7oNUQUzT5Yn00h-m_aoCvY,473
-stac_fastapi/core/utilities.py,sha256=viUM0JW4fRHZqbGHLzxOEAPEEoT9D4pl-geJ8PM5qh4,5771
-stac_fastapi/core/version.py,sha256=I6yN3SJF9c8gQmc5k4THOt7Vh8jd_Q50-0Zl7daL29k,47
+stac_fastapi/core/utilities.py,sha256=493rYGimjWykrkWnRia1Aquc4Jvlyvio21VZcEmdxPo,6743
+stac_fastapi/core/version.py,sha256=GsmpaQvFvJbtYx8dw8vx3_8haCi-G94TpDhDpEjX-8E,47
 stac_fastapi/core/extensions/__init__.py,sha256=2MCo0UoInkgItIM8id-rbeygzn_qUOvTGfr8jFXZjHQ,167
 stac_fastapi/core/extensions/aggregation.py,sha256=H5Yzvs-QH60P8jJm08Ng5FDvMU1o77WoNNZ2mKxUFjI,23062
 stac_fastapi/core/extensions/fields.py,sha256=NCT5XHvfaf297eDPNaIFsIzvJnbbUTpScqF0otdx0NA,1066
 stac_fastapi/core/extensions/filter.py,sha256=F7ECGQO-nDnc8TFmL5FK1TJMeWx5TmKMjwb8b4kRgOc,6394
-stac_fastapi/core/extensions/query.py,sha256=orFUi4F1hXtY8I2LhXcyDFI8x_v3mNUDRsc_oV1cw2s,1796
+stac_fastapi/core/extensions/query.py,sha256=Xmo8pfZEZKPudZEjjozv3R0wLOP0ayjC9E67sBOXqWY,1803
 stac_fastapi/core/models/__init__.py,sha256=g-D1DiGfmC9Bg27DW9JzkN6fAvscv75wyhyiZ6NzvIk,48
 stac_fastapi/core/models/links.py,sha256=3jk4t2wA3RGTq9_BbzFsMKvMbgDBajQy4vKZFSHt7E8,6666
 stac_fastapi/core/models/search.py,sha256=7SgAUyzHGXBXSqB4G6cwq9FMwoAS00momb7jvBkjyow,27
-stac_fastapi_core-4.0.0a1.dist-info/METADATA,sha256=e4U44khYsQZMJB1vcFULJ8bjZSSEVEfgXb86U1pGGBw,19093
-stac_fastapi_core-4.0.0a1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-stac_fastapi_core-4.0.0a1.dist-info/top_level.txt,sha256=vqn-D9-HsRPTTxy0Vk_KkDmTiMES4owwBQ3ydSZYb2s,13
-stac_fastapi_core-4.0.0a1.dist-info/RECORD,,
+stac_fastapi_core-4.0.0a2.dist-info/METADATA,sha256=y1XXMZGFyr30LDpVkWnko94Az0mzaCkqYqeUfVzg8oQ,20120
+stac_fastapi_core-4.0.0a2.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+stac_fastapi_core-4.0.0a2.dist-info/top_level.txt,sha256=vqn-D9-HsRPTTxy0Vk_KkDmTiMES4owwBQ3ydSZYb2s,13
+stac_fastapi_core-4.0.0a2.dist-info/RECORD,,