Improve enums and add a generic enum_from_proto()
#82
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
Signed-off-by: Leandro Lucarella <[email protected]>
github-actions
bot
added
part:tests
There was a problem hiding this comment.
Pull Request Overview
This PR improves enum handling by introducing a generic enum_from_proto function and making various enums unique, while deprecating their old from_proto methods.
- Introduces a generic enum_from_proto utility for converting protobuf enum values.
- Applies the @enum.unique decorator to enums and deprecates the from_proto methods.
- Adds missing component categories and updates Metric enum accordingly.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| tests/test_enum_proto.py | Adds tests for the new enum_from_proto utility |
| src/frequenz/client/common/microgrid/components/init.py | Updates enums with @enum.unique and adds new component categories; deprecates from_proto |
| src/frequenz/client/common/metric/init.py | Updates Metric enum with unique and deprecates from_proto method |
| src/frequenz/client/common/enum_proto.py | Introduces the generic enum_from_proto utility and updates its documentation |
Signed-off-by: Leandro Lucarella <[email protected]>
This needs a bump of the minimum `frequenz-api-common` to v0.6.1 as this category was added in that version. Signed-off-by: Leandro Lucarella <[email protected]>
github-actions
bot
added
the
part:tooling
|
@flora-hofmann-frequenz feel free to port these changes to the v0.x.x branch |
This function can convert any `int` to any `Enum`, with optional validation or forward-compatibility. Signed-off-by: Leandro Lucarella <[email protected]>
Recommend using the new `enum_from_proto()` instead. Signed-off-by: Leandro Lucarella <[email protected]>
This is to avoid errors in tests about duplicated `BaseId` prefixes. Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
shsms
approved these changes
Jun 30, 2025
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.
enum_from_proto()function.from_proto()