Cover conversion to/from builtins in usage docs#780
Open
ncoghlan wants to merge 3 commits into
Open
Conversation
Also clarify differences between `to_builtins` and `asdict`. Closes msgspec#778
Author
|
Likely worth linking to https://github.com/jcrist/msgspec/blob/main/docs/source/converters.rst from the new subsection, since that goes into more detail on how |
Siyet
added a commit
that referenced
this pull request
May 26, 2026
…1025) Add a usage docs section explaining that to_builtins is the encoding half (respects omit_defaults, UNSET, recurses into nested struct-like types, applies value-level conversions) while structs.asdict/astuple perform a one-to-one conversion following the dataclasses.asdict/astuple contract. Cross-reference the new section from the omit_defaults and UNSET sections, and update the C docstrings for asdict, astuple, and to_builtins. Fixes #778. Supersedes #780.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Also clarify differences between
to_builtinsandasdict.Closes #778