Add attributes option to from_builtins - #419
Merged
Merged
Conversation
This adds a new `attributes` option to `from_builtins`. If enabled, arbitrary objects may be coerced to `Struct`/`dataclasses`/`attrs` types by extracting attributes from the input object matching fields in the output type. One use case is converting database query results (ORM or otherwise) to msgspec structured types.
Member
Author
|
A quick example: import msgspec
class User(msgspec.Struct):
name: str
groups: list[str] = []
email: str | None = None
class UserORM:
"""An example ORM-like input object"""
def __init__(self, name, groups):
self.name = name
self.groups = groups
# No `email` present on ORM object, default will be used when converting
data = [UserORM("alice", ["admin"]), UserORM("ben", [])]
converted = msgspec.from_builtins(data, list[User], attributes=True)
print(converted)
#> [User(name='alice', groups=['admin'], email=None), User(name='ben', groups=[], email=None)] |
|
I've been playing with this a little and it's been working well for every case I've tried. |
Member
Author
|
Glad to hear it! |
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
2 participants
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
attributesoption tofrom_builtins. If enabled, arbitrary objects may be coerced toStruct/dataclasses/attrstypes by extracting attributes from the input object matching fields in the output type. One use case is converting database query results (ORM or otherwise) to msgspec structured types.Fixes #416.