feat: add support for flag enum

[Czaki]

As followup #205 I have checked that we do not have a test for another enum base class. So I prevent future failures, I added tests and spotted that flag support was not fully functional as it does not support element combinations.

Also add StrEnum test.

Summary by CodeRabbit

• New Feature: Enhanced the QEnumComboBox class to support Flag enums in addition to regular enums. This allows users to select multiple options from a combo box.
• Refactor: Improved the internal handling of enum classes in QEnumComboBox by introducing helper functions for retrieving enum member names and values.
• Test: Added comprehensive test cases for the new Flag enum support in QEnumComboBox, ensuring robust functionality and error handling.

[coderabbitai]

Walkthrough

The changes primarily enhance the handling of enum classes in the QEnumComboBox class, adding support for Flag enums. New utility functions are introduced to generate a list of enum members and retrieve selected enum members. The test suite is expanded with new enum classes and test cases for the updated functionality.

Changes

File	Summary
src/superqt/combobox/_enum_combobox.py	Added support for Flag enums. Introduced utility functions _get_name_with_value and _get_enum_member_list. Updated setEnumClass and currentEnum methods to use these new functions.
tests/test_enum_comb_box.py	Expanded test suite with new enum classes (IntFlag1, Flag1, IntFlag2, etc.) and added test cases for the updated QEnumComboBox functionality.

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• Mention @coderabbitai in any review comment for bot assistance.
• Note: Review comments are made on code diffs or files, not on the PR overview.

Pause Incremental Reviews

• Insert @coderabbitai: ignore in the PR description to halt the bot's ongoing reviews. Remove the line to resume.

[coderabbitai]

Review Status

Actionable comments generated: 1

Commits

Files that changed from the base of the PR and between 0b984c2 and cd59a2b.

Files selected for processing (2)

• src/superqt/combobox/_enum_combobox.py (4 hunks)
• tests/test_enum_comb_box.py (3 hunks)

Files skipped from review due to trivial changes (1)

• tests/test_enum_comb_box.py

Additional comments (Suppressed): 3

src/superqt/combobox/_enum_combobox.py (3)

• 1-8: The new imports Flag, reduce, combinations, and or_ are introduced to support the flag enum functionality. Ensure that these modules are used appropriately in the code.

• 27-28: The _get_name_with_value function is a helper function that returns a tuple of the human-readable name and the original Enum member. This function is used to create a dictionary mapping from names to Enum members, which is useful for supporting flag enums.

• 88-92: The currentEnum method has been updated to retrieve the selected enum member from the dictionary created by _get_name_with_value instead of directly from the enum class. This change supports the retrieval of combined flag enum members.

-                else:
-                    return list(self._enum_class.__members__.values())[
-                        self.currentIndex() - 1
-                    ]
-            return list(self._enum_class.__members__.values())[self.currentIndex()]
+            return self._get_enum_member_list(self._enum_class)[self.currentText()]

Ensure that this change does not affect the retrieval of non-flag enum members.

[codecov]

Codecov Report

Patch coverage: 96.42% and project coverage change: +0.04% 🎉

Comparison is base (0b984c2) 87.34% compared to head (b57a37c) 87.38%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #207      +/-   ##
==========================================
+ Coverage   87.34%   87.38%   +0.04%     
==========================================
  Files          45       45              
  Lines        3326     3346      +20     
==========================================
+ Hits         2905     2924      +19     
- Misses        421      422       +1     

Files Changed	Coverage Δ
src/superqt/combobox/_enum_combobox.py	94.31% <96.42%> (+0.20%)	⬆️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tlambert03]

Thanks @Czaki

Looks like it needs updating for everything below 3.11

[coderabbitai]

Review Status

Actionable comments generated: 0

Commits

Files that changed from the base of the PR and between cd59a2b and d698a0e.

Files selected for processing (2)

• src/superqt/combobox/_enum_combobox.py (4 hunks)
• tests/test_enum_comb_box.py (3 hunks)

Additional comments (Suppressed): 8

tests/test_enum_comb_box.py (3)

• 1-5: The new hunk imports additional classes Flag and IntFlag from the enum module. These are used to define flag enumerations in the test cases.

• 43-78: New flag enumeration classes (IntFlag1, Flag1, IntFlag2, Flag2, FlagOrNum) are defined for testing purposes. The values of these enums are set up in a way that allows for testing various scenarios, such as collisions and combinations of flags.

• 171-277: Several new test cases have been added to verify the behavior of the QEnumComboBox class with flag enumerations and string enumerations (introduced in Python 3.11). These tests cover scenarios like creating the combo box with flag enums, handling collisions between enum members, and dealing with different representations of flag combinations in different Python versions. The use of pytest.mark.skipif ensures that certain tests are only run under appropriate Python versions.

src/superqt/combobox/_enum_combobox.py (5)

• 1-9: The new imports Flag, reduce, combinations, and or_ are introduced to support the handling of flag enums. Ensure that these modules are used correctly throughout the code.

• 21-38: The _get_name function has been updated to handle Flag enums. It now checks if the enum value is an instance of Flag and if so, it decomposes the flag into its constituent members and joins their names with a '|'. This change seems to be backward compatible as it still handles non-flag enums in the same way as before. However, ensure that this change does not affect any existing functionality where _get_name is used.

• 41-42: The new helper function _get_name_with_value returns a tuple containing the name and value of an enum member. Verify that this function is used correctly in the code.

• 68-84: The setEnumClass method has been significantly modified. It now uses the new helper function _get_enum_member_list to generate a dictionary of enum member names and values. If the enum is a subclass of Flag, it generates all possible combinations of flag members. This change should improve the handling of flag enums, but make sure it doesn't break the handling of regular enums.

• 102-106: The currentEnum method has been updated to use the new _get_enum_member_list function. This change should improve the handling of both regular and flag enums. However, verify that this change does not affect any existing functionality where currentEnum is used.

[Czaki]

Looks like it needs updating for everything below 3.11

Yes. I also hit problems as there was a bug in the new name mechanism in Python 3.11(.3).

As it is fixed in 3.11.5 then I left only the workaround code with a docstring explanation.

[coderabbitai]

Review Status

Actionable comments generated: 2

Commits

Files that changed from the base of the PR and between d698a0e and b57a37c.

Files selected for processing (2)

• src/superqt/combobox/_enum_combobox.py (4 hunks)
• tests/test_enum_comb_box.py (3 hunks)

Files skipped from review due to trivial changes (1)

• tests/test_enum_comb_box.py

Additional comments (Suppressed): 2

src/superqt/combobox/_enum_combobox.py (2)

• 1-9: The new imports Flag, reduce, combinations, and or_ are introduced to support flag enums. The sys module is imported to handle version-specific behavior for Python versions below 3.11.

• 111-115: The currentEnum method now uses the _get_enum_member_list function to return the currently selected Enum member. This is a more flexible approach than the previous implementation, which relied on the current index of the combobox. It should work well for both regular and flag enums.

[tlambert03]

great digging. thanks for the updates and all the great tests! LGTM