fix: properly serialize pydantic models #1757
Merged
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.
Describe your changes
Problem:
Pydantic models are not being handled by our serialization process. This results in events that look like this:
Solution:
Introduce a
ModelArtifact
that is used exclusively for wrapping Pydantic models. This should be a non-breaking change since it subclassesGenericArtifact
. There are hacks we could use for getting information out ofGenericArtifact
, but they are hacky and would require non-trivial refactors to implement.During serialization, detect instances of
BaseModel
s and serialize them using a custom marshmallow field,fields.Model
. Deserialization for this field has not been implemented at this time as it would require us to somehow store the Pydantic model with the field. I don't think users will run into this during regular usage, but the workaround would be to manually deserialize the Pydantic model outside griptape.Serialized events now look like:
Issue ticket number and link
Closes #1756
YASW (yet another serialization woe): #1587