Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add _aenter_ helpers to v1 and v2 to allow version-specific functions via 'with ..' #482

Merged
merged 1 commit into from
Jan 21, 2025

Conversation

DCSBL
Copy link
Collaborator

@DCSBL DCSBL commented Jan 21, 2025

async with HomeWizardEnergyV2(...) as api: returned a HomeWizardEnergy, not a HomeWizardEnergyV2 according to MyPy. So for this call 'get_token' is not known (as it only exists in HomeWizardEnergyV2

Summary by CodeRabbit

  • New Features
    • Added asynchronous context manager support for HomeWizardEnergyV1 and HomeWizardEnergyV2 classes
    • Enables more flexible async resource management when using the library

@DCSBL DCSBL enabled auto-merge (squash) January 21, 2025 13:15
Copy link

coderabbitai bot commented Jan 21, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces asynchronous context manager methods (__aenter__) to both HomeWizardEnergyV1 and HomeWizardEnergyV2 classes. These additions enable the classes to be used with async with statements, allowing for more flexible and clean resource management in asynchronous Python code. The changes are consistent across both version classes, adding the same type of method without modifying existing functionality.

Changes

File Change Summary
homewizard_energy/v1/__init__.py Added async def __aenter__(self) -> HomeWizardEnergyV1 method to enable asynchronous context management
homewizard_energy/v2/__init__.py Added async def __aenter__(self) -> HomeWizardEnergyV2 method to enable asynchronous context management

Sequence Diagram

sequenceDiagram
    participant User
    participant HomeWizardEnergyClass
    
    User->>HomeWizardEnergyClass: async with HomeWizardEnergyClass() as instance
    activate HomeWizardEnergyClass
    HomeWizardEnergyClass-->>User: Returns instance
    
    Note over User,HomeWizardEnergyClass: Perform async operations
    
    User->>HomeWizardEnergyClass: Exit async context
    deactivate HomeWizardEnergyClass
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f4c6232 and 18476e7.

📒 Files selected for processing (2)
  • homewizard_energy/v1/__init__.py (1 hunks)
  • homewizard_energy/v2/__init__.py (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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 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.

@DCSBL DCSBL merged commit fd53364 into main Jan 21, 2025
30 checks passed
@DCSBL DCSBL deleted the DCSBL-2025-45 branch January 21, 2025 13:17
Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.63%. Comparing base (f4c6232) to head (18476e7).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #482   +/-   ##
=======================================
  Coverage   99.63%   99.63%           
=======================================
  Files           8        8           
  Lines         541      545    +4     
  Branches       40       40           
=======================================
+ Hits          539      543    +4     
  Misses          1        1           
  Partials        1        1           

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

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.

1 participant