stac-fastapi.extensions 3.0.0b3__tar.gz → 3.0.2__tar.gz

{stac_fastapi_extensions-3.0.0b3 → stac_fastapi_extensions-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.extensions
-Version: 3.0.0b3
+Version: 3.0.2
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -18,8 +18,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Requires-Dist: stac-fastapi.types
-Requires-Dist: stac-fastapi.api
+Requires-Dist: stac-fastapi.types~=3.0
+Requires-Dist: stac-fastapi.api~=3.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"

{stac_fastapi_extensions-3.0.0b3 → stac_fastapi_extensions-3.0.2}/setup.py

@@ -7,8 +7,8 @@ with open("README.md") as f:
     desc = f.read()
 
 install_requires = [
-    "stac-fastapi.types",
-    "stac-fastapi.api",
+    "stac-fastapi.types~=3.0",
+    "stac-fastapi.api~=3.0",
 ]
 
 extra_reqs = {

{stac_fastapi_extensions-3.0.0b3 → stac_fastapi_extensions-3.0.2}/stac_fastapi/extensions/core/__init__.py

@@ -2,7 +2,6 @@
 
 from .aggregation import AggregationExtension
 from .collection_search import CollectionSearchExtension, CollectionSearchPostExtension
-from .context import ContextExtension
 from .fields import FieldsExtension
 from .filter import FilterExtension
 from .free_text import FreeTextAdvancedExtension, FreeTextExtension
@@ -13,7 +12,6 @@ from .transaction import TransactionExtension
 
 __all__ = (
     "AggregationExtension",
-    "ContextExtension",
     "FieldsExtension",
     "FilterExtension",
     "FreeTextExtension",

{stac_fastapi_extensions-3.0.0b3 → stac_fastapi_extensions-3.0.2}/stac_fastapi/extensions/core/collection_search/collection_search.py

@@ -1,5 +1,6 @@
 """Collection-Search extension."""
 
+import warnings
 from enum import Enum
 from typing import List, Optional, Union
 
@@ -8,7 +9,7 @@ from fastapi import APIRouter, FastAPI
 from stac_pydantic.api.collections import Collections
 from stac_pydantic.shared import MimeTypes
 
-from stac_fastapi.api.models import GeoJSONResponse
+from stac_fastapi.api.models import GeoJSONResponse, create_request_model
 from stac_fastapi.api.routes import create_async_endpoint
 from stac_fastapi.types.config import ApiSettings
 from stac_fastapi.types.extension import ApiExtension
@@ -71,6 +72,48 @@ class CollectionSearchExtension(ApiExtension):
         """
         pass
 
+    @classmethod
+    def from_extensions(
+        cls,
+        extensions: List[ApiExtension],
+        schema_href: Optional[str] = None,
+    ) -> "CollectionSearchExtension":
+        """Create CollectionSearchExtension object from extensions."""
+        supported_extensions = {
+            "FreeTextExtension": ConformanceClasses.FREETEXT,
+            "FreeTextAdvancedExtension": ConformanceClasses.FREETEXT,
+            "QueryExtension": ConformanceClasses.QUERY,
+            "SortExtension": ConformanceClasses.SORT,
+            "FieldsExtension": ConformanceClasses.FIELDS,
+            "FilterExtension": ConformanceClasses.FILTER,
+        }
+        conformance_classes = [
+            ConformanceClasses.COLLECTIONSEARCH,
+            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:
+                conformance_classes.append(conf)
+
+        get_request_model = create_request_model(
+            model_name="CollectionsGetRequest",
+            base_model=BaseCollectionSearchGetRequest,
+            extensions=extensions,
+            request_type="GET",
+        )
+
+        return cls(
+            GET=get_request_model,
+            conformance_classes=conformance_classes,
+            schema_href=schema_href,
+        )
+
 
 @attr.s
 class CollectionSearchPostExtension(CollectionSearchExtension):
@@ -132,3 +175,60 @@ class CollectionSearchPostExtension(CollectionSearchExtension):
             endpoint=create_async_endpoint(self.client.post_all_collections, self.POST),
         )
         app.include_router(self.router)
+
+    @classmethod
+    def from_extensions(
+        cls,
+        extensions: List[ApiExtension],
+        *,
+        client: Union[AsyncBaseCollectionSearchClient, BaseCollectionSearchClient],
+        settings: ApiSettings,
+        schema_href: Optional[str] = None,
+        router: Optional[APIRouter] = None,
+    ) -> "CollectionSearchPostExtension":
+        """Create CollectionSearchPostExtension object from extensions."""
+        supported_extensions = {
+            "FreeTextExtension": ConformanceClasses.FREETEXT,
+            "FreeTextAdvancedExtension": ConformanceClasses.FREETEXT,
+            "QueryExtension": ConformanceClasses.QUERY,
+            "SortExtension": ConformanceClasses.SORT,
+            "FieldsExtension": ConformanceClasses.FIELDS,
+            "FilterExtension": ConformanceClasses.FILTER,
+        }
+        conformance_classes = [
+            ConformanceClasses.COLLECTIONSEARCH,
+            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:
+                conformance_classes.append(conf)
+
+        get_request_model = create_request_model(
+            model_name="CollectionsGetRequest",
+            base_model=BaseCollectionSearchGetRequest,
+            extensions=extensions,
+            request_type="GET",
+        )
+
+        post_request_model = create_request_model(
+            model_name="CollectionsPostRequest",
+            base_model=BaseCollectionSearchPostRequest,
+            extensions=extensions,
+            request_type="POST",
+        )
+
+        return cls(
+            client=client,
+            settings=settings,
+            GET=get_request_model,
+            POST=post_request_model,
+            conformance_classes=conformance_classes,
+            router=router or APIRouter(),
+            schema_href=schema_href,
+        )

{stac_fastapi_extensions-3.0.0b3 → stac_fastapi_extensions-3.0.2}/stac_fastapi/extensions/core/fields/request.py

@@ -1,6 +1,5 @@
 """Request models for the fields extension."""
 
-import warnings
 from typing import Dict, List, Optional, Set
 
 import attr
@@ -44,31 +43,6 @@ class PostFieldsExtension(BaseModel):
 
         return field_dict
 
-    @property
-    def filter_fields(self) -> Dict:
-        """Create pydantic include/exclude expression.
-
-        Create dictionary of fields to include/exclude on model export based on
-        the included and excluded fields passed to the API
-        Ref: https://pydantic-docs.helpmanual.io/usage/exporting_models/#advanced-include-and-exclude
-        """
-        warnings.warn(
-            """The `PostFieldsExtension.filter_fields`
-            method is deprecated and will be removed in 3.0.""",
-            DeprecationWarning,
-            stacklevel=1,
-        )
-
-        # Always include default_includes, even if they
-        # exist in the exclude list.
-        include = (self.include or set()) - (self.exclude or set())
-        include |= set()
-
-        return {
-            "include": self._get_field_dict(include),
-            "exclude": self._get_field_dict(self.exclude),
-        }
-
 
 def _fields_converter(
     val: Annotated[

stac_fastapi_extensions-3.0.2/stac_fastapi/extensions/version.py

@@ -0,0 +1,3 @@
+"""Library version."""
+
+__version__ = "3.0.2"

{stac_fastapi_extensions-3.0.0b3 → stac_fastapi_extensions-3.0.2}/stac_fastapi.extensions.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.extensions
-Version: 3.0.0b3
+Version: 3.0.2
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -18,8 +18,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Requires-Dist: stac-fastapi.types
-Requires-Dist: stac-fastapi.api
+Requires-Dist: stac-fastapi.types~=3.0
+Requires-Dist: stac-fastapi.api~=3.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"

{stac_fastapi_extensions-3.0.0b3 → stac_fastapi_extensions-3.0.2}/stac_fastapi.extensions.egg-info/SOURCES.txt

@@ -10,7 +10,6 @@ stac_fastapi.extensions.egg-info/top_level.txt
 stac_fastapi/extensions/__init__.py
 stac_fastapi/extensions/version.py
 stac_fastapi/extensions/core/__init__.py
-stac_fastapi/extensions/core/context.py
 stac_fastapi/extensions/core/transaction.py
 stac_fastapi/extensions/core/aggregation/__init__.py
 stac_fastapi/extensions/core/aggregation/aggregation.py

{stac_fastapi_extensions-3.0.0b3 → stac_fastapi_extensions-3.0.2}/stac_fastapi.extensions.egg-info/requires.txt

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

{stac_fastapi_extensions-3.0.0b3 → stac_fastapi_extensions-3.0.2}/tests/test_collection_search.py

@@ -2,13 +2,21 @@ import json
 from urllib.parse import quote_plus
 
 import attr
+import pytest
 from starlette.testclient import TestClient
 
 from stac_fastapi.api.app import StacApi
 from stac_fastapi.api.models import create_request_model
 from stac_fastapi.extensions.core import (
+    AggregationExtension,
     CollectionSearchExtension,
     CollectionSearchPostExtension,
+    FieldsExtension,
+    FilterExtension,
+    FreeTextAdvancedExtension,
+    FreeTextExtension,
+    QueryExtension,
+    SortExtension,
 )
 from stac_fastapi.extensions.core.collection_search import ConformanceClasses
 from stac_fastapi.extensions.core.collection_search.client import (
@@ -302,8 +310,8 @@ def test_collection_search_extension_post_models():
         client=DummyCoreClient(),
         extensions=[
             CollectionSearchPostExtension(
-                settings=settings,
                 client=DummyPostClient(),
+                settings=settings,
                 GET=get_request_model,
                 POST=post_request_model,
                 conformance_classes=[
@@ -392,3 +400,112 @@ def test_collection_search_extension_post_models():
         assert response_dict["query"]
         assert response_dict["sortby"]
         assert response_dict["fields"]
+
+
+@pytest.mark.parametrize(
+    "extensions",
+    [
+        # with FreeTextExtension
+        [
+            FieldsExtension(),
+            FilterExtension(),
+            FreeTextExtension(),
+            QueryExtension(),
+            SortExtension(),
+        ],
+        # with FreeTextAdvancedExtension
+        [
+            FieldsExtension(),
+            FilterExtension(),
+            FreeTextAdvancedExtension(),
+            QueryExtension(),
+            SortExtension(),
+        ],
+    ],
+)
+def test_from_extensions_methods(extensions):
+    """
+    Make sure `from_extensions` create the correct
+    models and adds desired conformances classes.
+    """
+    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, "fields")
+    assert hasattr(collection_search, "q")
+    assert hasattr(collection_search, "sortby")
+    assert hasattr(collection_search, "filter")
+    assert ext.conformance_classes == [
+        ConformanceClasses.COLLECTIONSEARCH,
+        ConformanceClasses.BASIS,
+        ConformanceClasses.FIELDS,
+        ConformanceClasses.FILTER,
+        ConformanceClasses.FREETEXT,
+        ConformanceClasses.QUERY,
+        ConformanceClasses.SORT,
+    ]
+
+    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, "fields")
+    assert hasattr(collection_search, "q")
+    assert hasattr(collection_search, "sortby")
+    assert hasattr(collection_search, "filter")
+    assert ext.conformance_classes == [
+        ConformanceClasses.COLLECTIONSEARCH,
+        ConformanceClasses.BASIS,
+        ConformanceClasses.FIELDS,
+        ConformanceClasses.FILTER,
+        ConformanceClasses.FREETEXT,
+        ConformanceClasses.QUERY,
+        ConformanceClasses.SORT,
+    ]
+
+
+def test_from_extensions_methods_invalid():
+    """Should raise warnings for invalid extensions."""
+    extensions = [
+        AggregationExtension(),
+    ]
+    with pytest.warns((UserWarning)):
+        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 ext.conformance_classes == [
+        ConformanceClasses.COLLECTIONSEARCH,
+        ConformanceClasses.BASIS,
+    ]
+
+    with pytest.warns((UserWarning)):
+        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 ext.conformance_classes == [
+        ConformanceClasses.COLLECTIONSEARCH,
+        ConformanceClasses.BASIS,
+    ]

stac_fastapi_extensions-3.0.0b3/stac_fastapi/extensions/core/context.py

@@ -1,46 +0,0 @@
-"""Context extension."""
-
-import warnings
-from typing import List, Optional
-
-import attr
-from fastapi import FastAPI
-
-from stac_fastapi.types.extension import ApiExtension
-
-
-@attr.s
-class ContextExtension(ApiExtension):
-    """Context Extension.
-
-    The Context extension adds a JSON object to ItemCollection responses (`/search`,
-    `/collections/{collection_id}/items`) which includes the number of items matched,
-    returned, and the limit requested.
-    https://github.com/stac-api-extensions/context
-    """
-
-    conformance_classes: List[str] = attr.ib(
-        factory=lambda: ["https://api.stacspec.org/v1.0.0-rc.2/item-search#context"]
-    )
-    schema_href: Optional[str] = attr.ib(
-        default="https://raw.githubusercontent.com/stac-api-extensions/context/v1.0.0-rc.2/json-schema/schema.json"
-    )
-
-    def __attrs_post_init__(self):
-        """init."""
-        warnings.warn(
-            "The ContextExtension is deprecated and will be removed in 3.0.",
-            DeprecationWarning,
-            stacklevel=1,
-        )
-
-    def register(self, app: FastAPI) -> None:
-        """Register the extension with a FastAPI application.
-
-        Args:
-            app: target FastAPI application.
-
-        Returns:
-            None
-        """
-        pass

stac_fastapi_extensions-3.0.0b3/stac_fastapi/extensions/version.py

@@ -1,2 +0,0 @@
-"""Library version."""
-__version__ = "3.0.0b3"