[Feature] Include _data in Event serialization by default.
#16841
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
dosubot
bot
added
the
size:M
nerdai
commented
Nov 5, 2024
| @@ -68,7 +74,8 @@ def __init__(self, **params: Any): | |||
| super().__init__(**fields) | |||
| for private_attr, value in private_attrs.items(): | |||
| super().__setattr__(private_attr, value) | |||
| self._data = data | |||
| if data: | |||
There was a problem hiding this comment.
Note: the super().__init__(...) call sets the PrivateAttr _data since we defined it's default_factory.
nerdai
force-pushed
the
nerdai/include-event-data-in-serialization
branch
from
8f7fde9 to
45af7da
Compare
nerdai
commented
Nov 5, 2024
| deseriazlied_ev, | ||
| ) | ||
| assert ev.param == deseriazlied_ev.param | ||
| assert ev._data == deseriazlied_ev._data |
There was a problem hiding this comment.
This last assertion fails without the custom additions to Event.model_dump() in this PR.
masci
approved these changes
Nov 6, 2024
logan-markewich
deleted the
nerdai/include-event-data-in-serialization
branch
YouNeedCryDear
pushed a commit
to raveharpaz/llama_index
that referenced
this pull request
Nov 8, 2024
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.
Description
With our
Eventabstraction, we can store data inFields,PrivateAttras well as_data. Specifically, a user can subclassEventto define their own customFields, andPrivateAttr. And,_dataacts like an underlyingdictas well:FieldorPrivateAttrof theEventgets added to_data._datavia a dictionary-like interface as well as via dot notationThis is kind of is against Pydantic
BaseModelconvention in thatPrivateAttr's start with an underscore "_" and are known to not be included in the model serialization. So, should we include_databy defaul in model serialization?Type of Change
Please delete options that are not relevant.
How Has This Been Tested?
Your pull-request will likely not be merged unless it is covered by some form of impactful unit testing.