Fix the order of fields in Protobuf #530
Merged
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
Previously, we relied on the order of ``set`` for the fields in Protobuf. This is dangerous as the order of ``set`` is not well-defined across different Python versions and implementations. To avoid potential bugs in the future, we fix the fields to correspond with the order of properties in the class. Note that this solution is also not completely future proof. If you add properties in the middle of a class, the field IDs in protocol buffers will change causing incompatibility between the two Protocol Buffer definitions.
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.
Previously, we relied on the order of
setfor the fields in Protobuf. This is dangerous as the order ofsetis not well-defined across different Python versions and implementations.To avoid potential bugs in the future, we fix the fields to correspond with the order of properties in the class.
Note that this solution is also not completely future proof. If you add properties in the middle of a class, the field IDs in protocol buffers will change causing incompatibility between the two Protocol Buffer definitions.