Add msgspec.to_builtins method - #258
Merged
Merged
Conversation
This adds a new `msgspec.to_builtins` function, for transforming objects composed of all the types `msgspec` supports to objects composed only of types standard python serializers support (`list`, `tuple`, `int`, `str`, ...). While this method *may* be useful directly to users, the primary intended use is for wrapping it with additional serialization APIs within `msgspec` itself (for example, a new `msgspec.yaml` module). While JSON may require high-performance and a builtin encoder, config-files like YAML, TOML, ... usually aren't performance sensitive, so the extra copies here shouldn't matter. Once this is in, we'll follow up with a `msgspec.from_builtins` for handling the "decoding" side of things.
Rather than roundtripping extra config through JSON, we can do the conversion from rich types -> builtin types directly.
msgspec.to_builtins methodmsgspec.to_builtins method
Member
Author
|
Example of usage: In [1]: import msgspec
In [2]: class User(msgspec.Struct):
...: name: str
...: groups: set[str] = set()
...: email: str | None = None
...:
In [3]: alice = User("alice", groups={"admin", "engineering"}, email="alice@company.com")
In [4]: alice
Out[4]: User(name='alice', groups={'engineering', 'admin'}, email='alice@company.com')
In [5]: msg = msgspec.to_builtins(alice) # convert to simple types
In [6]: msg
Out[6]:
{'name': 'alice',
'groups': ['engineering', 'admin'],
'email': 'alice@company.com'}
In [7]: import yaml
In [8]: print(yaml.safe_dump(msg, sort_keys=False)) # can pass to downstream libraries
name: alice
groups:
- engineering
- admin
email: alice@company.comLike I said above, ideally most users won't ever need to directly access this API - we should instead use it to wrap common downstream libraries ( |
This was referenced Jan 10, 2023
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.
This adds a new
msgspec.to_builtinsfunction, for transforming objects composed of all the typesmsgspecsupports to objects composed only of types standard python serializers support (list,tuple,int,str, ...).While this method may be useful directly to users, the primary intended use is for wrapping it with additional serialization APIs within
msgspecitself (for example, a newmsgspec.yamlmodule). While JSON may require high-performance and a builtin encoder, config-files like YAML, TOML, ... usually aren't perforamnce sensitive, so the extra copies here shouldn't matter.Once this is in, we'll follow up with a
msgspec.from_builtinsfor handling the "decoding" side of things.