Skip to content
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.

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

Add missing Dataset field serializers #384

Merged
merged 4 commits into from
Jul 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 13 additions & 1 deletion python/lib/core/dmod/core/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,19 @@ class Config:
# TODO: in future deprecate setting properties unless through a setter method
validate_assignment = True
arbitrary_types_allowed = True
field_serializers = {"uuid": lambda f: str(f)}

def _serialize_datetime(self: "Dataset", value: Optional[datetime]) -> Optional[str]:
if isinstance(value, datetime):
return value.strftime(self._SERIAL_DATETIME_STR_FORMAT)
return value

field_serializers = {
"uuid": lambda f: None if f is None else str(f),
"manager_uuid": lambda f: None if f is None else str(f),
"expires": _serialize_datetime,
"created_on": _serialize_datetime,
"last_updated": _serialize_datetime,
}

def __hash__(self):
members = [
Expand Down
39 changes: 35 additions & 4 deletions python/lib/core/dmod/test/test_dataset.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import unittest
from uuid import uuid4
from ..core.dataset import Dataset, DatasetType
from ..core.meta_data import DataCategory, DataDomain, DataFormat, DiscreteRestriction, TimeRange
from ..core.meta_data import DataCategory, DataDomain, DataFormat, DiscreteRestriction, TimeRange, StandardDatasetIndex
from datetime import datetime, timedelta
from typing import Optional, Union


class TestDataset(unittest.TestCase):

@classmethod
def generate_testing_time_range(cls, begin: Union[str, datetime], length: Optional[timedelta] = None,
pattern: Optional[str] = None) -> TimeRange:
Expand Down Expand Up @@ -67,7 +67,7 @@ def setUp(self) -> None:
"uuid": str(self.example_datasets[i].uuid),
"access_location": 'location_{}'.format(i),
"is_read_only": False,
"created_on": self._created_on, # NOTE: breaking change
"created_on": datetime.strftime(self._created_on, Dataset._SERIAL_DATETIME_STR_FORMAT),
})

def test_factory_init_from_deserialized_json_0_a(self):
Expand Down Expand Up @@ -114,4 +114,35 @@ def test_to_dict_1_a(self):

self.assertEqual(expected_data_dict, data_dict)


def test_fixes_377(self):
"""Verify fields with field_serializers are serialized to correct type."""

some_id = uuid4()
now = datetime.now()
m = Dataset(
name="fix-377",
data_category=DataCategory.CONFIG,
data_domain=DataDomain(
data_format=DataFormat.BMI_CONFIG,
discrete=[
DiscreteRestriction(
variable=StandardDatasetIndex.DATA_ID, values=["42"]
)
],
),
access_location="test_fixes_377",
uuid=some_id,
is_read_only=True,
created_on=now,
expires=now,
last_updated=now,
dataset_type=DatasetType.OBJECT_STORE,
manager_uuid=some_id,
)
serialized = m.dict()

self.assertTrue(isinstance(serialized["uuid"], str))
self.assertTrue(isinstance(serialized["manager_uuid"], str))
self.assertTrue(isinstance(serialized["created_on"], str))
self.assertTrue(isinstance(serialized["expires"], str))
self.assertTrue(isinstance(serialized["last_updated"], str))