feat!: do not auto convert enums to values for fetching attrs

[bdraco]

Description of change

The attrgetters no longer auto convert enums to their values

The objects we care about are str enums so convert should not be needed

I may have missed one but if so we can make a new function for it so we don't have to do the enum check for a case where 99%+ of the time is not needed (sometimes 10000+/min)

Summary by CodeRabbit

• Refactor

  • Removed the get_top_level_attr function from the public interface to streamline functionality.
  • Simplified logic in get_nested_attr and get_nested_attr_as_bool functions for improved performance.

• Tests

  • Updated test cases by removing get_top_level_attr references and adjusting assertions for get_nested_attr and boolean checks.

[coderabbitai]

Walkthrough

The recent update focuses on streamlining the codebase by removing the get_top_level_attr function from the uiprotect module's public interface. In utils.py, the logic of get_nested_attr and get_nested_attr_as_bool functions is simplified for efficiency. Corresponding tests in test_utils.py are also adjusted to reflect these changes, ensuring the code remains accurate and robust.

Changes

File	Change Summary
src/uiprotect/__init__.py	Removed get_top_level_attr function from the public interface.
src/uiprotect/utils.py	Simplified get_nested_attr and get_nested_attr_as_bool by removing unnecessary checks and refactored get_top_level_attr.
tests/test_utils.py	Adjusted tests to reflect the removal of get_top_level_attr and updated comparisons for get_nested_attr.

Poem

In the code's quiet drift and sway,
get_top_level_attr has gone away.
Nested attributes shine so bright,
Refactored logic, lean and light.
Tests now dance in gleeful cheer,
A cleaner path we now steer.
🌟🐇🚀

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Files	Coverage Δ
src/uiprotect/__init__.py	100.00% <ø> (ø)
src/uiprotect/utils.py	60.62% <100.00%> (-0.41%)	⬇️

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e4d53c1 and 16cc25c.

Files selected for processing (3)

• src/uiprotect/init.py (2 hunks)
• src/uiprotect/utils.py (2 hunks)
• tests/test_utils.py (4 hunks)

Files skipped from review due to trivial changes (1)

• src/uiprotect/init.py

Additional comments not posted (6)

tests/test_utils.py (1)

221-221: LGTM!

The change to directly compare the result with _MockEnum.C aligns with the PR objective to stop automatic conversion of enums to values.

src/uiprotect/utils.py (5)

637-637: LGTM!

The change to remove unnecessary checks for Enum types aligns with the PR objective to stop automatic conversion of enums to values.

---

646-646: LGTM!

The change to remove unnecessary checks for Enum types aligns with the PR objective to stop automatic conversion of enums to values.

---

651-651: LGTM!

The change to directly return the boolean value of the attribute aligns with the PR objective to stop automatic conversion of enums to values.

---

657-657: LGTM!

The change to use attrgetter for top-level attributes and get_nested_attr for nested attributes aligns with the PR objective to stop automatic conversion of enums to values.

---

651-651: LGTM!

The change to use get_top_level_attr_as_bool for top-level attributes and get_nested_attr_as_bool for nested attributes aligns with the PR objective to stop automatic conversion of enums to values.