feat: add display method to HtkIntFlag for human-readable flag names #505
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
## Changes - Introduced `display` class method in `HtkIntFlag` to convert combined flag values into a list of human-readable names. - Updated docstring for `HtkIntFlag` to reflect the new functionality. This enhancement improves usability by allowing easier interpretation of combined flag values.
jontsai
requested changes
Oct 22, 2025
utils/enums.py
Outdated
| """ | ||
|
|
||
| @classmethod | ||
| def display(cls, int_value): |
There was a problem hiding this comment.
Suggested change
| def display(cls, int_value): | |
| def display(cls, int_value) -> list[str]: |
## Changes - Modified the `display` method in `HtkIntFlag` to include a return type annotation of `list[str]`. - Enhanced the docstring with an example of how to use the `display` method with a sample class. This change improves code clarity and type safety.
jontsai
requested changes
Oct 22, 2025
utils/enums.py
Outdated
| return result | ||
|
|
||
| @classmethod | ||
| def list_flags(cls, int_value): |
There was a problem hiding this comment.
Suggested change
| def list_flags(cls, int_value): | |
| def list_flags(cls, int_value) -> list[HtkIntFlag]: |
Or list['HtkIntFlag']
## Changes - Updated the `list_flags` method in `HtkIntFlag` to specify a return type of `list[HtkIntFlag]`. - Enhanced the method's docstring for improved clarity. This change enhances code readability and type safety.
jontsai
approved these changes
Oct 22, 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.
Changes
displayclass method inHtkIntFlagto convert combined flag values into a list of human-readable names.HtkIntFlagto reflect the new functionality.This enhancement improves usability by allowing easier interpretation of combined flag values.