Skip to content

99 datetimeinterval RFC 3339 #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
pro-phil wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

99 datetimeinterval RFC 3339 #100

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
bf76aad
add cli with 5 commands: product, products, order, orders, opportunities
pro-phil Apr 3, 2025
bfdd154
Merge branch 'main' into main
pro-phil Apr 3, 2025
11b9fc6
Merge branch 'main' into main
pro-phil Apr 16, 2025
d44efe0
simpler json output, send errors to err
pro-phil Apr 16, 2025
a2dbc44
reformat for linter
pro-phil Apr 16, 2025
02255ad
Merge branch 'main' of github.com:phil-osk/pystapi
pro-phil Apr 17, 2025
8481b6c
remove types-click from parent pyproject.toml
pro-phil Apr 18, 2025
d46641e
Merge branch 'stapi-spec:main' into remove-types-click
pro-phil Apr 18, 2025
3b2d167
make DatetimeInterval RFC 3339 compliant
pro-phil Apr 18, 2025
9c212cb
Merge branch 'stapi-spec:main' into 99-datetimeinterval-pydantic-model
pro-phil Apr 23, 2025
a97129d
add a couple more tests to datetime interval; synch pytest versions
pro-phil Apr 23, 2025
7d245a2
reformat
pro-phil Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions stapi-pydantic/src/stapi_pydantic/datetime_interval.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,37 @@
WrapSerializer,
)

_DatetimeTuple = tuple[datetime | None, datetime | None]

def validate_before(
value: str | tuple[datetime, datetime],
) -> tuple[datetime, datetime]:

def validate_before(value: str | _DatetimeTuple) -> _DatetimeTuple:
if isinstance(value, str):
start, end = value.split("/", 1)
return (datetime.fromisoformat(start), datetime.fromisoformat(end))
start_str, end_str = value.split("/", 1)
start = None if start_str == ".." else datetime.fromisoformat(start_str)
end = None if end_str == ".." else datetime.fromisoformat(end_str)
value = (start, end)
Copy link
Copy Markdown
Contributor

@philvarner philvarner Apr 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: one of the intervals has to closed, e.g., ../.. and / are not allowed. The code from stac-server (that I believe to be correct) is:

if (datetime) {
    const datetimeUpperCase = datetime.toUpperCase()
    const [start, end, ...rest] = datetimeUpperCase.split('/')
    if (rest.length) {
      throw new ValidationError(
        'datetime value is invalid, too many forward slashes for an interval'
      )
    } else if ((!start && !end)
        || (start === '..' && end === '..')
        || (!start && end === '..')
        || (start === '..' && !end)
    ) {
      throw new ValidationError(
        'datetime value is invalid, at least one end of the interval must be closed'
      )
    } else {
      const startDateTime = (start && start !== '..') ? rfc3339ToDateTime(start) : undefined
      const endDateTime = (end && end !== '..') ? rfc3339ToDateTime(end) : undefined
      validateStartAndEndDatetimes(startDateTime, endDateTime)
    }
    return datetimeUpperCase
  }

return value


def validate_after(value: tuple[datetime, datetime]) -> tuple[datetime, datetime]:
if value[1] < value[0]:
def validate_after(value: _DatetimeTuple) -> _DatetimeTuple:
# None/date & date/None are always valid
if value[1] and value[0] and value[1] < value[0]:
raise ValueError("end before start")
return value


def serialize(
value: tuple[datetime, datetime],
serializer: Callable[[tuple[datetime, datetime]], tuple[str, str]],
value: _DatetimeTuple,
serializer: Callable[[_DatetimeTuple], tuple[str, str]],
) -> str:
del serializer # unused
return f"{value[0].isoformat()}/{value[1].isoformat()}"
start = value[0].isoformat() if value[0] else ".."
end = value[1].isoformat() if value[1] else ".."
return f"{start}/{end}"


DatetimeInterval = Annotated[
tuple[AwareDatetime, AwareDatetime],
tuple[AwareDatetime | None, AwareDatetime | None],
BeforeValidator(validate_before),
AfterValidator(validate_after),
WrapSerializer(serialize, return_type=str),
Expand Down
11 changes: 11 additions & 0 deletions stapi-pydantic/tests/test_datetime_interval.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
from stapi_pydantic import DatetimeInterval


def test_datetime_interval() -> None:
"""Test the datetime interval validator."""
dt1 = DatetimeInterval.__metadata__[0].func("2025-04-01T00:00:00Z/2025-04-01T23:59:59Z")
dt2 = DatetimeInterval.__metadata__[0].func("2025-04-01T00:00:00Z/..")
dt3 = DatetimeInterval.__metadata__[0].func("../2025-04-01T23:59:59Z")
Copy link
Copy Markdown
Member

@jkeifer jkeifer Apr 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like your code would support this, but I would also explicitly test the case of ../.., which I believe should also be valid.

Copy link
Copy Markdown
Contributor Author

@pro-phil pro-phil Apr 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll add.

Copy link
Copy Markdown
Contributor Author

@pro-phil pro-phil Apr 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added. Also, added unit test for end before start.

_ = DatetimeInterval.__metadata__[1].func(dt1)
_ = DatetimeInterval.__metadata__[1].func(dt2)
_ = DatetimeInterval.__metadata__[1].func(dt3)