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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.extensions
-Version: 3.0.2
+Version: 3.0.4
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -15,6 +15,7 @@ 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
 Description-Content-Type: text/markdown

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

@@ -38,6 +38,7 @@ setup(
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
         "License :: OSI Approved :: MIT License",
     ],
     keywords="STAC FastAPI COG",

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

@@ -5,7 +5,11 @@ from .collection_search import CollectionSearchExtension, CollectionSearchPostEx
 from .fields import FieldsExtension
 from .filter import FilterExtension
 from .free_text import FreeTextAdvancedExtension, FreeTextExtension
-from .pagination import PaginationExtension, TokenPaginationExtension
+from .pagination import (
+    OffsetPaginationExtension,
+    PaginationExtension,
+    TokenPaginationExtension,
+)
 from .query import QueryExtension
 from .sort import SortExtension
 from .transaction import TransactionExtension
@@ -16,6 +20,7 @@ __all__ = (
     "FilterExtension",
     "FreeTextExtension",
     "FreeTextAdvancedExtension",
+    "OffsetPaginationExtension",
     "PaginationExtension",
     "QueryExtension",
     "SortExtension",

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

@@ -70,7 +70,7 @@ class FilterExtensionPostRequest(BaseModel):
         default=None,
         description="The coordinate reference system (CRS) used by spatial literals in the 'filter' value. Default is `http://www.opengis.net/def/crs/OGC/1.3/CRS84`",  # noqa: E501
     )
