Move responsibility of fixing legacy model values to Model itself

[DCSBL]

Summary by CodeRabbit

• Refactor
  • Updated initialization method for CombinedModels class
  • Improved handling of device attributes and compatibility
  • Removed combined method from HomeWizardEnergyV1 class

[coderabbitai]

Walkthrough

The pull request modifies the CombinedModels class in the homewizard_energy/models.py file by introducing a custom __init__ method. This method initializes the class attributes with enhanced logic for backward compatibility, specifically handling the transfer of wifi_ssid from the measurement object to the system object and mapping the brightness attribute from the state object to system.status_led_brightness_pct. Simultaneously, the combined method is removed from the HomeWizardEnergyV1 class in homewizard_energy/v1/__init__.py.

Changes

File	Change Summary
homewizard_energy/models.py	Added custom __init__ method to CombinedModels class with logic for Wi-Fi SSID transfer and brightness mapping
homewizard_energy/v1/__init__.py	Removed combined method from HomeWizardEnergyV1 class and related CombinedModels import

Possibly related PRs

• Measurement in CombinedModels is not Optional, as all devices have support for Measurement API #459: Modifications to the measurement attribute in the CombinedModels class
• Use native arguments for set-functions and route led_brightness to state for v1 API #460: Changes to HomeWizardEnergy class handling of brightness settings

Suggested labels

breaking-change

---

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

[codecov]

Codecov Report

Attention: Patch coverage is 71.42857% with 4 lines in your changes missing coverage. Please review.

Project coverage is 95.37%. Comparing base (6649626) to head (24d8fd3).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
homewizard_energy/models.py	69.23%	2 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #462      +/-   ##
==========================================
+ Coverage   95.17%   95.37%   +0.20%     
==========================================
  Files           8        8              
  Lines         539      541       +2     
  Branches       40       40              
==========================================
+ Hits          513      516       +3     
  Misses         17       17              
+ Partials        9        8       -1     

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

homewizard_energy/models.py (2)

57-60: Avoid shadowing or re-initializing system if not necessary.

Currently, self.system might be re-initialized in subsequent steps (lines 65–66 and 71–72). Evaluate if it’s safe to set system here to a default System() object at the outset, minimizing further conditionals.

---

69-74: Ensure brightness is handled consistently.

The conversion (brightness / 255) * 100 returns a float. If status_led_brightness_pct is expected as an integer (0–100), consider rounding or clamping the result.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6649626 and 24d8fd3.

📒 Files selected for processing (2)

• homewizard_energy/models.py (1 hunks)
• homewizard_energy/v1/__init__.py (1 hunks)

🔇 Additional comments (3)

homewizard_energy/v1/__init__.py (1)

18-18: Removal of unused import is consistent with new architecture.

The removal of CombinedModels from the imports and the associated combined method in HomeWizardEnergyV1 aligns with the updated design, in which the CombinedModels initialization logic is moved to the class's own __init__ method in models.py.

homewizard_energy/models.py (2)

50-56: Constructor signature aligns with the new design.

By injecting device, measurement, state, and system into the CombinedModels constructor, you centralize the logic for backward compatibility within the model itself, making it more cohesive and self-contained.

---

62-68: Validate the potential conflicts when both measurement.wifi_ssid and system.wifi_ssid exist.

If system is provided with an existing wifi_ssid while measurement.wifi_ssid is also set, ensure there is a clear resolution strategy (which one takes precedence?).