Skip to content

🐛 fix: serialize Pendulum zero Duration as valid ISO 8601 'P0D' #320

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

Merged
merged 3 commits into from
May 19, 2025
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
3 changes: 3 additions & 0 deletions pydantic_extra_types/pendulum_dt.py
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,9 @@ def to_iso8601_string(self) -> str:
if self.total_seconds() < 0:
iso_duration = '-' + iso_duration

if iso_duration == 'P':
iso_duration = 'P0D'

return iso_duration

@classmethod
Expand Down
32 changes: 32 additions & 0 deletions tests/test_pendulum_dt.py
Original file line number Diff line number Diff line change
Expand Up @@ -414,3 +414,35 @@ def test_pendulum_duration_months_are_preserved():
m = DurationModel(delta_t=pendulum.Duration(months=1))

assert m.delta_t.months == 1


@pytest.mark.parametrize(
'zero_duration',
[
Duration(),
Duration(years=0, months=0, days=0, hours=0, minutes=0, seconds=0),
Duration(0),
pendulum.duration(),
],
)
def test_zero_duration_serialization_and_validation(zero_duration):
"""Zero durations should serialize as 'P0D' and round-trip without error."""
model = DurationModel(delta_t=zero_duration)
json_dump = model.model_dump_json()
assert json_dump == '{"delta_t":"P0D"}'
loaded = DurationModel.model_validate_json(json_dump)
assert loaded.delta_t == zero_duration
assert isinstance(loaded.delta_t, Duration)


def test_zero_duration_from_string():
"""'P0D' string should be accepted and produce a zero Duration."""
model = DurationModel(delta_t='P0D')
assert model.delta_t == Duration()
assert isinstance(model.delta_t, Duration)


def test_invalid_zero_duration_string():
"""'P' is not a valid ISO 8601 duration and should raise a validation error."""
with pytest.raises(ValidationError):
DurationModel(delta_t='P')