-    filter_lang: Optional[FilterLang] = Field(
+    filter_lang: Optional[Literal["cql-json", "cql2-json"]] = Field(
         alias="filter-lang",
         default="cql2-json",
         description="The CQL filter encoding that the 'filter' value uses.",

stac_fastapi_extensions-3.0.4/stac_fastapi/extensions/core/pagination/__init__.py

@@ -0,0 +1,7 @@
+"""Pagination classes as extensions."""
+
+from .offset_pagination import OffsetPaginationExtension
+from .pagination import PaginationExtension
+from .token_pagination import TokenPaginationExtension
+
+__all__ = ["OffsetPaginationExtension", "PaginationExtension", "TokenPaginationExtension"]

stac_fastapi_extensions-3.0.4/stac_fastapi/extensions/core/pagination/offset_pagination.py

@@ -0,0 +1,38 @@
+"""Pagination API extension."""
+
+from typing import List, Optional
+
+import attr
+from fastapi import FastAPI
+
+from stac_fastapi.types.extension import ApiExtension
+
+from .request import GETOffsetPagination, POSTOffsetPagination
+
+
+@attr.s
+class OffsetPaginationExtension(ApiExtension):
+    """Offset Pagination.
+
+    Though not strictly an extension, the chosen pagination will modify the form of the
+    request object. By making pagination an extension class, we can use
+    create_request_model to dynamically add the correct pagination parameter to the
+    request model for OpenAPI generation.
+    """
+
+    GET = GETOffsetPagination
+    POST = POSTOffsetPagination
+
+    conformance_classes: List[str] = attr.ib(factory=list)
+    schema_href: Optional[str] = attr.ib(default=None)
+
+    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.2 → stac_fastapi_extensions-3.0.4}/stac_fastapi/extensions/core/pagination/request.py

@@ -34,3 +34,16 @@ class POSTPagination(BaseModel):
     """Page based pagination for POST requests."""
 
     page: Optional[str] = None
+
+
+@attr.s
+class GETOffsetPagination(APIRequest):
+    """Offset pagination for GET requests."""
+
+    offset: Annotated[Optional[int], Query()] = attr.ib(default=None)
+
+
+class POSTOffsetPagination(BaseModel):
+    """Offset pagination model for POST requests."""
+
+    offset: Optional[int] = None

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.extensions
-Version: 3.0.2
+Version: 3.0.4
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -15,6 +15,7 @@ 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
 Description-Content-Type: text/markdown

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

@@ -31,6 +31,7 @@ stac_fastapi/extensions/core/free_text/__init__.py
 stac_fastapi/extensions/core/free_text/free_text.py
 stac_fastapi/extensions/core/free_text/request.py
 stac_fastapi/extensions/core/pagination/__init__.py
+stac_fastapi/extensions/core/pagination/offset_pagination.py
 stac_fastapi/extensions/core/pagination/pagination.py
 stac_fastapi/extensions/core/pagination/request.py
 stac_fastapi/extensions/core/pagination/token_pagination.py
@@ -46,5 +47,6 @@ tests/test_aggregation.py
 tests/test_collection_search.py
 tests/test_filter.py
 tests/test_free_text.py
+tests/test_pagination.py
 tests/test_query.py
 tests/test_transaction.py

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

@@ -62,12 +62,12 @@ def test_search_filter_post_filter_lang_default(client: TestClient):
 
 def test_search_filter_post_filter_lang_non_default(client: TestClient):
     """Test search POST endpoint with filter ext."""
-    filter_lang_value = "cql2-text"
+    filter_lang_value = "cql-json"
     response = client.post(
         "/search",
         json={
             "collections": ["test"],
-            "filter": {"op": "=", "args": [{"property": "test_property"}, "test-value"]},
+            "filter": {"eq": [{"property": "test_property"}, "test-value"]},
             "filter-lang": filter_lang_value,
         },
     )

stac_fastapi_extensions-3.0.4/tests/test_pagination.py

@@ -0,0 +1,132 @@
+from typing import Iterator
+
+import pytest
+from starlette.testclient import TestClient
+
+from stac_fastapi.api.app import StacApi
+from stac_fastapi.api.models import (
+    EmptyRequest,
+    create_post_request_model,
+    create_request_model,
+)
+from stac_fastapi.extensions.core import (
+    OffsetPaginationExtension,
+    PaginationExtension,
+    TokenPaginationExtension,
+)
+from stac_fastapi.types.config import ApiSettings
+from stac_fastapi.types.core import BaseCoreClient
+from stac_fastapi.types.search import BaseSearchGetRequest
+
+
+class DummyCoreClient(BaseCoreClient):
+    def all_collections(self, *args, **kwargs):
+        _ = kwargs.pop("request", None)
+        return args, kwargs
+
+    def get_collection(self, *args, **kwargs):
+        _ = kwargs.pop("request", None)
+        return args, kwargs
+
+    def get_item(self, *args, **kwargs):
+        _ = kwargs.pop("request", None)
+        return args, kwargs
+
+    def get_search(self, *args, **kwargs):
+        _ = kwargs.pop("request", None)
+        return args, kwargs
+
+    def post_search(self, *args, **kwargs):
+        _ = kwargs.pop("request", None)
+        return args[0].model_dump(), kwargs
+
+    def item_collection(self, *args, **kwargs):
+        _ = kwargs.pop("request", None)
+        return args, kwargs
+
+
+collections_get_request_model = create_request_model(
+    model_name="CollectionsGetRequest",
+    base_model=EmptyRequest,
+    mixins=[
+        OffsetPaginationExtension().GET,
+    ],
+    request_type="GET",
+)
+
+items_get_request_model = create_request_model(
+    model_name="ItemsGetRequest",
+    base_model=EmptyRequest,
+    mixins=[
+        PaginationExtension().GET,
+    ],
+    request_type="GET",
+)
+
+search_get_request_model = create_request_model(
+    model_name="SearchGetRequest",
+    base_model=BaseSearchGetRequest,
+    mixins=[
+        TokenPaginationExtension().GET,
+    ],
+    request_type="GET",
+)
+
+
+@pytest.fixture
+def client() -> Iterator[TestClient]:
+    settings = ApiSettings()
+
+    api = StacApi(
+        settings=settings,
+        client=DummyCoreClient(),
+        extensions=[],
+        collections_get_request_model=collections_get_request_model,
+        items_get_request_model=items_get_request_model,
+        search_get_request_model=search_get_request_model,
+        search_post_request_model=create_post_request_model([]),
+    )
+    with TestClient(api.app) as client:
+        yield client
+
+
+def test_pagination_extension(client: TestClient):
+    """Test endpoints with pagination extensions."""
+    # OffsetPaginationExtension
+    response = client.get("/collections")
+    assert response.is_success, response.json()
+    arg, kwargs = response.json()
+    assert "offset" in kwargs
+    assert kwargs["offset"] is None
+
+    response = client.get("/collections", params={"offset": 1})
+    assert response.is_success, response.json()
+    arg, kwargs = response.json()
+    assert "offset" in kwargs
+    assert kwargs["offset"] == 1
+
+    # PaginationExtension
+    response = client.get("/collections/a_collection/items")
+    assert response.is_success, response.json()
+    arg, kwargs = response.json()
+    assert "page" in kwargs
+    assert kwargs["page"] is None
+
+    response = client.get("/collections/a_collection/items", params={"page": "1"})
+    assert response.is_success, response.json()
+    arg, kwargs = response.json()
+    assert "page" in kwargs
+    assert kwargs["page"] == "1"
+
+    # TokenPaginationExtension
+    response = client.get("/search")
+    assert response.is_success, response.json()
+    arg, kwargs = response.json()
+    assert "token" in kwargs
+    assert kwargs["token"] is None
+
+    response = client.get("/search", params={"token": "atoken"})
+    assert response.is_success, response.json()
+    arg, kwargs = response.json()
+    assert "token" in kwargs
+    assert kwargs["token"] == "atoken"

stac_fastapi_extensions-3.0.2/stac_fastapi/extensions/core/pagination/__init__.py

@@ -1,6 +0,0 @@
-"""Pagination classes as extensions."""
-
-from .pagination import PaginationExtension
-from .token_pagination import TokenPaginationExtension
-
-__all__ = ["PaginationExtension", "TokenPaginationExtension"]