stac-fastapi.types 2.5.3__tar.gz → 2.5.5__tar.gz

{stac_fastapi_types-2.5.3 → stac_fastapi_types-2.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.types
-Version: 2.5.3
+Version: 2.5.5
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering

{stac_fastapi_types-2.5.3 → stac_fastapi_types-2.5.5}/stac_fastapi/types/core.py

@@ -109,10 +109,10 @@ class BaseTransactionsClient(abc.ABC):
     ) -> Optional[Union[stac_types.Collection, Response]]:
         """Perform a complete update on an existing collection.
 
-        Called with `PUT /collections/{collection_id}`. It is expected that this item
-        already exists.  The update should do a diff against the saved collection and
-        perform any necessary updates.  Partial updates are not supported by the
-        transactions extension.
+        Called with `PUT /collections/{collection_id}`. It is expected that this
+        collection already exists.  The update should do a diff against the saved
+        collection and perform any necessary updates.  Partial updates are not
+        supported by the transactions extension.
 
         Args:
             collection_id: id of the existing collection to be updated
@@ -404,9 +404,7 @@ class BaseCoreClient(LandingPageMixin, abc.ABC):
                 "rel": "service-desc",
                 "type": "application/vnd.oai.openapi+json;version=3.0",
                 "title": "OpenAPI service description",
-                "href": urljoin(
-                    str(request.base_url), request.app.openapi_url.lstrip("/")
-                ),
+                "href": str(request.url_for("openapi")),
             }
         )
 
@@ -416,9 +414,7 @@ class BaseCoreClient(LandingPageMixin, abc.ABC):
                 "rel": "service-doc",
                 "type": "text/html",
                 "title": "OpenAPI service documentation",
-                "href": urljoin(
-                    str(request.base_url), request.app.docs_url.lstrip("/")
-                ),
+                "href": str(request.url_for("swagger_ui_html")),
             }
         )
 

stac_fastapi_types-2.5.5/stac_fastapi/types/rfc3339.py

@@ -0,0 +1,126 @@
+"""rfc3339."""
+import re
+from datetime import datetime, timezone
+from typing import Optional, Tuple, Union
+
+import iso8601
+from fastapi import HTTPException
+from pystac.utils import datetime_to_str
+
+RFC33339_PATTERN = (
+    r"^(\d\d\d\d)\-(\d\d)\-(\d\d)(T|t)(\d\d):(\d\d):(\d\d)([.]\d+)?"
+    r"(Z|([-+])(\d\d):(\d\d))$"
+)
+
+DateTimeType = Union[
+    datetime,
+    Tuple[datetime, datetime],
+    Tuple[datetime, None],
+    Tuple[None, datetime],
+]
+
+
+def rfc3339_str_to_datetime(s: str) -> datetime:
+    """Convert a string conforming to RFC 3339 to a :class:`datetime.datetime`.
+
+    Uses :meth:`iso8601.parse_date` under the hood.
+
+    Args:
+        s (str) : The string to convert to :class:`datetime.datetime`.
+
+    Returns:
+        str: The datetime represented by the ISO8601 (RFC 3339) formatted string.
+
+    Raises:
+        ValueError: If the string is not a valid RFC 3339 string.
+    """
+    # Uppercase the string
+    s = s.upper()
+
+    # Match against RFC3339 regex.
+    result = re.match(RFC33339_PATTERN, s)
+    if not result:
+        raise ValueError("Invalid RFC3339 datetime.")
+
+    # Parse with pyiso8601
+    return iso8601.parse_date(s)
+
+
+def parse_single_date(date_str: str) -> datetime:
+    """
+    Parse a single RFC3339 date string into a datetime object.
+
+    Args:
+        date_str (str): A string representing the date in RFC3339 format.
+
+    Returns:
+        datetime: A datetime object parsed from the date_str.
+
+    Raises:
+        ValueError: If the date_str is empty or contains the placeholder '..'.
+    """
+    if ".." in date_str or not date_str:
+        raise ValueError("Invalid date format.")
+    return rfc3339_str_to_datetime(date_str)
+
+
+def str_to_interval(interval: Optional[str]) -> Optional[DateTimeType]:
+    """
+    Extract a tuple of datetime objects from an interval string defined by the OGC API.
+    The interval can either be a single datetime or a range with start and end datetime.
+
+    Args:
+        interval (Optional[str]): The interval string to convert to datetime objects,
+        or None if no datetime is specified.
+
+    Returns:
+        Optional[DateTimeType]: A tuple of datetime.datetime objects or
+        None if input is None.
+
+    Raises:
+        HTTPException: If the string is not valid for various reasons such as being empty,
+        having more than one slash, or if date formats are invalid.
+    """
+    if interval is None:
+        return None
+
+    if not interval:
+        raise HTTPException(status_code=400, detail="Empty interval string is invalid.")
+
+    values = interval.split("/")
+    if len(values) > 2:
+        raise HTTPException(
+            status_code=400,
+            detail="Interval string contains more than one forward slash.",
+        )
+
+    try:
+        start = parse_single_date(values[0]) if values[0] not in ["..", ""] else None
+        end = (
+            parse_single_date(values[1])
+            if len(values) > 1 and values[1] not in ["..", ""]
+            else None
+        )
+    except (ValueError, iso8601.ParseError) as e:
+        raise HTTPException(status_code=400, detail=str(e))
+
+    if start is None and end is None:
+        raise HTTPException(
+            status_code=400, detail="Double open-ended intervals are not allowed."
+        )
+    if start is not None and end is not None and start > end:
+        raise HTTPException(
+            status_code=400, detail="Start datetime cannot be before end datetime."
+        )
+
+    return start, end
+
+
+def now_in_utc() -> datetime:
+    """Return a datetime value of now with the UTC timezone applied."""
+    return datetime.now(timezone.utc)
+
+
+def now_to_rfc3339_str() -> str:
+    """Return an RFC 3339 string representing now."""
+    return datetime_to_str(now_in_utc())

{stac_fastapi_types-2.5.3 → stac_fastapi_types-2.5.5}/stac_fastapi/types/version.py

@@ -1,2 +1,2 @@
 """Library version."""
-__version__ = "2.5.3"
+__version__ = "2.5.5"

{stac_fastapi_types-2.5.3 → stac_fastapi_types-2.5.5}/stac_fastapi.types.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.types
-Version: 2.5.3
+Version: 2.5.5
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering

{stac_fastapi_types-2.5.3 → stac_fastapi_types-2.5.5}/tests/test_rfc3339.py

@@ -1,6 +1,7 @@
 from datetime import timezone
 
 import pytest
+from fastapi import HTTPException
 
 from stac_fastapi.types.rfc3339 import (
     now_in_utc,
@@ -86,8 +87,11 @@ def test_parse_valid_str_to_datetime(test_input):
 
 @pytest.mark.parametrize("test_input", invalid_intervals)
 def test_parse_invalid_interval_to_datetime(test_input):
-    with pytest.raises(ValueError):
+    with pytest.raises(HTTPException) as exc_info:
         str_to_interval(test_input)
+    assert (
+        exc_info.value.status_code == 400
+    ), "Should return a 400 status code for invalid intervals"
 
 
 @pytest.mark.parametrize("test_input", valid_intervals)

stac_fastapi_types-2.5.3/stac_fastapi/types/rfc3339.py

@@ -1,104 +0,0 @@
-"""rfc3339."""
-import re
-from datetime import datetime, timezone
-from typing import Optional, Tuple, Union
-
-import iso8601
-from pystac.utils import datetime_to_str
-
-RFC33339_PATTERN = (
-    r"^(\d\d\d\d)\-(\d\d)\-(\d\d)(T|t)(\d\d):(\d\d):(\d\d)([.]\d+)?"
-    r"(Z|([-+])(\d\d):(\d\d))$"
-)
-
-DateTimeType = Union[
-    datetime,
-    Tuple[datetime, datetime],
-    Tuple[datetime, None],
-    Tuple[None, datetime],
-]
-
-
-def rfc3339_str_to_datetime(s: str) -> datetime:
-    """Convert a string conforming to RFC 3339 to a :class:`datetime.datetime`.
-
-    Uses :meth:`iso8601.parse_date` under the hood.
-
-    Args:
-        s (str) : The string to convert to :class:`datetime.datetime`.
-
-    Returns:
-        str: The datetime represented by the ISO8601 (RFC 3339) formatted string.
-
-    Raises:
-        ValueError: If the string is not a valid RFC 3339 string.
-    """
-    # Uppercase the string
-    s = s.upper()
-
-    # Match against RFC3339 regex.
-    result = re.match(RFC33339_PATTERN, s)
-    if not result:
-        raise ValueError("Invalid RFC3339 datetime.")
-
-    # Parse with pyiso8601
-    return iso8601.parse_date(s)
-
-
-def str_to_interval(interval: Optional[str]) -> Optional[DateTimeType]:
-    """Extract a tuple of datetimes from an interval string.
-
-    Interval strings are defined by
-    OGC API - Features Part 1 for the datetime query parameter value. These follow the
-    form '1985-04-12T23:20:50.52Z/1986-04-12T23:20:50.52Z', and allow either the start
-    or end (but not both) to be open-ended with '..' or ''.
-
-    Args:
-        interval (str or None): The interval string to convert to a tuple of
-        datetime.datetime objects, or None if no datetime is specified.
-
-    Returns:
-        Optional[DateTimeType]: A tuple of datetime.datetime objects or None if
-        input is None.
-
-    Raises:
-        ValueError: If the string is not a valid interval string and not None.
-    """
-    if interval is None:
-        return None
-
-    if not interval:
-        raise ValueError("Empty interval string is invalid.")
-
-    values = interval.split("/")
-    if len(values) == 1:
-        # Single date for == date case
-        return rfc3339_str_to_datetime(values[0])
-    elif len(values) > 2:
-        raise ValueError(
-            f"Interval string '{interval}' contains more than one forward slash."
-        )
-
-    start = None
-    end = None
-    if values[0] not in ["..", ""]:
-        start = rfc3339_str_to_datetime(values[0])
-    if values[1] not in ["..", ""]:
-        end = rfc3339_str_to_datetime(values[1])
-
-    if start is None and end is None:
-        raise ValueError("Double open-ended intervals are not allowed.")
-    if start is not None and end is not None and start > end:
-        raise ValueError("Start datetime cannot be before end datetime.")
-    else:
-        return start, end
-
-
-def now_in_utc() -> datetime:
-    """Return a datetime value of now with the UTC timezone applied."""
-    return datetime.now(timezone.utc)
-
-
-def now_to_rfc3339_str() -> str:
-    """Return an RFC 3339 string representing now."""
-    return datetime_to_str(now_in_utc())