Add Enum class that supports deprecated members
#88
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
github-actions
bot
added
part:docs
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
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 introduces a new frequenz.core.enum module that provides an enhanced Enum class supporting deprecated enum members. The implementation extends the standard library's enum functionality to emit deprecation warnings when deprecated members are accessed.
Key changes:
- Added
DeprecatedMemberclass for marking deprecated enum members - Implemented
DeprecatingEnumMetametaclass to handle deprecation logic - Created comprehensive test suite covering attribute access, name lookup, and value lookup scenarios
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/frequenz/core/enum.py | Main implementation of the enhanced Enum class with deprecation support |
| tests/test_enum.py | Comprehensive test suite covering all deprecation warning scenarios |
| src/frequenz/core/datetime.py | Minor docstring update to improve module description |
| RELEASE_NOTES.md | Documentation of the new enum module feature |
| README.md | Added usage example for the new enum functionality |
| .github/labeler.yml | Added part:enum label configuration |
| .github/keylabeler.yml | Added enum part to key label mappings |
| .github/ISSUE_TEMPLATE/bug.yml | Added enum utilities to bug template options |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Signed-off-by: Leandro Lucarella <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Leandro Lucarella <[email protected]>
Marenz
reviewed
Aug 26, 2025
Marenz
reviewed
Aug 26, 2025
llucax
commented
Aug 26, 2025
|
I added a new fixup commit to replace |
This commit introduces a new `frequenz.core.enum` module that provides a drop-in replacement for the standard library's `enum.Enum` class, with added support for deprecating enum members. Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
|
And now that I see it was approved, I squashed all fixup commits, so this is ready for a final approval. |
Marenz
approved these changes
Aug 26, 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.
This commit introduces a new
frequenz.core.enummodule that provides a drop-in replacement for the standard library'senum.Enumclass, with added support for deprecating enum members.