Fix ExternalDeviceType not deserialised correctly

[DCSBL]

Summary by CodeRabbit

• New Features

  • Enhanced device type deserialization with case-insensitive matching for external devices.
  • Improved specificity of external device types in test data across various measurement instances.

• Bug Fixes

  • Fixed potential issues with device type identification by using more robust enum matching.

• Tests

  • Updated test snapshots to include more precise device type information.
  • Refined external device representations across multiple test scenarios, ensuring consistency and clarity.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request modifies the deserialization logic for the type field in the ExternalDevice class within the homewizard_energy/models.py file, allowing for case-insensitive matching of device types. Corresponding updates are made to multiple test snapshot files, enhancing the representation of external devices by replacing generic identifiers with specific device types across various measurement instances.

Changes

File	Change Summary
homewizard_energy/models.py	Updated ExternalDevice type deserialization to use case-insensitive enum matching via DeviceType.__members__.get(x.upper(), None)
tests/v1/__snapshots__/test_v1_homewizard_energy.ambr	Updated Measurement snapshots with specific external device types for HWE-P1 device
tests/v1/__snapshots__/test_v1_models.ambr	Modified test data snapshots with more specific external device types and identifiers
tests/v2/__snapshots__/test_v2_homewizard_energy.ambr	Updated Measurement snapshots to include specific device types like GAS_METER and WATER_METER
tests/v2/__snapshots__/test_v2_models.ambr	Updated test measurement snapshots with specific external device types

Sequence Diagram

sequenceDiagram
    participant Client
    participant ExternalDevice
    participant DeviceType
    
    Client->>ExternalDevice: Create with device type
    ExternalDevice->>DeviceType: Attempt to match type (case-insensitive)
    DeviceType-->>ExternalDevice: Return matched enum or None
    ExternalDevice-->>Client: Return ExternalDevice instance

Loading

Possibly related PRs

• Measurement in CombinedModels is not Optional, as all devices have support for Measurement API #459: The changes in this PR modify the CombinedModels class in homewizard_energy/models.py, specifically enforcing that the measurement attribute is required, which relates to the main PR's focus on the ExternalDevice class and its deserialization logic involving device types.
• Add CombinedModels model and 'fetch-all' method #453: This PR introduces the CombinedModels model in homewizard_energy/models.py, which is directly relevant to the main PR's changes in the same file, as both involve modifications to the structure and handling of device-related data.
• Use native arguments for set-functions and route led_brightness to state for v1 API #460: This PR updates method signatures in homewizard_energy.py, which may indirectly relate to the changes in the ExternalDevice class by altering how device data is managed and accessed, although it does not directly modify the same functions or classes.

---

📜 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 1e7fc27 and e706316.

📒 Files selected for processing (5)

• homewizard_energy/models.py (1 hunks)
• tests/v1/__snapshots__/test_v1_homewizard_energy.ambr (4 hunks)
• tests/v1/__snapshots__/test_v1_models.ambr (2 hunks)
• tests/v2/__snapshots__/test_v2_homewizard_energy.ambr (1 hunks)
• tests/v2/__snapshots__/test_v2_models.ambr (1 hunks)

---

🪧 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

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (1e7fc27) to head (e706316).
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #473   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          538       538           
  Branches        37        37           
=========================================
  Hits           538       538           

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