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

Reapply hotfix 'invalid tariff' #476

Merged
merged 1 commit into from
Jan 7, 2025
Merged

Reapply hotfix 'invalid tariff' #476

merged 1 commit into from
Jan 7, 2025

Conversation

DCSBL
Copy link
Collaborator

@DCSBL DCSBL commented Jan 7, 2025

Tariff may be a other value than 1,2,3 or 4. Any other value is invalid and will be ignored.

Summary by CodeRabbit

  • New Features

    • Enhanced validation for measurement tariff values
    • Automatically sets tariff to None when an invalid value is detected
  • Tests

    • Added test cases to verify tariff validation behavior in different API versions
    • Confirmed that invalid tariff values are correctly handled during object creation

Copy link
Contributor

coderabbitai bot commented Jan 7, 2025

Warning

Rate limit exceeded

@DCSBL has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 24 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 7877cfb and e20c1cb.

📒 Files selected for processing (3)
  • homewizard_energy/models.py (1 hunks)
  • tests/v1/test_v1_models.py (1 hunks)
  • tests/v2/test_v2_models.py (1 hunks)

Walkthrough

This pull request introduces a new validation mechanism for the Measurement class in the HomeWizard Energy models. A post-deserialization method __post_deserialize__ is added to handle invalid tariff values by setting them to None. Corresponding test cases are created in both v1 and v2 test suites to verify this new validation behavior, ensuring that Measurement instances gracefully handle unexpected tariff values.

Changes

File Change Summary
homewizard_energy/models.py Added __post_deserialize__ class method to Measurement class to validate and normalize tariff values during deserialization
tests/v1/test_v1_models.py Added test_data_ignores_invalid_tariff() async test to validate tariff value handling
tests/v2/test_v2_models.py Added test_measurement_ignores_invalid_tariff() async test to validate tariff value handling

Sequence Diagram

sequenceDiagram
    participant Deserializer
    participant Measurement
    Deserializer->>Measurement: Deserialize with tariff value
    Measurement->>Measurement: __post_deserialize__() method called
    alt Invalid Tariff
        Measurement-->>Measurement: Set tariff to None
    else Valid Tariff
        Measurement-->>Measurement: Keep original tariff value
    end
    Deserializer->>Deserializer: Continue processing
Loading

Possibly related PRs


🪧 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 enabled auto-merge (squash) January 7, 2025 21:44
@DCSBL DCSBL merged commit 3340ba6 into main Jan 7, 2025
30 checks passed
@DCSBL DCSBL deleted the DCSBL-2025-26 branch January 7, 2025 21:45
Copy link

codecov bot commented Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.62%. Comparing base (8c597e3) to head (e20c1cb).
Report is 4 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##              main     #476      +/-   ##
===========================================
- Coverage   100.00%   99.62%   -0.38%     
===========================================
  Files            8        8              
  Lines          526      539      +13     
  Branches        37       40       +3     
===========================================
+ Hits           526      537      +11     
- Misses           0        1       +1     
- Partials         0        1       +1     

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

@DCSBL DCSBL added the Bug/Bugfix Something isn't working, or is fixed label Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug/Bugfix Something isn't working, or is fixed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant