stac-fastapi.extensions 3.0.4__tar.gz → 4.0.0__tar.gz

{stac_fastapi_extensions-3.0.4 → stac_fastapi_extensions-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: stac-fastapi.extensions
-Version: 3.0.4
+Version: 4.0.0
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -10,17 +10,16 @@ Keywords: STAC FastAPI COG
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
 Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-Requires-Dist: stac-fastapi.types~=3.0
-Requires-Dist: stac-fastapi.api~=3.0
+Requires-Dist: stac-fastapi.types~=4.0
+Requires-Dist: stac-fastapi.api~=4.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -31,3 +30,14 @@ Provides-Extra: docs
 Requires-Dist: mkdocs; extra == "docs"
 Requires-Dist: mkdocs-material; extra == "docs"
 Requires-Dist: pdocs; extra == "docs"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

{stac_fastapi_extensions-3.0.4 → stac_fastapi_extensions-4.0.0}/setup.py

@@ -7,8 +7,8 @@ with open("README.md") as f:
     desc = f.read()
 
 install_requires = [
-    "stac-fastapi.types~=3.0",
-    "stac-fastapi.api~=3.0",
+    "stac-fastapi.types~=4.0",
+    "stac-fastapi.api~=4.0",
 ]
 
 extra_reqs = {
@@ -28,12 +28,11 @@ setup(
     description="An implementation of STAC API based on the FastAPI framework.",
     long_description=desc,
     long_description_content_type="text/markdown",
-    python_requires=">=3.8",
+    python_requires=">=3.9",
     classifiers=[
         "Intended Audience :: Developers",
         "Intended Audience :: Information Technology",
         "Intended Audience :: Science/Research",
-        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",

{stac_fastapi_extensions-3.0.4 → stac_fastapi_extensions-4.0.0}/stac_fastapi/extensions/core/collection_search/collection_search.py

@@ -1,6 +1,5 @@
 """Collection-Search extension."""
 
-import warnings
 from enum import Enum
 from typing import List, Optional, Union
 
@@ -79,7 +78,7 @@ class CollectionSearchExtension(ApiExtension):
         schema_href: Optional[str] = None,
     ) -> "CollectionSearchExtension":
         """Create CollectionSearchExtension object from extensions."""
-        supported_extensions = {
+        known_extension_conformances = {
             "FreeTextExtension": ConformanceClasses.FREETEXT,
             "FreeTextAdvancedExtension": ConformanceClasses.FREETEXT,
             "QueryExtension": ConformanceClasses.QUERY,
@@ -92,13 +91,7 @@ class CollectionSearchExtension(ApiExtension):
             ConformanceClasses.BASIS,
         ]
         for ext in extensions:
-            conf = supported_extensions.get(ext.__class__.__name__, None)
-            if not conf:
-                warnings.warn(
-                    f"Conformance class for `{ext.__class__.__name__}` extension not found.",  # noqa: E501
-                    UserWarning,
-                )
-            else:
+            if conf := known_extension_conformances.get(ext.__class__.__name__, None):
                 conformance_classes.append(conf)
 
         get_request_model = create_request_model(
@@ -187,7 +180,7 @@ class CollectionSearchPostExtension(CollectionSearchExtension):
         router: Optional[APIRouter] = None,
     ) -> "CollectionSearchPostExtension":
         """Create CollectionSearchPostExtension object from extensions."""
-        supported_extensions = {
+        known_extension_conformances = {
             "FreeTextExtension": ConformanceClasses.FREETEXT,
             "FreeTextAdvancedExtension": ConformanceClasses.FREETEXT,
             "QueryExtension": ConformanceClasses.QUERY,
@@ -200,13 +193,7 @@ class CollectionSearchPostExtension(CollectionSearchExtension):
             ConformanceClasses.BASIS,
         ]
         for ext in extensions:
-            conf = supported_extensions.get(ext.__class__.__name__, None)
-            if not conf:
-                warnings.warn(
-                    f"Conformance class for `{ext.__class__.__name__}` extension not found.",  # noqa: E501
-                    UserWarning,
-                )
-            else:
+            if conf := known_extension_conformances.get(ext.__class__.__name__, None):
                 conformance_classes.append(conf)
 
         get_request_model = create_request_model(

{stac_fastapi_extensions-3.0.4 → stac_fastapi_extensions-4.0.0}/stac_fastapi/extensions/core/collection_search/request.py

@@ -10,23 +10,22 @@ from stac_pydantic.api.search import SearchDatetime
 from stac_pydantic.shared import BBox
 from typing_extensions import Annotated
 
-from stac_fastapi.types.rfc3339 import DateTimeType
 from stac_fastapi.types.search import (
     APIRequest,
+    DatetimeMixin,
+    DateTimeQueryType,
     Limit,
     _bbox_converter,
-    _datetime_converter,
+    _validate_datetime,
 )
 
 
 @attr.s
-class BaseCollectionSearchGetRequest(APIRequest):
+class BaseCollectionSearchGetRequest(APIRequest, DatetimeMixin):
     """Basics additional Collection-Search parameters for the GET request."""
 
     bbox: Optional[BBox] = attr.ib(default=None, converter=_bbox_converter)
-    datetime: Optional[DateTimeType] = attr.ib(
-        default=None, converter=_datetime_converter
-    )
+    datetime: DateTimeQueryType = attr.ib(default=None, validator=_validate_datetime)
     limit: Annotated[
         Optional[Limit],
         Query(
@@ -38,8 +37,26 @@ class BaseCollectionSearchGetRequest(APIRequest):
 class BaseCollectionSearchPostRequest(BaseModel):
     """Collection-Search POST model."""
 
-    bbox: Optional[BBox] = None
-    datetime: Optional[str] = None
+    bbox: Optional[BBox] = Field(
+        default=None,
+        description="Only return items intersecting this bounding box. Mutually exclusive with **intersects**.",  # noqa: E501
+        json_schema_extra={
+            "example": [-175.05, -85.05, 175.05, 85.05],
+        },
+    )
+    datetime: Optional[str] = Field(
+        default=None,
+        description="""Only return items that have a temporal property that intersects this value.\n
+Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.""",  # noqa: E501
+        json_schema_extra={
+            "examples": {
+                "datetime": {"value": "2018-02-12T23:20:50Z"},
+                "closed-interval": {"value": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"},
+                "open-interval-from": {"value": "2018-02-12T00:00:00Z/.."},
+                "open-interval-to": {"value": "../2018-03-18T12:31:12Z"},
+            },
+        },
+    )
     limit: Optional[Limit] = Field(
         10,
         description="Limits the number of results that are included in each page of the response (capped to 10_000).",  # noqa: E501

{stac_fastapi_extensions-3.0.4 → stac_fastapi_extensions-4.0.0}/stac_fastapi/extensions/core/filter/request.py

@@ -16,9 +16,10 @@ FilterLang = Literal["cql-json", "cql2-json", "cql2-text"]
 class FilterExtensionGetRequest(APIRequest):
     """Filter extension GET request model."""
 
-    filter: Annotated[
+    filter_expr: Annotated[
         Optional[str],
         Query(
+            alias="filter",
             description="""A CQL filter expression for filtering items.\n
 Supports `CQL-JSON` as defined in https://portal.ogc.org/files/96288\n
 Remember to URL encode the CQL-JSON if using GET""",
@@ -46,8 +47,9 @@ Remember to URL encode the CQL-JSON if using GET""",
 class FilterExtensionPostRequest(BaseModel):
     """Filter extension POST request model."""
 
-    filter: Optional[Dict[str, Any]] = Field(
+    filter_expr: Optional[Dict[str, Any]] = Field(
         default=None,
+        alias="filter",
         description="A CQL filter expression for filtering items.",
         json_schema_extra={
             "example": {

{stac_fastapi_extensions-3.0.4 → stac_fastapi_extensions-4.0.0}/stac_fastapi/extensions/version.py

@@ -1,3 +1,3 @@
 """Library version."""
 
-__version__ = "3.0.4"
+__version__ = "4.0.0"

{stac_fastapi_extensions-3.0.4 → stac_fastapi_extensions-4.0.0}/stac_fastapi.extensions.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: stac-fastapi.extensions
-Version: 3.0.4
+Version: 4.0.0
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -10,17 +10,16 @@ Keywords: STAC FastAPI COG
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
 Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-Requires-Dist: stac-fastapi.types~=3.0
-Requires-Dist: stac-fastapi.api~=3.0
+Requires-Dist: stac-fastapi.types~=4.0
+Requires-Dist: stac-fastapi.api~=4.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -31,3 +30,14 @@ Provides-Extra: docs
 Requires-Dist: mkdocs; extra == "docs"
 Requires-Dist: mkdocs-material; extra == "docs"
 Requires-Dist: pdocs; extra == "docs"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

{stac_fastapi_extensions-3.0.4 → stac_fastapi_extensions-4.0.0}/stac_fastapi.extensions.egg-info/requires.txt

@@ -1,5 +1,5 @@
-stac-fastapi.types~=3.0
-stac-fastapi.api~=3.0
+stac-fastapi.types~=4.0
+stac-fastapi.api~=4.0
 
 [dev]
 pytest

{stac_fastapi_extensions-3.0.4 → stac_fastapi_extensions-4.0.0}/tests/test_collection_search.py

@@ -120,10 +120,7 @@ def test_collection_search_extension_default():
         assert response.is_success, response.json()
         response_dict = response.json()
         assert [-175.05, -85.05, 175.05, 85.05] == response_dict["bbox"]
-        assert [
-            "2020-06-13T13:00:00+00:00",
-            "2020-06-13T14:00:00+00:00",
-        ] == response_dict["datetime"]
+        assert "2020-06-13T13:00:00Z/2020-06-13T14:00:00Z" == response_dict["datetime"]
         assert 100 == response_dict["limit"]
 
 
@@ -188,7 +185,7 @@ def test_collection_search_extension_models():
         assert "datetime" in response_dict
         assert "limit" in response_dict
         assert "q" in response_dict
-        assert "filter" in response_dict
+        assert "filter_expr" in response_dict
         assert "query" in response_dict
         assert "sortby" in response_dict
         assert "fields" in response_dict
@@ -211,13 +208,12 @@ def test_collection_search_extension_models():
         assert response.is_success, response.json()
         response_dict = response.json()
         assert [-175.05, -85.05, 175.05, 85.05] == response_dict["bbox"]
-        assert [
-            "2020-06-13T13:00:00+00:00",
-            "2020-06-13T14:00:00+00:00",
-        ] == response_dict["datetime"]
+        assert "2020-06-13T13:00:00Z/2020-06-13T14:00:00Z" == response_dict["datetime"]
         assert 100 == response_dict["limit"]
         assert ["EO", "Earth Observation"] == response_dict["q"]
-        assert "id='item_id' AND collection='collection_id'" == response_dict["filter"]
+        assert (
+            "id='item_id' AND collection='collection_id'" == response_dict["filter_expr"]
+        )
         assert "filter_crs" in response_dict
         assert "cql2-text" in response_dict["filter_lang"]
         assert "query" in response_dict
@@ -353,7 +349,7 @@ def test_collection_search_extension_post_models():
         assert "datetime" in response_dict
         assert "limit" in response_dict
         assert "q" in response_dict
-        assert "filter" in response_dict
+        assert "filter_expr" in response_dict
         assert "query" in response_dict
         assert "sortby" in response_dict
         assert "fields" in response_dict
@@ -394,7 +390,7 @@ def test_collection_search_extension_post_models():
         assert "2020-06-13T13:00:00Z/2020-06-13T14:00:00Z" == response_dict["datetime"]
         assert 10_000 == response_dict["limit"]
         assert ["EO", "Earth Observation"] == response_dict["q"]
-        assert response_dict["filter"]
+        assert response_dict["filter_expr"]
         assert "filter_crs" in response_dict
         assert "cql2-json" in response_dict["filter_lang"]
         assert response_dict["query"]
@@ -439,7 +435,7 @@ def test_from_extensions_methods(extensions):
     assert hasattr(collection_search, "fields")
     assert hasattr(collection_search, "q")
     assert hasattr(collection_search, "sortby")
-    assert hasattr(collection_search, "filter")
+    assert hasattr(collection_search, "filter_expr")
     assert ext.conformance_classes == [
         ConformanceClasses.COLLECTIONSEARCH,
         ConformanceClasses.BASIS,
@@ -463,7 +459,7 @@ def test_from_extensions_methods(extensions):
     assert hasattr(collection_search, "fields")
     assert hasattr(collection_search, "q")
     assert hasattr(collection_search, "sortby")
-    assert hasattr(collection_search, "filter")
+    assert hasattr(collection_search, "filter_expr")
     assert ext.conformance_classes == [
         ConformanceClasses.COLLECTIONSEARCH,
         ConformanceClasses.BASIS,
@@ -476,35 +472,36 @@ def test_from_extensions_methods(extensions):
 
 
 def test_from_extensions_methods_invalid():
-    """Should raise warnings for invalid extensions."""
+    """Should also work with unknown extensions."""
     extensions = [
         AggregationExtension(),
     ]
-    with pytest.warns((UserWarning)):
-        ext = CollectionSearchExtension.from_extensions(
-            extensions,
-        )
+    ext = CollectionSearchExtension.from_extensions(
+        extensions,
+    )
+
     collection_search = ext.GET()
     assert collection_search.__class__.__name__ == "CollectionsGetRequest"
     assert hasattr(collection_search, "bbox")
     assert hasattr(collection_search, "datetime")
     assert hasattr(collection_search, "limit")
+    assert hasattr(collection_search, "aggregations")
     assert ext.conformance_classes == [
         ConformanceClasses.COLLECTIONSEARCH,
         ConformanceClasses.BASIS,
     ]
 
-    with pytest.warns((UserWarning)):
-        ext = CollectionSearchPostExtension.from_extensions(
-            extensions,
-            client=DummyPostClient(),
-            settings=ApiSettings(),
-        )
+    ext = CollectionSearchPostExtension.from_extensions(
+        extensions,
+        client=DummyPostClient(),
+        settings=ApiSettings(),
+    )
     collection_search = ext.POST()
     assert collection_search.__class__.__name__ == "CollectionsPostRequest"
     assert hasattr(collection_search, "bbox")
     assert hasattr(collection_search, "datetime")
     assert hasattr(collection_search, "limit")
+    assert hasattr(collection_search, "aggregations")
     assert ext.conformance_classes == [
         ConformanceClasses.COLLECTIONSEARCH,
         ConformanceClasses.BASIS,

{stac_fastapi_extensions-3.0.4 → stac_fastapi_extensions-4.0.0}/tests/test_filter.py

@@ -57,6 +57,7 @@ def test_search_filter_post_filter_lang_default(client: TestClient):
     )
     assert response.is_success, response.json()
     response_dict = response.json()
+    assert response_dict["filter_expr"]
     assert response_dict["filter_lang"] == "cql2-json"
 
 
@@ -73,6 +74,7 @@ def test_search_filter_post_filter_lang_non_default(client: TestClient):
     )
     assert response.is_success, response.json()
     response_dict = response.json()
+    assert response_dict["filter_expr"]
     assert response_dict["filter_lang"] == filter_lang_value
 
 
@@ -87,7 +89,7 @@ def test_search_filter_get(client: TestClient):
     assert response.is_success, response.json()
     response_dict = response.json()
     assert not response_dict["collections"]
-    assert response_dict["filter"] == "id='item_id' AND collection='collection_id'"
+    assert response_dict["filter_expr"] == "id='item_id' AND collection='collection_id'"
     assert not response_dict["filter_crs"]
     assert response_dict["filter_lang"] == "cql2-text"
 
@@ -102,7 +104,7 @@ def test_search_filter_get(client: TestClient):
     response_dict = response.json()
     assert not response_dict["collections"]
     assert (
-        response_dict["filter"]
+        response_dict["filter_expr"]
         == "{'op': '=', 'args': [{'property': 'id'}, 'test-item']}"
     )
     assert not response_dict["filter_crs"]