datetime.timedelta Support
#475
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These are encoded to ISO8601 duration strings. Only `'D'`, `'H'`, `'M'`, and `'S'` units are supported (no relative units like `Y` or `M` (month)).
If `strict=False` we also support decoding int/float values (or str representations of these values) to `timedelta` types. Note that a `double` cannot represent a timedelta with microsecond precision if the value is > ~270 years. For true roundtrip support we recommend serializing timedeltas as ISO 8601 strings.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds builtin timedelta support.
By default, we encode-to/decode-from a subset of ISO 8601 duration strings.
This subset matches the intersection between the one used by java's duration, and the proposed javascript
Temporal.Durationapi (docs here). Duration strings produced by msgspec should be compatible with either of these libraries (and most other ISO 8601 compatible systems). Likewise, durations produced by those libraries should be readable by msgspec. See the included docs update for a complete spec of what ISO8601 subset is supported.strict=False).We might want to also add a
timedelta_formatoption to the encoders so users can also encodetimedeltaobjects in this format as well. I'm less certain this is necessary. Adoublecan only represent a timedelta of ~270 years down to microsecond precision, deltas larger than this will start to lose precision when serialized as floats. Whether that matters is use case dependent.Fixes #260.