Ignore instead of forbid extra fields #89
Conversation
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
nesitor
approved these changes
Feb 1, 2024
|
I have doubts whether this is the best approach to take 🤔 In particular, using this on pyaleph would allow users to publish messages now that might not match a future format, so it would not be forward compatible in that case. |
|
This appears to me then a footgun for people not using the correct message format and/or trying weird things with the API. If this change means for us that we have an easier time upgrading the message spec, while avoiding breaking code of other users that upgrade their dependencies... Then I'd rather care to protect the latter group. A solid versioning scheme might help avoid this dilemma alltogether, in the future. But as you mentioned once, we don't want to go to extreme lengths regarding this topic, at least for now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
As the
Extra.forbidflag has been a footgun to us for a long time, with no apparent reason (see What is Extra? and Why use Extra.forbid?), we should from now on simply use the default,Extra.ignoreon our Pydantic models. This will allow forward-compatibility with newer message specs, but not impact existing functionality of old services using thealeph-messagepackage.