Skip to content

fix(jsonapi_serializer): allow date, datetime and time for both of theses types #329

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

Merged
jbarreau merged 3 commits into from
Apr 30, 2025
Merged

fix(jsonapi_serializer): allow date, datetime and time for both of theses types #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9d9bea3
fix(jsonapi_seralizer): allow date datetime and time as same data
jbarreau Apr 28, 2025
d4569c9
chore: add tests
jbarreau Apr 28, 2025
3d48bb6
chore: fix linting
jbarreau Apr 28, 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
10 changes: 6 additions & 4 deletions src/agent_toolkit/forestadmin/agent_toolkit/services/serializers/json_api_serializer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
from ast import literal_eval
from datetime import date, datetime, time
from typing import Any, Callable, Dict, List, Optional, Tuple, Union, cast
from urllib.parse import quote
from uuid import uuid4
Expand Down Expand Up @@ -134,15 +133,18 @@ def number_dump(val):
elif isinstance(val, str):
return literal_eval(str(value))

def date_types_dump(val):
return val if isinstance(val, str) else val.isoformat()

parser_map: Dict[PrimitiveType, Callable] = {
PrimitiveType.STRING: str,
PrimitiveType.ENUM: str,
PrimitiveType.BOOLEAN: bool,
PrimitiveType.NUMBER: number_dump,
PrimitiveType.UUID: str,
PrimitiveType.DATE_ONLY: lambda v: v if isinstance(v, str) else date.isoformat(v),
PrimitiveType.TIME_ONLY: lambda v: v if isinstance(v, str) else time.isoformat(v),
PrimitiveType.DATE: lambda v: v if isinstance(v, str) else datetime.isoformat(v),
PrimitiveType.DATE_ONLY: date_types_dump,
PrimitiveType.TIME_ONLY: date_types_dump,
PrimitiveType.DATE: date_types_dump,
PrimitiveType.POINT: lambda v: v,
PrimitiveType.BINARY: lambda v: v, # should not be called, because of binary decorator this type
# is transformed to string
Expand Down
135 changes: 135 additions & 0 deletions src/agent_toolkit/tests/services/serializers/test_jsonapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1353,3 +1353,138 @@ def test_string_foreign_keys_should_be_url_encoded_so_foreign_pk(self):
],
},
)

def test_datetime_should_also_serialize_dates_and_times(self):
serializer = JsonApiSerializer(self.datasource, Projection("all_types_pk", "datetime"))
record = {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"datetime": date(2023, 10, 10),
}
# date
dumped = serializer.serialize(record, self.collection_all_types)
self.assertEqual(
dumped,
{
"data": {
"type": "AllTypes",
"id": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"attributes": {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"datetime": "2023-10-10",
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
)
# time
record = {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"datetime": time(12, 12, 12),
}
dumped = serializer.serialize(record, self.collection_all_types)
self.assertEqual(
dumped,
{
"data": {
"type": "AllTypes",
"id": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"attributes": {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"datetime": "12:12:12",
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
)

def test_date_should_also_serialize_datetimes_and_times(self):
serializer = JsonApiSerializer(self.datasource, Projection("all_types_pk", "dateonly"))
record = {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"dateonly": datetime(2023, 10, 10, 12, 12, 12),
}
# datetime
dumped = serializer.serialize(record, self.collection_all_types)
self.assertEqual(
dumped,
{
"data": {
"type": "AllTypes",
"id": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"attributes": {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"dateonly": "2023-10-10T12:12:12",
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
)
# time
record = {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"dateonly": time(12, 12, 12),
}
dumped = serializer.serialize(record, self.collection_all_types)
self.assertEqual(
dumped,
{
"data": {
"type": "AllTypes",
"id": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"attributes": {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"dateonly": "12:12:12",
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
)

def test_time_only_should_also_serialize_dates_and_datetimes(self):
serializer = JsonApiSerializer(self.datasource, Projection("all_types_pk", "time_only"))
record = {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"time_only": datetime(2023, 10, 10, 12, 12, 12),
}
# datetime
dumped = serializer.serialize(record, self.collection_all_types)
self.assertEqual(
dumped,
{
"data": {
"type": "AllTypes",
"id": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"attributes": {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"time_only": "2023-10-10T12:12:12",
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
)
# date
record = {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"time_only": date(2023, 10, 10),
}
dumped = serializer.serialize(record, self.collection_all_types)
self.assertEqual(
dumped,
{
"data": {
"type": "AllTypes",
"id": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"attributes": {
"all_types_pk": "c578ccd6-3dd0-4315-87f3-e200d80dd6f9",
"time_only": "2023-10-10",
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
"links": {"self": "/forest/AllTypes/c578ccd6-3dd0-4315-87f3-e200d80dd6f9"},
},
)