Skip to content

Conversation

@bouwew
Copy link
Contributor

@bouwew bouwew commented Jan 21, 2025

When using Protocol for class-typing, the class should NOT have an init.

@bouwew bouwew requested a review from a team as a code owner January 21, 2025 17:12
@bouwew bouwew requested a review from brefra January 21, 2025 17:12
@coderabbitai
Copy link

coderabbitai bot commented Jan 21, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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
Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.08%. Comparing base (cd7a7bb) to head (cac9c9f).
Report is 10 commits behind head on async.

Additional details and impacted files
@@            Coverage Diff             @@
##            async     #198      +/-   ##
==========================================
+ Coverage   81.02%   81.08%   +0.06%     
==========================================
  Files          36       36              
  Lines        7325     7323       -2     
==========================================
+ Hits         5935     5938       +3     
+ Misses       1390     1385       -5     

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

Copy link
Contributor

@ArnoutD ArnoutD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading https://realpython.com/python-protocol/ this is not what a Protocol was for and if Home Assistant would publish a Coordinator like Protocol this would implement it not define it

@brefra
Copy link
Contributor

brefra commented Feb 1, 2025

I don't like to remove the protcol class. In the end the protocol class is used and useful for external typing
Lets remove the __init__ function instead.

@bouwew
Copy link
Contributor Author

bouwew commented Feb 2, 2025

@brefra Looks like keeping the Protocol typing and removing the init is also working.
I also tested with the Integration-code, the import-error is also gone with this code-variant.

Also I included a logger-change that @ArnoutD suggested.

@bouwew bouwew changed the title Remove Protocol typing Fix import error in the Integration due to incorrect use of Protocol typing Feb 2, 2025
@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 2, 2025

@bouwew bouwew changed the title Fix import error in the Integration due to incorrect use of Protocol typing Fix import error in Integration by correcting use of Protocol typing Feb 2, 2025
@bouwew bouwew merged commit ebba842 into async Feb 6, 2025
32 checks passed
@bouwew bouwew deleted the fix-typing branch February 6, 2025 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants