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 serialization with timezone to AwareDateTime #1676

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
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
10 changes: 10 additions & 0 deletions src/marshmallow/fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -1284,6 +1284,8 @@ class AwareDateTime(DateTime):
:param default_timezone: Used on deserialization. If `None`, naive
datetimes are rejected. If not `None`, naive datetimes are set this
timezone.
:param bool use_serialization: If `True`, naive datetimes are set to
`default_timezone` on serialization. If `False`, datetimes are not changed.
:param kwargs: The same keyword arguments that :class:`Field` receives.

.. versionadded:: 3.0.0rc9
Expand All @@ -1296,10 +1298,12 @@ def __init__(
format: typing.Optional[str] = None,
*,
default_timezone: typing.Optional[dt.tzinfo] = None,
use_serialization: bool = False,
**kwargs
):
super().__init__(format=format, **kwargs)
self.default_timezone = default_timezone
self.use_serialization = use_serialization

def _deserialize(self, value, attr, data, **kwargs):
ret = super()._deserialize(value, attr, data, **kwargs)
Expand All @@ -1313,6 +1317,12 @@ def _deserialize(self, value, attr, data, **kwargs):
ret = ret.replace(tzinfo=self.default_timezone)
return ret

def _serialize(self, value, attr, obj, **kwargs):
if self.use_serialization:
if value is not None and not is_aware(value):
value = value.replace(tzinfo=self.default_timezone)
return super()._serialize(value, attr, obj, **kwargs)


class Time(Field):
"""ISO8601-formatted time string.
Expand Down
20 changes: 20 additions & 0 deletions tests/test_serialization.py
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,26 @@ def test_datetime_field_format(self, user):
field = fields.DateTime(format=format)
assert field.serialize("created", user) == user.created.strftime(format)

@pytest.mark.parametrize(
("timezone", "value", "expected"),
[
(None, dt.datetime(2013, 11, 10, 1, 23, 45), "2013-11-10T01:23:45"),
(
dt.timezone.utc,
dt.datetime(2013, 11, 10, 1, 23, 45),
"2013-11-10T01:23:45+00:00",
),
(
dt.timezone(offset=dt.timedelta(hours=3)),
dt.datetime(2013, 11, 10, 1, 23, 45),
"2013-11-10T01:23:45+03:00",
),
],
)
def test_aware_datetime_use_serialization(self, timezone, value, expected):
field = fields.AwareDateTime(default_timezone=timezone, use_serialization=True)
assert field.serialize("d", {"d": value}) == expected

def test_string_field(self):
field = fields.String()
user = User(name=b"foo")
Expand Down